Move logging code to /common/logging and split into multiple files (#1800)

Author: charisk

extensions/ql-vscode/src/archive-filesystem-provider.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs-extra";
 import * as unzipper from "unzipper";
 import * as vscode from "vscode";
-import { logger } from "./logging";
+import { logger } from "./common";
 
 // All path operations in this file must be on paths *within* the zip
 // archive.

extensions/ql-vscode/src/cli-version.ts

@@ -1,6 +1,6 @@
 import * as semver from "semver";
 import { runCodeQlCliCommand } from "./cli";
-import { Logger } from "./logging";
+import { Logger } from "./common";
 import { getErrorMessage } from "./pure/helpers-pure";
 
 /**

extensions/ql-vscode/src/cli.ts

@@ -22,7 +22,7 @@ import {
   getErrorStack,
 } from "./pure/helpers-pure";
 import { QueryMetadata, SortDirection } from "./pure/interface-types";
-import { Logger, ProgressReporter } from "./logging";
+import { Logger, ProgressReporter } from "./common";
 import { CompilationMessage } from "./pure/legacy-messages";
 import { sarifParser } from "./sarif-parser";
 import { dbSchemeToLanguage, walkDirectory } from "./helpers";

extensions/ql-vscode/src/commandRunner.ts

@@ -7,7 +7,7 @@ import {
   ProgressLocation,
 } from "vscode";
 import { showAndLogErrorMessage, showAndLogWarningMessage } from "./helpers";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { getErrorMessage, getErrorStack } from "./pure/helpers-pure";
 import { telemetryListener } from "./telemetry";
 

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

@@ -0,0 +1 @@
+export * from "./logging";

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

@@ -0,0 +1,3 @@
+export * from "./logger";
+export * from "./vscode/loggers";
+export * from "./vscode/output-channel-logger";

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

@@ -0,0 +1,24 @@
+export interface LogOptions {
+  /** If false, don't output a trailing newline for the log entry. Default true. */
+  trailingNewline?: boolean;
+
+  /** If specified, add this log entry to the log file at the specified location. */
+  additionalLogLocation?: string;
+}
+
+export interface Logger {
+  /** Writes the given log message, optionally followed by a newline. */
+  log(message: string, options?: LogOptions): Promise<void>;
+  /**
+   * Reveal this channel in the UI.
+   *
+   * @param preserveFocus When `true` the channel will not take focus.
+   */
+  show(preserveFocus?: boolean): void;
+
+  /**
+   * Remove the log at the specified location
+   * @param location log to remove
+   */
+  removeAdditionalLogLocation(location: string | undefined): void;
+}

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

@@ -0,0 +1,15 @@
+import { OutputChannelLogger } from "./output-channel-logger";
+
+/** The global logger for the extension. */
+export const logger = new OutputChannelLogger("CodeQL Extension Log");
+
+/** The logger for messages from the query server. */
+export const queryServerLogger = new OutputChannelLogger("CodeQL Query Server");
+
+/** The logger for messages from the language server. */
+export const ideServerLogger = new OutputChannelLogger(
+  "CodeQL Language Server",
+);
+
+/** The logger for messages from tests. */
+export const testLogger = new OutputChannelLogger("CodeQL Tests");

extensions/ql-vscode/src/logging.ts …/logging/vscode/output-channel-logger.tsextensions/ql-vscode/src/logging.ts renamed to extensions/ql-vscode/src/common/logging/vscode/output-channel-logger.ts extensions/ql-vscode/src/logging.ts renamed to extensions/ql-vscode/src/common/logging/vscode/output-channel-logger.ts

@@ -1,34 +1,8 @@
 import { window as Window, OutputChannel, Progress } from "vscode";
-import { DisposableObject } from "./pure/disposable-object";
 import * as fs from "fs-extra";
 import * as path from "path";
-
-interface LogOptions {
-  /** If false, don't output a trailing newline for the log entry. Default true. */
-  trailingNewline?: boolean;
-
-  /** If specified, add this log entry to the log file at the specified location. */
-  additionalLogLocation?: string;
-}
-
-export interface Logger {
-  /** Writes the given log message, optionally followed by a newline. */
-  log(message: string, options?: LogOptions): Promise<void>;
-  /**
-   * Reveal this channel in the UI.
-   *
-   * @param preserveFocus When `true` the channel will not take focus.
-   */
-  show(preserveFocus?: boolean): void;
-
-  /**
-   * Remove the log at the specified location
-   * @param location log to remove
-   */
-  removeAdditionalLogLocation(location: string | undefined): void;
-}
-
-export type ProgressReporter = Progress<{ message: string }>;
+import { Logger, LogOptions } from "../logger";
+import { DisposableObject } from "../../../pure/disposable-object";
 
 /** A logger that writes messages to an output channel in the Output tab. */
 export class OutputChannelLogger extends DisposableObject implements Logger {
@@ -128,16 +102,4 @@ class AdditionalLogLocation {
   }
 }
 
-/** The global logger for the extension. */
-export const logger = new OutputChannelLogger("CodeQL Extension Log");
-
-/** The logger for messages from the query server. */
-export const queryServerLogger = new OutputChannelLogger("CodeQL Query Server");
-
-/** The logger for messages from the language server. */
-export const ideServerLogger = new OutputChannelLogger(
-  "CodeQL Language Server",
-);
-
-/** The logger for messages from tests. */
-export const testLogger = new OutputChannelLogger("CodeQL Tests");
+export type ProgressReporter = Progress<{ message: string }>;

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

@@ -5,7 +5,7 @@ import {
   ToCompareViewMessage,
   QueryCompareResult,
 } from "../pure/interface-types";
-import { Logger } from "../logging";
+import { Logger } from "../common";
 import { CodeQLCliServer } from "../cli";
 import { DatabaseManager } from "../databases";
 import { jumpToLocation } from "../interface-utils";