feat(amazonq lsp): Make chat client assets configurable (#6878)

## Problem
You can't point to a local chat client instance from flare

## Solution
Make that configurable


---

- 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.

Author: jpinkney-aws

CONTRIBUTING.md

@@ -439,6 +439,7 @@ Example:
     "supportedVersions": "4.0.0",
     "id": "AmazonQ",
     "path": "/custom/path/to/local/lsp/folder",
+    "ui": "/custom/path/to/chat-client/ui"
 }
 ```
 
@@ -503,11 +504,12 @@ Unlike the user setting overrides, not all of these environment variables have t
 -   `__AMAZONQLSP_MANIFEST_URL`: for aws.dev.amazonqLsp.manifestUrl
 -   `__AMAZONQLSP_SUPPORTED_VERSIONS`: for aws.dev.amazonqLsp.supportedVersions
 -   `__AMAZONQLSP_ID`: for aws.dev.amazonqLsp.id
--   `__AMAZONQLSP_PATH`: for aws.dev.amazonqWorkspaceLsp.locationOverride
+-   `__AMAZONQLSP_PATH`: for aws.dev.amazonqLsp.path
+-   `__AMAZONQLSP_UI`: for aws.dev.amazonqLsp.ui
 -   `__AMAZONQWORKSPACELSP_MANIFEST_URL`: for aws.dev.amazonqWorkspaceLsp.manifestUrl
 -   `__AMAZONQWORKSPACELSP_SUPPORTED_VERSIONS`: for aws.dev.amazonqWorkspaceLsp.supportedVersions
 -   `__AMAZONQWORKSPACELSP_ID`: for aws.dev.amazonqWorkspaceLsp.id
--   `__AMAZONQWORKSPACELSP_PATH`: for aws.dev.amazonqWorkspaceLsp.locationOverride
+-   `__AMAZONQWORKSPACELSP_PATH`: for aws.dev.amazonqWorkspaceLsp.path
 
 #### Lambda
 

docs/lsp.md

@@ -54,6 +54,7 @@ sequenceDiagram
     }
     ```
 4. Uncomment the `__AMAZONQLSP_PATH` variable in `amazonq/.vscode/launch.json` Extension configuration
+    1. Uncomment the `__AMAZONQLSP_UI` variable in `amazonq/.vscode/launch.json` Extension configuration if you want to debug the flare chat-client as well
 5. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server
 
 ## Amazon Q Inline Activation

packages/amazonq/.vscode/launch.json

@@ -15,6 +15,7 @@
                 "SSMDOCUMENT_LANGUAGESERVER_PORT": "6010",
                 "WEBPACK_DEVELOPER_SERVER": "http://localhost:8080"
                 // "__AMAZONQLSP_PATH": "${workspaceFolder}/../../../language-servers/app/aws-lsp-codewhisperer-runtimes/out/token-standalone.js",
+                // "__AMAZONQLSP_UI": "${workspaceFolder}/../../../language-servers/chat-client/build/amazonq-ui.js"
             },
             "envFile": "${workspaceFolder}/.local.env",
             "outFiles": ["${workspaceFolder}/dist/**/*.js", "${workspaceFolder}/../core/dist/**/*.js"],

packages/amazonq/src/lsp/chat/webviewProvider.ts

@@ -14,6 +14,7 @@ import {
 } from 'vscode'
 import { LanguageServerResolver } from 'aws-core-vscode/shared'
 import { QuickActionCommandGroup } from '@aws/mynah-ui'
+import * as path from 'path'
 
 export class AmazonQChatViewProvider implements WebviewViewProvider {
     public static readonly viewType = 'aws.amazonq.AmazonQChatView'
@@ -49,7 +50,7 @@ export class AmazonQChatViewProvider implements WebviewViewProvider {
         webviewView.webview.options = {
             enableScripts: true,
             enableCommandUris: true,
-            localResourceRoots: [lspDir],
+            localResourceRoots: [lspDir, Uri.parse(path.dirname(this.mynahUIPath))],
         }
 
         const uiPath = webviewView.webview.asWebviewUri(Uri.parse(this.mynahUIPath)).toString()

packages/amazonq/src/lsp/client.ts

@@ -126,7 +126,7 @@ export async function startLanguageServer(
         }
 
         if (Experiments.instance.get('amazonqChatLSP', false)) {
-            activate(client, encryptionKey, resourcePaths.mynahUI)
+            activate(client, encryptionKey, resourcePaths.ui)
         }
 
         // Temporary code for pen test. Will be removed when we switch to the real flare auth

packages/amazonq/src/lsp/config.ts

@@ -6,18 +6,23 @@
 import { DevSettings, getServiceEnvVarConfig } from 'aws-core-vscode/shared'
 import { LspConfig } from 'aws-core-vscode/amazonq'
 
-export const defaultAmazonQLspConfig: LspConfig = {
+export interface ExtendedAmazonQLSPConfig extends LspConfig {
+    ui?: string
+}
+
+export const defaultAmazonQLspConfig: ExtendedAmazonQLSPConfig = {
     manifestUrl: 'https://aws-toolkit-language-servers.amazonaws.com/codewhisperer/0/manifest.json',
     supportedVersions: '^3.1.1',
     id: 'AmazonQ', // used across IDEs for identifying global storage/local disk locations. Do not change.
     suppressPromptPrefix: 'amazonQ',
     path: undefined,
+    ui: undefined,
 }
 
-export function getAmazonQLspConfig(): LspConfig {
+export function getAmazonQLspConfig(): ExtendedAmazonQLSPConfig {
     return {
         ...defaultAmazonQLspConfig,
-        ...(DevSettings.instance.getServiceConfig('amazonqLsp', {}) as LspConfig),
+        ...(DevSettings.instance.getServiceConfig('amazonqLsp', {}) as ExtendedAmazonQLSPConfig),
         ...getServiceEnvVarConfig('amazonqLsp', Object.keys(defaultAmazonQLspConfig)),
     }
 }

packages/amazonq/src/lsp/lspInstaller.ts

@@ -5,15 +5,17 @@
 
 import { fs, getNodeExecutableName, BaseLspInstaller, ResourcePaths } from 'aws-core-vscode/shared'
 import path from 'path'
-import { getAmazonQLspConfig } from './config'
-import { LspConfig } from 'aws-core-vscode/amazonq'
+import { ExtendedAmazonQLSPConfig, getAmazonQLspConfig } from './config'
 
 export interface AmazonQResourcePaths extends ResourcePaths {
-    mynahUI: string
+    ui: string
 }
 
-export class AmazonQLspInstaller extends BaseLspInstaller.BaseLspInstaller<AmazonQResourcePaths> {
-    constructor(lspConfig: LspConfig = getAmazonQLspConfig()) {
+export class AmazonQLspInstaller extends BaseLspInstaller.BaseLspInstaller<
+    AmazonQResourcePaths,
+    ExtendedAmazonQLSPConfig
+> {
+    constructor(lspConfig: ExtendedAmazonQLSPConfig = getAmazonQLspConfig()) {
         super(lspConfig, 'amazonqLsp')
     }
 
@@ -27,15 +29,15 @@ export class AmazonQLspInstaller extends BaseLspInstaller.BaseLspInstaller<Amazo
             return {
                 lsp: this.config.path ?? '',
                 node: getNodeExecutableName(),
-                mynahUI: '', // TODO make mynah UI configurable
+                ui: this.config.ui ?? '',
             }
         }
 
         const nodePath = path.join(assetDirectory, `servers/${getNodeExecutableName()}`)
         return {
             lsp: path.join(assetDirectory, 'servers/aws-lsp-codewhisperer.js'),
             node: nodePath,
-            mynahUI: path.join(assetDirectory, 'clients/amazonq-ui.js'),
+            ui: path.join(assetDirectory, 'clients/amazonq-ui.js'),
         }
     }
 }

packages/amazonq/test/unit/amazonq/lsp/config.test.ts

@@ -6,25 +6,27 @@
 import assert from 'assert'
 import { DevSettings } from 'aws-core-vscode/shared'
 import sinon from 'sinon'
-import { defaultAmazonQLspConfig, getAmazonQLspConfig } from '../../../../src/lsp/config'
-import { LspConfig, getAmazonQWorkspaceLspConfig, defaultAmazonQWorkspaceLspConfig } from 'aws-core-vscode/amazonq'
+import { defaultAmazonQLspConfig, ExtendedAmazonQLSPConfig, getAmazonQLspConfig } from '../../../../src/lsp/config'
+import { defaultAmazonQWorkspaceLspConfig, getAmazonQWorkspaceLspConfig, LspConfig } from 'aws-core-vscode/amazonq'
 
 for (const [name, config, defaultConfig, setEnv, resetEnv] of [
     [
         'getAmazonQLspConfig',
         getAmazonQLspConfig,
         defaultAmazonQLspConfig,
-        (envConfig: LspConfig) => {
+        (envConfig: ExtendedAmazonQLSPConfig) => {
             process.env.__AMAZONQLSP_MANIFEST_URL = envConfig.manifestUrl
             process.env.__AMAZONQLSP_SUPPORTED_VERSIONS = envConfig.supportedVersions
             process.env.__AMAZONQLSP_ID = envConfig.id
             process.env.__AMAZONQLSP_PATH = envConfig.path
+            process.env.__AMAZONQLSP_UI = envConfig.ui
         },
         () => {
             delete process.env.__AMAZONQLSP_MANIFEST_URL
             delete process.env.__AMAZONQLSP_SUPPORTED_VERSIONS
             delete process.env.__AMAZONQLSP_ID
             delete process.env.__AMAZONQLSP_PATH
+            delete process.env.__AMAZONQLSP_UI
         },
     ],
     [
@@ -52,8 +54,9 @@ for (const [name, config, defaultConfig, setEnv, resetEnv] of [
             manifestUrl: 'https://custom.url/manifest.json',
             supportedVersions: '4.0.0',
             id: 'AmazonQSetting',
-            suppressPromptPrefix: 'amazonQSetting',
+            suppressPromptPrefix: config().suppressPromptPrefix,
             path: '/custom/path',
+            ...(name === 'getAmazonQLspConfig' && { ui: '/chat/client/location' }),
         }
 
         beforeEach(() => {
@@ -75,7 +78,7 @@ for (const [name, config, defaultConfig, setEnv, resetEnv] of [
             assert.deepStrictEqual(config(), defaultConfig)
         })
 
-        it('overrides location', () => {
+        it('overrides path', () => {
             const path = '/custom/path/to/lsp'
             serviceConfigStub.returns({ path })
 
@@ -92,21 +95,9 @@ for (const [name, config, defaultConfig, setEnv, resetEnv] of [
         })
 
         it('environment variable takes precedence over settings', () => {
-            const envConfig: LspConfig = {
-                manifestUrl: 'https://another-custom.url/manifest.json',
-                supportedVersions: '5.1.1',
-                id: 'AmazonQSetting',
-                suppressPromptPrefix: 'amazonQSetting',
-                path: '/some/new/custom/path',
-            }
-
-            setEnv(envConfig)
-            serviceConfigStub.returns(settingConfig)
-
-            assert.deepStrictEqual(config(), {
-                ...defaultAmazonQLspConfig,
-                ...envConfig,
-            })
+            setEnv(settingConfig)
+            serviceConfigStub.returns({})
+            assert.deepStrictEqual(config(), settingConfig)
         })
     })
 }

packages/core/src/shared/lsp/baseLspInstaller.ts

@@ -14,11 +14,11 @@ import { Range } from 'semver'
 import { getLogger } from '../logger/logger'
 import type { Logger, LogTopic } from '../logger/logger'
 
-export abstract class BaseLspInstaller<T extends ResourcePaths = ResourcePaths> {
+export abstract class BaseLspInstaller<T extends ResourcePaths = ResourcePaths, Config extends LspConfig = LspConfig> {
     private logger: Logger
 
     constructor(
-        protected config: LspConfig,
+        protected config: Config,
         loggerName: Extract<LogTopic, 'amazonqLsp' | 'amazonqWorkspaceLsp'>
     ) {
         this.logger = getLogger(loggerName)