Move show and log functions to common

This moves the `showAndLog` family of functions to the `common/logging`
directory. It explicitly moves the `showAndLogExceptionWithTelemetry`
function to the `common/vscode/logging.ts` file because it still has a
dependency on the `telemetryListener`, which depends on the `vscode`
module.

Author: koesie10

extensions/ql-vscode/src/codeql-cli/distribution.ts

@@ -25,7 +25,7 @@ import {
 import {
   showAndLogErrorMessage,
   showAndLogWarningMessage,
-} from "../common/vscode/log";
+} from "../common/logging";
 
 /**
  * distribution.ts

extensions/ql-vscode/src/codeql-cli/query-language.ts

@@ -4,7 +4,7 @@ import { isQueryLanguage, QueryLanguage } from "../common/query-language";
 import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { extLogger } from "../common";
 import { UserCancellationException } from "../common/vscode/progress";
-import { showAndLogErrorMessage } from "../common/vscode/log";
+import { showAndLogErrorMessage } from "../common/logging";
 
 /**
  * Finds the language that a query targets.

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

@@ -1,5 +1,6 @@
 export * from "./logger";
 export * from "./notification-logger";
+export * from "./notifications";
 export * from "./tee-logger";
 export * from "./vscode/loggers";
 export * from "./vscode/output-channel-logger";

…sions/ql-vscode/src/common/vscode/log.ts …code/src/common/logging/notifications.tsextensions/ql-vscode/src/common/vscode/log.ts renamed to extensions/ql-vscode/src/common/logging/notifications.ts extensions/ql-vscode/src/common/vscode/log.ts renamed to extensions/ql-vscode/src/common/logging/notifications.ts

@@ -1,38 +1,13 @@
-import { RedactableError } from "../../pure/errors";
-import { telemetryListener } from "../../telemetry";
-import { NotificationLogger } from "../logging";
+import { NotificationLogger } from "./notification-logger";
 
-interface ShowAndLogExceptionOptions extends ShowAndLogOptions {
-  /** Custom properties to include in the telemetry report. */
-  extraTelemetryProperties?: { [key: string]: string };
-}
-
-interface ShowAndLogOptions {
+export interface ShowAndLogOptions {
   /**
    * An alternate message that is added to the log, but not displayed in the popup.
    * This is useful for adding extra detail to the logs that would be too noisy for the popup.
    */
   fullMessage?: string;
 }
 
-/**
- * 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 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,
-  error: RedactableError,
-  options: ShowAndLogExceptionOptions = {},
-): Promise<void> {
-  telemetryListener?.sendError(error, options.extraTelemetryProperties);
-  return showAndLogErrorMessage(logger, error.fullMessage, options);
-}
-
 /**
  * Show an error message and log it to the console
  *

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

@@ -1,6 +1,10 @@
 import { commands, Disposable } from "vscode";
 import { CommandFunction, CommandManager } from "../../packages/commands";
-import { extLogger, OutputChannelLogger } from "../logging";
+import {
+  extLogger,
+  OutputChannelLogger,
+  showAndLogWarningMessage,
+} from "../logging";
 import {
   asError,
   getErrorMessage,
@@ -9,10 +13,7 @@ import {
 import { redactableError } from "../../pure/errors";
 import { UserCancellationException } from "./progress";
 import { telemetryListener } from "../../telemetry";
-import {
-  showAndLogExceptionWithTelemetry,
-  showAndLogWarningMessage,
-} from "./log";
+import { showAndLogExceptionWithTelemetry } from "./logging";
 
 /**
  * Create a command manager for VSCode, wrapping registerCommandWithErrorHandling

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

@@ -7,8 +7,8 @@ import {
   getErrorMessage,
   getErrorStack,
 } from "../../pure/helpers-pure";
-import { showAndLogExceptionWithTelemetry } from "./log";
 import { extLogger } from "../logging";
+import { showAndLogExceptionWithTelemetry } from "./logging";
 
 export async function tryOpenExternalFile(
   commandManager: AppCommandManager,

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

@@ -0,0 +1,30 @@
+import {
+  NotificationLogger,
+  showAndLogErrorMessage,
+  ShowAndLogOptions,
+} from "../logging";
+import { RedactableError } from "../../pure/errors";
+import { telemetryListener } from "../../telemetry";
+
+interface ShowAndLogExceptionOptions extends ShowAndLogOptions {
+  /** Custom properties to include in the telemetry report. */
+  extraTelemetryProperties?: { [key: string]: string };
+}
+
+/**
+ * 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 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,
+  error: RedactableError,
+  options: ShowAndLogExceptionOptions = {},
+): Promise<void> {
+  telemetryListener?.sendError(error, options.extraTelemetryProperties);
+  return showAndLogErrorMessage(logger, error.fullMessage, options);
+}

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

@@ -3,8 +3,7 @@ import {
   TreeViewContextMultiSelectionCommandFunction,
   TreeViewContextSingleSelectionCommandFunction,
 } from "../commands";
-import { showAndLogErrorMessage } from "./log";
-import { extLogger } from "../logging";
+import { showAndLogErrorMessage, extLogger } from "../logging";
 
 // A hack to match types that are not an array, which is useful to help avoid
 // misusing createSingleSelectionCommand, e.g. where T accidentally gets instantiated

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

@@ -6,6 +6,7 @@ import {
   QueryCompareResult,
 } from "../pure/interface-types";
 import { extLogger, Logger } from "../common";
+import { showAndLogExceptionWithTelemetry } from "../common/vscode/logging";
 import { CodeQLCliServer } from "../codeql-cli/cli";
 import { DatabaseManager } from "../databases/local-databases";
 import { jumpToLocation } from "../databases/local-databases/locations";
@@ -25,8 +26,6 @@ import {
 import { telemetryListener } from "../telemetry";
 import { redactableError } from "../pure/errors";
 
-import { showAndLogExceptionWithTelemetry } from "../common/vscode/log";
-
 interface ComparePair {
   from: CompletedLocalQueryInfo;
   to: CompletedLocalQueryInfo;

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

@@ -9,7 +9,7 @@ import { join } from "path";
 import { App } from "../common/app";
 import { withProgress } from "../common/vscode/progress";
 import { pickExtensionPackModelFile } from "./extension-pack-picker";
-import { showAndLogErrorMessage } from "../common/vscode/log";
+import { showAndLogErrorMessage } from "../common/logging";
 import { extLogger } from "../common";
 
 const SUPPORTED_LANGUAGES: string[] = ["java", "csharp"];