fix(amazonq): show error messages in chat and match with IntelliJ (aws#4715)

* fix(amazonq): show error messages in chat and match with IntelliJ

* revert accidental deletion:

* remove unused button

* small string changes

* fix lint issues

* Update transformByQ.test.ts

---------

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

Author: dhasani23

.changes/next-release/Bug Fix-5d6c3406-8213-4aec-ba80-a488e9728e3a.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "Amazon Q Code Transformation: show error messages in chat"
+}

packages/core/src/amazonqGumby/activation.ts

@@ -9,7 +9,6 @@ import { TransformationHubViewProvider } from '../codewhisperer/service/transfor
 import { ExtContext } from '../shared/extensions'
 import { stopTransformByQ } from '../codewhisperer/commands/startTransformByQ'
 import { transformByQState } from '../codewhisperer/models/model'
-import * as CodeWhispererConstants from '../codewhisperer/models/constants'
 import { ProposedTransformationExplorer } from '../codewhisperer/service/transformByQ/transformationResultsViewProvider'
 import { codeTransformTelemetryState } from './telemetry/codeTransformTelemetryState'
 import { telemetry } from '../shared/telemetry/telemetry'
@@ -52,8 +51,6 @@ export async function activate(context: ExtContext) {
             Commands.register('aws.amazonq.stopTransformationInHub', async (cancelSrc: CancelActionPositions) => {
                 if (transformByQState.isRunning()) {
                     void stopTransformByQ(transformByQState.getJobId(), cancelSrc)
-                } else {
-                    void vscode.window.showInformationMessage(CodeWhispererConstants.noOngoingJobMessage)
                 }
             }),
 

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

@@ -24,6 +24,7 @@ import {
     validateCanCompileProject,
 } from '../../../codewhisperer/commands/startTransformByQ'
 import { JDKVersion, TransformationCandidateProject, transformByQState } from '../../../codewhisperer/models/model'
+import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
 import { JavaHomeNotSetError, NoJavaProjectsFoundError, NoMavenJavaProjectsFoundError } from '../../errors'
 import MessengerUtils, { ButtonActions, GumbyCommands } from './messenger/messengerUtils'
 import { CancelActionPositions } from '../../telemetry/codeTransformTelemetry'
@@ -213,7 +214,7 @@ export class GumbyController {
                 await this.initiateTransformationOnProject(message)
                 break
             case ButtonActions.CANCEL_TRANSFORMATION_FORM:
-                this.messenger.sendJobFinishedMessage(message.tabId, true)
+                this.messenger.sendJobFinishedMessage(message.tabId, CodeWhispererConstants.jobCancelledChatMessage)
                 break
             case ButtonActions.VIEW_TRANSFORMATION_HUB:
                 await vscode.commands.executeCommand(GumbyCommands.FOCUS_TRANSFORMATION_HUB)
@@ -309,10 +310,10 @@ export class GumbyController {
         await this.prepareProjectForSubmission(message)
     }
 
-    private async transformationFinished(tabID: string, jobStatus: string = '') {
+    private async transformationFinished(data: { message: string; tabID: string }) {
         this.sessionStorage.getSession().conversationState = ConversationState.IDLE
         // at this point job is either completed, partially_completed, cancelled, or failed
-        this.messenger.sendJobFinishedMessage(tabID, false)
+        this.messenger.sendJobFinishedMessage(data.tabID, data.message)
     }
 
     private async processHumanChatMessage(data: { message: string; tabID: string }) {

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

@@ -12,6 +12,7 @@ import { AuthFollowUpType, expiredText, enableQText, reauthenticateText } from '
 import { ChatItemType } from '../../../../amazonqFeatureDev/models'
 import { JDKVersion, TransformationCandidateProject } from '../../../../codewhisperer/models/model'
 import { FeatureAuthState } from '../../../../codewhisperer/util/authUtil'
+import * as CodeWhispererConstants from '../../../../codewhisperer/models/constants'
 import {
     AppToWebViewMessageDispatcher,
     AsyncEventProgressMessage,
@@ -35,7 +36,6 @@ export type StaticTextResponseType =
 
 export type ErrorTextResponseType =
     | 'no-project-found'
-    | 'no-workspace-open'
     | 'no-java-project-found'
     | 'no-maven-java-project-found'
     | 'could-not-compile-project'
@@ -65,7 +65,7 @@ export class Messenger {
 
     public sendErrorMessage(errorMessage: string, tabID: string) {
         this.dispatcher.sendErrorMessage(
-            new ErrorMessage(`Sorry, we encountered a problem when processing your request.`, errorMessage, tabID)
+            new ErrorMessage(CodeWhispererConstants.genericErrorMessage, errorMessage, tabID)
         )
     }
 
@@ -195,7 +195,7 @@ export class Messenger {
     }
 
     public sendCompilationInProgress(tabID: string) {
-        const message = `I'm building your project. This can take up to 10 minutes, depending on the size of your project.`
+        const message = CodeWhispererConstants.buildStartedChatMessage
 
         this.dispatcher.sendAsyncEventProgress(
             new AsyncEventProgressMessage(tabID, { inProgress: true, message: undefined })
@@ -210,7 +210,7 @@ export class Messenger {
     }
 
     public sendCompilationFinished(tabID: string) {
-        const message = `I was able to build your project. I'll start transforming your code soon.`
+        const message = CodeWhispererConstants.buildSucceededChatMessage
 
         this.dispatcher.sendAsyncEventProgress(
             new AsyncEventProgressMessage(tabID, {
@@ -221,23 +221,22 @@ export class Messenger {
     }
 
     public sendJobSubmittedMessage(tabID: string, disableJobActions: boolean = false) {
-        const message = `I'm starting to transform your code. It can take 10 to 30 minutes to upgrade your code, depending on the size of your project. To monitor progress, go to the Transformation Hub.`
+        const message = CodeWhispererConstants.jobStartedChatMessage
 
         const buttons: ChatItemButton[] = []
 
         if (!disableJobActions) {
             // Note: buttons can only be clicked once.
-            // To get around this, we remove the card after they're clicked and then
-            // resubmit the message.
+            // To get around this, we remove the card after it's clicked and then resubmit the message.
             buttons.push({
                 keepCardAfterClick: true,
-                text: 'Open Transformation Hub',
+                text: CodeWhispererConstants.openTransformationHubButtonText,
                 id: ButtonActions.VIEW_TRANSFORMATION_HUB,
             })
 
             buttons.push({
                 keepCardAfterClick: true,
-                text: 'Stop transformation',
+                text: CodeWhispererConstants.stopTransformationButtonText,
                 id: ButtonActions.STOP_TRANSFORMATION_JOB,
             })
         }
@@ -291,40 +290,29 @@ export class Messenger {
         let message = '...'
 
         switch (type) {
-            case 'no-workspace-open':
-                message = 'To begin, please open a workspace.'
-                break
             case 'no-project-found':
-                message = `Sorry, I couldn't find any open projects. Currently, I can only upgrade Java projects built on Maven. 
-
-For more information, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html).`
+                message = CodeWhispererConstants.noOpenProjectsFoundChatMessage
                 break
             case 'no-java-project-found':
-                message = `Sorry, I can't upgrade any of your open projects. Currently, I can only upgrade Java projects built on Maven. 
-
-For more information, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html).`
+                message = CodeWhispererConstants.noJavaProjectsFoundChatMessage
                 break
             case 'no-maven-java-project-found':
-                message = `Sorry, I can't upgrade any of your open projects. I couldn't find a pom.xml file in any of your Java projects. Currently, I can only upgrade Java projects built on Maven.
-                    
-For more information, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html).`
+                message = CodeWhispererConstants.noPomXmlFoundChatMessage
                 break
             case 'could-not-compile-project':
-                message = `Sorry, I couldn't run Maven clean install to build your project. To troubleshoot, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html#maven-commands-failing).`
+                message = CodeWhispererConstants.cleanInstallErrorChatMessage
                 break
             case 'invalid-java-home':
-                message = `Sorry, I couldn't locate your Java installation. To troubleshoot, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html#maven-commands-failing).`
+                message = CodeWhispererConstants.noJavaHomeFoundChatMessage
                 break
             case 'unsupported-source-jdk-version':
-                message = `Sorry, currently I can only upgrade Java 8 or Java 11 projects.
-                
-For more information, see the [Amazon Q documentation.](https://docs.aws.amazon.com/amazonq/latest/aws-builder-use-ug/troubleshooting-code-transformation.html).`
+                message = CodeWhispererConstants.unsupportedJavaVersionChatMessage
         }
 
         const buttons: ChatItemButton[] = []
         buttons.push({
             keepCardAfterClick: false,
-            text: 'Start a new transformation',
+            text: CodeWhispererConstants.startTransformationButtonText,
             id: ButtonActions.CONFIRM_START_TRANSFORMATION_FLOW,
         })
 
@@ -344,19 +332,11 @@ For more information, see the [Amazon Q documentation.](https://docs.aws.amazon.
         this.dispatcher.sendCommandMessage(new SendCommandMessage(message.command, message.tabId, message.eventId))
     }
 
-    public sendJobFinishedMessage(tabID: string, cancelled: boolean, jobStatus: string = '') {
-        let message =
-            'I cancelled your transformation. If you want to start another transformation, choose **Start a new transformation**.'
-
-        if (!cancelled) {
-            message =
-                'The transformation job is over. If you want to start another transformation, choose **Start a new transformation**.'
-        }
-
+    public sendJobFinishedMessage(tabID: string, message: string = '') {
         const buttons: ChatItemButton[] = []
         buttons.push({
             keepCardAfterClick: false,
-            text: 'Start a new transformation',
+            text: CodeWhispererConstants.startTransformationButtonText,
             id: ButtonActions.CONFIRM_START_TRANSFORMATION_FLOW,
         })
 
@@ -380,7 +360,7 @@ For more information, see the [Amazon Q documentation.](https://docs.aws.amazon.
         this.dispatcher.sendAsyncEventProgress(
             new AsyncEventProgressMessage(tabID, {
                 inProgress: true,
-                message: "I'm checking for open projects that are eligible for Code Transformation.",
+                message: CodeWhispererConstants.checkingForProjectsChatMessage,
             })
         )
     }

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

@@ -6,12 +6,7 @@
 
 import * as os from 'os'
 import { transformByQState, JDKVersion } from '../../../../codewhisperer/models/model'
-import {
-    enterJavaHomeMessage,
-    nonWindowsJava11HomeHelpMessage,
-    nonWindowsJava8HomeHelpMessage,
-    windowsJavaHomeHelpMessage,
-} from './stringConstants'
+import * as CodeWhispererConstants from '../../../../codewhisperer/models/constants'
 
 // These enums map to string IDs
 export enum ButtonActions {
@@ -32,18 +27,20 @@ export enum GumbyCommands {
 
 export default class MessengerUtils {
     static createJavaHomePrompt = (): string => {
-        let javaHomePrompt = `${enterJavaHomeMessage} ${transformByQState.getSourceJDKVersion()}. \n`
+        let javaHomePrompt = `${
+            CodeWhispererConstants.enterJavaHomeChatMessage
+        } ${transformByQState.getSourceJDKVersion()}. \n`
         if (os.platform() === 'win32') {
-            javaHomePrompt += windowsJavaHomeHelpMessage.replace(
+            javaHomePrompt += CodeWhispererConstants.windowsJavaHomeHelpChatMessage.replace(
                 'JAVA_VERSION_HERE',
                 transformByQState.getSourceJDKVersion()!
             )
         } else {
             const jdkVersion = transformByQState.getSourceJDKVersion()
             if (jdkVersion === JDKVersion.JDK8) {
-                javaHomePrompt += ` ${nonWindowsJava8HomeHelpMessage}`
+                javaHomePrompt += ` ${CodeWhispererConstants.nonWindowsJava8HomeHelpChatMessage}`
             } else if (jdkVersion === JDKVersion.JDK11) {
-                javaHomePrompt += ` ${nonWindowsJava11HomeHelpMessage}`
+                javaHomePrompt += ` ${CodeWhispererConstants.nonWindowsJava11HomeHelpChatMessage}`
             }
         }
         return javaHomePrompt
@@ -77,6 +74,6 @@ export default class MessengerUtils {
             }
         }
 
-        return `I can upgrade your ${javaVersionString}. To start the transformation, I need some information from you. Choose the project you want to upgrade and the target code version to upgrade to. Then, choose Transform.`
+        return CodeWhispererConstants.projectPromptChatMessage.replace('JAVA_VERSION_HERE', javaVersionString)
     }
 }