Add JobId to Code Transform History (#4087)

tincheng · web-flow · commit db4128905d08 · 2024-01-04T18:15:17.000-08:00
diff --git a/.changes/next-release/feature-c84d6202-5fca-44b9-b30a-da4d9d30f177.json b/.changes/next-release/feature-c84d6202-5fca-44b9-b30a-da4d9d30f177.json
@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "Add Job Id to Code Transform Job History"
+}
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/CodeModernizerManager.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/CodeModernizerManager.kt
@@ -352,7 +352,7 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
             codeTransformationSession = session
             initModernizationJobUI(false, project.getModuleOrProjectNameForFile(session.sessionContext.configurationFile))
             codeModernizerBottomWindowPanelManager.setResumeJobUI(currentJobResult, plan, session.sessionContext.sourceJavaVersion)
-            session.resumeJob(currentJobResult.creationTime())
+            session.resumeJob(currentJobResult.creationTime(), lastJobId)
             val result = handleJobStarted(lastJobId, session)
             postModernizationJob(result)
         } catch (e: Exception) {
@@ -606,7 +606,7 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
                     // Code successfully stopped toast will display when post job is run after this
                     CodetransformTelemetry.totalRunTime(
                         codeTransformSessionId = CodeTransformTelemetryState.instance.getSessionId(),
-                        codeTransformResultStatusMessage = "JobCanceled",
+                        codeTransformResultStatusMessage = "JobCancelled",
                         codeTransformRunTimeLatency = calculateTotalLatency(CodeTransformTelemetryState.instance.getStartTime(), Instant.now())
                     )
                 }
@@ -615,7 +615,7 @@ class CodeModernizerManager(private val project: Project) : PersistentStateCompo
                 notifyTransformationFailedToStop(e.localizedMessage)
                 CodetransformTelemetry.totalRunTime(
                     codeTransformSessionId = CodeTransformTelemetryState.instance.getSessionId(),
-                    codeTransformResultStatusMessage = "JobCanceled",
+                    codeTransformResultStatusMessage = "JobCancelled",
                     codeTransformRunTimeLatency = calculateTotalLatency(CodeTransformTelemetryState.instance.getStartTime(), Instant.now())
                 )
             }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/CodeModernizerSession.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/CodeModernizerSession.kt
@@ -116,15 +116,15 @@ class CodeModernizerSession(
                 return CodeModernizerStartJobResult.Cancelled
             }
             val startJobResponse = startJob(uploadId)
-            state.putJobHistory(sessionContext, "STARTED")
+            state.putJobHistory(sessionContext, TransformationStatus.STARTED, startJobResponse.transformationJobId())
             state.currentJobStatus = TransformationStatus.STARTED
             CodeModernizerStartJobResult.Started(JobId(startJobResponse.transformationJobId()))
         } catch (e: AlreadyDisposedException) {
             LOG.warn { e.localizedMessage }
             return CodeModernizerStartJobResult.Disposed
         } catch (e: Exception) {
             val errorMessage = "Failed to start job"
-            state.putJobHistory(sessionContext, "FAILED TO START")
+            state.putJobHistory(sessionContext, TransformationStatus.FAILED)
             state.currentJobStatus = TransformationStatus.FAILED
             CodetransformTelemetry.logGeneralError(
                 codeTransformApiErrorMessage = errorMessage,
@@ -161,7 +161,7 @@ class CodeModernizerSession(
             state.currentJobStatus = new
             sessionContext.project.refreshCwQTree()
             val instant = Instant.now()
-            state.updateJobHistory(sessionContext, new.name, instant)
+            state.updateJobHistory(sessionContext, new, instant)
             setCurrentJobStopTime(new, instant)
             setCurrentJobSummary(new)
             jobTransitionHandler(new, plan)
@@ -250,7 +250,7 @@ class CodeModernizerSession(
     /**
      * This will resume the job, i.e. it will resume the main job loop kicked of by [createModernizationJob]
      */
-    fun resumeJob(startTime: Instant) = state.putJobHistory(sessionContext, "Started", startTime)
+    fun resumeJob(startTime: Instant, jobId: JobId) = state.putJobHistory(sessionContext, TransformationStatus.STARTED, jobId.id, startTime)
 
     /*
      * Adapted from [CodeWhispererCodeScanSession]
@@ -412,7 +412,7 @@ class CodeModernizerSession(
                     isPartialSuccess = true
                 }
                 val instant = Instant.now()
-                state.updateJobHistory(sessionContext, new.name, instant)
+                state.updateJobHistory(sessionContext, new, instant)
                 setCurrentJobStopTime(new, instant)
                 jobTransitionHandler(new, plan)
                 LOG.warn { "in awaitJobCompletion, state changed for job $jobId: $old -> $new" }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/model/JobHistoryItem.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/model/JobHistoryItem.kt
@@ -7,12 +7,13 @@ import java.time.Instant
 import kotlin.time.Duration.Companion.seconds
 import kotlin.time.toKotlinDuration
 
-data class JobHistoryItem(val moduleName: String, val status: String, val startTime: Instant, val runTime: java.time.Duration) {
+data class JobHistoryItem(val moduleName: String, val status: String, val startTime: Instant, val runTime: java.time.Duration, val jobId: String) {
     operator fun get(col: Int): Any = when (col) {
         0 -> moduleName
         1 -> status
         2 -> startTime
         3 -> runTime.toKotlinDuration().inWholeSeconds.seconds.toString()
+        4 -> jobId
         else -> throw IllegalArgumentException("Invalid column $col")
     }
 }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/panels/CodeModernizerJobHistoryTablePanel.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/panels/CodeModernizerJobHistoryTablePanel.kt
@@ -21,7 +21,8 @@ class CodeModernizerJobHistoryTablePanel : JPanel(BorderLayout()) {
         message("codemodernizer.toolwindow.table.header.module_name"),
         message("codemodernizer.toolwindow.table.header.status"),
         message("codemodernizer.toolwindow.table.header.date"),
-        message("codemodernizer.toolwindow.table.header.run_length")
+        message("codemodernizer.toolwindow.table.header.run_length"),
+        message("codemodernizer.toolwindow.table.header.job_id"),
     )
     var tableData: Array<JobHistoryItem> = emptyArray()
     var tableModel = JobHistoryTableModel(tableData, columnNames)
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/state/CodeModernizerSessionState.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codemodernizer/state/CodeModernizerSessionState.kt
@@ -29,23 +29,24 @@ class CodeModernizerSessionState {
     var transformationSummary: TransformationSummary? = null
     var currentJobId: JobId? = null
 
-    private fun getJobItemId(sessionContext: CodeModernizerSessionContext) = Path(sessionContext.configurationFile.path).toAbsolutePath().toString()
-    fun putJobHistory(sessionContext: CodeModernizerSessionContext, status: String, startedAt: Instant = Instant.now()) {
-        val id = getJobItemId(sessionContext)
+    private fun getJobModuleName(sessionContext: CodeModernizerSessionContext) = Path(sessionContext.configurationFile.path).toAbsolutePath().toString()
+    fun putJobHistory(sessionContext: CodeModernizerSessionContext, status: TransformationStatus, jobId: String = "", startedAt: Instant = Instant.now()) {
+        val moduleName = getJobModuleName(sessionContext)
         val jobHistoryItem = JobHistoryItem(
-            id,
-            status,
+            moduleName,
+            status.name,
             startedAt,
             Duration.ZERO,
+            jobId,
         )
-        previousJobHistory[id] = jobHistoryItem
+        previousJobHistory[moduleName] = jobHistoryItem
     }
 
-    fun updateJobHistory(sessionContext: CodeModernizerSessionContext, newStatus: String, endTime: Instant) {
-        val id = getJobItemId(sessionContext)
-        val jobStatus = previousJobHistory.get(id) ?: throw CodeModernizerException("Unable to update the job history for $id")
+    fun updateJobHistory(sessionContext: CodeModernizerSessionContext, newStatus: TransformationStatus, endTime: Instant) {
+        val moduleName = getJobModuleName(sessionContext)
+        val jobStatus = previousJobHistory.get(moduleName) ?: throw CodeModernizerException("Unable to update the job history for $moduleName")
         val timeTaken = Duration.between(jobStatus.startTime, endTime)
-        previousJobHistory[id] = jobStatus.copy(status = newStatus, runTime = timeTaken)
+        previousJobHistory[moduleName] = jobStatus.copy(status = newStatus.name, runTime = timeTaken)
     }
 
     fun getJobHistory(): Array<JobHistoryItem> = previousJobHistory.values.toTypedArray()
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codemodernizer/panels/CodeModernizerJobHistoryPanelTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/services/codewhisperer/codemodernizer/panels/CodeModernizerJobHistoryPanelTest.kt
@@ -17,15 +17,15 @@ class CodeModernizerJobHistoryPanelTest {
     @Test
     fun `does render table with headers and text`() {
         val testData = arrayOf(
-            JobHistoryItem("Java8Test", "Completed", Instant.now(), Duration.ZERO),
+            JobHistoryItem("Java8Test", "Completed", Instant.now(), Duration.ZERO, "MockJobId"),
         )
         val tablePanelMock = spy(CodeModernizerJobHistoryTablePanel())
         tablePanelMock.setDefaultUI()
         tablePanelMock.updateTableData(testData)
         verify(tablePanelMock, times(1)).setDefaultUI()
         verify(tablePanelMock, times(1)).updateTableData(testData)
         assertThat(tablePanelMock.headerLabel.text).isEqualTo("Transformation job history")
-        assertThat(tablePanelMock.jbTable.columnCount).isEqualTo(4)
+        assertThat(tablePanelMock.jbTable.columnCount).isEqualTo(5)
         assertThat(tablePanelMock.jbTable.isEmpty).isFalse()
         assertThat(tablePanelMock.tableData).isEqualTo(testData)
     }
diff --git a/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties b/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties
@@ -590,6 +590,7 @@ codemodernizer.toolwindow.scan_in_progress.stopping=Stopping the job...
 codemodernizer.toolwindow.scan_in_progress.transforming=Amazon Q is transforming your code. Details will appear soon.
 codemodernizer.toolwindow.stop_scan=Stop job
 codemodernizer.toolwindow.table.header.date=Date
+codemodernizer.toolwindow.table.header.job_id=Job Id
 codemodernizer.toolwindow.table.header.module_name=Module name
 codemodernizer.toolwindow.table.header.run_length=Job running time
 codemodernizer.toolwindow.table.header.status=Status

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "type" : "feature",
 +  "description" : "Add Job Id to Code Transform Job History"
 +}
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,13 @@ import java.time.Instant`
`7`	`7`	`import kotlin.time.Duration.Companion.seconds`
`8`	`8`	`import kotlin.time.toKotlinDuration`
`9`	`9`
`10`		`-data class JobHistoryItem(val moduleName: String, val status: String, val startTime: Instant, val runTime: java.time.Duration) {`
	`10`	`+data class JobHistoryItem(val moduleName: String, val status: String, val startTime: Instant, val runTime: java.time.Duration, val jobId: String) {`
`11`	`11`	`operator fun get(col: Int): Any = when (col) {`
`12`	`12`	`0 -> moduleName`
`13`	`13`	`1 -> status`
`14`	`14`	`2 -> startTime`
`15`	`15`	`3 -> runTime.toKotlinDuration().inWholeSeconds.seconds.toString()`
	`16`	`+ 4 -> jobId`
`16`	`17`	`else -> throw IllegalArgumentException("Invalid column $col")`
`17`	`18`	`}`
`18`	`19`	`}`