fix: filter telemetry with ip address in trace and data2 (#1693)

* fix: filter telemetry with ip address in trace and data2

* fix: update code

* fix: update data2 to data3

Author: wenytang-ms

extension/src/Extension.ts

@@ -307,7 +307,7 @@ export class Extension {
                 const selection = await this.showRestartWindow();
                 sendInfo("", {
                     kind: "wrapperPropertiesChangedReloadRequest",
-                    data2: selection === OPT_RESTART ? "true" : "false",
+                    data3: selection === OPT_RESTART ? "true" : "false",
                 });
                 if (selection === OPT_RESTART) {
                     await this.restartServer();
@@ -345,7 +345,7 @@ export class Extension {
                     const selection = await this.showRestartWindow();
                     sendInfo("", {
                         kind: "javaHomeChangedReloadRequest",
-                        data2: selection === OPT_RESTART ? "true" : "false",
+                        data3: selection === OPT_RESTART ? "true" : "false",
                     });
                     if (selection === OPT_RESTART) {
                         await this.restartServer();

extension/src/bs/BuildServerController.ts

@@ -75,12 +75,12 @@ export class BuildServerController implements Disposable {
                         kind: "bsp-error",
                         operationName: jsonObj.operationName,
                         rootCauseMessage,
-                        trace,
+                        traceLog: jsonObj[trace],
                     });
                 } else {
                     sendInfo("", {
                         kind: kind,
-                        data2: JSON.stringify(rest),
+                        data3: JSON.stringify(rest),
                         ...(schemaVersion && { schemaVersion: schemaVersion }),
                     });
                 }
@@ -150,7 +150,7 @@ export class BuildServerController implements Disposable {
         machineStatus.hasProjectAtWorkspaceRoot = (await this.hasProjectAtWorkspaceRoot()).toString();
         sendInfo("", {
             kind: "machineStatus",
-            data2: JSON.stringify(machineStatus),
+            data3: JSON.stringify(machineStatus),
         });
     }
 

extension/src/index.ts

@@ -1,13 +1,15 @@
 import * as vscode from "vscode";
 import { initializeFromJsonFile, instrumentOperation } from "vscode-extension-telemetry-wrapper";
-
 import { Api } from "./api";
 import { Extension } from "./Extension";
+import { TelemetryFilter } from "./util/telemetryFilter";
 
 let extension: Extension;
 
 export async function activate(context: vscode.ExtensionContext): Promise<Api> {
-    await initializeFromJsonFile(context.asAbsolutePath("./package.json"));
+    await initializeFromJsonFile(context.asAbsolutePath("./package.json"), {
+        replacementOptions: [TelemetryFilter.hideUrlOption],
+    });
     return instrumentOperation("activation", activateExtension)(context);
 }
 

extension/src/logger/Logger.ts

@@ -56,7 +56,7 @@ export class Logger {
         this.log(error, LogVerbosity.ERROR);
         sendInfo("", {
             kind: "gradleTaskServerError",
-            data2: error,
+            data3: error,
         });
     }
 

extension/src/server/GradleServer.ts

@@ -127,7 +127,7 @@ export class GradleServer {
         );
         sendInfo("", {
             kind: "serverProcessExitRestart",
-            data2: selection === OPT_RESTART ? "true" : "false",
+            data3: selection === OPT_RESTART ? "true" : "false",
         });
         if (selection === OPT_RESTART) {
             await commands.executeCommand("workbench.action.restartExtensionHost");
@@ -169,7 +169,7 @@ export class GradleServer {
     private async handleServerStartError(code: number | null): Promise<void> {
         sendInfo("", {
             kind: "serverProcessExit",
-            data2: code ? code.toString() : "",
+            data3: code ? code.toString() : "",
         });
         await this.showRestartMessage();
     }

extension/src/util/telemetryFilter.ts

@@ -0,0 +1,8 @@
+import { ReplacementOption } from "@vscode/extension-telemetry";
+
+export class TelemetryFilter {
+    public static hideUrlOption: ReplacementOption = {
+        lookup: /https?:\/\/[^:\s]+:[^@\s]+@[^\s]+/g, // match URLs with embedded credentials
+        replacementString: "<REDACTED: sensitive-url>",
+    };
+}