fix(amazonq): disclaimer acknowledgement fails web build

justinmk3 · justinmk3 · commit 65eaf41a16d5 · 2025-04-08T09:19:53.000-07:00
Problem:
Webpack fails on the parent commit:

  2025-04-07T17:25:48.4129595Z Error: Cannot find module './globalState'
  2025-04-07T17:25:48.4148372Z at webpackMissingModule (file:///…/packages/amazonq/dist/test/web/testRunnerWebCore.js#vscode-extension:159675:92)

Solution:
Avoid importing `'aws-core-vscode/amazonq'` in `webviewProvider.ts`.
`AmazonQPromptSettings` is intended to have application-specific logic,
so move the logic there and drop the special `disclaimer.ts` module.
diff --git a/packages/amazonq/package.json b/packages/amazonq/package.json
@@ -128,7 +128,7 @@
                             "type": "boolean",
                             "default": false
                         },
-                        "amazonQChatDisclaimerAcknowledged": {
+                        "amazonQChatDisclaimer": {
                             "type": "boolean",
                             "default": false
                         }
diff --git a/packages/amazonq/src/lsp/chat/messages.ts b/packages/amazonq/src/lsp/chat/messages.ts
@@ -109,7 +109,7 @@ export function registerMessageListeners(
                 break
             }
             case DISCLAIMER_ACKNOWLEDGED: {
-                void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)
+                void AmazonQPromptSettings.instance.disablePrompt('amazonQChatDisclaimer')
                 break
             }
             case chatRequestType.method: {
diff --git a/packages/amazonq/src/lsp/chat/webviewProvider.ts b/packages/amazonq/src/lsp/chat/webviewProvider.ts
@@ -14,8 +14,7 @@ import {
 } from 'vscode'
 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'
+import { AmazonQPromptSettings, LanguageServerResolver } from 'aws-core-vscode/shared'
 
 export class AmazonQChatViewProvider implements WebviewViewProvider {
     public static readonly viewType = 'aws.amazonq.AmazonQChatView'
@@ -65,7 +64,7 @@ export class AmazonQChatViewProvider implements WebviewViewProvider {
     }
 
     private async getWebviewContent(mynahUIPath: string) {
-        const disclaimerAcknowledged = await disclaimer.disclaimerAcknowledged()
+        const disclaimerAcknowledged = AmazonQPromptSettings.instance.isPromptEnabled('amazonQChatDisclaimer')
         return `
         <!DOCTYPE html>
         <html lang="en">
diff --git a/packages/core/src/amazonq/index.ts b/packages/core/src/amazonq/index.ts
@@ -48,7 +48,6 @@ 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
diff --git a/packages/core/src/amazonq/webview/generators/webViewContent.ts b/packages/core/src/amazonq/webview/generators/webViewContent.ts
@@ -9,7 +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'
+import { AmazonQPromptSettings } from '../../../shared/settings'
 
 export class WebViewContentGenerator {
     private async generateFeatureConfigsData(): Promise<string> {
@@ -83,7 +83,7 @@ export class WebViewContentGenerator {
         const isSMUS = isSageMaker('SMUS')
 
         const disabledCommandsString = isSM ? `['/dev', '/transform', '/test', '/review', '/doc']` : '[]'
-        const enableDisclaimer = await disclaimerAcknowledged()
+        const disclaimerAcknowledged = !AmazonQPromptSettings.instance.isPromptEnabled('amazonQChatDisclaimer')
         const welcomeLoadCount = globals.globalState.tryGet('aws.amazonq.welcomeChatShowCount', Number, 0)
 
         return `
@@ -93,7 +93,7 @@ export class WebViewContentGenerator {
             const init = () => {
                 createMynahUI(acquireVsCodeApi(), ${
                     (await AuthUtil.instance.getChatAuthState()).amazonQ === 'connected'
-                },${featureConfigsString},${welcomeLoadCount},${enableDisclaimer},${disabledCommandsString},${isSMUS},${isSM});
+                },${featureConfigsString},${welcomeLoadCount},${disclaimerAcknowledged},${disabledCommandsString},${isSMUS},${isSM});
             }
         </script>
         `
diff --git a/packages/core/src/amazonq/webview/messages/messageDispatcher.ts b/packages/core/src/amazonq/webview/messages/messageDispatcher.ts
@@ -78,7 +78,7 @@ export function dispatchWebViewMessagesToApps(
                 return
             }
             case 'disclaimer-acknowledged': {
-                void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)
+                void AmazonQPromptSettings.instance.disablePrompt('amazonQChatDisclaimer')
                 return
             }
             case 'update-welcome-count': {
diff --git a/packages/core/src/shared/globalState.ts b/packages/core/src/shared/globalState.ts
@@ -35,7 +35,7 @@ export type globalKey =
     | 'aws.amazonq.codescan.groupingStrategy'
     | 'aws.amazonq.notifications'
     | 'aws.amazonq.welcomeChatShowCount'
-    | 'aws.amazonq.disclaimerAcknowledged'
+    | 'aws.amazonq.disclaimerAcknowledged' // Legacy, use `AmazonQPromptSettings` instead.
     | 'aws.notifications'
     | 'aws.notifications.dev' // keys to store notifications for testing
     | 'aws.downloadPath'
diff --git a/packages/core/src/shared/settings-amazonq.gen.ts b/packages/core/src/shared/settings-amazonq.gen.ts
@@ -21,7 +21,7 @@ export const amazonqSettings = {
         "ssoCacheError": {},
         "amazonQLspManifestMessage": {},
         "amazonQWorkspaceLspManifestMessage": {},
-        "amazonQChatDisclaimerAcknowledged": {}
+        "amazonQChatDisclaimer": {}
     },
     "amazonQ.showCodeWithReferences": {},
     "amazonQ.allowFeatureDevelopmentToRunCodeAndTests": {},
diff --git a/packages/core/src/shared/settings.ts b/packages/core/src/shared/settings.ts
@@ -662,6 +662,15 @@ export class AmazonQPromptSettings
 {
     public isPromptEnabled(promptName: amazonQPromptName): boolean {
         try {
+            // Legacy migration for old globalState settings:
+            if (promptName === 'amazonQChatDisclaimer') {
+                const acknowledged = globals.globalState.tryGet('aws.amazonq.disclaimerAcknowledged', Boolean, false)
+                if (acknowledged) {
+                    void this.update(promptName, true)
+                    globals.globalState.tryUpdate('aws.amazonq.disclaimerAcknowledged', undefined)
+                }
+            }
+
             return !this._getOrThrow(promptName, false)
         } catch (e) {
             this._log('prompt check for "%s" failed: %s', promptName, (e as Error).message)
diff --git a/packages/webpack.web.config.js b/packages/webpack.web.config.js
@@ -50,13 +50,6 @@ 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'],
@@ -83,10 +76,6 @@ 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
`@@ -128,7 +128,7 @@`
`128`	`128`	`"type": "boolean",`
`129`	`129`	`"default": false`
`130`	`130`	`},`
`131`		`- "amazonQChatDisclaimerAcknowledged": {`
	`131`	`+ "amazonQChatDisclaimer": {`
`132`	`132`	`"type": "boolean",`
`133`	`133`	`"default": false`
`134`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ export function registerMessageListeners(`
`109`	`109`	`break`
`110`	`110`	`}`
`111`	`111`	`case DISCLAIMER_ACKNOWLEDGED: {`
`112`		`- void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)`
	`112`	`+ void AmazonQPromptSettings.instance.disablePrompt('amazonQChatDisclaimer')`
`113`	`113`	`break`
`114`	`114`	`}`
`115`	`115`	`case chatRequestType.method: {`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ export function dispatchWebViewMessagesToApps(`
`78`	`78`	`return`
`79`	`79`	`}`
`80`	`80`	`case 'disclaimer-acknowledged': {`
`81`		`- void AmazonQPromptSettings.instance.update('amazonQChatDisclaimerAcknowledged', true)`
	`81`	`+ void AmazonQPromptSettings.instance.disablePrompt('amazonQChatDisclaimer')`
`82`	`82`	`return`
`83`	`83`	`}`
`84`	`84`	`case 'update-welcome-count': {`