fix(gumby): add jobId to feedback, delete temp files, use shell:true aws#4237

Problem:
1. Need to add jobId to in-IDE feedback when a transformation job was run so that we can investigate any issues
2. Need to delete temp files (the ZIP upload and the result archive) once no longer needed
3. Need a test requested by AppSec to ensure zipCode behaves correctly
4. Minor typos
5. Dropdown menu with 3 buttons (Show Changes, Show Plan, Show Summary) was inconsistent: Show Plan was visible but enabled/disabled as necessary while the other 2 buttons toggled their visibility as necessary
6. Used Font Awesome for an icon, but better to use built-in icon
7. When running shell commands setting `shell: false` resulted in the `mvn` command failing for 1 user due to inability to find the Maven executable

Solution:
1. Add jobId
2. Delete temp files
3. Write test
4. Fix typos
5. Align behavior of all 3 buttons via `"enablement"`
6. Use built-in icon
7. Set `shell: true`

Author: dhasani23

.changes/next-release/Bug Fix-40e7e079-f63c-4ca8-8639-8a8810f59f85.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "Amazon Q Transform: delete temp files we create when no longer needed"
+}

.changes/next-release/Bug Fix-488470d7-db3a-48fe-8c06-2b499e374995.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "Amazon Q Transform: make copy-dependencies command less error prone"
+}

package.json

@@ -787,7 +787,7 @@
             },
             {
                 "view": "aws.amazonq.transformationProposedChangesTree",
-                "contents": "Project transformation is complete.\n Downloading the updated code.",
+                "contents": "Project transformation is complete.\n Downloading the proposed changes...",
                 "when": "gumby.reviewState == PreparingReview"
             }
         ],
@@ -1343,11 +1343,11 @@
                 },
                 {
                     "command": "aws.amazonq.transformationHub.summary.reveal",
-                    "when": "view == aws.amazonq.transformationHub && gumby.reviewState == InReview"
+                    "when": "view == aws.amazonq.transformationHub"
                 },
                 {
                     "command": "aws.amazonq.transformationHub.reviewChanges.reveal",
-                    "when": "view == aws.amazonq.transformationHub && gumby.reviewState == InReview"
+                    "when": "view == aws.amazonq.transformationHub"
                 },
                 {
                     "command": "aws.amazonq.showTransformationPlanInHub",
@@ -2414,15 +2414,18 @@
             },
             {
                 "command": "aws.amazonq.transformationHub.summary.reveal",
-                "title": "%AWS.command.q.transform.showChangeSummary%"
+                "title": "%AWS.command.q.transform.showChangeSummary%",
+                "enablement": "gumby.reviewState == InReview"
             },
             {
                 "command": "aws.amazonq.transformationHub.reviewChanges.reveal",
-                "title": "%AWS.command.q.transform.showChanges%"
+                "title": "%AWS.command.q.transform.showChanges%",
+                "enablement": "gumby.reviewState == InReview"
             },
             {
                 "command": "aws.amazonq.showTransformationPlanInHub",
-                "title": "%AWS.command.q.transform.showTransformationPlan%"
+                "title": "%AWS.command.q.transform.showTransformationPlan%",
+                "enablement": "gumby.isPlanAvailable"
             },
             {
                 "command": "aws.auth.switchConnections",

src/codewhisperer/commands/startTransformByQ.ts

@@ -164,6 +164,7 @@ export async function startTransformByQ() {
     let intervalId = undefined
     let errorMessage = ''
     let resultStatusMessage = ''
+    let payloadFileName = ''
 
     try {
         intervalId = setInterval(() => {
@@ -176,11 +177,11 @@ export async function startTransformByQ() {
         let uploadId = ''
         throwIfCancelled()
         try {
-            const payloadFileName = await zipCode(state.project.description!)
+            payloadFileName = await zipCode(state.project.description!)
             await vscode.commands.executeCommand('aws.amazonq.refresh') // so that button updates
             uploadId = await uploadPayload(payloadFileName)
         } catch (error) {
-            errorMessage = 'Failed to upload archive'
+            errorMessage = 'Failed to upload code'
             telemetry.codeTransform_logGeneralError.emit({
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformApiErrorMessage: errorMessage,
@@ -331,6 +332,10 @@ export async function startTransformByQ() {
         } else if (transformByQState.isPartiallySucceeded()) {
             void vscode.window.showInformationMessage(CodeWhispererConstants.transformByQPartiallyCompletedMessage)
         }
+
+        if (payloadFileName !== '') {
+            fs.rmSync(payloadFileName, { recursive: true, force: true }) // delete ZIP if it exists
+        }
     }
     clearInterval(intervalId)
     transformByQState.setToNotStarted() // so that the "Transform by Q" button resets

src/codewhisperer/models/model.ts

@@ -274,6 +274,8 @@ export class TransformByQState {
     private planFilePath: string = ''
     private summaryFilePath: string = ''
 
+    private resultArchiveFilePath: string = ''
+
     private polledJobStatus: string = ''
 
     private jobFailureReason: string = ''
@@ -338,6 +340,10 @@ export class TransformByQState {
         return this.summaryFilePath
     }
 
+    public getResultArchiveFilePath() {
+        return this.resultArchiveFilePath
+    }
+
     public getJobFailureReason() {
         return this.jobFailureReason
     }
@@ -402,6 +408,10 @@ export class TransformByQState {
         this.summaryFilePath = filePath
     }
 
+    public setResultArchiveFilePath(filePath: string) {
+        this.resultArchiveFilePath = filePath
+    }
+
     public setJobFailureReason(reason: string) {
         this.jobFailureReason = reason
     }

src/codewhisperer/service/transformByQHandler.ts

@@ -113,7 +113,7 @@ export async function validateProjectSelection(project: vscode.QuickPickItem) {
     const classFilePath = compiledJavaFiles[0].fsPath
     const baseCommand = 'javap'
     const args = ['-v', classFilePath]
-    const spawnResult = spawnSync(baseCommand, args, { shell: false, encoding: 'utf-8' })
+    const spawnResult = spawnSync(baseCommand, args, { shell: true, encoding: 'utf-8' })
 
     if (spawnResult.error || spawnResult.status !== 0) {
         void vscode.window.showErrorMessage(CodeWhispererConstants.noSupportedJavaProjectsFoundMessage)
@@ -190,13 +190,13 @@ export async function uploadArtifactToS3(fileName: string, resp: CreateUploadUrl
         })
         getLogger().info(`CodeTransform: Status from S3 Upload = ${response.status}`)
     } catch (e: any) {
-        const errorMessage = e?.message || 'Error in S3 UploadZip API call'
+        const errorMessage = (e as Error).message ?? 'Error in S3 UploadZip API call'
         getLogger().error('CodeTransform: UploadZip error = ', errorMessage)
         telemetry.codeTransform_logApiError.emit({
             codeTransformApiNames: 'UploadZip',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
-            codeTransformRequestId: e?.requestId,
+            codeTransformRequestId: e.requestId ?? '',
             result: MetadataResult.Fail,
             reason: 'UploadToS3Failed',
         })
@@ -229,8 +229,8 @@ export async function stopJob(jobId: string) {
                 codeTransformApiNames: 'StopTransformation',
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformJobId: jobId,
-                codeTransformApiErrorMessage: e?.message || errorMessage,
-                codeTransformRequestId: e?.requestId,
+                codeTransformApiErrorMessage: (e as Error).message ?? errorMessage,
+                codeTransformRequestId: e.requestId ?? '',
                 result: MetadataResult.Fail,
                 reason: 'StopTransformationFailed',
             })
@@ -242,9 +242,10 @@ export async function stopJob(jobId: string) {
 export async function uploadPayload(payloadFileName: string) {
     const sha256 = getSha256(payloadFileName)
     throwIfCancelled()
+    let response = undefined
     try {
         const apiStartTime = Date.now()
-        const response = await codeWhisperer.codeWhispererClient.createUploadUrl({
+        response = await codeWhisperer.codeWhispererClient.createUploadUrl({
             contentChecksum: sha256,
             contentChecksumType: CodeWhispererConstants.contentChecksumType,
             uploadIntent: CodeWhispererConstants.uploadIntent,
@@ -257,22 +258,27 @@ export async function uploadPayload(payloadFileName: string) {
             codeTransformRequestId: response.$response.requestId,
             result: MetadataResult.Pass,
         })
-        await uploadArtifactToS3(payloadFileName, response)
-        return response.uploadId
     } catch (e: any) {
-        const errorMessage = e?.message || 'Error in CreateUploadUrl API call'
+        const errorMessage = (e as Error).message ?? 'Error in CreateUploadUrl API call'
         getLogger().error('CodeTransform: CreateUploadUrl error: = ', errorMessage)
         telemetry.codeTransform_logApiError.emit({
             codeTransformApiNames: 'CreateUploadUrl',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
-            codeTransformRequestId: e?.requestId,
+            codeTransformRequestId: e.requestId ?? '',
             result: MetadataResult.Fail,
             reason: 'CreateUploadUrlFailed',
         })
         // Pass along error to callee function
         throw new ToolkitError(errorMessage, { cause: e as Error })
     }
+    try {
+        await uploadArtifactToS3(payloadFileName, response)
+    } catch (e: any) {
+        const errorMessage = (e as Error).message ?? 'Error in uploadArtifactToS3 call'
+        throw new ToolkitError(errorMessage, { cause: e as Error })
+    }
+    return response.uploadId
 }
 
 /**
@@ -317,7 +323,7 @@ function getProjectDependencies(modulePath: string): string[] {
         '-Dmdep.copyPom=true',
         '-Dmdep.addParentPoms=true',
     ]
-    const spawnResult = spawnSync(baseCommand, args, { cwd: modulePath, shell: false, encoding: 'utf-8' })
+    const spawnResult = spawnSync(baseCommand, args, { cwd: modulePath, shell: true, encoding: 'utf-8' })
 
     if (spawnResult.error || spawnResult.status !== 0) {
         void vscode.window.showErrorMessage(CodeWhispererConstants.dependencyErrorMessage)
@@ -439,13 +445,13 @@ export async function startJob(uploadId: string) {
         })
         return response.transformationJobId
     } catch (e: any) {
-        const errorMessage = e?.message || 'Error in StartTransformation API call'
+        const errorMessage = (e as Error).message ?? 'Error in StartTransformation API call'
         getLogger().error('CodeTransform: StartTransformation error = ', errorMessage)
         telemetry.codeTransform_logApiError.emit({
             codeTransformApiNames: 'StartTransformation',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformApiErrorMessage: errorMessage,
-            codeTransformRequestId: e?.requestId,
+            codeTransformRequestId: e.requestId ?? '',
             result: MetadataResult.Fail,
             reason: 'StartTransformationFailed',
         })
@@ -490,14 +496,14 @@ export async function getTransformationPlan(jobId: string) {
 
         return plan
     } catch (e: any) {
-        const errorMessage = e?.message || 'Error in GetTransformationPlan API call'
+        const errorMessage = (e as Error).message ?? 'Error in GetTransformationPlan API call'
         getLogger().error('CodeTransform: GetTransformationPlan error = ', errorMessage)
         telemetry.codeTransform_logApiError.emit({
             codeTransformApiNames: 'GetTransformationPlan',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformJobId: jobId,
             codeTransformApiErrorMessage: errorMessage,
-            codeTransformRequestId: e?.requestId,
+            codeTransformRequestId: e.requestId ?? '',
             result: MetadataResult.Fail,
             reason: 'GetTransformationPlanFailed',
         })
@@ -523,14 +529,14 @@ export async function getTransformationSteps(jobId: string) {
         })
         return response.transformationPlan.transformationSteps
     } catch (e: any) {
-        const errorMessage = e?.message || 'Error in GetTransformationPlan API call'
+        const errorMessage = (e as Error).message ?? 'Error in GetTransformationPlan API call'
         getLogger().error('CodeTransform: GetTransformationPlan error = ', errorMessage)
         telemetry.codeTransform_logApiError.emit({
             codeTransformApiNames: 'GetTransformationPlan',
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
             codeTransformJobId: jobId,
             codeTransformApiErrorMessage: errorMessage,
-            codeTransformRequestId: e?.requestId,
+            codeTransformRequestId: e.requestId ?? '',
             result: MetadataResult.Fail,
             reason: 'GetTransformationPlanFailed',
         })
@@ -584,14 +590,14 @@ export async function pollTransformationJob(jobId: string, validStates: string[]
                 throw new Error('Transform by Q timed out')
             }
         } catch (e: any) {
-            const errorMessage = e?.message || 'Error in GetTransformation API call'
+            const errorMessage = (e as Error).message ?? 'Error in GetTransformation API call'
             getLogger().error('CodeTransform: GetTransformation error = ', errorMessage)
             telemetry.codeTransform_logApiError.emit({
                 codeTransformApiNames: 'GetTransformation',
                 codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
                 codeTransformJobId: jobId,
                 codeTransformApiErrorMessage: errorMessage,
-                codeTransformRequestId: e?.requestId,
+                codeTransformRequestId: e.requestId ?? '',
                 result: MetadataResult.Fail,
                 reason: 'GetTransformationFailed',
             })

src/codewhisperer/service/transformationHubViewProvider.ts

@@ -123,7 +123,7 @@ export class TransformationHubViewProvider implements vscode.WebviewViewProvider
             progressHtml = `<p><b>Transformation Status</b></p>`
             progressHtml += `<p> ${this.getProgressIconMarkup(
                 planProgress['uploadCode']
-            )} Upload code to secure build environment</p>`
+            )} Zip code and upload to secure build environment</p>`
             if (planProgress['uploadCode'] === StepProgress.Succeeded) {
                 progressHtml += `<p> ${this.getProgressIconMarkup(
                     planProgress['buildCode']
@@ -189,7 +189,20 @@ export class TransformationHubViewProvider implements vscode.WebviewViewProvider
             <html lang="en">
             <head>
             <title>Transformation Hub</title>
-            <script src="https://kit.fontawesome.com/f865aad943.js" crossorigin="anonymous"></script>
+            <style>
+                @keyframes spin {
+                    0% {
+                        transform: rotate(0deg);
+                    }
+                    100% {
+                        transform: rotate(360deg);
+                    }
+                }
+                .spinner {
+                    display: inline-block;
+                    animation: spin 1s infinite;
+                }
+            </style>
             </head>
             <body>
             <div style="display: flex">
@@ -233,13 +246,14 @@ export class TransformationHubViewProvider implements vscode.WebviewViewProvider
             </html>`
     }
 
+    // TODO: replace these pasted icons with codicons
     private getProgressIconMarkup(stepStatus: StepProgress) {
         if (stepStatus === StepProgress.Succeeded) {
             return `<span style="color: green"> ✓ </span>`
         } else if (stepStatus === StepProgress.Pending) {
-            return `<span> <i class="fas fa-spinner fa-spin"></i> </span>` // TODO: switch from FA to native VSCode icons
+            return `<span style="color: grey" class="spinner"> ↻ </span>`
         } else {
-            return `<span style="color: red"> X </span>`
+            return `<span style="color: grey"> ✓ </span>`
         }
     }
 }