Move logging code to /common/logging and split into multiple files

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 → 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";

extensions/ql-vscode/src/config.ts

@@ -7,7 +7,7 @@ import {
   ConfigurationTarget,
 } from "vscode";
 import { DistributionManager } from "./distribution";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { ONE_DAY_IN_MS } from "./pure/time";
 
 export const ALL_SETTINGS: Setting[] = [];

extensions/ql-vscode/src/contextual/queryResolver.ts

@@ -8,7 +8,7 @@ import { KeyType, kindOfKeyType, nameOfKeyType, tagOfKeyType } from "./keyType";
 import { CodeQLCliServer } from "../cli";
 import { DatabaseItem } from "../databases";
 import { QlPacksForLanguage } from "../helpers";
-import { logger } from "../logging";
+import { logger } from "../common";
 import { createInitialQueryInfo } from "../run-queries-shared";
 import { CancellationToken, Uri } from "vscode";
 import { ProgressCallback } from "../commandRunner";

extensions/ql-vscode/src/databaseFetcher.ts

@@ -11,7 +11,7 @@ import { retry } from "@octokit/plugin-retry";
 import { DatabaseManager, DatabaseItem } from "./databases";
 import { showAndLogInformationMessage } from "./helpers";
 import { reportStreamProgress, ProgressCallback } from "./commandRunner";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { tmpDir } from "./helpers";
 import { Credentials } from "./authentication";
 import { REPO_REGEX, getErrorMessage } from "./pure/helpers-pure";

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

@@ -27,7 +27,7 @@ import {
   isLikelyDbLanguageFolder,
   showAndLogErrorMessage,
 } from "./helpers";
-import { logger } from "./logging";
+import { logger } from "./common";
 import {
   importArchiveDatabase,
   promptImportGithubDatabase,

extensions/ql-vscode/src/databases.ts

@@ -18,7 +18,7 @@ import {
   encodeSourceArchiveUri,
 } from "./archive-filesystem-provider";
 import { DisposableObject } from "./pure/disposable-object";
-import { Logger, logger } from "./logging";
+import { Logger, logger } from "./common";
 import { getErrorMessage } from "./pure/helpers-pure";
 import { QueryRunner } from "./queryRunner";
 

extensions/ql-vscode/src/databases/db-module.ts

@@ -1,6 +1,6 @@
 import { App, AppMode } from "../common/app";
 import { isCanary, isNewQueryRunExperienceEnabled } from "../config";
-import { logger } from "../logging";
+import { logger } from "../common";
 import { DisposableObject } from "../pure/disposable-object";
 import { DbConfigStore } from "./config/db-config-store";
 import { DbManager } from "./db-manager";

extensions/ql-vscode/src/discovery.ts

@@ -1,5 +1,5 @@
 import { DisposableObject } from "./pure/disposable-object";
-import { logger } from "./logging";
+import { logger } from "./common";
 
 /**
  * Base class for "discovery" operations, which scan the file system to find specific kinds of

extensions/ql-vscode/src/distribution.ts

@@ -12,7 +12,7 @@ import {
   showAndLogErrorMessage,
   showAndLogWarningMessage,
 } from "./helpers";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { getCodeQlCliVersion } from "./cli-version";
 import { ProgressCallback, reportStreamProgress } from "./commandRunner";
 import {

extensions/ql-vscode/src/extension.ts

@@ -79,7 +79,7 @@ import {
   logger,
   ProgressReporter,
   queryServerLogger,
-} from "./logging";
+} from "./common";
 import { QueryHistoryManager } from "./query-history";
 import { CompletedLocalQueryInfo, LocalQueryInfo } from "./query-results";
 import * as legacyQueryServer from "./legacy-query-server/queryserver-client";

extensions/ql-vscode/src/helpers.ts

@@ -12,7 +12,7 @@ import {
 } from "vscode";
 import { CodeQLCliServer, QlpacksInfo } from "./cli";
 import { UserCancellationException } from "./commandRunner";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { QueryMetadata } from "./pure/interface-types";
 
 // Shared temporary folder for the extension.

extensions/ql-vscode/src/ide-server.ts

@@ -2,7 +2,7 @@ import { ProgressLocation, window } from "vscode";
 import { StreamInfo } from "vscode-languageclient";
 import * as cli from "./cli";
 import { QueryServerConfig } from "./config";
-import { ideServerLogger } from "./logging";
+import { ideServerLogger } from "./common";
 
 /**
  * Managing the language server for CodeQL.

extensions/ql-vscode/src/interface-utils.ts

@@ -17,7 +17,7 @@ import {
 import { tryGetResolvableLocation, isLineColumnLoc } from "./pure/bqrs-utils";
 import { DatabaseItem, DatabaseManager } from "./databases";
 import { ViewSourceFileMsg } from "./pure/interface-types";
-import { Logger } from "./logging";
+import { Logger } from "./common";
 import {
   LineColumnLocation,
   WholeFileLocation,

extensions/ql-vscode/src/interface.ts

@@ -34,7 +34,7 @@ import {
   RawResultsSortState,
   NavigationDirection,
 } from "./pure/interface-types";
-import { Logger } from "./logging";
+import { Logger } from "./common";
 import { commandRunner } from "./commandRunner";
 import {
   CompletedQueryInfo,

extensions/ql-vscode/src/json-rpc-server.ts

@@ -1,4 +1,4 @@
-import { Logger } from "./logging";
+import { Logger } from "./common";
 import * as cp from "child_process";
 import { Disposable } from "vscode";
 import { MessageConnection } from "vscode-jsonrpc";

extensions/ql-vscode/src/legacy-query-server/queryserver-client.ts

@@ -6,7 +6,7 @@ import { CancellationToken, commands } from "vscode";
 import { createMessageConnection, RequestType } from "vscode-jsonrpc";
 import * as cli from "../cli";
 import { QueryServerConfig } from "../config";
-import { Logger, ProgressReporter } from "../logging";
+import { Logger, ProgressReporter } from "../common";
 import {
   completeQuery,
   EvaluationResult,

extensions/ql-vscode/src/legacy-query-server/run-queries.ts

@@ -16,7 +16,7 @@ import {
 } from "../helpers";
 import { ProgressCallback } from "../commandRunner";
 import { QueryMetadata } from "../pure/interface-types";
-import { logger } from "../logging";
+import { logger } from "../common";
 import * as messages from "../pure/legacy-messages";
 import { InitialQueryInfo, LocalQueryInfo } from "../query-results";
 import * as qsClient from "./queryserver-client";

extensions/ql-vscode/src/legacy-query-server/upgrades.ts

@@ -5,7 +5,7 @@ import {
   tmpDir,
 } from "../helpers";
 import { ProgressCallback, UserCancellationException } from "../commandRunner";
-import { logger } from "../logging";
+import { logger } from "../common";
 import * as messages from "../pure/legacy-messages";
 import * as qsClient from "./queryserver-client";
 import * as tmp from "tmp-promise";

extensions/ql-vscode/src/log-insights/log-scanner-service.ts

@@ -8,7 +8,7 @@ import {
 } from "./log-scanner";
 import { PipelineInfo, SummarySymbols } from "./summary-parser";
 import * as fs from "fs-extra";
-import { logger } from "../logging";
+import { logger } from "../common";
 
 /**
  * Compute the key used to find a predicate in the summary symbols.

extensions/ql-vscode/src/log-insights/summary-language-support.ts

@@ -14,7 +14,7 @@ import {
 } from "vscode";
 import { DisposableObject } from "../pure/disposable-object";
 import { commandRunner } from "../commandRunner";
-import { logger } from "../logging";
+import { logger } from "../common";
 import { getErrorMessage } from "../pure/helpers-pure";
 
 /** A `Position` within a specified file on disk. */

extensions/ql-vscode/src/packaging.ts

@@ -6,7 +6,7 @@ import {
 } from "./helpers";
 import { QuickPickItem, window } from "vscode";
 import { ProgressCallback, UserCancellationException } from "./commandRunner";
-import { logger } from "./logging";
+import { logger } from "./common";
 
 const QUERY_PACKS = [
   "codeql/cpp-queries",

extensions/ql-vscode/src/query-history-scrubber.ts

@@ -2,7 +2,7 @@ import * as fs from "fs-extra";
 import * as os from "os";
 import * as path from "path";
 import { Disposable, ExtensionContext } from "vscode";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { QueryHistoryManager } from "./query-history";
 
 const LAST_SCRUB_TIME_KEY = "lastScrubTime";

extensions/ql-vscode/src/query-history.ts

@@ -24,7 +24,7 @@ import {
   showAndLogWarningMessage,
   showBinaryChoiceDialog,
 } from "./helpers";
-import { logger } from "./logging";
+import { logger } from "./common";
 import { URLSearchParams } from "url";
 import { DisposableObject } from "./pure/disposable-object";
 import { commandRunner } from "./commandRunner";

extensions/ql-vscode/src/query-server/queryserver-client.ts

@@ -6,7 +6,7 @@ import { CancellationToken, commands } from "vscode";
 import { createMessageConnection, RequestType } from "vscode-jsonrpc";
 import * as cli from "../cli";
 import { QueryServerConfig } from "../config";
-import { Logger, ProgressReporter } from "../logging";
+import { Logger, ProgressReporter } from "../common";
 import {
   progress,
   ProgressMessage,

extensions/ql-vscode/src/query-server/run-queries.ts

@@ -9,7 +9,7 @@ import {
   showAndLogWarningMessage,
   tryGetQueryMetadata,
 } from "../helpers";
-import { logger } from "../logging";
+import { logger } from "../common";
 import * as messages from "../pure/new-messages";
 import * as legacyMessages from "../pure/legacy-messages";
 import { InitialQueryInfo, LocalQueryInfo } from "../query-results";

extensions/ql-vscode/src/remote-queries/analyses-results-manager.ts

@@ -4,7 +4,7 @@ import * as path from "path";
 import { CancellationToken, ExtensionContext } from "vscode";
 
 import { Credentials } from "../authentication";
-import { Logger } from "../logging";
+import { Logger } from "../common";
 import { downloadArtifactFromLink } from "./gh-api/gh-actions-api-client";
 import { AnalysisSummary } from "./shared/remote-query-result";
 import {

extensions/ql-vscode/src/remote-queries/bqrs-processing.ts

@@ -1,5 +1,5 @@
 import { CodeQLCliServer } from "../cli";
-import { Logger } from "../logging";
+import { Logger } from "../common";
 import { transformBqrsResultSet } from "../pure/bqrs-cli-types";
 import { AnalysisRawResults } from "./shared/analysis-result";
 import { MAX_RAW_RESULTS } from "./shared/result-limits";

extensions/ql-vscode/src/remote-queries/export-results.ts

@@ -12,7 +12,7 @@ import {
 import { Credentials } from "../authentication";
 import { UserCancellationException } from "../commandRunner";
 import { showInformationMessageWithAction } from "../helpers";
-import { logger } from "../logging";
+import { logger } from "../common";
 import { QueryHistoryManager } from "../query-history";
 import { createGist } from "./gh-api/gh-api-client";
 import { RemoteQueriesManager } from "./remote-queries-manager";

extensions/ql-vscode/src/remote-queries/gh-api/gh-actions-api-client.ts

@@ -6,7 +6,7 @@ import {
   tmpDir,
 } from "../../helpers";
 import { Credentials } from "../../authentication";
-import { logger } from "../../logging";
+import { logger } from "../../common";
 import { RemoteQueryWorkflowResult } from "../remote-query-workflow-result";
 import { DownloadLink, createDownloadPath } from "../download-link";
 import { RemoteQuery } from "../remote-query";

extensions/ql-vscode/src/remote-queries/remote-queries-manager.ts

@@ -20,7 +20,7 @@ import {
   showAndLogInformationMessage,
   showInformationMessageWithAction,
 } from "../helpers";
-import { Logger } from "../logging";
+import { Logger } from "../common";
 import { prepareRemoteQueryRun } from "./run-remote-query";
 import { RemoteQueriesView } from "./remote-queries-view";
 import { buildRemoteQueryEntity, RemoteQuery } from "./remote-query";