test(amazon): add more debugging information to inline tests (#6644)

## Problem
- we have no way to get any information on why an inline test was flaky.
It might be because telemetry events are being out of order?
- Since fib doesn't have spaces in the contents it's autocompleting on
the very first line which may be causing the backend to return no
results

## Solution
- add more debugging information to understand why there was a failure
- add spaces to the test fib function
- consider a suggestion shown if the recommendation handler says its
visible or if its state has been declared as 'Shown'


---

- Treat all work as PUBLIC. Private `feature/x` branches will not be
squash-merged at release time.
- Your code changes must meet the guidelines in
[CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
- License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.

Author: jpinkney-aws

packages/amazonq/test/e2e/inline/inline.test.ts

@@ -6,7 +6,6 @@
 import * as vscode from 'vscode'
 import assert from 'assert'
 import {
-    assertTelemetry,
     closeAllEditors,
     getTestWindow,
     registerAuthHook,
@@ -15,7 +14,7 @@ import {
     toTextEditor,
     using,
 } from 'aws-core-vscode/test'
-import { RecommendationHandler, RecommendationService } from 'aws-core-vscode/codewhisperer'
+import { RecommendationHandler, RecommendationService, session } from 'aws-core-vscode/codewhisperer'
 import { Commands, globals, sleep, waitUntil } from 'aws-core-vscode/shared'
 import { loginToIdC } from '../amazonq/utils/setup'
 
@@ -50,31 +49,47 @@ describe('Amazon Q Inline', async function () {
         const textContents =
             contents ??
             `function fib() {
-
-
+    
+    
 }`
         await toTextEditor(textContents, fileName, tempFolder, {
             selection: new vscode.Range(new vscode.Position(1, 4), new vscode.Position(1, 4)),
         })
     }
 
     async function waitForRecommendations() {
-        const ok = await waitUntil(async () => RecommendationHandler.instance.isSuggestionVisible(), waitOptions)
-        if (!ok) {
-            assert.fail('Suggestions failed to become visible')
-        }
-    }
-
-    async function waitForTelemetry() {
         const ok = await waitUntil(
             async () =>
-                globals.telemetry.logger.query({
-                    metricName: 'codewhisperer_userTriggerDecision',
-                }).length > 0,
+                RecommendationHandler.instance.isSuggestionVisible() || session.getSuggestionState(0) === 'Showed',
             waitOptions
         )
         if (!ok) {
-            assert.fail('Telemetry failed to be emitted')
+            assert.fail(
+                `Suggestions failed to become visible. Suggestion States: ${JSON.stringify(session.suggestionStates)}`
+            )
+        }
+    }
+
+    /**
+     * Waits for a specific telemetry event to be emitted with the expected suggestion state.
+     * It looks like there might be a potential race condition in codewhisperer causing telemetry
+     * events to be emitted in different orders
+     */
+    async function waitForTelemetry(metricName: string, suggestionState: string) {
+        const ok = await waitUntil(async () => {
+            const events = globals.telemetry.logger.query({
+                metricName,
+            })
+            return events.some((event) => event.codewhispererSuggestionState === suggestionState)
+        }, waitOptions)
+        const events = globals.telemetry.logger.query({
+            metricName,
+        })
+        if (!ok) {
+            assert.fail(`Telemetry failed to be emitted. Current events: ${JSON.stringify(events)}`)
+        }
+        if (events.length > 1 && events[events.length - 1].codewhispererSuggestionState !== suggestionState) {
+            assert.fail(`Telemetry events were emitted in the wrong order. Current events: ${JSON.stringify(events)}`)
         }
     }
 
@@ -119,10 +134,7 @@ describe('Amazon Q Inline', async function () {
 
                     assert.ok(suggestionAccepted, 'Editor contents should have changed')
 
-                    await waitForTelemetry()
-                    assertTelemetry('codewhisperer_userTriggerDecision', {
-                        codewhispererSuggestionState: 'Accept',
-                    })
+                    await waitForTelemetry('codewhisperer_userTriggerDecision', 'Accept')
                 })
 
                 it(`${name} invoke reject`, async function () {
@@ -131,11 +143,7 @@ describe('Amazon Q Inline', async function () {
 
                     // Contents haven't changed
                     assert.deepStrictEqual(vscode.window.activeTextEditor?.document.getText(), originalEditorContents)
-
-                    await waitForTelemetry()
-                    assertTelemetry('codewhisperer_userTriggerDecision', {
-                        codewhispererSuggestionState: 'Reject',
-                    })
+                    await waitForTelemetry('codewhisperer_userTriggerDecision', 'Reject')
                 })
 
                 it(`${name} invoke discard`, async function () {