Merge remote-tracking branch 'origin/main' into koesie10/load-results-tests

Author: koesie10

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 "./common";
+import { extLogger } from "./common";
 
 // All path operations in this file must be on paths *within* the zip
 // archive.
@@ -118,7 +118,7 @@ class InvalidSourceArchiveUriError extends Error {
 export function decodeSourceArchiveUri(uri: vscode.Uri): ZipFileReference {
   if (!uri.authority) {
     // Uri is malformed, but this is recoverable
-    void logger.log(
+    void extLogger.log(
       `Warning: ${new InvalidSourceArchiveUriError(uri).message}`,
     );
     return {
@@ -148,7 +148,7 @@ function ensureFile(map: DirectoryHierarchyMap, file: string) {
   const dirname = path.dirname(file);
   if (dirname === ".") {
     const error = `Ill-formed path ${file} in zip archive (expected absolute path)`;
-    void logger.log(error);
+    void extLogger.log(error);
     throw new Error(error);
   }
   ensureDir(map, dirname);

extensions/ql-vscode/src/commandRunner.ts

@@ -7,7 +7,7 @@ import {
   ProgressLocation,
 } from "vscode";
 import { showAndLogErrorMessage, showAndLogWarningMessage } from "./helpers";
-import { logger } from "./common";
+import { extLogger } from "./common";
 import { getErrorMessage, getErrorStack } from "./pure/helpers-pure";
 import { telemetryListener } from "./telemetry";
 
@@ -131,7 +131,7 @@ export function commandRunner(
       if (e instanceof UserCancellationException) {
         // User has cancelled this action manually
         if (e.silent) {
-          void logger.log(errorMessage);
+          void extLogger.log(errorMessage);
         } else {
           void showAndLogWarningMessage(errorMessage);
         }
@@ -166,7 +166,7 @@ export function commandRunnerWithProgress<R>(
   commandId: string,
   task: ProgressTask<R>,
   progressOptions: Partial<ProgressOptions>,
-  outputLogger = logger,
+  outputLogger = extLogger,
 ): Disposable {
   return commands.registerCommand(commandId, async (...args: any[]) => {
     const startTime = Date.now();

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

@@ -1,23 +1,34 @@
 export interface LogOptions {
-  /** If false, don't output a trailing newline for the log entry. Default true. */
+  // 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. */
+  // 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. */
+  /**
+   * Writes the given log message, optionally followed by a newline.
+   * This function is asynchronous and will only resolve once the message is written
+   * to the side log (if required). It is not necessary to await the results of this
+   * function if you don't need to guarantee that the log writing is complete before
+   * continuing.
+   *
+   * @param message The message to log.
+   * @param options Optional settings.
+   */
   log(message: string, options?: LogOptions): Promise<void>;
+
   /**
-   * Reveal this channel in the UI.
+   * Reveal the logger 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
+   * 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

@@ -1,15 +1,19 @@
+/**
+ * This module contains instantiated loggers to use in the extension.
+ */
+
 import { OutputChannelLogger } from "./output-channel-logger";
 
-/** The global logger for the extension. */
-export const logger = new OutputChannelLogger("CodeQL Extension Log");
+// Global logger for the extension.
+export const extLogger = new OutputChannelLogger("CodeQL Extension Log");
 
-/** The logger for messages from the query server. */
+// Logger for messages from the query server.
 export const queryServerLogger = new OutputChannelLogger("CodeQL Query Server");
 
-/** The logger for messages from the language server. */
+// Logger for messages from the language server.
 export const ideServerLogger = new OutputChannelLogger(
   "CodeQL Language Server",
 );
 
-/** The logger for messages from tests. */
+// Logger for messages from tests.
 export const testLogger = new OutputChannelLogger("CodeQL Tests");

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

@@ -4,7 +4,9 @@ import * as path from "path";
 import { Logger, LogOptions } from "../logger";
 import { DisposableObject } from "../../../pure/disposable-object";
 
-/** A logger that writes messages to an output channel in the Output tab. */
+/**
+ * A logger that writes messages to an output channel in the VS Code Output tab.
+ */
 export class OutputChannelLogger extends DisposableObject implements Logger {
   public readonly outputChannel: OutputChannel;
   private readonly additionalLocations = new Map<
@@ -20,12 +22,6 @@ export class OutputChannelLogger extends DisposableObject implements Logger {
     this.isCustomLogDirectory = false;
   }
 
-  /**
-   * This function is asynchronous and will only resolve once the message is written
-   * to the side log (if required). It is not necessary to await the results of this
-   * function if you don't need to guarantee that the log writing is complete before
-   * continuing.
-   */
   async log(message: string, options = {} as LogOptions): Promise<void> {
     try {
       if (options.trailingNewline === undefined) {
@@ -82,9 +78,7 @@ export class OutputChannelLogger extends DisposableObject implements Logger {
 }
 
 class AdditionalLogLocation {
-  constructor(private location: string) {
-    /**/
-  }
+  constructor(private location: string) {}
 
   async log(message: string, options = {} as LogOptions): Promise<void> {
     if (options.trailingNewline === undefined) {

extensions/ql-vscode/src/config.ts

@@ -7,7 +7,7 @@ import {
   ConfigurationTarget,
 } from "vscode";
 import { DistributionManager } from "./distribution";
-import { logger } from "./common";
+import { extLogger } from "./common";
 import { ONE_DAY_IN_MS } from "./pure/time";
 
 export const ALL_SETTINGS: Setting[] = [];
@@ -349,7 +349,7 @@ export class QueryServerConfigListener
       return undefined;
     }
     if (memory == 0 || typeof memory !== "number") {
-      void logger.log(
+      void extLogger.log(
         `Ignoring value '${memory}' for setting ${MEMORY_SETTING.qualifiedName}`,
       );
       return undefined;

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 "../common";
+import { extLogger } from "../common";
 import { createInitialQueryInfo } from "../run-queries-shared";
 import { CancellationToken, Uri } from "vscode";
 import { ProgressCallback } from "../commandRunner";
@@ -161,17 +161,17 @@ async function resolveContextualQuery(
     // No lock file, likely because this library pack is in the package cache.
     // Create a lock file so that we can resolve dependencies and library path
     // for the contextual query.
-    void logger.log(
+    void extLogger.log(
       `Library pack ${packPath} is missing a lock file; creating a temporary lock file`,
     );
     await cli.packResolveDependencies(packPath);
     createdTempLockFile = true;
     // Clear CLI server pack cache before installing dependencies,
     // so that it picks up the new lock file, not the previously cached pack.
-    void logger.log("Clearing the CodeQL CLI server's pack cache");
+    void extLogger.log("Clearing the CodeQL CLI server's pack cache");
     await cli.clearCache();
     // Install dependencies.
-    void logger.log(
+    void extLogger.log(
       `Installing package dependencies for library pack ${packPath}`,
     );
     await cli.packInstall(packPath);
@@ -181,7 +181,7 @@ async function resolveContextualQuery(
 
 async function removeTemporaryLockFile(packPath: string) {
   const tempLockFilePath = path.resolve(packPath, "codeql-pack.lock.yml");
-  void logger.log(
+  void extLogger.log(
     `Deleting temporary package lock file at ${tempLockFilePath}`,
   );
   // It's fine if the file doesn't exist.
@@ -212,7 +212,7 @@ export async function runContextualQuery(
     },
     false,
   );
-  void logger.log(
+  void extLogger.log(
     `Running contextual query ${query}; results will be stored in ${queryStorageDir}`,
   );
   const queryResult = await qs.compileAndRunQueryAgainstDatabase(

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 "./common";
+import { extLogger } from "./common";
 import { tmpDir } from "./helpers";
 import { Credentials } from "./authentication";
 import { REPO_REGEX, getErrorMessage } from "./pure/helpers-pure";
@@ -585,7 +585,7 @@ export async function convertGithubNwoToDatabaseUrl(
       name: repo,
     };
   } catch (e) {
-    void logger.log(`Error: ${getErrorMessage(e)}`);
+    void extLogger.log(`Error: ${getErrorMessage(e)}`);
     throw new Error(`Unable to get database for '${githubRepo}'`);
   }
 }
@@ -696,7 +696,7 @@ export async function convertLgtmUrlToDatabaseUrl(
       language,
     ].join("/")}`;
   } catch (e) {
-    void logger.log(`Error: ${getErrorMessage(e)}`);
+    void extLogger.log(`Error: ${getErrorMessage(e)}`);
     throw new Error(`Invalid LGTM URL: ${lgtmUrl}`);
   }
 }

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

@@ -27,7 +27,7 @@ import {
   isLikelyDbLanguageFolder,
   showAndLogErrorMessage,
 } from "./helpers";
-import { logger } from "./common";
+import { extLogger } from "./common";
 import {
   importArchiveDatabase,
   promptImportGithubDatabase,
@@ -241,7 +241,7 @@ export class DatabaseUI extends DisposableObject {
   }
 
   init() {
-    void logger.log("Registering database panel commands.");
+    void extLogger.log("Registering database panel commands.");
     this.push(
       commandRunnerWithProgress(
         "codeQL.setCurrentDatabase",
@@ -393,14 +393,14 @@ export class DatabaseUI extends DisposableObject {
   };
 
   handleRemoveOrphanedDatabases = async (): Promise<void> => {
-    void logger.log("Removing orphaned databases from workspace storage.");
+    void extLogger.log("Removing orphaned databases from workspace storage.");
     let dbDirs = undefined;
 
     if (
       !(await fs.pathExists(this.storagePath)) ||
       !(await fs.stat(this.storagePath)).isDirectory()
     ) {
-      void logger.log(
+      void extLogger.log(
         "Missing or invalid storage directory. Not trying to remove orphaned databases.",
       );
       return;
@@ -425,7 +425,7 @@ export class DatabaseUI extends DisposableObject {
     dbDirs = await asyncFilter(dbDirs, isLikelyDatabaseRoot);
 
     if (!dbDirs.length) {
-      void logger.log("No orphaned databases found.");
+      void extLogger.log("No orphaned databases found.");
       return;
     }
 
@@ -434,7 +434,7 @@ export class DatabaseUI extends DisposableObject {
     await Promise.all(
       dbDirs.map(async (dbDir) => {
         try {
-          void logger.log(`Deleting orphaned database '${dbDir}'.`);
+          void extLogger.log(`Deleting orphaned database '${dbDir}'.`);
           await fs.remove(dbDir);
         } catch (e) {
           failures.push(`${path.basename(dbDir)}`);

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 "./common";
+import { Logger, extLogger } from "./common";
 import { getErrorMessage } from "./pure/helpers-pure";
 import { QueryRunner } from "./queryRunner";
 
@@ -545,7 +545,7 @@ function eventFired<T>(
 ): Promise<T | undefined> {
   return new Promise((res, _rej) => {
     const timeout = setTimeout(() => {
-      void logger.log(
+      void extLogger.log(
         `Waiting for event ${event} timed out after ${timeoutMs}ms`,
       );
       res(undefined);
@@ -657,12 +657,12 @@ export class DatabaseManager extends DisposableObject {
 
       const msg = item.verifyZippedSources();
       if (msg) {
-        void logger.log(`Could not add source folder because ${msg}`);
+        void extLogger.log(`Could not add source folder because ${msg}`);
         return;
       }
 
       const uri = item.getSourceArchiveExplorerUri();
-      void logger.log(
+      void extLogger.log(
         `Adding workspace folder for ${item.name} source archive at index ${end}`,
       );
       if ((vscode.workspace.workspaceFolders || []).length < 2) {
@@ -916,7 +916,7 @@ export class DatabaseManager extends DisposableObject {
       (folder) => item.belongsToSourceArchiveExplorerUri(folder.uri),
     );
     if (folderIndex >= 0) {
-      void logger.log(`Removing workspace folder at index ${folderIndex}`);
+      void extLogger.log(`Removing workspace folder at index ${folderIndex}`);
       vscode.workspace.updateWorkspaceFolders(folderIndex, 1);
     }
 
@@ -925,11 +925,11 @@ export class DatabaseManager extends DisposableObject {
 
     // Delete folder from file system only if it is controlled by the extension
     if (this.isExtensionControlledLocation(item.databaseUri)) {
-      void logger.log("Deleting database from filesystem.");
+      void extLogger.log("Deleting database from filesystem.");
       fs.remove(item.databaseUri.fsPath).then(
-        () => void logger.log(`Deleted '${item.databaseUri.fsPath}'`),
+        () => void extLogger.log(`Deleted '${item.databaseUri.fsPath}'`),
         (e) =>
-          void logger.log(
+          void extLogger.log(
             `Failed to delete '${
               item.databaseUri.fsPath
             }'. Reason: ${getErrorMessage(e)}`,