feat(amazonq): show all customizations across different profiles (aws#7060)

Will-ShaoHua · web-flow · commit 70ba83fc066c · 2025-04-21T13:30:17.000-07:00
## Problem followup of aws#7049 as mentioned in aws#7049 ``` Before we introduced QProfile customization is bound to a specific idc instance After customization is bound to a specific Q profile and an idc instance can have multi profiles in other words, each Q profile will have access to different sets of customization ``` ## Solution Product team wants us to show all customizations across profiles instead of the connected one only. By that mean, when users select a customization, it might implicitly change the profile for users in the selected customization is not accessible by the current profile. The purpose is to reduce the churn users might be lost what profile has access to what customization. ## user story 1. click "select customization" button from the menu -> should show "all" customizations across profiles 2. select a customization under different profile -> should change the profile to the one owning the newly selected customization 3. select a profile which doesn't have access to the selected customization -> should fallback to "default" and prompt ui saying you don't have access to the customization ### Implicity change profile when user selects a customization under a different profile https://github.com/user-attachments/assets/49bfe61f-04a7-4d07-aaff-1e3c284fb710 ### Change profile should validate if the selected customization is under the new profile or not https://github.com/user-attachments/assets/414f85dd-50a1-4d28-9b33-e59691f25a0c Note that customization will have only 1 profile owner, so there wont be duplicate customization across profiles --- - Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time. - Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). - License: I confirm that my contribution is made under the terms of the Apache 2.0 license.
diff --git a/packages/amazonq/.changes/next-release/Feature-2a696d00-e8c8-44a4-ab2c-2204b4d8e31d.json b/packages/amazonq/.changes/next-release/Feature-2a696d00-e8c8-44a4-ab2c-2204b4d8e31d.json
@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Support selecting customizations across all Q profiles with automatic profile switching for enterprise users"
+}
diff --git a/packages/amazonq/test/unit/codewhisperer/region/regionProfileManager.test.ts b/packages/amazonq/test/unit/codewhisperer/region/regionProfileManager.test.ts
@@ -65,7 +65,7 @@ describe('RegionProfileManager', function () {
             const mockClient = {
                 listAvailableProfiles: listProfilesStub,
             }
-            const createClientStub = sinon.stub(sut, 'createQClient').resolves(mockClient)
+            const createClientStub = sinon.stub(sut, '_createQClient').resolves(mockClient)
 
             const r = await sut.listRegionProfile()
 
@@ -234,13 +234,65 @@ describe('RegionProfileManager', function () {
     })
 
     describe('createQClient', function () {
+        it(`should configure the endpoint and region from a profile`, async function () {
+            await setupConnection('idc')
+
+            const iadClient = await sut.createQClient({
+                name: 'foo',
+                region: 'us-east-1',
+                arn: 'arn',
+                description: 'description',
+            })
+
+            assert.deepStrictEqual(iadClient.config.region, 'us-east-1')
+            assert.deepStrictEqual(iadClient.endpoint.href, 'https://q.us-east-1.amazonaws.com/')
+
+            const fraClient = await sut.createQClient({
+                name: 'bar',
+                region: 'eu-central-1',
+                arn: 'arn',
+                description: 'description',
+            })
+
+            assert.deepStrictEqual(fraClient.config.region, 'eu-central-1')
+            assert.deepStrictEqual(fraClient.endpoint.href, 'https://q.eu-central-1.amazonaws.com/')
+        })
+
+        it(`should throw if the region is not supported or recognizable by Q`, async function () {
+            await setupConnection('idc')
+
+            await assert.rejects(
+                async () => {
+                    await sut.createQClient({
+                        name: 'foo',
+                        region: 'ap-east-1',
+                        arn: 'arn',
+                        description: 'description',
+                    })
+                },
+                { message: /trying to initiatize Q client with unrecognizable region/ }
+            )
+
+            await assert.rejects(
+                async () => {
+                    await sut.createQClient({
+                        name: 'foo',
+                        region: 'unknown-somewhere',
+                        arn: 'arn',
+                        description: 'description',
+                    })
+                },
+                { message: /trying to initiatize Q client with unrecognizable region/ }
+            )
+        })
+
         it(`should configure the endpoint and region correspondingly`, async function () {
             await setupConnection('idc')
             await sut.switchRegionProfile(profileFoo, 'user')
             assert.deepStrictEqual(sut.activeRegionProfile, profileFoo)
             const conn = authUtil.conn as SsoConnection
 
-            const client = await sut.createQClient('eu-central-1', 'https://amazon.com/', conn)
+            const client = await sut._createQClient('eu-central-1', 'https://amazon.com/', conn)
 
             assert.deepStrictEqual(client.config.region, 'eu-central-1')
             assert.deepStrictEqual(client.endpoint.href, 'https://amazon.com/')
diff --git a/packages/core/src/codewhisperer/activation.ts b/packages/core/src/codewhisperer/activation.ts
@@ -72,12 +72,7 @@ import { AuthUtil } from './util/authUtil'
 import { ImportAdderProvider } from './service/importAdderProvider'
 import { TelemetryHelper } from './util/telemetryHelper'
 import { openUrl } from '../shared/utilities/vsCodeUtils'
-import {
-    getAvailableCustomizationsList,
-    getSelectedCustomization,
-    notifyNewCustomizations,
-    switchToBaseCustomizationAndNotify,
-} from './util/customizationUtil'
+import { notifyNewCustomizations, onProfileChangedListener } from './util/customizationUtil'
 import { CodeWhispererCommandBackend, CodeWhispererCommandDeclarations } from './commands/gettingStartedPageCommands'
 import { SecurityIssueHoverProvider } from './service/securityIssueHoverProvider'
 import { SecurityIssueCodeActionProvider } from './service/securityIssueCodeActionProvider'
@@ -343,26 +338,7 @@ export async function activate(context: ExtContext): Promise<void> {
             SecurityIssueCodeActionProvider.instance
         ),
         vscode.commands.registerCommand('aws.amazonq.openEditorAtRange', openEditorAtRange),
-        auth.regionProfileManager.onDidChangeRegionProfile(() => {
-            // Validate user still has access to the selected customization.
-            const selectedCustomization = getSelectedCustomization()
-            // No need to validate base customization which has empty arn.
-            if (selectedCustomization.arn.length > 0) {
-                getAvailableCustomizationsList()
-                    .then(async (customizations) => {
-                        const r = customizations.find((it) => it.arn === selectedCustomization.arn)
-                        if (!r) {
-                            await switchToBaseCustomizationAndNotify()
-                        }
-                    })
-                    .catch((e) => {
-                        getLogger().error(
-                            `encounter error while validating selected customization on profile change: %s`,
-                            (e as Error).message
-                        )
-                    })
-            }
-        })
+        auth.regionProfileManager.onDidChangeRegionProfile(onProfileChangedListener)
     )
 
     // run the auth startup code with context for telemetry
diff --git a/packages/core/src/codewhisperer/client/codewhisperer.ts b/packages/core/src/codewhisperer/client/codewhisperer.ts
@@ -7,19 +7,17 @@ import { AWSError, Credentials, Service } from 'aws-sdk'
 import globals from '../../shared/extensionGlobals'
 import * as CodeWhispererClient from './codewhispererclient'
 import * as CodeWhispererUserClient from './codewhispereruserclient'
-import { ListAvailableCustomizationsResponse, SendTelemetryEventRequest } from './codewhispereruserclient'
+import { SendTelemetryEventRequest } from './codewhispereruserclient'
 import { ServiceOptions } from '../../shared/awsClientBuilder'
 import { hasVendedIamCredentials } from '../../auth/auth'
 import { CodeWhispererSettings } from '../util/codewhispererSettings'
 import { PromiseResult } from 'aws-sdk/lib/request'
 import { AuthUtil } from '../util/authUtil'
 import { isSsoConnection } from '../../auth/connection'
-import { pageableToCollection } from '../../shared/utilities/collectionUtils'
 import apiConfig = require('./service-2.json')
 import userApiConfig = require('./user-service-2.json')
 import { session } from '../util/codeWhispererSession'
 import { getLogger } from '../../shared/logger/logger'
-import { indent } from '../../shared/utilities/textUtilities'
 import { getClientId, getOptOutPreference, getOperatingSystem } from '../../shared/telemetry/util'
 import { extensionVersion, getServiceEnvVarConfig } from '../../shared/vscode/env'
 import { DevSettings } from '../../shared/settings'
@@ -219,28 +217,6 @@ export class DefaultCodeWhispererClient {
             .promise()
     }
 
-    public async listAvailableCustomizations(): Promise<ListAvailableCustomizationsResponse[]> {
-        const client = await this.createUserSdkClient()
-        const profile = AuthUtil.instance.regionProfileManager.activeRegionProfile
-        const requester = async (request: CodeWhispererUserClient.ListAvailableCustomizationsRequest) =>
-            client.listAvailableCustomizations(request).promise()
-        return pageableToCollection(requester, { profileArn: profile?.arn }, 'nextToken')
-            .promise()
-            .then((resps) => {
-                let logStr = 'amazonq: listAvailableCustomizations API request:'
-                for (const resp of resps) {
-                    const requestId = resp.$response.requestId
-                    logStr += `\n${indent('RequestID: ', 4)}${requestId},\n${indent('Customizations:', 4)}`
-                    for (const [index, c] of resp.customizations.entries()) {
-                        const entry = `${index.toString().padStart(2, '0')}: ${c.name?.trim()}`
-                        logStr += `\n${indent(entry, 8)}`
-                    }
-                }
-                getLogger().debug(logStr)
-                return resps
-            })
-    }
-
     public async sendTelemetryEvent(request: SendTelemetryEventRequest) {
         const requestWithCommonFields: SendTelemetryEventRequest = {
             ...request,
diff --git a/packages/core/src/codewhisperer/index.ts b/packages/core/src/codewhisperer/index.ts
@@ -99,7 +99,13 @@ export * as diagnosticsProvider from './service/diagnosticsProvider'
 export * from './ui/codeWhispererNodes'
 export { SecurityScanError, SecurityScanTimedOutError } from '../codewhisperer/models/errors'
 export * as CodeWhispererConstants from '../codewhisperer/models/constants'
-export { getSelectedCustomization, setSelectedCustomization, baseCustomization } from './util/customizationUtil'
+export {
+    getSelectedCustomization,
+    setSelectedCustomization,
+    baseCustomization,
+    onProfileChangedListener,
+    CustomizationProvider,
+} from './util/customizationUtil'
 export { Container } from './service/serviceContainer'
 export * from './util/gitUtil'
 export * from './ui/prompters'
diff --git a/packages/core/src/codewhisperer/region/regionProfileManager.ts b/packages/core/src/codewhisperer/region/regionProfileManager.ts
@@ -47,12 +47,17 @@ const endpoints = createConstantMap({
  * 'update' -> plugin auto select the profile on users' behalf as there is only 1 profile
  * 'reload' -> on plugin restart, plugin will try to reload previous selected profile
  */
-export type ProfileSwitchIntent = 'user' | 'auth' | 'update' | 'reload'
+export type ProfileSwitchIntent = 'user' | 'auth' | 'update' | 'reload' | 'customization'
+
+export type ProfileChangedEvent = {
+    profile: RegionProfile | undefined
+    intent: ProfileSwitchIntent
+}
 
 export class RegionProfileManager {
     private static logger = getLogger()
     private _activeRegionProfile: RegionProfile | undefined
-    private _onDidChangeRegionProfile = new vscode.EventEmitter<RegionProfile | undefined>()
+    private _onDidChangeRegionProfile = new vscode.EventEmitter<ProfileChangedEvent>()
     public readonly onDidChangeRegionProfile = this._onDidChangeRegionProfile.event
 
     // Store the last API results (for UI propuse) so we don't need to call service again if doesn't require "latest" result
@@ -112,7 +117,7 @@ export class RegionProfileManager {
         }
         const availableProfiles: RegionProfile[] = []
         for (const [region, endpoint] of endpoints.entries()) {
-            const client = await this.createQClient(region, endpoint, conn as SsoConnection)
+            const client = await this._createQClient(region, endpoint, conn as SsoConnection)
             const requester = async (request: CodeWhispererUserClient.ListAvailableProfilesRequest) =>
                 client.listAvailableProfiles(request).promise()
             const request: CodeWhispererUserClient.ListAvailableProfilesRequest = {}
@@ -162,7 +167,7 @@ export class RegionProfileManager {
         const ssoConn = this.connectionProvider() as SsoConnection
 
         // only prompt to users when users switch from A profile to B profile
-        if (this.activeRegionProfile !== undefined && regionProfile !== undefined) {
+        if (source !== 'customization' && this.activeRegionProfile !== undefined && regionProfile !== undefined) {
             const response = await showConfirmationMessage({
                 prompt: localize(
                     'AWS.amazonq.profile.confirmation',
@@ -204,13 +209,16 @@ export class RegionProfileManager {
             })
         }
 
-        await this._switchRegionProfile(regionProfile)
+        await this._switchRegionProfile(regionProfile, source)
     }
 
-    private async _switchRegionProfile(regionProfile: RegionProfile | undefined) {
+    private async _switchRegionProfile(regionProfile: RegionProfile | undefined, source: ProfileSwitchIntent) {
         this._activeRegionProfile = regionProfile
 
-        this._onDidChangeRegionProfile.fire(regionProfile)
+        this._onDidChangeRegionProfile.fire({
+            profile: regionProfile,
+            intent: source,
+        })
         // dont show if it's a default (fallback)
         if (regionProfile && this.profiles.length > 1) {
             void vscode.window.showInformationMessage(`You are using the ${regionProfile.name} profile for Q.`).then()
@@ -343,7 +351,21 @@ export class RegionProfileManager {
         }
     }
 
-    async createQClient(region: string, endpoint: string, conn: SsoConnection): Promise<CodeWhispererUserClient> {
+    // TODO: Should maintain sdk client in a better way
+    async createQClient(profile: RegionProfile): Promise<CodeWhispererUserClient> {
+        const conn = this.connectionProvider()
+        if (conn === undefined || !isSsoConnection(conn)) {
+            throw new Error('No valid SSO connection')
+        }
+        const endpoint = endpoints.get(profile.region)
+        if (!endpoint) {
+            throw new Error(`trying to initiatize Q client with unrecognizable region ${profile.region}`)
+        }
+        return this._createQClient(profile.region, endpoint, conn)
+    }
+
+    // Visible for testing only, do not use this directly, please use createQClient(profile)
+    async _createQClient(region: string, endpoint: string, conn: SsoConnection): Promise<CodeWhispererUserClient> {
         const token = (await conn.getToken()).accessToken
         const serviceOption: ServiceOptions = {
             apiConfig: userApiConfig,
diff --git a/packages/core/src/codewhisperer/util/customizationUtil.ts b/packages/core/src/codewhisperer/util/customizationUtil.ts
diff --git a/packages/core/src/shared/featureConfig.ts b/packages/core/src/shared/featureConfig.ts
diff --git a/packages/core/src/test/amazonq/customizationUtil.test.ts b/packages/core/src/test/amazonq/customizationUtil.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +	"type": "Feature",
 +	"description": "Support selecting customizations across all Q profiles with automatic profile switching for enterprise users"
 +}