feat(codeTransform): upload error logs #4325

Problem
We run Maven shell commands to install and copy-dependencies and a javap shell command to determine a project's java version, and although we know the frequency of failures for these commands, we have insufficient insight into why they failed.

Solution
- Add the error message to existing metrics when these commands fail.
- Add error logs to our upload ZIP so that we can process it in the backend.

Author: dhasani23

package-lock.json

@@ -4269,7 +4269,7 @@
     },
     "devDependencies": {
         "@aws-sdk/types": "^3.13.1",
-        "@aws-toolkits/telemetry": "^1.0.176",
+        "@aws-toolkits/telemetry": "^1.0.182",
         "@aws/fully-qualified-names": "^2.1.1",
         "@cspotcode/source-map-support": "^0.8.1",
         "@sinonjs/fake-timers": "^10.0.2",

package.json

@@ -22,6 +22,7 @@ import {
     convertDateToTimestamp,
     getOpenProjects,
     validateProjectSelection,
+    getVersionData,
 } from '../service/transformByQHandler'
 import { QuickPickItem } from 'vscode'
 import path from 'path'
@@ -328,11 +329,20 @@ export async function postTransformationJob(userInputState: UserInputState) {
     const durationInMs = calculateTotalLatency(codeTransformTelemetryState.getStartTime())
     const resultStatusMessage = codeTransformTelemetryState.getResultStatus()
 
+    const versionInfoWrapper = await getVersionData('mvnw', transformByQState.getProjectPath())
+    let mavenVersionInfoMessage = versionInfoWrapper[0]
+    let javaVersionInfoMessage = versionInfoWrapper[1]
+    const versionInfo = await getVersionData('mvn', transformByQState.getProjectPath())
+    mavenVersionInfoMessage += ` (mvnw) -- ${versionInfo[0]} (mvn)`
+    javaVersionInfoMessage += ` (mvnw) -- ${versionInfo[1]} (mvn)`
+
     // Note: IntelliJ implementation of ResultStatusMessage includes additional metadata such as jobId.
     telemetry.codeTransform_totalRunTime.emit({
         codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
         codeTransformResultStatusMessage: resultStatusMessage,
         codeTransformRunTimeLatency: durationInMs,
+        codeTransformLocalMavenVersion: mavenVersionInfoMessage,
+        codeTransformLocalJavaVersion: javaVersionInfoMessage,
         result: resultStatusMessage === 'JobCompletedSuccessfully' ? MetadataResult.Pass : MetadataResult.Fail,
         reason: resultStatusMessage,
     })

src/amazonqFeatureDev/util/download.ts

@@ -324,8 +324,11 @@ export const dependencyDisclaimer =
 
 export const dependencyFolderName = 'transformation_dependencies_temp_'
 
+export const installErrorMessage =
+    'Failed to execute Maven install. It is possible that the upload does not include all dependencies. We will still attempt to complete the transformation.'
+
 export const dependencyErrorMessage =
-    'Failed to execute Maven. It is possible that the upload does not include all dependencies. We will still attempt to complete the transformation.'
+    'Failed to execute Maven copy-dependencies. It is possible that the upload does not include all dependencies. We will still attempt to complete the transformation.'
 
 export const planIntroductionMessage =
     'We reviewed your Java JAVA_VERSION_HERE application and generated a transformation plan. Any code changes made to your application will be done in the sandbox so as to not interfere with your working repository. Once the transformation job is done, we will share the new code which you can review before acccepting the code changes. In the meantime, you can work on your codebase and invoke Q Chat to answer questions about your codebase.'
@@ -338,6 +341,8 @@ export const JDK11VersionNumber = '55'
 
 export const numMillisecondsPerSecond = 1000
 
+export const maxBufferSize = 1024 * 1024 // this is 1MB, the default max buffer size for stdout for spawnSync
+
 export const transformByQStateRunningMessage = 'running'
 
 export const transformByQStateCancellingMessage = 'cancelling'

src/codewhisperer/commands/startTransformByQ.ts

@@ -280,6 +280,8 @@ export class TransformByQState {
 
     private jobFailureErrorMessage: string = ''
 
+    private errorLog: string = ''
+
     public isNotStarted() {
         return this.transformByQState === TransformByQStatus.NotStarted
     }
@@ -360,6 +362,14 @@ export class TransformByQState {
         return this.jobFailureErrorMessage
     }
 
+    public getErrorLog() {
+        return this.errorLog
+    }
+
+    public appendToErrorLog(message: string) {
+        this.errorLog += `${message}\n\n`
+    }
+
     public setToNotStarted() {
         this.transformByQState = TransformByQStatus.NotStarted
     }