fix: Show "Must select Developer Profile" message

Problem:

THe show developer profile message was appearing at the wrong time.
It was due to the order that the code executed. This was because when we
called to check if the profiles were restored from cache, the logic that
restored them had not actually run yet.

Solution:

Move the logic that decides to show the Needs Profile message, to after the code that
restores the Profile.

It is also only called once since we only want to show the message on startup.

Signed-off-by: nkomonen-amazon <[email protected]>

Author: nkomonen-amazon

packages/amazonq/src/developerProfile/util.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import * as nls from 'vscode-nls'
+const localize = nls.loadMessageBundle()
+import vscode from 'vscode'
+import { AmazonQPromptSettings, placeholder } from 'aws-core-vscode/shared'
+import { telemetry } from 'aws-core-vscode/telemetry'
+import { selectRegionProfileCommand, toastMessage } from 'aws-core-vscode/codewhisperer'
+import { once } from 'aws-core-vscode/utils'
+
+/**
+ * Creates a toast message telling the user they need to select a Developer Profile
+ */
+export const notifySelectDeveloperProfile = once(_notifySelectDeveloperProfile)
+async function _notifySelectDeveloperProfile() {
+    const suppressId = 'amazonQSelectDeveloperProfile'
+    const settings = AmazonQPromptSettings.instance
+    const shouldShow = settings.isPromptEnabled(suppressId)
+    if (!shouldShow) {
+        return
+    }
+
+    const message = localize(
+        'aws.amazonq.profile.mustSelectMessage',
+        'You must select a Q Developer Profile for Amazon Q features to work.'
+    )
+    const selectProfile = 'Select Profile'
+    const dontShowAgain = 'Dont Show Again'
+
+    await telemetry.toolkit_showNotification.run(async () => {
+        telemetry.record({ id: 'mustSelectDeveloperProfileMessage' })
+        void vscode.window.showWarningMessage(message, selectProfile, dontShowAgain).then(async (resp) => {
+            await telemetry.toolkit_invokeAction.run(async () => {
+                if (resp === selectProfile) {
+                    // Show Profile
+                    telemetry.record({ action: 'select' })
+                    void selectRegionProfileCommand.execute(placeholder, toastMessage)
+                } else if (resp === dontShowAgain) {
+                    telemetry.record({ action: 'dontShowAgain' })
+                    await settings.disablePrompt(suppressId)
+                } else {
+                    telemetry.record({ action: 'ignore' })
+                }
+            })
+        })
+    })
+}

packages/core/src/codewhisperer/activation.ts

@@ -91,7 +91,6 @@ import { setContext } from '../shared/vscode/setContext'
 import { syncSecurityIssueWebview } from './views/securityIssue/securityIssueWebview'
 import { detectCommentAboveLine } from '../shared/utilities/commentUtils'
 import { activateEditTracking } from './nextEditPrediction/activation'
-import { notifySelectDeveloperProfile } from './region/utils'
 
 let localize: nls.LocalizeFunc
 
@@ -351,10 +350,6 @@ export async function activate(context: ExtContext): Promise<void> {
                     await AuthUtil.instance.notifySessionConfiguration()
                 }
             }
-
-            if (AuthUtil.instance.regionProfileManager.requireProfileSelection()) {
-                await notifySelectDeveloperProfile()
-            }
         },
         { emit: false, functionId: { name: 'activateCwCore' } }
     )

packages/core/src/codewhisperer/util/authUtil.ts

@@ -30,6 +30,8 @@ import { builderIdStartUrl, internalStartUrl } from '../../auth/sso/constants'
 import { VSCODE_EXTENSION_ID } from '../../shared/extensions'
 import { RegionProfileManager } from '../region/regionProfileManager'
 import { AuthFormId } from '../../login/webview/vue/types'
+import { notifySelectDeveloperProfile } from '../region/utils'
+import { once } from '../../shared/utilities/functionUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -91,8 +93,20 @@ export class AuthUtil implements IAuthProvider {
         return this.session.loginType === LoginTypes.SSO
     }
 
+    /**
+     * HACK: Ideally we'd put {@link notifySelectDeveloperProfile} in to {@link restore}.
+     *       But because {@link refreshState} is only called if !isConnected, we cannot do it since
+     *       {@link notifySelectDeveloperProfile} needs {@link refreshState} to run so it can set
+     *       the Bearer Token in the LSP first.
+     */
+    startedConnected = false
+
     async restore() {
         await this.session.restore()
+        this.startedConnected = this.isConnected()
+
+        // HACK: The LSP should allow us to call refreshState multiple times, but for some reason it breaks.
+        // isConnected somehow allows it to work. Assumption is that the LSP does not handle redundant calls nicely.
         if (!this.isConnected()) {
             await this.refreshState()
         }
@@ -258,7 +272,6 @@ export class AuthUtil implements IAuthProvider {
     private async refreshState(state = this.getAuthState()) {
         if (state === 'expired' || state === 'notConnected') {
             this.lspAuth.deleteBearerToken()
-
             if (this.isIdcConnection()) {
                 await this.regionProfileManager.invalidateProfile(this.regionProfileManager.activeRegionProfile?.arn)
                 await this.regionProfileManager.clearCache()
@@ -273,6 +286,9 @@ export class AuthUtil implements IAuthProvider {
             }
         }
 
+        // regardless of state, send message at startup if user needs to select a Developer Profile
+        void this.tryNotifySelectDeveloperProfile()
+
         vsCodeState.isFreeTierLimitReached = false
         await this.setVscodeContextProps(state)
         await Promise.all([
@@ -285,6 +301,12 @@ export class AuthUtil implements IAuthProvider {
         }
     }
 
+    private tryNotifySelectDeveloperProfile = once(async () => {
+        if (this.regionProfileManager.requireProfileSelection() && this.startedConnected) {
+            await notifySelectDeveloperProfile()
+        }
+    })
+
     async getTelemetryMetadata(): Promise<TelemetryMetadata> {
         if (!this.isConnected()) {
             return {