[DO NOT MERGE] Initial check-in for supporting telemetry in vscode

.chronus/changes/vscode-telemetry-2025-1-24-22-51-43.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - typespec-vscode
+---
+
+Support telemetry

eng/tsp-core/pipelines/jobs/build-for-publish.yml

@@ -10,6 +10,9 @@ jobs:
         parameters:
           useDotNet: true
 
+      - script: pnpm run update-telemetry-key $(vscode-telemetry-key)
+        workingDirectory: $(Build.SourcesDirectory)/packages/typespec-vscode
+
       - template: /eng/tsp-core/pipelines/templates/build.yml
 
       - script: pnpm run test:ci

packages/typespec-vscode/ThirdPartyNotices.txt

@@ -8,11 +8,69 @@ original copyright notices and the licenses under which Microsoft received such
 components are set forth below. Microsoft reserves all rights not expressly
 granted herein, whether by implication, estoppel or otherwise.
 
-1. balanced-match version 1.0.2 (https://github.com/juliangruber/balanced-match)
-2. brace-expansion version 2.0.1 (https://github.com/juliangruber/brace-expansion)
-3. minimatch version 5.1.6 (https://github.com/isaacs/minimatch)
-4. semver version 7.6.3 (https://github.com/npm/node-semver)
-5. yaml version 2.7.0 (github:eemeli/yaml)
+1. @nevware21/ts-async version 0.5.4 (https://github.com/nevware21/ts-async)
+2. @nevware21/ts-utils version 0.11.6 (https://github.com/nevware21/ts-utils)
+3. balanced-match version 1.0.2 (https://github.com/juliangruber/balanced-match)
+4. brace-expansion version 2.0.1 (https://github.com/juliangruber/brace-expansion)
+5. minimatch version 5.1.6 (https://github.com/isaacs/minimatch)
+6. semver version 7.6.3 (https://github.com/npm/node-semver)
+7. yaml version 2.7.0 (github:eemeli/yaml)
+
+
+%% @nevware21/ts-async NOTICES AND INFORMATION BEGIN HERE
+=====================================================
+MIT License
+
+Copyright (c) 2022 NevWare21 Solutions LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=====================================================");
+END OF @nevware21/ts-async NOTICES AND INFORMATION
+
+
+%% @nevware21/ts-utils NOTICES AND INFORMATION BEGIN HERE
+=====================================================
+MIT License
+
+Copyright (c) 2022 NevWare21 Solutions LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=====================================================");
+END OF @nevware21/ts-utils NOTICES AND INFORMATION
 
 
 %% balanced-match NOTICES AND INFORMATION BEGIN HERE

packages/typespec-vscode/package.json

@@ -36,6 +36,7 @@
     "workspaceContains:**/tspconfig.yaml"
   ],
   "icon": "./icons/logo.png",
+  "telemetryKey": "19cdc7e5-ff34-485f-b2cb-9538638cba7c",
   "contributes": {
     "viewsWelcome": [
       {
@@ -232,6 +233,7 @@
     "copy-tmlanguage": "node scripts/copy-tmlanguage.js",
     "generate-language-configuration": "node scripts/generate-language-configuration.js",
     "generate-third-party-notices": "typespec-build-tool generate-third-party-notices",
+    "update-telemetry-key": "node scripts/update-telemetry-key.js",
     "package-vsix": "vsce package",
     "deploy": "vsce publish",
     "open-in-browser": "vscode-test-web --extensionDevelopmentPath=. .",
@@ -240,6 +242,7 @@
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "~28.0.2",
+    "@rollup/plugin-json": "~6.1.0",
     "@rollup/plugin-node-resolve": "~16.0.0",
     "@rollup/plugin-typescript": "~12.1.0",
     "@types/mocha": "^10.0.9",
@@ -250,6 +253,7 @@
     "@typespec/internal-build-utils": "workspace:~",
     "@vitest/coverage-v8": "^3.0.4",
     "@vitest/ui": "^3.0.3",
+    "@vscode/extension-telemetry": "^0.9.8",
     "@vscode/test-web": "^0.0.65",
     "@vscode/vsce": "~3.2.1",
     "c8": "^10.1.3",

packages/typespec-vscode/rollup.config.ts

@@ -3,11 +3,12 @@ import resolve from "@rollup/plugin-node-resolve";
 import typescript from "@rollup/plugin-typescript";
 import { dirname } from "path";
 
+import json from "@rollup/plugin-json";
 import { defineConfig } from "rollup";
 import { fileURLToPath } from "url";
 const projDir = dirname(fileURLToPath(import.meta.url));
 
-const plugins = [(resolve as any)({ preferBuiltins: true }), (commonjs as any)()];
+const plugins = [(resolve as any)({ preferBuiltins: true }), (commonjs as any)(), (json as any)()];
 const baseConfig = defineConfig({
   input: "src/extension.ts",
   output: {

packages/typespec-vscode/scripts/update-telemetry-key.js

@@ -0,0 +1,26 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const newKey = process.argv[2];
+if (!newKey) {
+  console.log("One argument for telemetry-key to use is expected. Exit without updating anything");
+} else {
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  const targetPackageJsonFile = path.resolve(__dirname, "../package.json");
+  console.log(`Updating package.json at ${targetPackageJsonFile}`);
+  const packageJson = JSON.parse(fs.readFileSync(targetPackageJsonFile, "utf8"));
+  const oldKey = packageJson.telemetryKey;
+
+  const getLastSegOfKey = (key) => key.substring(Math.max(0, newKey.length - 12));
+
+  console.log(
+    `Updating telemetry key from ...${getLastSegOfKey(oldKey)} to ...${getLastSegOfKey(newKey)}`,
+  );
+  packageJson.telemetryKey = newKey;
+
+  fs.writeFileSync(targetPackageJsonFile, JSON.stringify(packageJson, null, 2));
+
+  console.log("package.json updated successfully");
+}

packages/typespec-vscode/src/extension.ts

@@ -6,11 +6,16 @@ import { ExtensionLogListener, getPopupAction } from "./log/extension-log-listen
 import logger from "./log/logger.js";
 import { TypeSpecLogOutputChannel } from "./log/typespec-log-output-channel.js";
 import { createTaskProvider } from "./task-provider.js";
+import telemetryClient from "./telemetry/telemetry-client.js";
+import { OperationTelemetryEvent, TelemetryEventName } from "./telemetry/telemetry-event.js";
 import { TspLanguageClient } from "./tsp-language-client.js";
 import {
   CommandName,
   InstallGlobalCliCommandArgs,
   RestartServerCommandArgs,
+  RestartServerCommandResult,
+  Result,
+  ResultCode,
   SettingName,
 } from "./types.js";
 import { isWhitespaceStringOrUndefined } from "./utils.js";
@@ -30,6 +35,8 @@ logger.registerLogListener("extension-log", new ExtensionLogListener(outputChann
 export async function activate(context: ExtensionContext) {
   const stateManager = new ExtensionStateManager(context);
 
+  context.subscriptions.push(telemetryClient);
+
   context.subscriptions.push(createTaskProvider());
 
   context.subscriptions.push(createCodeActionProvider());
@@ -67,26 +74,35 @@ export async function activate(context: ExtensionContext) {
   context.subscriptions.push(
     commands.registerCommand(
       CommandName.RestartServer,
-      async (args: RestartServerCommandArgs | undefined): Promise<TspLanguageClient> => {
+      async (args: RestartServerCommandArgs | undefined): Promise<RestartServerCommandResult> => {
         return vscode.window.withProgress(
           {
             title: args?.notificationMessage ?? "Restarting TypeSpec language service...",
             location: vscode.ProgressLocation.Notification,
           },
           async () => {
-            if (args?.forceRecreate === true) {
-              logger.info("Forcing to recreate TypeSpec LSP server...");
-              return await recreateLSPClient(context);
-            }
-            if (client && client.state === State.Running) {
-              await client.restart();
-              return client;
-            } else {
-              logger.info(
-                "TypeSpec LSP server is not running which is not expected, try to recreate and start...",
-              );
-              return recreateLSPClient(context);
-            }
+            return await telemetryClient.doOperationWithTelemetry(
+              TelemetryEventName.RestartServer,
+              async (tel) => {
+                if (args?.forceRecreate === true) {
+                  logger.info("Forcing to recreate TypeSpec LSP server...");
+                  tel.lastStep = "Recreate LSP client in force";
+                  return await recreateLSPClient(context, tel.activityId);
+                }
+                if (client && client.state === State.Running) {
+                  tel.lastStep = "Restart LSP client";
+                  await client.restart();
+                  return { code: ResultCode.Success, value: client };
+                } else {
+                  logger.info(
+                    "TypeSpec LSP server is not running which is not expected, try to recreate and start...",
+                  );
+                  tel.lastStep = "Recreate LSP client";
+                  return await recreateLSPClient(context, tel.activityId);
+                }
+              },
+              args?.activityId,
+            );
           },
         );
       },
@@ -118,7 +134,12 @@ export async function activate(context: ExtensionContext) {
     vscode.workspace.onDidChangeConfiguration(async (e: vscode.ConfigurationChangeEvent) => {
       if (e.affectsConfiguration(SettingName.TspServerPath)) {
         logger.info("TypeSpec server path changed, restarting server...");
-        await recreateLSPClient(context);
+        await telemetryClient.doOperationWithTelemetry(
+          TelemetryEventName.ServerPathSettingChanged,
+          async (tel) => {
+            return await recreateLSPClient(context, tel.activityId);
+          },
+        );
       }
     }),
   );
@@ -160,7 +181,12 @@ export async function activate(context: ExtensionContext) {
         location: vscode.ProgressLocation.Notification,
       },
       async () => {
-        await recreateLSPClient(context);
+        await telemetryClient.doOperationWithTelemetry(
+          TelemetryEventName.StartExtension,
+          async (tel: OperationTelemetryEvent) => {
+            return await recreateLSPClient(context, tel.activityId);
+          },
+        );
       },
     );
   } else {
@@ -173,13 +199,23 @@ export async function deactivate() {
   await client?.stop();
 }
 
-async function recreateLSPClient(context: ExtensionContext) {
+async function recreateLSPClient(
+  context: ExtensionContext,
+  activityId: string,
+): Promise<Result<TspLanguageClient>> {
   logger.info("Recreating TypeSpec LSP server...");
   const oldClient = client;
-  client = await TspLanguageClient.create(context, outputChannel);
+  client = await TspLanguageClient.create(activityId, context, outputChannel);
   await oldClient?.stop();
-  await client.start();
-  return client;
+  await client.start(activityId);
+  if (client.state === State.Running) {
+    telemetryClient.logOperationDetailTelemetry(activityId, {
+      compilerVersion: client.initializeResult?.serverInfo?.version ?? "< 0.64.0",
+    });
+    return { code: ResultCode.Success, value: client };
+  } else {
+    return { code: ResultCode.Fail, details: "TspLanguageClient is not running." };
+  }
 }
 
 function showStartUpMessages(stateManager: ExtensionStateManager) {