Merge pull request aws#6462 from aws/feature/amazonqLSP

feat(amazonq): Add basic language server support for amazon q inline through flare

Author: jpinkney-aws

CONTRIBUTING.md

@@ -427,6 +427,32 @@ Example:
 }
 ```
 
+<a name="amazonqLsp-settings">Overrides specifically for the Amazon Q language server</a> can be set using the `aws.dev.amazonqLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `path`.
+
+Example:
+
+```json
+"aws.dev.amazonqLsp": {
+    "manifestUrl": "https://custom.url/manifest.json",
+    "supportedVersions": "4.0.0",
+    "id": "AmazonQ",
+    "path": "/custom/path/to/local/lsp/folder",
+}
+```
+
+<a name="amazonqWorkspaceLsp-settings">Overrides specifically for the Amazon Q Workspace Context language server</a> can be set using the `aws.dev.amazonqWorkspaceLsp` setting. This is a JSON object consisting of keys/values required to override language server: `manifestUrl`, `supportedVersions`, `id`, and `path`.
+
+Example:
+
+```json
+"aws.dev.amazonqWorkspaceLsp": {
+    "manifestUrl": "https://custom.url/manifest.json",
+    "supportedVersions": "4.0.0",
+    "id": "AmazonQ",
+    "path": "/custom/path/to/local/lsp/folder",
+}
+```
+
 ### Environment variables
 
 Environment variables can be used to modify the behaviour of VSCode. The following are environment variables that can be used to configure the extension:
@@ -472,6 +498,14 @@ Unlike the user setting overrides, not all of these environment variables have t
 
 -   `__CODEWHISPERER_REGION`: for aws.dev.codewhispererService.region
 -   `__CODEWHISPERER_ENDPOINT`: for aws.dev.codewhispererService.endpoint
+-   `__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
+-   `__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
 
 #### Lambda
 

docs/TEST_E2E.md

@@ -17,3 +17,27 @@ With this approach, the follow things can be tested:
 -   Whether or not certain features show/not show depending on the status of the users auth
 -   Run requests directly against the backend and see if we get results back
 -   Clicking any follow up buttons (including examples)
+
+## Flare Chat E2E Test flow (Not implemented yet)
+
+This is the new flow that should be introduced when we moved to Flare chat.
+
+```mermaid
+sequenceDiagram
+    participant test as Test
+    participant framework as Test Framework
+    participant ui as Virtual DOM
+    participant lsp as Language Server
+    participant mynah as Mynah UI
+
+    test->>test: starts
+    test->>framework: creates test framework
+    framework->>ui: adds mynah ui to virtual dom
+    test->>lsp: waits for language server activation
+    test->>mynah: triggers action on mynah ui
+    mynah->>framework: sends message
+    framework->>lsp: sends message
+    lsp->>framework: gets response
+    framework->>ui: displays response
+    test->>ui: assert test expectations
+```

docs/lsp.md

@@ -0,0 +1,53 @@
+# Flare Language Server
+
+## Chat Activation flow
+
+```mermaid
+sequenceDiagram
+    participant user as User
+    participant ext as Extension
+    participant webview as Chat Webview
+    participant flare as Amazon Q LSP
+    participant backend as Amazon Q Backend
+
+    user->>ext: opens IDE
+    ext->>ext: activates
+    ext->>webview: loads UI
+    ext->>flare: initialize process
+    flare->>flare: starts and waits
+    user->>webview: interacts
+    webview->>ext: sends message
+    ext->>flare: sends message
+    flare->>backend: call api
+    backend->>flare: returns
+    flare->>ext: display
+    ext->>webview: display
+```
+
+## Language Server Debugging
+
+1. Clone https://github.com/aws/language-servers.git and set it up in the same workspace as this project
+
+    e.g.
+
+    ```
+    /aws-toolkit-vscode
+    /toolkit
+    /core
+    /amazonq
+    /language-servers
+    ```
+
+2. Inside of the language-servers project run:
+    ```
+    npm install
+    npm run compile
+    npm run package
+    ```
+    to get the project setup
+3. Uncomment the `__AMAZONQLSP_PATH` variable in `amazonq/.vscode/launch.json` Extension configuration
+4. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server
+
+## Amazon Q Inline Activation
+
+-   In order to get inline completion working you must open a supported file type defined in CodewhispererInlineCompletionLanguages in `packages/amazonq/src/app/inline/completion.ts`

package-lock.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "(Experimental) Amazon Q inline code suggestions via Amazon Q Language Server. (enable with `aws.experiments.amazonqLSP: true`)"
+}

packages/amazonq/.changes/next-release/Feature-7a3c930e-cc8e-4323-9ecd-c1bf767fd2ed.json

@@ -14,6 +14,7 @@
             "env": {
                 "SSMDOCUMENT_LANGUAGESERVER_PORT": "6010",
                 "WEBPACK_DEVELOPER_SERVER": "http://localhost:8080"
+                // "__AMAZONQLSP_PATH": "${workspaceFolder}/../../../language-servers/app/aws-lsp-codewhisperer-runtimes/out/token-standalone.js",
             },
             "envFile": "${workspaceFolder}/.local.env",
             "outFiles": ["${workspaceFolder}/dist/**/*.js", "${workspaceFolder}/../core/dist/**/*.js"],
@@ -135,6 +136,31 @@
                 "group": "4_E2ETestCurrentFile",
                 "order": 2
             }
+        },
+        {
+            "name": "Attach to Language Server",
+            "type": "node",
+            "request": "attach",
+            "port": 6080, // Hard defined in core/src/shared/lsp/platform.ts
+            "outFiles": ["${workspaceFolder}/../../../language-servers/**/out/**/*.js"],
+            "skipFiles": [
+                "<node_internals>/**",
+                "${workspaceFolder}/../../../language-servers/**/node_modules/**/*.js"
+            ],
+            "restart": {
+                "maxAttempts": 10,
+                "delay": 1000
+            }
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Launch LSP with Debugging",
+            "configurations": ["Extension", "Attach to Language Server"],
+            "presentation": {
+                "group": "1_Extension",
+                "order": 5
+            }
         }
     ]
 }