Merge branch 'master' into lint/noJsonStringify

Author: Hweinstock

.github/workflows/notification.yml

@@ -37,7 +37,7 @@ jobs:
               if: github.event_name == 'pull_request_target'
               with:
                   node-version: '20'
-            - name: Check for tests
+            - name: Comment about contribution guidelines
               uses: actions/github-script@v7
               if: github.event_name == 'pull_request_target'
               with:

.github/workflows/notify.js

@@ -6,9 +6,10 @@
 const { hasPath, dedupComment } = require('./utils')
 
 const testFilesMessage =
-    'This pull request modifies code in src/ but no tests were added/updated. Confirm whether tests should be added or ensure the PR description explains why tests are not required.'
+    '- This pull request modifies code in `src/*` but no tests were added/updated.\n    - Confirm whether tests should be added or ensure the PR description explains why tests are not required.\n'
 
-const changelogMessage = `This pull request implements a feature or fix, so it must include a changelog entry. See [CONTRIBUTING.md#changelog](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#changelog) for instructions.`
+const changelogMessage =
+    '- This pull request implements a `feat` or `fix`, so it must include a changelog entry (unless the fix is for an *unreleased* feature). Review the [changelog guidelines](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#changelog).\n    - Note: beta or "experiment" features that have active users *should* announce fixes in the changelog.\n    - If this is not a feature or fix, use an appropriate type from the [title guidelines](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#pull-request-title). For example, telemetry-only changes should use the `telemetry` type.\n'
 
 /**
  * Remind partner teams that tests are required. We don't need to remind them if:
@@ -44,12 +45,16 @@ module.exports = async ({ github, context }) => {
         issue_number: pullRequestId,
     })
 
+    let msg = ''
     if (shouldAddTestFileMessage) {
-        await dedupComment({ github, comments, owner, repo, pullRequestId, message: testFilesMessage })
+        msg += testFilesMessage
     }
-
     if (shouldAddChangelogMessage) {
-        await dedupComment({ github, comments, owner, repo, pullRequestId, message: changelogMessage })
+        msg += changelogMessage
+    }
+
+    if (shouldAddTestFileMessage || shouldAddChangelogMessage) {
+        await dedupComment({ github, comments, owner, repo, pullRequestId, message: msg })
     }
 }
 
@@ -69,7 +74,12 @@ function requiresChangelogMessage(filenames, title) {
  * Require the test files message if there are changes to source files but aren't any
  * changes to the test files
  */
-function requiresTestFilesMessage(filenames) {
+function requiresTestFilesMessage(filenames, title) {
+    if (/^\s*[mM]erge/.test(title)) {
+        console.log('"Merge" pull request')
+        return
+    }
+
     // Check if src directory changed
     if (!hasPath(filenames, 'src/')) {
         console.log('Did not find src files in the code changes')

CONTRIBUTING.md

@@ -188,11 +188,11 @@ To run a single test in VSCode, do any one of:
 
     -   Unix/macOS/POSIX shell:
         ```
-        TEST_FILE=src/test/foo.test.ts npm run test
+        TEST_FILE=../core/src/test/foo.test.ts npm run test
         ```
     -   Powershell:
         ```
-        $Env:TEST_FILE = "src/test/foo.test.ts"; npm run test
+        $Env:TEST_FILE = "../core/src/test/foo.test.ts"; npm run test
         ```
 
 -   To run all tests in a particular subdirectory, you can edit
@@ -209,11 +209,11 @@ To run tests against a specific folder in VSCode, do any one of:
 -   Run in your terminal
     -   Unix/macOS/POSIX shell:
         ```
-        TEST_DIR=src/test/foo npm run test
+        TEST_DIR=../core/src/test/foo npm run test
         ```
     -   Powershell:
         ```
-        $Env:TEST_DIR = "src/test/foo"; npm run test
+        $Env:TEST_DIR = "../core/src/test/foo"; npm run test
         ```
 
 ### Coverage report

docs/telemetry-perf.md

@@ -259,6 +259,292 @@ How long it took from when the user stopped pressing a key to when they were sho
         end
 ```
 
+## Amazon Q Chat
+
+### amazonq_chatRoundTrip
+
+Measures sequential response times in Q chat, from user input to message display. Tracks time intervals between key events: editor receiving the message, feature processing, and final message rendering
+
+```mermaid
+    sequenceDiagram
+        participant User
+        participant chat as Chat UI
+        participant vscode as VSCode
+        participant event as Event Recorder
+        participant partner as Partner team code
+        participant telemetry
+
+        User->>chat: Write chat message and press enter
+        chat->>vscode: send message with timestamp
+        vscode->>event: record chatMessageSent/editorReceivedMessage timestamps
+        vscode->>partner: forward chat message
+        partner->>event: record featureReceivedMessage timestamp
+        partner->>partner: call backend/get response
+        partner->>vscode: forward response contents
+        vscode->>chat: display message
+        chat->>vscode: send stop-chat-message-telemetry event
+        vscode->>event: record messageDisplayed timestamp
+        event->>vscode: get the telemetry timestamps
+        vscode->>telemetry: emit amazonq_chatRoundTrip with telemetry timestamps
+```
+
+### cwsprChatTimeToFirstChunk
+
+The time between when the conversation stream is created and when we got back the first usable result
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        generateResponse->>backend: start stream
+        backend->>backend: create conversation id
+        backend->>generateResponse: get conversation id
+        note over backend, generateResponse: cwsprChatTimeToFirstChunk
+        rect rgb(230, 230, 230, 0.5)
+            backend->>backend: generate first chunk
+            backend->>generateResponse: chunk received
+        end
+        generateResponse->>vscode: send chunk to display
+        vscode->>chat: display chunk
+        loop for each subsequent chunk
+            backend->>backend: generate next chunk
+            backend->>generateResponse: chunk received
+            generateResponse->>vscode: send chunk to display
+            vscode->>chat: display chunk
+        end
+```
+
+### cwsprChatTimeBetweenChunks
+
+An array of time when successive pieces of data are received from the server
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        generateResponse->>backend: start stream
+        backend->>backend: create conversation id
+        backend->>generateResponse: get conversation id
+
+        loop for each subsequent chunk
+            note over backend, generateResponse: cwsprChatTimeBetweenChunks
+            rect rgb(230, 230, 230, 0.5)
+                backend->>backend: generate next chunk
+                backend->>generateResponse: chunk received
+                generateResponse->>generateResponse: record timestamp
+            end
+
+            generateResponse->>vscode: send chunk to display
+            vscode->>chat: display chunk
+        end
+```
+
+### cwsprChatFullResponseLatency
+
+The time between when the conversation id was created and the final response from the server was received
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        generateResponse->>backend: start stream
+        backend->>backend: create conversation id
+        backend->>generateResponse: get conversation id
+
+        note over backend, chat: cwsprChatFullResponseLatency
+        rect rgb(230, 230, 230, 0.5)
+            loop for each subsequent chunk
+                backend->>backend: generate next chunk
+                backend->>generateResponse: chunk received
+                generateResponse->>vscode: send chunk to display
+                vscode->>chat: display chunk
+            end
+            backend->>generateResponse: final chunk received
+        end
+        generateResponse->>vscode: send chunk to display
+        vscode->>chat: display chunk
+```
+
+### cwsprChatTimeToFirstUsableChunk
+
+The time between the initial server request, including creating the conversation stream, and the first usable result
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        note over backend, generateResponse: cwsprChatTimeToFirstUsableChunk
+        rect rgb(230, 230, 230, 0.5)
+        generateResponse->>backend: start stream
+            backend->>backend: create conversation id
+            backend->>generateResponse: get conversation id
+            backend->>backend: generate first chunk
+            backend->>generateResponse: chunk received
+        end
+        generateResponse->>vscode: send chunk to display
+        vscode->>chat: display chunk
+        loop for each subsequent chunk
+            backend->>backend: generate next chunk
+            backend->>generateResponse: chunk received
+            generateResponse->>vscode: send chunk to display
+            vscode->>chat: display chunk
+        end
+```
+
+### cwsprChatFullServerResponseLatency
+
+The time between the initial server request, including creating the conversation stream, and the final response from the server
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        note over backend, chat: cwsprChatFullServerResponseLatency
+        rect rgb(230, 230, 230, 0.5)
+            generateResponse->>backend: start stream
+            backend->>backend: create conversation id
+            backend->>generateResponse: get conversation id
+            loop for each subsequent chunk
+                backend->>backend: generate next chunk
+                backend->>generateResponse: chunk received
+                generateResponse->>vscode: send chunk to display
+                vscode->>chat: display chunk
+            end
+            backend->>generateResponse: final chunk received
+        end
+        generateResponse->>vscode: send chunk to display
+        vscode->>chat: display chunk
+```
+
+### cwsprChatTimeToFirstDisplay
+
+The time between the user pressing enter and when the first piece of data is displayed to the user
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+        note over backend, user: cwsprChatTimeToFirstDisplay
+        rect rgb(230, 230, 230, 0.5)
+            user->>chat: Presses enter with message
+            chat->>vscode: Tell VSCode to generate a response
+            vscode->>generateResponse: start generating
+            generateResponse->>backend: start stream
+            backend->>backend: create conversation id
+            backend->>generateResponse: get conversation id
+            backend->>backend: generate first chunk
+            backend->>generateResponse: chunk received
+            generateResponse->>vscode: send chunk to display
+            vscode->>chat: display chunk
+        end
+        loop for each subsequent chunk
+            backend->>backend: generate next chunk
+            backend->>generateResponse: chunk received
+            generateResponse->>vscode: send chunk to display
+            vscode->>chat: display chunk
+        end
+```
+
+### cwsprChatTimeBetweenDisplays
+
+An array of time when successive pieces of server responses are displayed to the user
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        user->>chat: Presses enter with message
+        chat->>vscode: Tell VSCode to generate a response
+        vscode->>generateResponse: start generating
+        generateResponse->>backend: start stream
+        backend->>backend: create conversation id
+        backend->>generateResponse: get conversation id
+
+        note over backend, chat: cwsprChatTimeBetweenDisplays
+        rect rgb(230, 230, 230, 0.5)
+            loop for each subsequent chunk
+                backend->>backend: generate next chunk
+                backend->>generateResponse: chunk received
+                generateResponse->>vscode: send chunk to display
+                vscode->>chat: display chunk
+                chat->>vscode: record display timestamp
+            end
+        end
+```
+
+### cwsprChatFullDisplayLatency
+
+The time between the user pressing enter and the entire response being rendered
+
+```mermaid
+    sequenceDiagram
+        participant user as User
+        participant chat as Chat UI
+        participant vscode as VSCode extension host
+        participant generateResponse as Generate response
+        participant backend as Q service backend
+
+        note over backend, user: cwsprChatFullDisplayLatency
+        rect rgb(230, 230, 230, 0.5)
+            user->>chat: Presses enter with message
+            chat->>vscode: Tell VSCode to generate a response
+            vscode->>generateResponse: start generating
+            generateResponse->>backend: start stream
+            backend->>backend: create conversation id
+            backend->>generateResponse: get conversation id
+            generateResponse->>backend: start stream
+            backend->>backend: create conversation id
+            loop for each subsequent chunk
+                backend->>backend: generate next chunk
+                backend->>vscode: send chunk to display
+                vscode->>chat: display chunk
+            end
+        end
+
+```
+
 ## Crash Monitoring
 
 We make an attempt to gather information regarding when the IDE crashes, then report it to telemetry. This is the diagram of the steps that take place.