Add telemetry as argument to showAndLogExceptionWithTelemetry

Author: koesie10

extensions/ql-vscode/src/common/vscode/commands.ts

@@ -14,16 +14,20 @@ import { redactableError } from "../../pure/errors";
 import { UserCancellationException } from "./progress";
 import { telemetryListener } from "./telemetry";
 import { showAndLogExceptionWithTelemetry } from "./logging";
+import { AppTelemetry } from "../telemetry";
 
 /**
  * Create a command manager for VSCode, wrapping registerCommandWithErrorHandling
  * and vscode.executeCommand.
  */
 export function createVSCodeCommandManager<
   Commands extends Record<string, CommandFunction>,
->(logger?: NotificationLogger): CommandManager<Commands> {
+>(
+  logger?: NotificationLogger,
+  telemetry?: AppTelemetry,
+): CommandManager<Commands> {
   return new CommandManager((commandId, task) => {
-    return registerCommandWithErrorHandling(commandId, task, logger);
+    return registerCommandWithErrorHandling(commandId, task, logger, telemetry);
   }, wrapExecuteCommand);
 }
 
@@ -34,11 +38,13 @@ export function createVSCodeCommandManager<
  * @param task The task to run. It is passed directly to `commands.registerCommand`. Any
  * arguments to the command handler are passed on to the task.
  * @param logger The logger to use for error reporting.
+ * @param telemetry The telemetry listener to use for error reporting.
  */
 export function registerCommandWithErrorHandling(
   commandId: string,
   task: (...args: any[]) => Promise<any>,
   logger: NotificationLogger = extLogger,
+  telemetry: AppTelemetry | undefined = telemetryListener,
 ): Disposable {
   return commands.registerCommand(commandId, async (...args: any[]) => {
     const startTime = Date.now();
@@ -64,7 +70,7 @@ export function registerCommandWithErrorHandling(
         const fullMessage = errorStack
           ? `${errorMessage.fullMessage}\n${errorStack}`
           : errorMessage.fullMessage;
-        void showAndLogExceptionWithTelemetry(logger, errorMessage, {
+        void showAndLogExceptionWithTelemetry(logger, telemetry, errorMessage, {
           fullMessage,
           extraTelemetryProperties: {
             command: commandId,

extensions/ql-vscode/src/common/vscode/external-files.ts

@@ -9,6 +9,7 @@ import {
 } from "../../pure/helpers-pure";
 import { extLogger } from "../logging";
 import { showAndLogExceptionWithTelemetry } from "./logging";
+import { telemetryListener } from "./telemetry";
 
 export async function tryOpenExternalFile(
   commandManager: AppCommandManager,
@@ -36,6 +37,7 @@ the file in the file explorer and dragging it into the workspace.`,
         } catch (e) {
           void showAndLogExceptionWithTelemetry(
             extLogger,
+            telemetryListener,
             redactableError(
               asError(e),
             )`Failed to reveal file in OS: ${getErrorMessage(e)}`,
@@ -45,6 +47,7 @@ the file in the file explorer and dragging it into the workspace.`,
     } else {
       void showAndLogExceptionWithTelemetry(
         extLogger,
+        telemetryListener,
         redactableError(asError(e))`Could not open file ${fileLocation}`,
         {
           fullMessage: `${getErrorMessage(e)}\n${getErrorStack(e)}`,

extensions/ql-vscode/src/common/vscode/logging.ts

@@ -4,7 +4,7 @@ import {
   ShowAndLogOptions,
 } from "../logging";
 import { RedactableError } from "../../pure/errors";
-import { telemetryListener } from "./telemetry";
+import { AppTelemetry } from "../telemetry";
 
 interface ShowAndLogExceptionOptions extends ShowAndLogOptions {
   /** Custom properties to include in the telemetry report. */
@@ -15,16 +15,18 @@ interface ShowAndLogExceptionOptions extends ShowAndLogOptions {
  * Show an error message, log it to the console, and emit redacted information as telemetry
  *
  * @param logger The logger that will receive the message.
+ * @param telemetry The telemetry instance to use for reporting.
  * @param error The error to show. Only redacted information will be included in the telemetry.
  * @param options See individual fields on `ShowAndLogExceptionOptions` type.
  *
  * @return A promise that resolves to the selected item or undefined when being dismissed.
  */
 export async function showAndLogExceptionWithTelemetry(
   logger: NotificationLogger,
+  telemetry: AppTelemetry | undefined,
   error: RedactableError,
   options: ShowAndLogExceptionOptions = {},
 ): Promise<void> {
-  telemetryListener?.sendError(error, options.extraTelemetryProperties);
+  telemetry?.sendError(error, options.extraTelemetryProperties);
   return showAndLogErrorMessage(logger, error.fullMessage, options);
 }

extensions/ql-vscode/src/compare/compare-view.ts

@@ -152,6 +152,7 @@ export class CompareView extends AbstractWebview<
       case "unhandledError":
         void showAndLogExceptionWithTelemetry(
           extLogger,
+          telemetryListener,
           redactableError(
             msg.error,
           )`Unhandled error in result comparison view: ${msg.error.message}`,

extensions/ql-vscode/src/data-extensions-editor/data-extensions-editor-view.ts

@@ -276,6 +276,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
     } catch (err) {
       void showAndLogExceptionWithTelemetry(
         this.app.logger,
+        this.app.telemetry,
         redactableError(
           asError(err),
         )`Failed to load external API usages: ${getErrorMessage(err)}`,
@@ -342,6 +343,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
     } catch (e: unknown) {
       void showAndLogExceptionWithTelemetry(
         this.app.logger,
+        this.app.telemetry,
         redactableError(
           asError(e),
         )`Failed to generate flow model: ${getErrorMessage(e)}`,
@@ -476,6 +478,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
       if (e instanceof RequestError && e.status === 429) {
         void showAndLogExceptionWithTelemetry(
           this.app.logger,
+          this.app.telemetry,
           redactableError(e)`Rate limit hit, please try again soon.`,
         );
         return null;

extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts

@@ -14,6 +14,7 @@ import { fetchExternalApiQueries } from "./queries";
 import { QueryResultType } from "../pure/new-messages";
 import { join } from "path";
 import { redactableError } from "../pure/errors";
+import { telemetryListener } from "../common/vscode/telemetry";
 
 export type RunQueryOptions = {
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks">;
@@ -42,6 +43,7 @@ export async function runQuery({
   if (!isQueryLanguage(databaseItem.language)) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`Unsupported database language ${databaseItem.language}`,
     );
     return;
@@ -51,6 +53,7 @@ export async function runQuery({
   if (!query) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`No external API usage query found for language ${databaseItem.language}`,
     );
     return;
@@ -107,6 +110,7 @@ export async function runQuery({
   if (completedQuery.resultType !== QueryResultType.SUCCESS) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`External API usage query failed: ${
         completedQuery.message ?? "No message"
       }`,
@@ -130,6 +134,7 @@ export async function readQueryResults({
   if (bqrsInfo["result-sets"].length !== 1) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`Expected exactly one result set, got ${bqrsInfo["result-sets"].length}`,
     );
     return undefined;

extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts

@@ -18,6 +18,7 @@ import { file } from "tmp-promise";
 import { writeFile } from "fs-extra";
 import { dump } from "js-yaml";
 import { qlpackOfDatabase } from "../language-support";
+import { telemetryListener } from "../common/vscode/telemetry";
 
 type FlowModelOptions = {
   cliServer: CodeQLCliServer;
@@ -82,6 +83,7 @@ async function getModeledMethodsFromFlow(
   if (queryPath === undefined) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`Failed to find ${type} query`,
     );
     return [];
@@ -117,6 +119,7 @@ async function getModeledMethodsFromFlow(
   if (queryResult.resultType !== QueryResultType.SUCCESS) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`Failed to run ${basename(queryPath)} query: ${
         queryResult.message ?? "No message"
       }`,
@@ -130,6 +133,7 @@ async function getModeledMethodsFromFlow(
   if (bqrsInfo["result-sets"].length !== 1) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError`Expected exactly one result set, got ${
         bqrsInfo["result-sets"].length
       } for ${basename(queryPath)}`,

extensions/ql-vscode/src/databases/local-databases-ui.ts

@@ -280,6 +280,7 @@ export class DatabaseUI extends DisposableObject {
     } catch (e) {
       void showAndLogExceptionWithTelemetry(
         this.app.logger,
+        this.app.telemetry,
         redactableError(
           asError(e),
         )`Failed to choose and set database: ${getErrorMessage(e)}`,
@@ -420,6 +421,7 @@ export class DatabaseUI extends DisposableObject {
         } catch (e) {
           void showAndLogExceptionWithTelemetry(
             this.app.logger,
+            this.app.telemetry,
             redactableError(
               asError(e),
             )`Failed to delete orphaned database: ${getErrorMessage(e)}`,
@@ -449,6 +451,7 @@ export class DatabaseUI extends DisposableObject {
     } catch (e: unknown) {
       void showAndLogExceptionWithTelemetry(
         this.app.logger,
+        this.app.telemetry,
         redactableError(
           asError(e),
         )`Failed to choose and set database: ${getErrorMessage(e)}`,

extensions/ql-vscode/src/databases/local-databases/database-manager.ts

@@ -29,6 +29,7 @@ import { remove } from "fs-extra";
 import { containsPath } from "../../pure/files";
 import { DatabaseChangedEvent, DatabaseEventKind } from "./database-events";
 import { DatabaseResolver } from "./database-resolver";
+import { telemetryListener } from "../../common/vscode/telemetry";
 
 /**
  * The name of the key in the workspaceState dictionary in which we
@@ -413,6 +414,7 @@ export class DatabaseManager extends DisposableObject {
         // database list had an unexpected type - nothing to be done?
         void showAndLogExceptionWithTelemetry(
           extLogger,
+          telemetryListener,
           redactableError(
             asError(e),
           )`Database list loading failed: ${getErrorMessage(e)}`,

extensions/ql-vscode/src/extension.ts

@@ -90,7 +90,10 @@ import {
 import { QLTestAdapterFactory } from "./query-testing/test-adapter";
 import { TestUIService } from "./query-testing/test-ui";
 import { CompareView } from "./compare/compare-view";
-import { initializeTelemetry } from "./common/vscode/telemetry";
+import {
+  initializeTelemetry,
+  telemetryListener,
+} from "./common/vscode/telemetry";
 import { ProgressCallback, withProgress } from "./common/vscode/progress";
 import { CodeQlStatusBarHandler } from "./status-bar";
 import { getPackagingCommands } from "./packaging";
@@ -1134,6 +1137,7 @@ async function showResultsForComparison(
   } catch (e) {
     void showAndLogExceptionWithTelemetry(
       extLogger,
+      telemetryListener,
       redactableError(asError(e))`Failed to show results: ${getErrorMessage(
         e,
       )}`,
@@ -1159,16 +1163,16 @@ function addUnhandledRejectionListener() {
       )`Unhandled error: ${getErrorMessage(error)}`;
       // Add a catch so that showAndLogExceptionWithTelemetry fails, we avoid
       // triggering "unhandledRejection" and avoid an infinite loop
-      showAndLogExceptionWithTelemetry(extLogger, message).catch(
-        (telemetryError: unknown) => {
-          void extLogger.log(
-            `Failed to send error telemetry: ${getErrorMessage(
-              telemetryError,
-            )}`,
-          );
-          void extLogger.log(message.fullMessage);
-        },
-      );
+      showAndLogExceptionWithTelemetry(
+        extLogger,
+        telemetryListener,
+        message,
+      ).catch((telemetryError: unknown) => {
+        void extLogger.log(
+          `Failed to send error telemetry: ${getErrorMessage(telemetryError)}`,
+        );
+        void extLogger.log(message.fullMessage);
+      });
     }
   };