Merge pull request #2506 from github/koesie10/split-helpers-3

Move show and log functions out of helpers

Author: koesie10

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

@@ -6,7 +6,6 @@ import * as semver from "semver";
 import { URL } from "url";
 import { ExtensionContext, Event } from "vscode";
 import { DistributionConfig } from "../config";
-import { showAndLogErrorMessage, showAndLogWarningMessage } from "../helpers";
 import { extLogger } from "../common";
 import { getCodeQlCliVersion } from "./cli-version";
 import {
@@ -23,6 +22,10 @@ import {
   InvocationRateLimiter,
   InvocationRateLimiterResultKind,
 } from "../common/invocation-rate-limiter";
+import {
+  showAndLogErrorMessage,
+  showAndLogWarningMessage,
+} from "../common/vscode/log";
 
 /**
  * distribution.ts

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

@@ -8,11 +8,11 @@ import {
 } from "../../pure/helpers-pure";
 import { redactableError } from "../../pure/errors";
 import { UserCancellationException } from "./progress";
+import { telemetryListener } from "../../telemetry";
 import {
   showAndLogExceptionWithTelemetry,
   showAndLogWarningMessage,
-} from "../../helpers";
-import { telemetryListener } from "../../telemetry";
+} from "./log";
 
 /**
  * Create a command manager for VSCode, wrapping registerCommandWithErrorHandling

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

@@ -1,13 +1,13 @@
 import { Uri, window } from "vscode";
 import { AppCommandManager } from "../commands";
-import { showAndLogExceptionWithTelemetry } from "../../helpers";
 import { showBinaryChoiceDialog } from "./dialog";
 import { redactableError } from "../../pure/errors";
 import {
   asError,
   getErrorMessage,
   getErrorStack,
 } from "../../pure/helpers-pure";
+import { showAndLogExceptionWithTelemetry } from "./log";
 
 export async function tryOpenExternalFile(
   commandManager: AppCommandManager,

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

@@ -0,0 +1,109 @@
+import { window } from "vscode";
+import { RedactableError } from "../../pure/errors";
+import { telemetryListener } from "../../telemetry";
+import { extLogger, OutputChannelLogger } from "../logging";
+
+interface ShowAndLogExceptionOptions extends ShowAndLogOptions {
+  /** Custom properties to include in the telemetry report. */
+  extraTelemetryProperties?: { [key: string]: string };
+}
+
+interface ShowAndLogOptions {
+  /** The output logger that will receive the message. */
+  outputLogger?: OutputChannelLogger;
+  /** A set of items that will be rendered as actions in the message. */
+  items?: string[];
+  /**
+   * 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 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(
+  error: RedactableError,
+  options: ShowAndLogExceptionOptions = {},
+): Promise<string | undefined> {
+  telemetryListener?.sendError(error, options.extraTelemetryProperties);
+  return showAndLogErrorMessage(error.fullMessage, options);
+}
+
+/**
+ * Show an error message and log it to the console
+ *
+ * @param message The message to show.
+ * @param options See individual fields on `ShowAndLogOptions` type.
+ *
+ * @return A promise that resolves to the selected item or undefined when being dismissed.
+ */
+export async function showAndLogErrorMessage(
+  message: string,
+  options?: ShowAndLogOptions,
+): Promise<string | undefined> {
+  return internalShowAndLog(
+    dropLinesExceptInitial(message),
+    window.showErrorMessage,
+    { fullMessage: message, ...options },
+  );
+}
+
+function dropLinesExceptInitial(message: string, n = 2) {
+  return message.toString().split(/\r?\n/).slice(0, n).join("\n");
+}
+
+/**
+ * Show a warning message and log it to the console
+ *
+ * @param message The message to show.
+ * @param options See individual fields on `ShowAndLogOptions` type.
+ *
+ * @return A promise that resolves to the selected item or undefined when being dismissed.
+ */
+export async function showAndLogWarningMessage(
+  message: string,
+  options?: ShowAndLogOptions,
+): Promise<string | undefined> {
+  return internalShowAndLog(message, window.showWarningMessage, options);
+}
+
+/**
+ * Show an information message and log it to the console
+ *
+ * @param message The message to show.
+ * @param options See individual fields on `ShowAndLogOptions` type.
+ *
+ * @return A promise that resolves to the selected item or undefined when being dismissed.
+ */
+export async function showAndLogInformationMessage(
+  message: string,
+  options?: ShowAndLogOptions,
+): Promise<string | undefined> {
+  return internalShowAndLog(message, window.showInformationMessage, options);
+}
+
+type ShowMessageFn = (
+  message: string,
+  ...items: string[]
+) => Thenable<string | undefined>;
+
+async function internalShowAndLog(
+  message: string,
+  fn: ShowMessageFn,
+  { items = [], outputLogger = extLogger, fullMessage }: ShowAndLogOptions = {},
+): Promise<string | undefined> {
+  const label = "Show Log";
+  void outputLogger.log(fullMessage || message);
+  const result = await fn(message, label, ...items);
+  if (result === label) {
+    outputLogger.show();
+  }
+  return result;
+}

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

@@ -1,9 +1,9 @@
-import { showAndLogErrorMessage } from "../../helpers";
 import {
   ExplorerSelectionCommandFunction,
   TreeViewContextMultiSelectionCommandFunction,
   TreeViewContextSingleSelectionCommandFunction,
 } from "../commands";
+import { showAndLogErrorMessage } from "./log";
 
 // 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

@@ -24,7 +24,8 @@ import {
 } from "../common/vscode/abstract-webview";
 import { telemetryListener } from "../telemetry";
 import { redactableError } from "../pure/errors";
-import { showAndLogExceptionWithTelemetry } from "../helpers";
+
+import { showAndLogExceptionWithTelemetry } from "../common/vscode/log";
 
 interface ComparePair {
   from: CompletedLocalQueryInfo;

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

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

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

@@ -17,10 +17,6 @@ import {
 } from "../pure/interface-types";
 import { ProgressUpdate } from "../common/vscode/progress";
 import { QueryRunner } from "../query-server";
-import {
-  showAndLogErrorMessage,
-  showAndLogExceptionWithTelemetry,
-} from "../helpers";
 import { extLogger } from "../common";
 import { outputFile, pathExists, readFile } from "fs-extra";
 import { load as loadYaml } from "js-yaml";
@@ -46,6 +42,10 @@ import {
 } from "./auto-model";
 import { showLlmGeneration } from "../config";
 import { getAutoModelUsages } from "./auto-model-usages-query";
+import {
+  showAndLogErrorMessage,
+  showAndLogExceptionWithTelemetry,
+} from "../common/vscode/log";
 
 export class DataExtensionsEditorView extends AbstractWebview<
   ToDataExtensionsEditorMessage,

extensions/ql-vscode/src/data-extensions-editor/extension-pack-picker.ts

@@ -4,7 +4,6 @@ import { dump as dumpYaml, load as loadYaml } from "js-yaml";
 import { minimatch } from "minimatch";
 import { CancellationToken, window } from "vscode";
 import { CodeQLCliServer } from "../codeql-cli/cli";
-import { showAndLogErrorMessage } from "../helpers";
 import {
   getOnDiskWorkspaceFolders,
   getOnDiskWorkspaceFoldersObjects,
@@ -14,6 +13,7 @@ import { DatabaseItem } from "../databases/local-databases";
 import { getQlPackPath, QLPACK_FILENAMES } from "../pure/ql";
 import { getErrorMessage } from "../pure/helpers-pure";
 import { ExtensionPack, ExtensionPackModelFile } from "./shared/extension-pack";
+import { showAndLogErrorMessage } from "../common/vscode/log";
 import { containsPath } from "../pure/files";
 
 const maxStep = 3;

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

@@ -2,7 +2,6 @@ import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { dir } from "tmp-promise";
 import { writeFile } from "fs-extra";
 import { dump as dumpYaml } from "js-yaml";
-import { showAndLogExceptionWithTelemetry } from "../helpers";
 import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { TeeLogger } from "../common";
 import { isQueryLanguage } from "../common/query-language";
@@ -14,6 +13,7 @@ import { fetchExternalApiQueries } from "./queries";
 import { QueryResultType } from "../pure/new-messages";
 import { join } from "path";
 import { redactableError } from "../pure/errors";
+import { showAndLogExceptionWithTelemetry } from "../common/vscode/log";
 
 export type RunQueryOptions = {
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks">;