feat(amazonq): Handle disclaimer acknowledgement

jpinkney-aws · jpinkney-aws · commit b02e418a52d4 · 2025-04-02T14:21:10.000-04:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/amazonq/package.json b/packages/amazonq/package.json
@@ -127,6 +127,10 @@
                         "amazonQWorkspaceLspManifestMessage": {
                             "type": "boolean",
                             "default": false
+                        },
+                        "amazonQChatDisclaimerAcknowledged": {
+                            "type": "boolean",
+                            "default": false
                         }
                     },
                     "additionalProperties": false
diff --git a/packages/amazonq/src/lsp/chat/messages.ts b/packages/amazonq/src/lsp/chat/messages.ts
@@ -10,6 +10,7 @@ import {
     CHAT_OPTIONS,
     COPY_TO_CLIPBOARD,
     AuthFollowUpType,
+    DISCLAIMER_ACKNOWLEDGED,
 } from '@aws/chat-client-ui-types'
 import {
     ChatResult,
@@ -27,6 +28,7 @@ import { Disposable, LanguageClient, Position, State, TextDocumentIdentifier } f
 import * as jose from 'jose'
 import { AmazonQChatViewProvider } from './webviewProvider'
 import { AuthUtil } from 'aws-core-vscode/codewhisperer'
+import { AmazonQPromptSettings } from 'aws-core-vscode/shared'
 
 export function registerLanguageServerEventListener(languageClient: LanguageClient, provider: AmazonQChatViewProvider) {
     languageClient.onDidChangeState(({ oldState, newState }) => {
@@ -106,6 +108,10 @@ export function registerMessageListeners(
                 }
                 break
             }
+            case DISCLAIMER_ACKNOWLEDGED: {
+                void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)
+                break
+            }
             case chatRequestType.method: {
                 const partialResultToken = uuidv4()
                 const chatDisposable = languageClient.onProgress(chatRequestType, partialResultToken, (partialResult) =>
diff --git a/packages/amazonq/src/lsp/chat/webviewProvider.ts b/packages/amazonq/src/lsp/chat/webviewProvider.ts
@@ -12,9 +12,10 @@ import {
     WebviewViewResolveContext,
     Uri,
 } from 'vscode'
-import { LanguageServerResolver } from 'aws-core-vscode/shared'
 import { QuickActionCommandGroup } from '@aws/mynah-ui'
 import * as path from 'path'
+import { LanguageServerResolver } from 'aws-core-vscode/shared'
+import { disclaimer } from 'aws-core-vscode/amazonq'
 
 export class AmazonQChatViewProvider implements WebviewViewProvider {
     public static readonly viewType = 'aws.amazonq.AmazonQChatView'
@@ -43,7 +44,11 @@ export class AmazonQChatViewProvider implements WebviewViewProvider {
 
     constructor(private readonly mynahUIPath: string) {}
 
-    public resolveWebviewView(webviewView: WebviewView, context: WebviewViewResolveContext, _token: CancellationToken) {
+    public async resolveWebviewView(
+        webviewView: WebviewView,
+        context: WebviewViewResolveContext,
+        _token: CancellationToken
+    ) {
         this.webview = webviewView.webview
 
         const lspDir = Uri.parse(LanguageServerResolver.defaultDir)
@@ -54,12 +59,13 @@ export class AmazonQChatViewProvider implements WebviewViewProvider {
         }
 
         const uiPath = webviewView.webview.asWebviewUri(Uri.parse(this.mynahUIPath)).toString()
-        webviewView.webview.html = this.getWebviewContent(uiPath)
+        webviewView.webview.html = await this.getWebviewContent(uiPath)
 
         this.onDidResolveWebviewEmitter.fire()
     }
 
-    private getWebviewContent(mynahUIPath: string) {
+    private async getWebviewContent(mynahUIPath: string) {
+        const disclaimerAcknowledged = await disclaimer.disclaimerAcknowledged()
         return `
         <!DOCTYPE html>
         <html lang="en">
@@ -84,7 +90,7 @@ export class AmazonQChatViewProvider implements WebviewViewProvider {
             <script type="text/javascript" src="${mynahUIPath.toString()}" defer onload="init()"></script>
             <script type="text/javascript">
                 const init = () => {
-                    amazonQChat.createChat(acquireVsCodeApi(), { disclaimerAcknowledged: false, quickActionCommands: ${JSON.stringify(this.quickActionCommands)}});
+                    amazonQChat.createChat(acquireVsCodeApi(), { disclaimerAcknowledged: ${disclaimerAcknowledged}, quickActionCommands: ${JSON.stringify(this.quickActionCommands)}});
                 }
             </script>
         </body>
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -440,7 +440,7 @@
     },
     "devDependencies": {
         "@aws-sdk/types": "^3.13.1",
-        "@aws/chat-client-ui-types": "^0.0.8",
+        "@aws/chat-client-ui-types": "^0.1.12",
         "@aws/language-server-runtimes": "^0.2.49",
         "@aws/language-server-runtimes-types": "^0.1.10",
         "@cspotcode/source-map-support": "^0.8.1",
diff --git a/packages/core/src/amazonq/index.ts b/packages/core/src/amazonq/index.ts
@@ -48,6 +48,7 @@ export * from './lsp/config'
 export * as WorkspaceLspInstaller from './lsp/workspaceInstaller'
 export * as secondaryAuth from '../auth/secondaryAuth'
 export * as authConnection from '../auth/connection'
+export * as disclaimer from './util/disclaimer'
 import { FeatureContext } from '../shared/featureConfig'
 
 /**
diff --git a/packages/core/src/amazonq/util/disclaimer.ts b/packages/core/src/amazonq/util/disclaimer.ts
@@ -0,0 +1,21 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import globals from '../../shared/extensionGlobals'
+import { AmazonQPromptSettings } from '../../shared/settings'
+
+/**
+ * If the previous global state was acknowledged, then suppress the prompt and set global state to false
+ * Otherwise, the new flows will enable amazonQChatDisclaimerAcknowledged directly
+ */
+export async function disclaimerAcknowledged(): Promise<boolean> {
+    const acknowledged = globals.globalState.tryGet('aws.amazonq.disclaimerAcknowledged', Boolean, false)
+    if (acknowledged) {
+        await AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)
+        await globals.globalState.update('aws.amazonq.disclaimerAcknowledged', false)
+    }
+
+    return AmazonQPromptSettings.instance.get('amazonQChatDisclaimerAcknowledged', false)
+}
diff --git a/packages/core/src/amazonq/webview/generators/webViewContent.ts b/packages/core/src/amazonq/webview/generators/webViewContent.ts
@@ -9,6 +9,7 @@ import { AuthUtil } from '../../../codewhisperer/util/authUtil'
 import { FeatureConfigProvider, FeatureContext } from '../../../shared/featureConfig'
 import globals from '../../../shared/extensionGlobals'
 import { isSageMaker } from '../../../shared/extensionUtilities'
+import { disclaimerAcknowledged } from '../../util/disclaimer'
 
 export class WebViewContentGenerator {
     private async generateFeatureConfigsData(): Promise<string> {
@@ -80,8 +81,7 @@ export class WebViewContentGenerator {
         const featureConfigsString = await this.generateFeatureConfigsData()
 
         const disabledCommandsString = isSageMaker() ? `['/dev', '/transform']` : '[]'
-        const disclaimerAcknowledged = globals.globalState.tryGet('aws.amazonq.disclaimerAcknowledged', Boolean, false)
-
+        const enableDisclaimer = await disclaimerAcknowledged()
         const welcomeLoadCount = globals.globalState.tryGet('aws.amazonq.welcomeChatShowCount', Number, 0)
         const isSMUS = isSageMaker('SMUS')
 
@@ -92,7 +92,7 @@ export class WebViewContentGenerator {
             const init = () => {
                 createMynahUI(acquireVsCodeApi(), ${
                     (await AuthUtil.instance.getChatAuthState()).amazonQ === 'connected'
-                },${featureConfigsString},${welcomeLoadCount},${disclaimerAcknowledged},${disabledCommandsString},${isSMUS});
+                },${featureConfigsString},${welcomeLoadCount},${enableDisclaimer},${disabledCommandsString},${isSMUS});
             }
         </script>
         `
diff --git a/packages/core/src/amazonq/webview/messages/messageDispatcher.ts b/packages/core/src/amazonq/webview/messages/messageDispatcher.ts
@@ -15,6 +15,7 @@ import { isClickTelemetry, isOpenAgentTelemetry } from '../ui/telemetry/actions'
 import globals from '../../../shared/extensionGlobals'
 import { openUrl } from '../../../shared/utilities/vsCodeUtils'
 import { DefaultAmazonQAppInitContext } from '../../apps/initContext'
+import { AmazonQPromptSettings } from '../../../shared/settings'
 
 const qChatModuleName = 'amazonqChat'
 
@@ -77,7 +78,7 @@ export function dispatchWebViewMessagesToApps(
                 return
             }
             case 'disclaimer-acknowledged': {
-                globals.globalState.tryUpdate('aws.amazonq.disclaimerAcknowledged', true)
+                void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)
                 return
             }
             case 'update-welcome-count': {
diff --git a/packages/core/src/shared/index.ts b/packages/core/src/shared/index.ts
@@ -13,7 +13,7 @@ export { activate as activateLogger } from './logger/activation'
 export { activate as activateTelemetry } from './telemetry/activation'
 export { DefaultAwsContext } from './awsContext'
 export { DefaultAWSClientBuilder, ServiceOptions } from './awsClientBuilder'
-export { Settings, Experiments, DevSettings } from './settings'
+export { Settings, Experiments, DevSettings, AmazonQPromptSettings } from './settings'
 export * from './extensionUtilities'
 export * from './extensionStartup'
 export { RegionProvider } from './regions/regionProvider'
diff --git a/packages/core/src/shared/settings-amazonq.gen.ts b/packages/core/src/shared/settings-amazonq.gen.ts
@@ -20,7 +20,8 @@ export const amazonqSettings = {
         "minIdeVersion": {},
         "ssoCacheError": {},
         "amazonQLspManifestMessage": {},
-        "amazonQWorkspaceLspManifestMessage": {}
+        "amazonQWorkspaceLspManifestMessage": {},
+        "amazonQChatDisclaimerAcknowledged": {}
     },
     "amazonQ.showCodeWithReferences": {},
     "amazonQ.allowFeatureDevelopmentToRunCodeAndTests": {},
diff --git a/packages/webpack.web.config.js b/packages/webpack.web.config.js
@@ -50,6 +50,13 @@ module.exports = (env, argv) => {
             new webpack.IgnorePlugin({
                 resourceRegExp: /ps-list/, // matches the path in the require() statement
             }),
+            /**
+             * HACK: the glob module breaks Web mode if imported, BUT we still dynamically import this module for non web mode
+             * environments. The following allows compilation to pass by never bundling the module in the final output for web mode.
+             */
+            new webpack.IgnorePlugin({
+                resourceRegExp: /glob/, // matches the path in the require() statement
+            }),
         ],
         resolve: {
             extensions: ['.ts', '.js'],
@@ -76,6 +83,10 @@ module.exports = (env, argv) => {
                 child_process: false, // Reason for error: 'TypeError: The "original" argument must be of type Function'
                 async_hooks: false,
                 net: false,
+
+                // codewhisperer chat imports jsdom which doesn't run in web mode
+                vm: false,
+                tls: false,
             },
         },
         optimization: {

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import { isClickTelemetry, isOpenAgentTelemetry } from '../ui/telemetry/actions'`
`15`	`15`	`import globals from '../../../shared/extensionGlobals'`
`16`	`16`	`import { openUrl } from '../../../shared/utilities/vsCodeUtils'`
`17`	`17`	`import { DefaultAmazonQAppInitContext } from '../../apps/initContext'`
	`18`	`+import { AmazonQPromptSettings } from '../../../shared/settings'`
`18`	`19`
`19`	`20`	`const qChatModuleName = 'amazonqChat'`
`20`	`21`
`@@ -77,7 +78,7 @@ export function dispatchWebViewMessagesToApps(`
`77`	`78`	`return`
`78`	`79`	`}`
`79`	`80`	`case 'disclaimer-acknowledged': {`
`80`		`- globals.globalState.tryUpdate('aws.amazonq.disclaimerAcknowledged', true)`
	`81`	`+ void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)`
`81`	`82`	`return`
`82`	`83`	`}`
`83`	`84`	`case 'update-welcome-count': {`