Merge master into feature/ui-e2e-tests

Author: aws-toolkit-automation

docs/lsp.md

@@ -25,6 +25,7 @@ sequenceDiagram
 ```
 
 ## Language Server Debugging
+If you want to connect a local version of language-servers to aws-toolkit-vscode, follow these steps:
 
 1. Clone https://github.com/aws/language-servers.git and set it up in the same workspace as this project by cmd+shift+p and "add folder to workspace" and selecting the language-servers folder that you just cloned. Your VS code folder structure should look like below.
 
@@ -55,6 +56,43 @@ sequenceDiagram
 5. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server, Once you run "Launch LSP with Debugging" a new window should start, wait for the plugin to show up there. Then go to the run menu again and run "Attach to Language Server (amazonq)" after this you should be able to add breakpoints in the LSP code.
 6. (Optional): Enable `"amazonq.trace.server": "on"` or `"amazonq.trace.server": "verbose"` in your VSCode settings to view detailed log messages sent to/from the language server. These log messages will show up in the "Amazon Q Language Server" output channel
 
+### Breakpoints Work-Around
+If the breakpoints in your language-servers project remain greyed out and do not trigger when you run `Launch LSP with Debugging`, your debugger may be attaching to the language server before it has launched. You can follow the work-around below to avoid this problem. If anyone fixes this issue, please remove this section.
+1. Set your breakpoints and click `Launch LSP with Debugging`
+2. Once the debugging session has started, click `Launch LSP with Debugging` again, then `Cancel` on any pop-ups that appear
+3. On the debug panel, click `Attach to Language Server (amazonq)` next to the red stop button
+4. Click `Launch LSP with Debugging` again, then `Cancel` on any pop-ups that appear
+
+## Language Server Runtimes Debugging
+If you want to connect a local version of language-server-runtimes to aws-toolkit-vscode, follow these steps:
+
+1. Clone https://github.com/aws/language-server-runtimes.git and set it up in the same workspace as this project by cmd+shift+p and "add folder to workspace" and selecting the language-server-runtimes folder that you just cloned. Your VS code folder structure should look like below.
+
+    ```
+    /aws-toolkit-vscode
+    /toolkit
+    /core
+    /amazonq
+    /language-server-runtimes
+    ```
+2. Inside of the language-server-runtimes project run:
+    ```
+    npm install
+    npm run compile
+    cd runtimes
+    npm run prepub
+    cd out
+    npm link
+    cd ../../types
+    npm link
+    ```
+    If you get an error running `npm run prepub`, you can instead run `npm run prepub:copyFiles` to skip cleaning and testing.
+3. Inside of aws-toolkit-vscode run:
+    ```
+    npm install
+    npm link @aws/language-server-runtimes @aws/language-server-runtimes-types
+    ```
+
 ## 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

@@ -35,6 +35,9 @@ import {
     inlineCompletionsDebounceDelay,
     noInlineSuggestionsMsg,
     ReferenceInlineProvider,
+    getDiagnosticsDifferences,
+    getDiagnosticsOfCurrentFile,
+    toIdeDiagnostics,
 } from 'aws-core-vscode/codewhisperer'
 import { LineTracker } from './stateTracker/lineTracker'
 import { InlineTutorialAnnotation } from './tutorials/inlineTutorialAnnotation'
@@ -116,6 +119,13 @@ export class InlineCompletionManager implements Disposable {
             firstCompletionDisplayLatency?: number
         ) => {
             // TODO: also log the seen state for other suggestions in session
+            // Calculate timing metrics before diagnostic delay
+            const totalSessionDisplayTime = performance.now() - requestStartTime
+            await sleep(1000)
+            const diagnosticDiff = getDiagnosticsDifferences(
+                this.sessionManager.getActiveSession()?.diagnosticsBeforeAccept,
+                getDiagnosticsOfCurrentFile()
+            )
             const params: LogInlineCompletionSessionResultsParams = {
                 sessionId: sessionId,
                 completionSessionResult: {
@@ -125,8 +135,10 @@ export class InlineCompletionManager implements Disposable {
                         discarded: false,
                     },
                 },
-                totalSessionDisplayTime: Date.now() - requestStartTime,
+                totalSessionDisplayTime: totalSessionDisplayTime,
                 firstCompletionDisplayLatency: firstCompletionDisplayLatency,
+                addedDiagnostics: diagnosticDiff.added.map((it) => toIdeDiagnostics(it)),
+                removedDiagnostics: diagnosticDiff.removed.map((it) => toIdeDiagnostics(it)),
             }
             this.languageClient.sendNotification(this.logSessionResultMessageName, params)
             this.disposable.dispose()

packages/amazonq/src/app/inline/completion.ts

@@ -4,6 +4,7 @@
  */
 import * as vscode from 'vscode'
 import { InlineCompletionItemWithReferences } from '@aws/language-server-runtimes-types'
+import { FileDiagnostic, getDiagnosticsOfCurrentFile } from 'aws-core-vscode/codewhisperer'
 
 // TODO: add more needed data to the session interface
 export interface CodeWhispererSession {
@@ -14,6 +15,7 @@ export interface CodeWhispererSession {
     requestStartTime: number
     firstCompletionDisplayLatency?: number
     startPosition: vscode.Position
+    diagnosticsBeforeAccept: FileDiagnostic | undefined
     // partialResultToken for the next trigger if user accepts an EDITS suggestion
     editsStreakPartialResultToken?: number | string
 }
@@ -31,13 +33,15 @@ export class SessionManager {
         startPosition: vscode.Position,
         firstCompletionDisplayLatency?: number
     ) {
+        const diagnosticsBeforeAccept = getDiagnosticsOfCurrentFile()
         this.activeSession = {
             sessionId,
             suggestions,
             isRequestInProgress: true,
             requestStartTime,
             startPosition,
             firstCompletionDisplayLatency,
+            diagnosticsBeforeAccept,
         }
     }
 

packages/amazonq/src/app/inline/sessionManager.ts

@@ -471,8 +471,8 @@
         "@aws-sdk/types": "^3.13.1",
         "@aws/chat-client": "^0.1.4",
         "@aws/chat-client-ui-types": "^0.1.47",
-        "@aws/language-server-runtimes": "^0.2.99",
-        "@aws/language-server-runtimes-types": "^0.1.41",
+        "@aws/language-server-runtimes": "^0.2.101",
+        "@aws/language-server-runtimes-types": "^0.1.42",
         "@cspotcode/source-map-support": "^0.8.1",
         "@sinonjs/fake-timers": "^10.0.2",
         "@types/adm-zip": "^0.4.34",

packages/core/package.json

@@ -41,6 +41,10 @@ export class FeedbackWebview extends VueWebview {
             return 'Choose a reaction (smile/frown)'
         }
 
+        if (message.comment.length < 188) {
+            return 'Please add atleast 100 characters in the template describing your issue.'
+        }
+
         if (this.commentData) {
             message.comment = `${message.comment}\n\n${this.commentData}`
         }

packages/core/src/feedback/vue/submitFeedback.ts

@@ -34,6 +34,26 @@
                             >.</em
                         >
                     </div>
+                    <div style="margin-top: 10px">
+                        <em>For helpful feedback, please include:</em>
+                        <ul style="margin-top: 5px; margin-bottom: 5px">
+                            <li>
+                                <em><strong>Issue:</strong> A brief summary of the issue or suggestion</em>
+                            </li>
+                            <li>
+                                <em
+                                    ><strong>Reproduction Steps:</strong> Clear steps to reproduce the issue (if
+                                    applicable)</em
+                                >
+                            </li>
+                            <li>
+                                <em
+                                    ><strong>Expected vs. Actual:</strong> What you expected and what actually
+                                    happened</em
+                                >
+                            </li>
+                        </ul>
+                    </div>
                     <br />
                     <div>
                         <em>
@@ -66,7 +86,16 @@ const client = WebviewClientFactory.create<FeedbackWebview>()
 export default defineComponent({
     data() {
         return {
-            comment: '',
+            comment: `Issue:
+
+Reproduction Steps:
+1. 
+2. 
+3. 
+
+Expected Behavior: 
+
+Actual Behavior: `,
             sentiment: '',
             isSubmitting: false,
             error: '',

packages/core/src/feedback/vue/submitFeedback.vue

@@ -10,9 +10,14 @@ import { FeedbackWebview } from '../../../feedback/vue/submitFeedback'
 import sinon from 'sinon'
 import { waitUntil } from '../../../shared'
 
-const comment = 'comment'
+const comment =
+    'This is a detailed feedback comment that meets the minimum length requirement. ' +
+    'It includes specific information about the issue, steps to reproduce, expected behavior, and actual behavior. ' +
+    'This comment is long enough to pass the 188 character validation rule.'
 const sentiment = 'Positive'
 const message = { command: 'submitFeedback', comment: comment, sentiment: sentiment }
+const shortComment = 'This is a short comment'
+const shortMessage = { command: 'submitFeedback', comment: shortComment, sentiment: sentiment }
 
 describe('submitFeedbackListener', function () {
     let mockTelemetry: TelemetryService
@@ -47,5 +52,14 @@ describe('submitFeedbackListener', function () {
             const result = await webview.submit(message)
             assert.strictEqual(result, expectedError)
         })
+
+        it(`validates ${productName} feedback comment length is at least 188 characters`, async function () {
+            const postStub = sinon.stub()
+            mockTelemetry.postFeedback = postStub
+            const webview = new FeedbackWebview(mockTelemetry, productName)
+            const result = await webview.submit(shortMessage)
+            assert.strictEqual(result, 'Please add atleast 100 characters in the template describing your issue.')
+            assert.strictEqual(postStub.called, false, 'postFeedback should not be called for short comments')
+        })
     }
 })