fix(CodeTransform): add check for zip size, show logs, get JAVA_HOME (#4452)

* fix(CodeTransform): add check for zip size and show logs

* nit: fix message

* remove duplicate metric emission

* update error message

* fix: just check size of ZIP file itself

* update messages

* add changelog

* remove blank line

---------

Co-authored-by: David Hasani <[email protected]>

Author: dhasani23

.changes/next-release/Feature-fcb124d9-b38d-4477-a3c3-ac344f03e084.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Amazon Q CodeTransformation: show user build logs for Maven install and copy-deps commands"
+}

package-lock.json

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

packages/toolkit/package.json

@@ -51,14 +51,6 @@ export class Session {
         if (!this.preloaderFinished) {
             await this.setupConversation(msg)
             this.preloaderFinished = true
-
-            telemetry.amazonq_startChat.emit({
-                amazonqConversationId: this.conversationId,
-                value: 1,
-                result: 'Succeeded',
-                credentialStartUrl: AuthUtil.instance.startUrl,
-            })
-
             this.messenger.sendAsyncEventProgress(this.tabID, true, undefined)
         }
     }

packages/toolkit/src/amazonqFeatureDev/session/session.ts

@@ -88,9 +88,7 @@ async function collectInput(validProjects: Map<vscode.QuickPickItem, JDKVersion
     } else if (state.sourceJavaVersion.label === 'Other') {
         telemetry.codeTransform_jobStartedCompleteFromPopupDialog.emit({
             codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
-            codeTransformJavaSourceVersionsAllowed: JDKToTelemetryValue(
-                transformByQState.getSourceJDKVersion()!
-            ) as CodeTransformJavaSourceVersionsAllowed, // will be 'undefined'
+            codeTransformJavaSourceVersionsAllowed: 'Other',
             codeTransformJavaTargetVersionsAllowed: JDKToTelemetryValue(
                 transformByQState.getTargetJDKVersion()
             ) as CodeTransformJavaTargetVersionsAllowed,
@@ -169,11 +167,14 @@ async function setMaven() {
     if (fs.existsSync(mavenWrapperExecutablePath)) {
         if (mavenWrapperExecutableName === 'mvnw') {
             mavenWrapperExecutableName = './mvnw' // add the './' for non-Windows
+        } else if (mavenWrapperExecutableName === 'mvnw.cmd') {
+            mavenWrapperExecutableName = '.\\mvnw.cmd' // add the '.\' for Windows
         }
         transformByQState.setMavenName(mavenWrapperExecutableName)
     } else {
         transformByQState.setMavenName('mvn')
     }
+    getLogger().info(`CodeTransform: using Maven ${transformByQState.getMavenName()}`)
 }
 
 async function validateJavaHome() {
@@ -188,16 +189,41 @@ async function validateJavaHome() {
         }
     }
     if (javaVersionUsedByMaven !== transformByQState.getSourceJDKVersion()) {
+        telemetry.codeTransform_isDoubleClickedToTriggerInvalidProject.emit({
+            codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            codeTransformPreValidationError: 'ProjectJDKDiffersFromMavenJDK',
+            result: MetadataResult.Fail,
+            reason: `${transformByQState.getSourceJDKVersion()} (project) - ${javaVersionUsedByMaven} (maven)`,
+        })
+        let javaHomePrompt = `${
+            CodeWhispererConstants.enterJavaHomeMessage
+        } ${transformByQState.getSourceJDKVersion()}. `
+        if (os.platform() === 'win32') {
+            javaHomePrompt += CodeWhispererConstants.windowsJavaHomeHelpMessage.replace(
+                'JAVA_VERSION_HERE',
+                transformByQState.getSourceJDKVersion()!
+            )
+        } else {
+            const jdkVersion = transformByQState.getSourceJDKVersion()
+            if (jdkVersion === JDKVersion.JDK8) {
+                javaHomePrompt += CodeWhispererConstants.nonWindowsJava8HomeHelpMessage
+            } else if (jdkVersion === JDKVersion.JDK11) {
+                javaHomePrompt += CodeWhispererConstants.nonWindowsJava11HomeHelpMessage
+            }
+        }
         // means either javaVersionUsedByMaven is undefined or it does not match the project JDK
-        // TO-DO: give user help on how to find JAVA_HOME for corresponding project JDK
         const javaHome = await vscode.window.showInputBox({
             title: CodeWhispererConstants.transformByQWindowTitle,
-            prompt: `${CodeWhispererConstants.enterJavaHomeMessage} ${transformByQState.getSourceJDKVersion()}`,
+            prompt: javaHomePrompt,
+            ignoreFocusOut: true,
         })
         if (!javaHome || !javaHome.trim()) {
             throw new ToolkitError('No JAVA_HOME provided', { code: 'NoJavaHomePath' })
         }
         transformByQState.setJavaHome(javaHome.trim())
+        getLogger().info(
+            `CodeTransform: using JAVA_HOME = ${transformByQState.getJavaHome()} since source JDK does not match Maven JDK`
+        )
     }
 }
 

packages/toolkit/src/codewhisperer/commands/startTransformByQ.ts

@@ -279,7 +279,7 @@ export const newCustomizationAvailableKey = 'CODEWHISPERER_NEW_CUSTOMIZATION_AVA
 export const selectProjectPrompt = 'Select the project you want to transform'
 
 export const unsupportedJavaVersionSelectedMessage =
-    'Thank you for trying our product. We currently only support Java 8 and 11. We appreciate you taking the time to use the product, and hope to expand support to more Java versions in the future.'
+    'Thank you for trying our product. We currently only support Java 8 and 11. We appreciate you taking the time to use the product, and hope to expand support to more Java versions in the future. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 export const transformByQWindowTitle = 'Amazon Q Code Transformation'
 
@@ -296,9 +296,10 @@ export const transformByQCompletedMessage = 'Transformation completed'
 export const transformByQPartiallyCompletedMessage = 'Transformation partially completed'
 
 export const noPomXmlFoundMessage =
-    'None of your open Java projects are supported by Amazon Q Code Transformation. We were unable to find a pom.xml in any of your Java projects. We only support Java projects built on Maven at the moment.'
+    'None of your open Java projects are supported by Amazon Q Code Transformation. We were unable to find a pom.xml in any of your Java projects. We only support Java projects built on Maven at the moment. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
-export const noActiveIdCMessage = 'Amazon Q Code Transformation requires an active IAM Identity Center connection'
+export const noActiveIdCMessage =
+    'Amazon Q Code Transformation requires an active IAM Identity Center connection. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 export const noOngoingJobMessage = 'No job is in-progress at the moment'
 
@@ -316,32 +317,46 @@ export const viewProposedChangesMessage =
 export const changesAppliedMessage = 'Changes applied'
 
 export const noSupportedJavaProjectsFoundMessage =
-    'None of your open projects are supported by Amazon Q Code Transformation. We were unable to find a Java project. We only support Java projects built on Maven at the moment.'
+    'None of your open projects are supported by Amazon Q Code Transformation. We were unable to find a Java project. We only support Java projects built on Maven at the moment. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 export const dependencyDisclaimer =
     'Please confirm you are ready to proceed with the transformation. Amazon Q Code Transformation will upload the application code and its dependency binaries from your machine to start the upgrade. If you have not yet compiled the application on your local machine, please do so once before starting the upgrade. Install Maven to ensure all module dependencies are picked for Transformation.'
 
 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.'
+    'Failed to execute Maven install. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 export const dependencyErrorMessage =
-    '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.'
+    'Failed to execute Maven copy-dependencies. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 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.'
 
 export const planDisclaimerMessage = '**Proposed transformation changes** \n\n\n'
 
-export const enterJavaHomeMessage = 'Enter the value of JAVA_HOME for Java'
+export const enterJavaHomeMessage = 'Enter the path to JDK'
+
+export const windowsJavaHomeHelpMessage =
+    'In a terminal, try running "cd C:\\Program Files\\Java" and then "dir" to see a list of installed JDKs. Then "cd" into JDK JAVA_VERSION_HERE (if present) and run "cd" once more to get the path we need. It should look something like "C:\\Program Files\\Java\\jdk-11.0.1"'
+
+export const nonWindowsJava8HomeHelpMessage =
+    'Try running "/usr/libexec/java_home -v 1.8" in a terminal to find this. It should look something like "/Library/Java/JavaVirtualMachines/jdk-8.jdk/Contents/Home"'
+
+export const nonWindowsJava11HomeHelpMessage =
+    'Try running "/usr/libexec/java_home -v 11" in a terminal to find this. It should look something like "/Library/Java/JavaVirtualMachines/jdk-11.jdk/Contents/Home"'
+
+export const projectSizeTooLargeMessage =
+    'Your project size exceeds the Amazon Q Code Transformation upload limit of 1GB. Please see: https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/code-transformation.html'
 
 export const JDK8VersionNumber = '52'
 
 export const JDK11VersionNumber = '55'
 
 export const numMillisecondsPerSecond = 1000
 
+export const uploadZipSizeLimitInBytes = 1000000000 // 1GB
+
 export const maxBufferSize = 1024 * 1024 // this is 1MB, the default max buffer size for stdout for spawnSync
 
 export const transformByQStateRunningMessage = 'running'

packages/toolkit/src/codewhisperer/models/constants.ts

@@ -498,6 +498,7 @@ export class TransformByQState {
         this.polledJobStatus = '' // reset polled job status too
         this.jobFailureErrorMessage = ''
         this.payloadFilePath = ''
+        this.errorLog = ''
     }
 }