Merge pull request #5402 from dhasani23/pomParse

feat(amazonq): parse pom.xml for absolute paths

Author: jpinkney-aws

packages/amazonq/.changes/next-release/Feature-adb7e3c8-9c3e-4090-a283-2d29fc396f04.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Amazon Q Code Transformation: warn user if absolute file paths are found in the pom.xml"
+}

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

@@ -22,6 +22,7 @@ import {
     getValidCandidateProjects,
     openBuildLogFile,
     openHilPomFile,
+    parseBuildFile,
     postTransformationJob,
     processTransformFormInput,
     startTransformByQ,
@@ -31,6 +32,7 @@ import {
 } from '../../../codewhisperer/commands/startTransformByQ'
 import { JDKVersion, TransformationCandidateProject, transformByQState } from '../../../codewhisperer/models/model'
 import {
+    AbsolutePathDetectedError,
     AlternateDependencyVersionsNotFoundError,
     JavaHomeNotSetError,
     JobStartError,
@@ -424,6 +426,9 @@ export class GumbyController {
             return
         }
 
+        // give user a non-blocking warning if build file appears to contain absolute paths
+        await parseBuildFile()
+
         this.messenger.sendAsyncEventProgress(
             message.tabID,
             true,
@@ -513,7 +518,7 @@ export class GumbyController {
 
     private async handleError(message: { error: Error; tabID: string }) {
         if (message.error instanceof AlternateDependencyVersionsNotFoundError) {
-            this.messenger.sendKnownErrorResponse('no-alternate-dependencies-found', message.tabID)
+            this.messenger.sendKnownErrorResponse(message.tabID, CodeWhispererConstants.dependencyVersionsErrorMessage)
             await this.continueTransformationWithoutHIL(message)
         } else if (message.error instanceof ModuleUploadError) {
             this.resetTransformationChatFlow()
@@ -529,6 +534,8 @@ export class GumbyController {
             )
             await openBuildLogFile()
             this.messenger.sendViewBuildLog(message.tabID)
+        } else if (message.error instanceof AbsolutePathDetectedError) {
+            this.messenger.sendKnownErrorResponse(message.tabID, message.error.message)
         }
     }
 

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

@@ -46,8 +46,6 @@ export type UnrecoverableErrorType =
     | 'upload-to-s3-failed'
     | 'job-start-failed'
 
-export type ErrorResponseType = 'no-alternate-dependencies-found'
-
 export enum GumbyNamedMessages {
     COMPILATION_PROGRESS_MESSAGE = 'gumbyProjectCompilationMessage',
     JOB_SUBMISSION_STATUS_MESSAGE = 'gumbyJobSubmissionMessage',
@@ -356,15 +354,7 @@ export class Messenger {
      * informational purposes, or some other error workflow is meant to contribute a
      * follow-up with a user action.
      */
-    public sendKnownErrorResponse(type: ErrorResponseType, tabID: string) {
-        let message = '...'
-
-        switch (type) {
-            case 'no-alternate-dependencies-found':
-                message = `I could not find any other versions of this dependency in your local Maven repository. Try transforming the dependency to make it compatible with Java 17, and then try transforming this module again.`
-                break
-        }
-
+    public sendKnownErrorResponse(tabID: string, message: string) {
         this.dispatcher.sendChatMessage(
             new ChatMessage(
                 {

packages/core/src/amazonqGumby/errors.ts

@@ -71,3 +71,9 @@ export class PollJobError extends Error {
         super('Poll job failed')
     }
 }
+
+export class AbsolutePathDetectedError extends Error {
+    constructor(message: string) {
+        super(message)
+    }
+}

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

@@ -50,6 +50,7 @@ import { MetadataResult } from '../../shared/telemetry/telemetryClient'
 import { submitFeedback } from '../../feedback/vue/submitFeedback'
 import { placeholder } from '../../shared/vscode/commands2'
 import {
+    AbsolutePathDetectedError,
     AlternateDependencyVersionsNotFoundError,
     JavaHomeNotSetError,
     JobStartError,
@@ -235,6 +236,41 @@ export async function finalizeTransformByQ(status: string) {
     }
 }
 
+export async function parseBuildFile() {
+    try {
+        const absolutePaths = ['users/', 'system/', 'volumes/', 'c:\\', 'd:\\']
+        const alias = path.basename(os.homedir())
+        absolutePaths.push(alias)
+        const buildFilePath = path.join(transformByQState.getProjectPath(), 'pom.xml')
+        if (fs.existsSync(buildFilePath)) {
+            const buildFileContents = fs.readFileSync(buildFilePath).toString().toLowerCase()
+            const detectedPaths = []
+            for (const absolutePath of absolutePaths) {
+                if (buildFileContents.includes(absolutePath)) {
+                    detectedPaths.push(absolutePath)
+                }
+            }
+            if (detectedPaths.length > 0) {
+                const warningMessage = CodeWhispererConstants.absolutePathDetectedMessage(
+                    detectedPaths.length,
+                    path.basename(buildFilePath),
+                    detectedPaths.join(', ')
+                )
+                transformByQState.getChatControllers()?.errorThrown.fire({
+                    error: new AbsolutePathDetectedError(warningMessage),
+                    tabID: ChatSessionManager.Instance.getSession().tabID,
+                })
+                getLogger().info('CodeTransformation: absolute path potentially in build file')
+                return warningMessage
+            }
+        }
+    } catch (err: any) {
+        // swallow error
+        getLogger().error(`CodeTransformation: error scanning for absolute paths, tranformation continuing: ${err}`)
+    }
+    return undefined
+}
+
 export async function preTransformationUploadCode() {
     await vscode.commands.executeCommand('aws.amazonq.transformationHub.focus')
 

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

@@ -454,6 +454,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 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.`
+
 export const unsupportedJavaVersionChatMessage = `Sorry, currently I can only upgrade Java 8 or Java 11 projects. For more information, see the [Amazon Q documentation](${codeTransformPrereqDoc}).`
 
 export const failedToStartJobChatMessage =
@@ -528,6 +531,9 @@ export const noPomXmlFoundNotification = `None of your open projects are support
 
 export const noJavaHomeFoundChatMessage = `Sorry, I couldn\'t locate your Java installation. For more information, see the [Amazon Q documentation](${codeTransformPrereqDoc}).`
 
+export const dependencyVersionsErrorMessage =
+    'I could not find any other versions of this dependency in your local Maven repository. Try transforming the dependency to make it compatible with Java 17, and then try transforming this module again.'
+
 export const errorUploadingWithExpiredUrl = `The upload error may have been caused by the expiration of the S3 pre-signed URL that was used to upload code artifacts to Q Code Transformation. The S3 pre-signed URL expires in 30 minutes. This could be caused by any delays introduced by intermediate services in your network infrastructure. Please investigate your network configuration and consider allowlisting 'amazonq-code-transformation-us-east-1-c6160f047e0.s3.amazonaws.com' to skip any scanning that might delay the upload. For more information, see the [Amazon Q documentation](${codeTransformTroubleshootAllowS3Access}).`
 
 export const socketConnectionFailed =

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

@@ -9,7 +9,7 @@ import * as fs from 'fs-extra'
 import * as sinon from 'sinon'
 import { makeTemporaryToolkitFolder } from '../../../shared/filesystemUtilities'
 import { transformByQState, TransformByQStoppedError } from '../../../codewhisperer/models/model'
-import { stopTransformByQ } from '../../../codewhisperer/commands/startTransformByQ'
+import { parseBuildFile, stopTransformByQ } from '../../../codewhisperer/commands/startTransformByQ'
 import { HttpResponse } from 'aws-sdk'
 import * as codeWhisperer from '../../../codewhisperer/client/codewhisperer'
 import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
@@ -297,4 +297,15 @@ describe('transformByQ', function () {
         }
         assert.deepStrictEqual(actual, expected)
     })
+
+    it(`WHEN parseBuildFile on pom.xml with absolute path THEN absolute path detected`, async function () {
+        const dirPath = await createTestWorkspaceFolder()
+        transformByQState.setProjectPath(dirPath.uri.fsPath)
+        const pomPath = path.join(dirPath.uri.fsPath, 'pom.xml')
+        await toFile('<project><properties><path>system/name/here</path></properties></project>', pomPath)
+        const expectedWarning =
+            'I detected 1 potential absolute file path(s) in your pom.xml file: **system/**. Absolute file paths might cause issues when I build your code. Any errors will show up in the build log.'
+        const warningMessage = await parseBuildFile()
+        assert.strictEqual(expectedWarning, warningMessage)
+    })
 })