fix(amazonq): batch telemetry for edits

Author: floralph

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

@@ -245,6 +245,37 @@ export class AmazonQInlineCompletionItemProvider implements InlineCompletionItem
         return session !== undefined && session.displayed && !session.suggestions.some((item) => item.isInlineEdit)
     }
 
+    /**
+     * Batch discard telemetry for completion suggestions when edit suggestion is active
+     */
+    public batchDiscardTelemetryForEditSuggestion(items: any[], session: any): void {
+        // Emit DISCARD telemetry for completion suggestions that can't be shown due to active edit
+        const completionSessionResult: {
+            [key: string]: { seen: boolean; accepted: boolean; discarded: boolean }
+        } = {}
+
+        for (const item of items) {
+            if (!item.isInlineEdit && item.itemId) {
+                completionSessionResult[item.itemId] = {
+                    seen: false,
+                    accepted: false,
+                    discarded: true,
+                }
+            }
+        }
+
+        // Send single telemetry event for all discarded items
+        if (Object.keys(completionSessionResult).length > 0) {
+            const params: LogInlineCompletionSessionResultsParams = {
+                sessionId: session.sessionId,
+                completionSessionResult,
+                firstCompletionDisplayLatency: session.firstCompletionDisplayLatency,
+                totalSessionDisplayTime: performance.now() - session.requestStartTime,
+            }
+            this.languageClient.sendNotification(this.logSessionResultMessageName, params)
+        }
+    }
+
     /**
      * Check if an edit suggestion is currently active
      */
@@ -452,24 +483,7 @@ ${itemLog}
 
             // Check if an edit suggestion is currently active - if so, discard completion suggestions
             if (this.isEditSuggestionActive()) {
-                // Emit DISCARD telemetry for completion suggestions that can't be shown due to active edit
-                for (const item of items) {
-                    if (!item.isInlineEdit && item.itemId) {
-                        const params: LogInlineCompletionSessionResultsParams = {
-                            sessionId: session.sessionId,
-                            completionSessionResult: {
-                                [item.itemId]: {
-                                    seen: false,
-                                    accepted: false,
-                                    discarded: true,
-                                },
-                            },
-                            firstCompletionDisplayLatency: session.firstCompletionDisplayLatency,
-                            totalSessionDisplayTime: performance.now() - session.requestStartTime,
-                        }
-                        this.languageClient.sendNotification(this.logSessionResultMessageName, params)
-                    }
-                }
+                this.batchDiscardTelemetryForEditSuggestion(items, session)
                 this.sessionManager.clear()
                 logstr += `- completion suggestions discarded due to active edit suggestion`
                 return []

packages/amazonq/test/unit/app/inline/completion.test.ts

@@ -0,0 +1,120 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as assert from 'assert'
+import * as sinon from 'sinon'
+import { AmazonQInlineCompletionItemProvider } from '../../../../src/app/inline/completion'
+
+describe('AmazonQInlineCompletionItemProvider', function () {
+    let provider: AmazonQInlineCompletionItemProvider
+    let mockLanguageClient: any
+    let sandbox: sinon.SinonSandbox
+
+    beforeEach(function () {
+        sandbox = sinon.createSandbox()
+        mockLanguageClient = {
+            sendNotification: sandbox.stub(),
+        }
+
+        // Create provider with minimal mocks
+        provider = new AmazonQInlineCompletionItemProvider(
+            mockLanguageClient,
+            {} as any, // recommendationService
+            {} as any, // sessionManager
+            {} as any, // inlineTutorialAnnotation
+            {} as any // documentEventListener
+        )
+    })
+
+    afterEach(function () {
+        sandbox.restore()
+    })
+
+    describe('batchDiscardTelemetryForEditSuggestion', function () {
+        it('should batch multiple completion items into single telemetry event', function () {
+            const items = [
+                { itemId: 'item1', isInlineEdit: false },
+                { itemId: 'item2', isInlineEdit: false },
+                { itemId: 'item3', isInlineEdit: false },
+            ]
+
+            const session = {
+                sessionId: 'test-session',
+                firstCompletionDisplayLatency: 100,
+                requestStartTime: performance.now() - 1000,
+            }
+
+            provider.batchDiscardTelemetryForEditSuggestion(items, session)
+
+            // Verify single telemetry notification was sent
+            assert.strictEqual(mockLanguageClient.sendNotification.callCount, 1)
+
+            // Verify the notification contains all items
+            const call = mockLanguageClient.sendNotification.getCall(0)
+            const params = call.args[1]
+
+            assert.strictEqual(params.sessionId, 'test-session')
+            assert.strictEqual(Object.keys(params.completionSessionResult).length, 3)
+            assert.deepStrictEqual(params.completionSessionResult.item1, {
+                seen: false,
+                accepted: false,
+                discarded: true,
+            })
+            assert.deepStrictEqual(params.completionSessionResult.item2, {
+                seen: false,
+                accepted: false,
+                discarded: true,
+            })
+            assert.deepStrictEqual(params.completionSessionResult.item3, {
+                seen: false,
+                accepted: false,
+                discarded: true,
+            })
+        })
+
+        it('should filter out inline edit items', function () {
+            const items = [
+                { itemId: 'item1', isInlineEdit: false },
+                { itemId: 'item2', isInlineEdit: true }, // Should be filtered out
+                { itemId: 'item3', isInlineEdit: false },
+            ]
+
+            const session = {
+                sessionId: 'test-session',
+                firstCompletionDisplayLatency: 100,
+                requestStartTime: performance.now() - 1000,
+            }
+
+            provider.batchDiscardTelemetryForEditSuggestion(items, session)
+
+            const call = mockLanguageClient.sendNotification.getCall(0)
+            const params = call.args[1]
+
+            // Should only include 2 items (item2 filtered out)
+            assert.strictEqual(Object.keys(params.completionSessionResult).length, 2)
+            assert.ok(params.completionSessionResult.item1)
+            assert.ok(params.completionSessionResult.item3)
+            assert.ok(!params.completionSessionResult.item2)
+        })
+
+        it('should not send notification when no valid items', function () {
+            const items = [
+                { itemId: 'item1', isInlineEdit: true }, // Filtered out
+                { itemId: null, isInlineEdit: false }, // No itemId
+            ]
+
+            const session = {
+                sessionId: 'test-session',
+                firstCompletionDisplayLatency: 100,
+                requestStartTime: performance.now() - 1000,
+            }
+
+            provider.batchDiscardTelemetryForEditSuggestion(items, session)
+
+            // No notification should be sent
+            assert.strictEqual(mockLanguageClient.sendNotification.callCount, 0)
+        })
+    })
+})