feat(amazonq): Add acknowledgement button for disclaimer (#5178)

Author: rli

.changes/next-release/feature-d6ec19f0-49b2-4abe-ba30-c946dae6ce27.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "Add acknowledgement button for Amazon Q Chat disclaimer"
+}

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/webview/Browser.kt

@@ -87,12 +87,13 @@ class Browser(parent: Disposable) : Disposable {
                             }
                         },
                         ${MeetQSettings.getInstance().reinvent2024OnboardingCount < MAX_ONBOARDING_PAGE_COUNT},
+                        ${MeetQSettings.getInstance().disclaimerAcknowledged},
                         $isFeatureDevAvailable, // whether /dev is available
                         $isCodeTransformAvailable, // whether /transform is available
                         $isDocAvailable, // whether /doc is available
                         $isCodeScanAvailable, // whether /scan is available
                         $isCodeTestAvailable // whether /test is available
-                    ); 
+                    );
                 }
             </script>        
         """.trimIndent()

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonq/webview/BrowserConnector.kt

@@ -49,6 +49,10 @@ class BrowserConnector(
                         }
                     }
 
+                    "disclaimer-acknowledged" -> {
+                        MeetQSettings.getInstance().disclaimerAcknowledged = true
+                    }
+
                     // some weird issue preventing deserialization from working
                     "open-user-guide" -> {
                         BrowserUtil.browse(node.get("userGuideLink").asText())

plugins/amazonq/mynah-ui/src/mynah-ui/ui/commands.ts

@@ -12,6 +12,7 @@ type MessageCommand =
     | 'tab-was-removed'
     | 'tab-was-changed'
     | 'ui-is-ready'
+    | 'disclaimer-acknowledged'
     | 'ui-focus'
     | 'follow-up-was-clicked'
     | 'auth-follow-up-was-clicked'

plugins/amazonq/mynah-ui/src/mynah-ui/ui/main.ts

@@ -30,16 +30,20 @@ import { ChatPrompt, CodeSelectionType} from "@aws/mynah-ui-chat/dist/static";
 import {welcomeScreenTabData} from "./walkthrough/welcome";
 import { agentWalkthroughDataModel } from './walkthrough/agent'
 import {createClickTelemetry, createOpenAgentTelemetry} from "./telemetry/actions";
+import {disclaimerAcknowledgeButtonId, disclaimerCard} from "./texts/disclaimer";
 
 export const createMynahUI = (
     ideApi: any,
     showWelcomePage: boolean,
+    disclaimerAcknowledged: boolean,
     featureDevInitEnabled: boolean,
     codeTransformInitEnabled: boolean,
     docInitEnabled: boolean,
     codeScanEnabled: boolean,
     codeTestEnabled: boolean
 ) => {
+    let disclaimerCardActive = !disclaimerAcknowledged
+
     // eslint-disable-next-line prefer-const
     let mynahUI: MynahUI
     // eslint-disable-next-line prefer-const
@@ -556,6 +560,7 @@ export const createMynahUI = (
             // make sure to show/hide it accordingly
             mynahUI.updateStore(tabID, {
                 quickActionCommands: tabDataGenerator.quickActionsGenerator.generateForTab('unknown'),
+                ...(disclaimerCardActive ? { promptInputStickyCard: disclaimerCard } : {}),
             })
             connector.onTabAdd(tabID)
         },
@@ -690,12 +695,32 @@ export const createMynahUI = (
         tabs: {
             'tab-1': {
                 isSelected: true,
-                store: showWelcomePage
-                    ? welcomeScreenTabData(tabDataGenerator).store
-                    : tabDataGenerator.getTabData('cwc', true),
+                store: {
+                    ...(showWelcomePage
+                        ? welcomeScreenTabData(tabDataGenerator).store
+                        : tabDataGenerator.getTabData('cwc', true)),
+                    ...(disclaimerCardActive ? { promptInputStickyCard: disclaimerCard } : {}),
+                },
             },
         },
         onInBodyButtonClicked: (tabId, messageId, action, eventId) => {
+            if (action.id === disclaimerAcknowledgeButtonId) {
+                disclaimerCardActive = false
+                // post message to tell IDE that disclaimer is acknowledged
+                ideApi.postMessage({
+                    command: 'disclaimer-acknowledged',
+                })
+
+                // create telemetry
+                ideApi.postMessage(createClickTelemetry('amazonq-disclaimer-acknowledge-button'))
+
+                // remove all disclaimer cards from all tabs
+                Object.keys(mynahUI.getAllTabs()).forEach((storeTabKey) => {
+                    // eslint-disable-next-line no-null/no-null
+                    mynahUI.updateStore(storeTabKey, { promptInputStickyCard: null })
+                })
+            }
+
             if (action.id === 'quick-start') {
                 /**
                  * quick start is the action on the welcome page. When its

plugins/amazonq/mynah-ui/src/mynah-ui/ui/tabs/generator.ts

@@ -94,7 +94,7 @@ What would you like to work on?`,
         return {
             tabTitle: taskName ?? this.tabTitle.get(tabType),
             promptInputInfo:
-                'Amazon Q Developer uses generative AI. You may need to verify responses. See the [AWS Responsible AI Policy](https://aws.amazon.com/machine-learning/responsible-ai/policy/). Amazon Q Developer processes data across all US Regions. See [here](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/cross-region-inference.html) for more info. Amazon Q may retain chats to provide and maintain the service.',
+                'Amazon Q Developer uses generative AI. You may need to verify responses. See the [AWS Responsible AI Policy](https://aws.amazon.com/machine-learning/responsible-ai/policy/).',
             quickActionCommands: this.quickActionsGenerator.generateForTab(tabType),
             promptInputPlaceholder: this.tabInputPlaceholder.get(tabType),
             contextCommands: this.tabContextCommand.get(tabType),

plugins/amazonq/mynah-ui/src/mynah-ui/ui/texts/disclaimer.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ChatItem, MynahIcons } from '@aws/mynah-ui-chat'
+
+export const disclaimerAcknowledgeButtonId = 'amazonq-disclaimer-acknowledge-button-id'
+export const disclaimerCard: Partial<ChatItem> = {
+    messageId: 'amazonq-disclaimer-card',
+    body: 'Amazon Q Developer uses generative AI. You may need to verify responses. See the [AWS Responsible AI Policy](https://aws.amazon.com/machine-learning/responsible-ai/policy/). Amazon Q Developer processes data across all US Regions. See [here](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/cross-region-inference.html) for more info. Amazon Q may retain chats to provide and maintain the service.',
+    buttons: [
+        {
+            text: 'Acknowledge',
+            id: disclaimerAcknowledgeButtonId,
+            status: 'info',
+            icon: MynahIcons.OK,
+        },
+    ],
+}

plugins/amazonq/shared/jetbrains-community/src/software/aws/toolkits/jetbrains/settings/MeetQSettings.kt

@@ -32,11 +32,18 @@ class MeetQSettings : PersistentStateComponent<MeetQSettingsConfiguration> {
             state.reinvent2024OnboardingCount = value
         }
 
+    var disclaimerAcknowledged: Boolean
+        get() = state.disclaimerAcknowledged
+        set(value) {
+            state.disclaimerAcknowledged = value
+        }
+
     companion object {
         fun getInstance(): MeetQSettings = service()
     }
 }
 data class MeetQSettingsConfiguration(
     var shouldDisplayPage: Boolean = true,
     var reinvent2024OnboardingCount: Int = 0,
+    var disclaimerAcknowledged: Boolean = false,
 )