telemetry(lsp): Integrate language server/manifest resolver telemetry

package.json

@@ -40,7 +40,7 @@
         "mergeReports": "ts-node ./scripts/mergeReports.ts"
     },
     "devDependencies": {
-        "@aws-toolkits/telemetry": "^1.0.295",
+        "@aws-toolkits/telemetry": "^1.0.296",
         "@playwright/browser-chromium": "^1.43.1",
         "@stylistic/eslint-plugin": "^2.11.0",
         "@types/he": "^1.2.3",

packages/amazonq/src/lsp/activation.ts

@@ -6,12 +6,14 @@
 import vscode from 'vscode'
 import { startLanguageServer } from './client'
 import { AmazonQLSPResolver } from './lspInstaller'
-import { Commands, ToolkitError } from 'aws-core-vscode/shared'
+import { Commands, lspSetupStage, ToolkitError } from 'aws-core-vscode/shared'
 
 export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
     try {
-        const installResult = await new AmazonQLSPResolver().resolve()
-        await startLanguageServer(ctx, installResult.resourcePaths)
+        await lspSetupStage('all', async () => {
+            const installResult = await new AmazonQLSPResolver().resolve()
+            await lspSetupStage('launch', async () => await startLanguageServer(ctx, installResult.resourcePaths))
+        })
         ctx.subscriptions.push(
             Commands.register({ id: 'aws.amazonq.invokeInlineCompletion', autoconnect: true }, async () => {
                 await vscode.commands.executeCommand('editor.action.inlineSuggest.trigger')

packages/amazonq/test/e2e/lsp/lspInstaller.test.ts

@@ -8,12 +8,17 @@ import sinon from 'sinon'
 import { AmazonQLSPResolver, supportedLspServerVersions } from '../../../src/lsp/lspInstaller'
 import {
     fs,
+    globals,
     LanguageServerResolver,
     makeTemporaryToolkitFolder,
     ManifestResolver,
+    manifestStorageKey,
     request,
 } from 'aws-core-vscode/shared'
 import * as semver from 'semver'
+import { assertTelemetry } from 'aws-core-vscode/test'
+import { LspController } from 'aws-core-vscode/amazonq'
+import { LanguageServerSetup } from 'aws-core-vscode/telemetry'
 
 function createVersion(version: string) {
     return {
@@ -40,12 +45,22 @@ describe('AmazonQLSPInstaller', () => {
     let resolver: AmazonQLSPResolver
     let sandbox: sinon.SinonSandbox
     let tempDir: string
+    // If globalState contains an ETag that is up to date with remote, we won't fetch it resulting in inconsistent behavior.
+    // Therefore, we clear it temporarily for these tests to ensure consistent behavior.
+    let manifestStorage: { [key: string]: any }
+
+    before(async () => {
+        manifestStorage = globals.globalState.get(manifestStorageKey) || {}
+    })
 
     beforeEach(async () => {
         sandbox = sinon.createSandbox()
         resolver = new AmazonQLSPResolver()
         tempDir = await makeTemporaryToolkitFolder()
         sandbox.stub(LanguageServerResolver.prototype, 'defaultDownloadFolder').returns(tempDir)
+        // Called on extension activation and can contaminate telemetry.
+        sandbox.stub(LspController.prototype, 'trySetupLsp')
+        await globals.globalState.update(manifestStorageKey, {})
     })
 
     afterEach(async () => {
@@ -56,6 +71,10 @@ describe('AmazonQLSPInstaller', () => {
         })
     })
 
+    after(async () => {
+        await globals.globalState.update(manifestStorageKey, manifestStorage)
+    })
+
     describe('resolve()', () => {
         it('uses AWS_LANGUAGE_SERVER_OVERRIDE', async () => {
             const overridePath = '/custom/path/to/lsp'
@@ -117,6 +136,94 @@ describe('AmazonQLSPInstaller', () => {
             assert.ok(fallback.assetDirectory.startsWith(tempDir))
             assert.deepStrictEqual(fallback.location, 'fallback')
             assert.ok(semver.satisfies(fallback.version, supportedLspServerVersions))
+
+            /* First Try Telemetry
+                    getManifest: remote succeeds
+                    getServer: cache fails then remote succeeds.
+                    validate: succeeds.
+            */
+            const firstTryTelemetry: Partial<LanguageServerSetup>[] = [
+                {
+                    id: 'AmazonQ',
+                    manifestLocation: 'remote',
+                    languageServerSetupStage: 'getManifest',
+                    result: 'Succeeded',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'cache',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Failed',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'remote',
+                    languageServerSetupStage: 'validate',
+                    result: 'Succeeded',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'remote',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Succeeded',
+                },
+            ]
+
+            /* Second Try Telemetry
+                    getManifest: remote fails, then cache succeeds.
+                    getServer: cache succeeds
+                    validate: doesn't run since its cached.
+            */
+            const secondTryTelemetry: Partial<LanguageServerSetup>[] = [
+                {
+                    id: 'AmazonQ',
+                    manifestLocation: 'remote',
+                    languageServerSetupStage: 'getManifest',
+                    result: 'Failed',
+                },
+                {
+                    id: 'AmazonQ',
+                    manifestLocation: 'cache',
+                    languageServerSetupStage: 'getManifest',
+                    result: 'Succeeded',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'cache',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Succeeded',
+                },
+            ]
+
+            /* Third Try Telemetry
+                    getManifest: (stubbed to fail, no telemetry)
+                    getServer: remote and cache fail
+                    validate: no validation since not remote. 
+            */
+            const thirdTryTelemetry: Partial<LanguageServerSetup>[] = [
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'cache',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Failed',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'remote',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Failed',
+                },
+                {
+                    id: 'AmazonQ',
+                    languageServerLocation: 'fallback',
+                    languageServerSetupStage: 'getServer',
+                    result: 'Succeeded',
+                },
+            ]
+
+            const expectedTelemetry = firstTryTelemetry.concat(secondTryTelemetry, thirdTryTelemetry)
+
+            assertTelemetry('languageServer_setup', expectedTelemetry)
         })
     })
 })

packages/core/package.nls.json

@@ -20,7 +20,7 @@
     "AWS.configuration.description.suppressPrompts": "Prompts which ask for confirmation. Checking an item suppresses the prompt.",
     "AWS.configuration.enableCodeLenses": "Enable SAM hints in source code and template.yaml files",
     "AWS.configuration.description.resources.enabledResources": "AWS resources to display in the 'Resources' portion of the explorer.",
-      "AWS.configuration.description.featureDevelopment.allowRunningCodeAndTests": "Allow /dev to run code and test commands",
+    "AWS.configuration.description.featureDevelopment.allowRunningCodeAndTests": "Allow /dev to run code and test commands",
     "AWS.configuration.description.experiments": "Try experimental features and give feedback. Note that experimental features may be removed at any time.\n * `jsonResourceModification` - Enables basic create, update, and delete support for cloud resources via the JSON Resources explorer component.",
     "AWS.stepFunctions.asl.format.enable.desc": "Enables the default formatter used with Amazon States Language files",
     "AWS.stepFunctions.asl.maxItemsComputed.desc": "The maximum number of outline symbols and folding regions computed (limited for performance reasons).",

packages/core/src/amazonq/lsp/lspController.ts

@@ -15,6 +15,7 @@ import { isCloud9 } from '../../shared/extensionUtilities'
 import globals, { isWeb } from '../../shared/extensionGlobals'
 import { isAmazonInternalOs } from '../../shared/vscode/env'
 import { WorkspaceLSPResolver } from './workspaceInstaller'
+import { lspSetupStage } from '../../shared'
 
 export interface Chunk {
     readonly filePath: string
@@ -160,9 +161,7 @@ export class LspController {
         }
         setImmediate(async () => {
             try {
-                const installResult = await new WorkspaceLSPResolver().resolve()
-                await activateLsp(context, installResult.resourcePaths)
-                getLogger().info('LspController: LSP activated')
+                await this.setupLsp(context)
                 void LspController.instance.buildIndex(buildIndexConfig)
                 // log the LSP server CPU and Memory usage per 30 minutes.
                 globals.clock.setInterval(
@@ -183,4 +182,12 @@ export class LspController {
             }
         })
     }
+
+    private async setupLsp(context: vscode.ExtensionContext) {
+        await lspSetupStage('all', async () => {
+            const installResult = await new WorkspaceLSPResolver().resolve()
+            await lspSetupStage('launch', async () => activateLsp(context, installResult.resourcePaths))
+            getLogger().info('LspController: LSP activated')
+        })
+    }
 }

packages/core/src/shared/index.ts

@@ -65,6 +65,7 @@ export { TabTypeDataMap } from '../amazonq/webview/ui/tabs/constants'
 export * from './lsp/manifestResolver'
 export * from './lsp/lspResolver'
 export * from './lsp/types'
+export * from './lsp/utils/setupStage'
 export * from './lsp/utils/cleanup'
 export { default as request } from './request'
 export * from './lsp/utils/platform'