add permissions prompt

Author: David Hasani

packages/core/src/amazonqGumby/chat/controller/controller.ts

@@ -57,8 +57,10 @@ import {
     openBuildLogFile,
     parseBuildFile,
     validateSQLMetadataFile,
+    validateYamlFile,
 } from '../../../codewhisperer/service/transformByQ/transformFileHandler'
 import { getAuthType } from '../../../auth/utils'
+import fs from '../../../shared/fs/fs'
 
 // These events can be interactions within the chat,
 // or elsewhere in the IDE
@@ -385,6 +387,9 @@ export class GumbyController {
                 transformByQState.setCustomDependencyVersionFilePath('')
                 this.promptJavaHome('source', message.tabID)
                 break
+            case ButtonActions.AGREE_TO_LOCAL_BUILD:
+                await this.prepareLanguageUpgradeProject(message) // build project locally right after user agrees to do so
+                break
             case ButtonActions.VIEW_TRANSFORMATION_HUB:
                 await vscode.commands.executeCommand(GumbyCommands.FOCUS_TRANSFORMATION_HUB, CancelActionPositions.Chat)
                 break
@@ -585,8 +590,12 @@ export class GumbyController {
         if (!fileUri || fileUri.length === 0) {
             return
         }
-        // TO-DO: validate the YAML file?
-        this.messenger.sendMessage('Received custom dependency version YAML file!', message.tabID, 'ai-prompt')
+        const fileContents = await fs.readFileText(fileUri[0].fsPath)
+        const isValidYaml = await validateYamlFile(fileContents, message)
+        if (!isValidYaml) {
+            return
+        }
+        this.messenger.sendMessage('Received custom dependency version YAML file.', message.tabID, 'ai-prompt')
         transformByQState.setCustomDependencyVersionFilePath(fileUri[0].fsPath)
         this.promptJavaHome('source', message.tabID)
     }
@@ -686,7 +695,7 @@ export class GumbyController {
                 const pathToJavaHome = extractPath(data.message)
                 if (pathToJavaHome) {
                     transformByQState.setTargetJavaHome(pathToJavaHome)
-                    await this.prepareLanguageUpgradeProject(data) // build project locally right after saving target JDK path
+                    this.messenger.sendPermissionToBuildMessage(data.tabID)
                 } else {
                     this.messenger.sendUnrecoverableErrorResponse('invalid-java-home', data.tabID)
                 }

packages/core/src/amazonqGumby/chat/controller/messenger/messenger.ts

@@ -50,6 +50,7 @@ export type UnrecoverableErrorType =
     | 'job-start-failed'
     | 'unsupported-source-db'
     | 'unsupported-target-db'
+    | 'missing-yaml-key'
     | 'error-parsing-sct-file'
     | 'invalid-zip-no-sct-file'
     | 'invalid-from-to-jdk'
@@ -345,6 +346,35 @@ export class Messenger {
         )
     }
 
+    public sendPermissionToBuildMessage(tabID: string) {
+        const message = CodeWhispererConstants.buildLocallyChatMessage
+
+        const buttons: ChatItemButton[] = []
+        buttons.push({
+            keepCardAfterClick: false,
+            text: 'Agree',
+            id: ButtonActions.AGREE_TO_LOCAL_BUILD,
+            position: 'outside',
+        })
+        buttons.push({
+            keepCardAfterClick: false,
+            text: 'No, stop the transformation',
+            id: ButtonActions.CANCEL_TRANSFORMATION_FORM,
+            position: 'outside',
+        })
+
+        this.dispatcher.sendChatMessage(
+            new ChatMessage(
+                {
+                    message,
+                    messageType: 'ai-prompt',
+                    buttons,
+                },
+                tabID
+            )
+        )
+    }
+
     public sendAsyncEventProgress(
         tabID: string,
         inProgress: boolean,
@@ -461,6 +491,9 @@ export class Messenger {
             case 'unsupported-target-db':
                 message = CodeWhispererConstants.invalidMetadataFileUnsupportedTargetDB
                 break
+            case 'missing-yaml-key':
+                message = CodeWhispererConstants.invalidYamlFileMissingKey
+                break
             case 'error-parsing-sct-file':
                 message = CodeWhispererConstants.invalidMetadataFileErrorParsing
                 break
@@ -786,7 +819,7 @@ dependencyManagement:
       originType: "FIRST_PARTY" # or "THIRD_PARTY"  # Optional
     - identifier: "com.example:library2"
       targetVersion: "3.0.0"
-      origin: "THIRD_PARTY"
+      originType: "THIRD_PARTY"
   plugins:
     - identifier: "com.example.plugin"
       targetVersion: "1.2.0"

packages/core/src/amazonqGumby/chat/controller/messenger/messengerUtils.ts

@@ -22,6 +22,7 @@ export enum ButtonActions {
     SELECT_SQL_CONVERSION_METADATA_FILE = 'gumbySQLConversionMetadataTransformFormConfirm',
     SELECT_CUSTOM_DEPENDENCY_VERSION_FILE = 'gumbyCustomDependencyVersionTransformFormConfirm',
     CONTINUE_TRANSFORMATION_FORM = 'gumbyTransformFormContinue',
+    AGREE_TO_LOCAL_BUILD = 'gumbyAgreeToLocalBuild',
     CONFIRM_DEPENDENCY_FORM = 'gumbyTransformDependencyFormConfirm',
     CANCEL_DEPENDENCY_FORM = 'gumbyTransformDependencyFormCancel',
     CONFIRM_JAVA_HOME_FORM = 'gumbyJavaHomeFormConfirm',

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

@@ -587,6 +587,9 @@ export const buildSucceededChatMessage = 'I was able to build your project and w
 export const buildSucceededNotification =
     'Amazon Q was able to build your project and will start transforming your code soon.'
 
+export const buildLocallyChatMessage =
+    'I will build your project on this machine throughout the transformation process.'
+
 export const absolutePathDetectedMessage = (numPaths: number, buildFile: string, listOfPaths: string) =>
     `I detected ${numPaths} potential absolute file path(s) in your ${buildFile} file: **${listOfPaths}**. Absolute file paths might cause issues when I build your code. Any errors will show up in the build log.`
 
@@ -599,6 +602,9 @@ export const invalidMetadataFileUnsupportedSourceDB =
 export const invalidMetadataFileUnsupportedTargetDB =
     'I can only convert SQL for migrations to Aurora PostgreSQL or Amazon RDS for PostgreSQL target databases. The provided .sct file indicates another target database for this migration.'
 
+export const invalidYamlFileMissingKey =
+    'Your YAML file is not formatted correctly. Make sure that the .yaml file you upload follows the format of the sample file provided.'
+
 export const invalidMetadataFileErrorParsing =
     "It looks like the .sct file you provided isn't valid. Make sure that you've uploaded the .zip file you retrieved from your schema conversion in AWS DMS."
 

packages/core/src/codewhisperer/service/transformByQ/transformApiHandler.ts

@@ -783,7 +783,12 @@ async function processClientInstructions(jobId: string, clientInstructionsPath:
 export async function runClientSideBuild(projectPath: string, clientInstructionArtifactId: string) {
     // baseCommand will be one of: '.\mvnw.cmd', './mvnw', 'mvn'
     const baseCommand = transformByQState.getMavenName()
-    const args = ['test']
+    const args = ['clean']
+    if (transformByQState.getCustomBuildCommand() === CodeWhispererConstants.skipUnitTestsBuildCommand) {
+        args.push('test-compile')
+    } else {
+        args.push('test')
+    }
     // TO-DO / QUESTION: why not use the build command from the downloaded manifest?
     transformByQState.appendToBuildLog(`Running ${baseCommand} ${args}`)
     const environment = { ...process.env, JAVA_HOME: transformByQState.getTargetJavaHome() }

packages/core/src/codewhisperer/service/transformByQ/transformFileHandler.ts

@@ -28,6 +28,7 @@ export function getDependenciesFolderInfo(): FolderInfo {
     }
 }
 
+// TO-DO: what happens when intermediate build logs are massive from downloading dependencies? exlude those lines?
 export async function writeAndShowBuildLogs() {
     const logFilePath = path.join(os.tmpdir(), 'build-logs.txt')
     writeFileSync(logFilePath, transformByQState.getBuildLog())
@@ -137,6 +138,18 @@ export async function parseBuildFile() {
     return undefined
 }
 
+export async function validateYamlFile(fileContents: string, message: any) {
+    const requiredKeys = ['dependencyManagement:', 'identifier:', 'targetVersion:']
+    for (const key of requiredKeys) {
+        if (!fileContents.includes(key)) {
+            getLogger().info(`CodeTransformation: missing yaml key: ${key}`)
+            transformByQState.getChatMessenger()?.sendUnrecoverableErrorResponse('missing-yaml-key', message.tabID)
+            return false
+        }
+    }
+    return true
+}
+
 export async function validateSQLMetadataFile(fileContents: string, message: any) {
     try {
         const sctData = await xml2js.parseStringPromise(fileContents)

packages/core/src/codewhisperer/service/transformByQ/transformationHubViewProvider.ts

@@ -349,6 +349,8 @@ export class TransformationHubViewProvider implements vscode.WebviewViewProvider
                 CodeWhispererConstants.uploadingCodeStepMessage,
                 activeStepId === 0
             )
+            // TO-DO: remove this step entirely since we do entirely client-side builds
+            // TO-DO: do we still show the "Building in Java 17/21 environment" progress update?
             const buildMarkup =
                 activeStepId >= 1 && transformByQState.getTransformationType() !== TransformationType.SQL_CONVERSION // for SQL conversions, don't show buildCode step
                     ? simpleStep(

packages/core/src/test/codewhisperer/commands/transformByQ.test.ts

@@ -42,6 +42,7 @@ import {
     parseBuildFile,
     validateSQLMetadataFile,
     createLocalBuildUploadZip,
+    validateYamlFile,
 } from '../../../codewhisperer/service/transformByQ/transformFileHandler'
 import { uploadArtifactToS3 } from '../../../codewhisperer/indexNode'
 import request from '../../../shared/request'
@@ -50,6 +51,19 @@ import * as nodefs from 'fs' // eslint-disable-line no-restricted-imports
 describe('transformByQ', function () {
     let fetchStub: sinon.SinonStub
     let tempDir: string
+    const validYamlFile = `name: "custom-dependency-management"
+description: "Custom dependency version management for Java migration from JDK 8/11/17 to JDK 17/21"
+dependencyManagement:
+  dependencies:
+    - identifier: "com.example:library1"
+        targetVersion: "2.1.0"
+        versionProperty: "library1.version"
+        originType: "FIRST_PARTY"
+  plugins:
+    - identifier: "com.example.plugin"
+        targetVersion: "1.2.0"
+        versionProperty: "plugin.version"`
+
     const validSctFile = `<?xml version="1.0" encoding="UTF-8"?>
     <tree>
     <instances>
@@ -466,6 +480,17 @@ describe('transformByQ', function () {
         assert.strictEqual(expectedWarning, warningMessage)
     })
 
+    it(`WHEN validateYamlFile on fully valid .yaml file THEN passes validation`, async function () {
+        const isValidYaml = await validateYamlFile(validYamlFile, { tabID: 'abc123' })
+        assert.strictEqual(isValidYaml, true)
+    })
+
+    it(`WHEN validateYamlFile on invalid .yaml file THEN fails validation`, async function () {
+        const invalidYamlFile = validYamlFile.replace('dependencyManagement', 'invalidKey')
+        const isValidYaml = await validateYamlFile(invalidYamlFile, { tabID: 'abc123' })
+        assert.strictEqual(isValidYaml, false)
+    })
+
     it(`WHEN validateMetadataFile on fully valid .sct file THEN passes validation`, async function () {
         const isValidMetadata = await validateSQLMetadataFile(validSctFile, { tabID: 'abc123' })
         assert.strictEqual(isValidMetadata, true)