feat(amazonq): Chat Project Context With LSP

packages/amazonq/.changes/next-release/Feature-69f0d3bf-3e57-4ad6-93ea-48de3c890331.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Add LSP for Amazon Q Chat Local Indexing. Customers can use @workspace to ask questions regarding local workspace."
+}

packages/amazonq/package.json

@@ -125,6 +125,30 @@
                     "markdownDescription": "%AWS.configuration.description.amazonq.shareContentWithAWS%",
                     "default": true,
                     "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndex": {
+                    "type": "boolean",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndex%",
+                    "default": false,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexWorkerThreads": {
+                    "type": "number",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexWorkerThreads%",
+                    "default": 0,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexUseGPU": {
+                    "type": "boolean",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexUseGPU%",
+                    "default": false,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexMaxSize": {
+                    "type": "number",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexMaxSize%",
+                    "default": 250,
+                    "scope": "application"
                 }
             }
         },

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

@@ -0,0 +1,51 @@
+import * as sinon from 'sinon'
+import assert from 'assert'
+import { globals } from 'aws-core-vscode/shared'
+import { LspClient } from 'aws-core-vscode/amazonq'
+
+describe('Amazon Q LSP client', function () {
+    let lspClient: LspClient
+    let encryptFunc: sinon.SinonSpy
+
+    beforeEach(async function () {
+        sinon.stub(globals, 'isWeb').returns(false)
+        lspClient = new LspClient()
+        encryptFunc = sinon.spy(lspClient, 'encrypt')
+    })
+
+    it('encrypts payload of query ', async () => {
+        await lspClient.query('mock_input')
+        assert.ok(encryptFunc.calledOnce)
+        assert.ok(encryptFunc.calledWith(JSON.stringify({ query: 'mock_input' })))
+        const value = await encryptFunc.returnValues[0]
+        // verifies JWT encryption header
+        assert.ok(value.startsWith(`eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0`))
+    })
+
+    it('encrypts payload of index files ', async () => {
+        await lspClient.indexFiles(['fileA'], 'path', false)
+        assert.ok(encryptFunc.calledOnce)
+        assert.ok(
+            encryptFunc.calledWith(
+                JSON.stringify({
+                    filePaths: ['fileA'],
+                    rootPath: 'path',
+                    refresh: false,
+                })
+            )
+        )
+        const value = await encryptFunc.returnValues[0]
+        // verifies JWT encryption header
+        assert.ok(value.startsWith(`eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0`))
+    })
+
+    it('encrypt removes readable information', async () => {
+        const sample = 'hello'
+        const encryptedSample = await lspClient.encrypt(sample)
+        assert.ok(!encryptedSample.includes('hello'))
+    })
+
+    afterEach(() => {
+        sinon.restore()
+    })
+})

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

@@ -0,0 +1,51 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import assert from 'assert'
+import sinon from 'sinon'
+import { Content, LspController } from 'aws-core-vscode/amazonq'
+import { createTestFile } from 'aws-core-vscode/test'
+import { fs } from 'aws-core-vscode/shared'
+
+describe('Test LSP controller', function () {
+    it('Downloaded mechanism checks against hash, when hash matches', async function () {
+        const content = {
+            filename: 'qserver-linux-x64.zip',
+            url: 'https://x/0.0.6/qserver-linux-x64.zip',
+            hashes: [
+                'sha384:768412320f7b0aa5812fce428dc4706b3cae50e02a64caa16a782249bfe8efc4b7ef1ccb126255d196047dfedf17a0a9',
+            ],
+            bytes: 512,
+        } as Content
+        const lspController = new LspController()
+        sinon.stub(lspController, '_download')
+        const mockFileName = 'test_case_1.zip'
+        const mockDownloadFile = await createTestFile(mockFileName)
+        await fs.writeFile(mockDownloadFile.fsPath, 'test')
+        const result = await lspController.downloadAndCheckHash(mockDownloadFile.fsPath, content)
+        assert.strictEqual(result, true)
+    })
+
+    it('Verify downloaded mechanism checks against hash, when hash does not match', async function () {
+        const content = {
+            filename: 'qserver-linux-x64.zip',
+            url: 'https://x/0.0.6/qserver-linux-x64.zip',
+            hashes: [
+                'sha384:38b060a751ac96384cd9327eb1b1e36a21fdb71114be07434c0cc7bf63f6e1da274edebfe76f65fbd51ad2f14898b95b',
+            ],
+            bytes: 512,
+        } as Content
+        const lspController = new LspController()
+        sinon.stub(lspController, '_download')
+        const mockFileName = 'test_case_2.zip'
+        const mockDownloadFile = await createTestFile(mockFileName)
+        await fs.writeFile(mockDownloadFile.fsPath, 'file_content')
+        const result = await lspController.downloadAndCheckHash(mockDownloadFile.fsPath, content)
+        assert.strictEqual(result, false)
+    })
+
+    afterEach(() => {
+        sinon.restore()
+    })
+})

packages/core/package.json

@@ -284,6 +284,30 @@
                     "markdownDescription": "%AWS.configuration.description.amazonq.shareContentWithAWS%",
                     "default": true,
                     "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndex": {
+                    "type": "boolean",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndex%",
+                    "default": false,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexWorkerThreads": {
+                    "type": "number",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexWorkerThreads%",
+                    "default": 0,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexUseGPU": {
+                    "type": "boolean",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexUseGPU%",
+                    "default": false,
+                    "scope": "application"
+                },
+                "amazonQ.localWorkspaceIndexMaxSize": {
+                    "type": "number",
+                    "markdownDescription": "%AWS.configuration.description.amazonq.localWorkspaceIndexMaxSize%",
+                    "default": 250,
+                    "scope": "application"
                 }
             }
         },
@@ -4118,6 +4142,7 @@
         "immutable": "^4.3.0",
         "js-yaml": "^4.1.0",
         "jsonc-parser": "^3.2.0",
+        "jose": "5.4.1",
         "lodash": "^4.17.21",
         "markdown-it": "^13.0.2",
         "mime-types": "^2.1.32",

packages/core/package.nls.json

@@ -73,6 +73,10 @@
     "AWS.configuration.description.amazonq": "Amazon Q creates a code reference when you insert a code suggestion from Amazon Q that is similar to training data. When unchecked, Amazon Q will not show code suggestions that have code references. If you authenticate through IAM Identity Center, this setting is controlled by your Amazon Q administrator. [Learn More](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/code-reference.html)",
     "AWS.configuration.description.amazonq.shareContentWithAWS": "When checked, your content processed by Amazon Q may be used for service improvement (except for content processed by the Amazon Q Enterprise service tier). Unchecking this box will cause AWS to delete any of your content used for that purpose. The information used to provide the Amazon Q service to you will not be affected. See the [Service Terms](https://aws.amazon.com/service-terms) for more detail.",
     "AWS.configuration.description.amazonq.importRecommendation": "Amazon Q will add import statements with inline code suggestions when necessary.",
+    "AWS.configuration.description.amazonq.localWorkspaceIndex": "This feature is in BETA. When you add @workspace to your question in Amazon Q chat, Amazon Q will index your open workspace files locally to use as context for its response. Extra CPU usage is expected while indexing a workspace. This will not impact Amazon Q features or your IDE, but you may manage CPU usage by setting the number of local threads in 'Local Workspace Index Threads'.",
+    "AWS.configuration.description.amazonq.localWorkspaceIndexWorkerThreads": "Number of worker threads of Amazon Q local index process. '0' will use the system default worker threads for balance performance. You may increase this number to more quickly index your workspace, but only up to your hardware's number of CPU cores. Please restart VS Code or reload the VS Code window after changing worker threads.",
+    "AWS.configuration.description.amazonq.localWorkspaceIndexUseGPU": "Enable GPU to help index your local workspace files. Only applies to Linux and Windows.",
+    "AWS.configuration.description.amazonq.localWorkspaceIndexMaxSize": "The maximum size of local workspace files to be indexed in MB",
     "AWS.command.apig.copyUrl": "Copy URL",
     "AWS.command.apig.invokeRemoteRestApi": "Invoke on AWS",
     "AWS.command.apig.invokeRemoteRestApi.cn": "Invoke on Amazon",

packages/core/src/amazonq/activation.ts

@@ -22,8 +22,11 @@ import { listCodeWhispererCommandsWalkthrough } from '../codewhisperer/ui/status
 import { Commands, placeholder } from '../shared/vscode/commands2'
 import { focusAmazonQPanel, focusAmazonQPanelKeybinding } from '../codewhispererChat/commands/registerCommands'
 import { TryChatCodeLensProvider, tryChatCodeLensCommand } from '../codewhispererChat/editor/codelens'
+import { LspController } from './lsp/lspController'
 import { Auth } from '../auth'
 import { telemetry } from '../shared/telemetry'
+import { CodeWhispererSettings } from '../codewhisperer/util/codewhispererSettings'
+import { debounce } from '../shared/utilities/functionUtils'
 
 export async function activate(context: ExtensionContext) {
     const appInitContext = DefaultAmazonQAppInitContext.instance
@@ -39,6 +42,10 @@ export async function activate(context: ExtensionContext) {
 
     await TryChatCodeLensProvider.register(appInitContext.onDidChangeAmazonQVisibility.event)
 
+    const setupLsp = debounce(async () => {
+        void LspController.instance.trySetupLsp(context)
+    }, 5000)
+
     context.subscriptions.push(
         window.registerWebviewViewProvider(AmazonQChatViewProvider.viewType, provider, {
             webviewOptions: {
@@ -52,14 +59,22 @@ export async function activate(context: ExtensionContext) {
         listCodeWhispererCommandsWalkthrough.register(),
         focusAmazonQPanel.register(),
         focusAmazonQPanelKeybinding.register(),
-        tryChatCodeLensCommand.register()
+        tryChatCodeLensCommand.register(),
+        vscode.workspace.onDidChangeConfiguration(async configurationChangeEvent => {
+            if (configurationChangeEvent.affectsConfiguration('amazonQ.localWorkspaceIndex')) {
+                if (CodeWhispererSettings.instance.isLocalIndexEnabled()) {
+                    void setupLsp()
+                }
+            }
+        })
     )
 
     Commands.register('aws.amazonq.learnMore', () => {
         void vscode.env.openExternal(vscode.Uri.parse(amazonQHelpUrl))
     })
 
     await activateBadge()
+    void setupLsp()
     void setupAuthNotification()
 }
 

packages/core/src/amazonq/index.ts

@@ -11,7 +11,8 @@ export { MessageListener } from './messages/messageListener'
 export { AuthController } from './auth/controller'
 export { showAmazonQWalkthroughOnce } from './onboardingPage/walkthrough'
 export { openAmazonQWalkthrough } from './onboardingPage/walkthrough'
-
+export { LspController, Content } from './lsp/lspController'
+export { LspClient } from './lsp/lspClient'
 /**
  * main from createMynahUI is a purely browser dependency. Due to this
  * we need to create a wrapper function that will dynamically execute it