refine handling of telemetry key

eng/tsp-core/pipelines/templates/build.yml

@@ -1,9 +1,5 @@
 # Template building all packages with parallelism.
 
 steps:
-  - script: pnpm run update-telemetry-key $(vscode.telemetryKey)
-    workingDirectory: $(Build.SourcesDirectory)/packages/typespec-vscode
-    displayName: Update vscode telemetry key
-
   - script: pnpm run build
     displayName: Build

packages/typespec-vscode/package.json

@@ -36,7 +36,7 @@
     "workspaceContains:**/tspconfig.yaml"
   ],
   "icon": "./icons/logo.png",
-  "telemetryKey": "19cdc7e5-ff34-485f-b2cb-9538638cba7c",
+  "telemetryKey": "00000000-0000-0000-0000-000000000000",
   "contributes": {
     "viewsWelcome": [
       {

packages/typespec-vscode/src/const.ts

@@ -1,2 +1,3 @@
 export const StartFileName = "main.tsp";
 export const TspConfigFileName = "tspconfig.yaml";
+export const EmptyGuid = "00000000-0000-0000-0000-000000000000";

packages/typespec-vscode/src/telemetry/telemetry-client.ts

@@ -1,5 +1,6 @@
 import TelemetryReporter from "@vscode/extension-telemetry";
 import pkgJson from "../../package.json" assert { type: "json" };
+import { EmptyGuid } from "../const.js";
 import logger from "../log/logger.js";
 import { ResultCode } from "../types.js";
 import { isWhitespaceStringOrUndefined } from "../utils.js";
@@ -19,17 +20,38 @@ class TelemetryClient {
   private _logTelemetryErrorCount = 0;
 
   constructor() {
-    this._client = new (TelemetryReporter as any)(this.getConnectionString());
+    this.initClient();
   }
 
-  private getConnectionString() {
+  private initClient() {
+    const cs = this.getConnectionString();
+    if (!cs) {
+      this.logErrorWhenLoggingTelemetry(
+        "Skip initializing telemetry client because no telemetry key is provided",
+      );
+      this._client = undefined;
+    } else {
+      this._client = new (TelemetryReporter as any)(cs);
+    }
+  }
+
+  private getConnectionString(): string | undefined {
+    let key: string | undefined = pkgJson.telemetryKey;
+    if (!key || key === EmptyGuid) {
+      // try to check environment variable VSCODE_TELEMETRY_KEY if the key is not provided in package.json
+      key = process.env.VSCODE_TELEMETRY_KEY;
+    }
+    if (!key || key === EmptyGuid) {
+      return undefined;
+    }
     return `InstrumentationKey=${pkgJson.telemetryKey}`;
   }
 
   public async flush() {
     // flush function is not exposed by the telemetry client, so we leverage dispose to trigger the flush and recreate the client
     await this._client?.dispose();
-    this._client = new (TelemetryReporter as any)(this.getConnectionString());
+    this._client = undefined;
+    this.initClient();
   }
 
   private sendEvent(

packages/typespec-vscode/src/telemetry/telemetry-event.ts

@@ -1,3 +1,4 @@
+import { EmptyGuid } from "../const.js";
 import { ResultCode } from "../types.js";
 
 export enum TelemetryEventName {
@@ -26,6 +27,8 @@ export interface OperationTelemetryEvent extends TelemetryEventBase {
 export enum OperationDetailPropertyName {
   error,
   emitterPackage,
+  emitterVersion,
+  emitResult,
   compilerLocation,
   compilerVersion,
 }
@@ -34,4 +37,4 @@ export function generateActivityId() {
   return crypto.randomUUID();
 }
 
-export const emptyActivityId = "00000000-0000-0000-0000-000000000000";
+export const emptyActivityId = EmptyGuid;