Use app logger instead of extLogger where possible

To increase the use of the `app` logger, this replaces the direct use of
`extLogger` by the `app.logger` where possible. This should not change
the behavior since the `extLogger` is the logger used by the `app`.

Author: koesie10

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

@@ -2,7 +2,7 @@ import { commands, Disposable } from "vscode";
 import { CommandFunction, CommandManager } from "../../packages/commands";
 import {
   extLogger,
-  OutputChannelLogger,
+  NotificationLogger,
   showAndLogWarningMessage,
 } from "../logging";
 import {
@@ -21,9 +21,9 @@ import { showAndLogExceptionWithTelemetry } from "./logging";
  */
 export function createVSCodeCommandManager<
   Commands extends Record<string, CommandFunction>,
->(outputLogger?: OutputChannelLogger): CommandManager<Commands> {
+>(logger?: NotificationLogger): CommandManager<Commands> {
   return new CommandManager((commandId, task) => {
-    return registerCommandWithErrorHandling(commandId, task, outputLogger);
+    return registerCommandWithErrorHandling(commandId, task, logger);
   }, wrapExecuteCommand);
 }
 
@@ -33,11 +33,12 @@ export function createVSCodeCommandManager<
  * @param commandId The ID of the command to register.
  * @param task The task to run. It is passed directly to `commands.registerCommand`. Any
  * arguments to the command handler are passed on to the task.
+ * @param logger The logger to use for error reporting.
  */
 export function registerCommandWithErrorHandling(
   commandId: string,
   task: (...args: any[]) => Promise<any>,
-  outputLogger = extLogger,
+  logger: NotificationLogger = extLogger,
 ): Disposable {
   return commands.registerCommand(commandId, async (...args: any[]) => {
     const startTime = Date.now();
@@ -53,17 +54,17 @@ export function registerCommandWithErrorHandling(
       if (e instanceof UserCancellationException) {
         // User has cancelled this action manually
         if (e.silent) {
-          void outputLogger.log(errorMessage.fullMessage);
+          void logger.log(errorMessage.fullMessage);
         } else {
-          void showAndLogWarningMessage(outputLogger, errorMessage.fullMessage);
+          void showAndLogWarningMessage(logger, errorMessage.fullMessage);
         }
       } else {
         // Include the full stack in the error log only.
         const errorStack = getErrorStack(e);
         const fullMessage = errorStack
           ? `${errorMessage.fullMessage}\n${errorStack}`
           : errorMessage.fullMessage;
-        void showAndLogExceptionWithTelemetry(outputLogger, errorMessage, {
+        void showAndLogExceptionWithTelemetry(logger, errorMessage, {
           fullMessage,
           extraTelemetryProperties: {
             command: commandId,

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

@@ -3,7 +3,7 @@ import {
   TreeViewContextMultiSelectionCommandFunction,
   TreeViewContextSingleSelectionCommandFunction,
 } from "../commands";
-import { showAndLogErrorMessage, extLogger } from "../logging";
+import { showAndLogErrorMessage, NotificationLogger } 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
@@ -25,6 +25,7 @@ type SelectionCommand<T extends NotArray> = CreateSupertypeOf<
 >;
 
 export function createSingleSelectionCommand<T extends NotArray>(
+  logger: NotificationLogger,
   f: (argument: T) => Promise<void>,
   itemName: string,
 ): SelectionCommand<T> {
@@ -33,7 +34,7 @@ export function createSingleSelectionCommand<T extends NotArray>(
       return f(singleItem);
     } else {
       void showAndLogErrorMessage(
-        extLogger,
+        logger,
         `Please select a single ${itemName}.`,
       );
       return;

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

@@ -10,7 +10,6 @@ import { App } from "../common/app";
 import { withProgress } from "../common/vscode/progress";
 import { pickExtensionPackModelFile } from "./extension-pack-picker";
 import { showAndLogErrorMessage } from "../common/logging";
-import { extLogger } from "../common";
 
 const SUPPORTED_LANGUAGES: string[] = ["java", "csharp"];
 
@@ -57,13 +56,13 @@ export class DataExtensionsEditorModule {
       "codeQL.openDataExtensionsEditor": async () => {
         const db = this.databaseManager.currentDatabaseItem;
         if (!db) {
-          void showAndLogErrorMessage(extLogger, "No database selected");
+          void showAndLogErrorMessage(this.app.logger, "No database selected");
           return;
         }
 
         if (!SUPPORTED_LANGUAGES.includes(db.language)) {
           void showAndLogErrorMessage(
-            extLogger,
+            this.app.logger,
             `The data extensions editor is not supported for ${db.language} databases.`,
           );
           return;
@@ -73,7 +72,7 @@ export class DataExtensionsEditorModule {
           async (progress, token) => {
             if (!(await this.cliServer.cliConstraints.supportsQlpacksKind())) {
               void showAndLogErrorMessage(
-                extLogger,
+                this.app.logger,
                 `This feature requires CodeQL CLI version ${CliVersionConstraint.CLI_VERSION_WITH_QLPACKS_KIND.format()} or later.`,
               );
               return;
@@ -82,6 +81,7 @@ export class DataExtensionsEditorModule {
             const modelFile = await pickExtensionPackModelFile(
               this.cliServer,
               db,
+              this.app.logger,
               progress,
               token,
             );

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

@@ -17,7 +17,6 @@ import {
 } from "../pure/interface-types";
 import { ProgressUpdate } from "../common/vscode/progress";
 import { QueryRunner } from "../query-server";
-import { extLogger } from "../common";
 import { showAndLogExceptionWithTelemetry } from "../common/vscode/logging";
 import { outputFile, pathExists, readFile } from "fs-extra";
 import { load as loadYaml } from "js-yaml";
@@ -165,10 +164,10 @@ export class DataExtensionsEditorView extends AbstractWebview<
             "Original file of this result is not in the database's source archive.",
           );
         } else {
-          void extLogger.log(`Unable to handleMsgFromView: ${e.message}`);
+          void this.app.logger.log(`Unable to handleMsgFromView: ${e.message}`);
         }
       } else {
-        void extLogger.log(`Unable to handleMsgFromView: ${e}`);
+        void this.app.logger.log(`Unable to handleMsgFromView: ${e}`);
       }
     }
   }
@@ -185,7 +184,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
 
     await outputFile(this.modelFile.filename, yaml);
 
-    void extLogger.log(
+    void this.app.logger.log(
       `Saved data extension YAML to ${this.modelFile.filename}`,
     );
   }
@@ -206,7 +205,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
 
       if (!existingModeledMethods) {
         void showAndLogErrorMessage(
-          extLogger,
+          this.app.logger,
           `Failed to parse data extension YAML ${this.modelFile.filename}.`,
         );
         return;
@@ -218,7 +217,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
       });
     } catch (e: unknown) {
       void showAndLogErrorMessage(
-        extLogger,
+        this.app.logger,
         `Unable to read data extension YAML ${
           this.modelFile.filename
         }: ${getErrorMessage(e)}`,
@@ -276,7 +275,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
       await this.clearProgress();
     } catch (err) {
       void showAndLogExceptionWithTelemetry(
-        extLogger,
+        this.app.logger,
         redactableError(
           asError(err),
         )`Failed to load external API usages: ${getErrorMessage(err)}`,
@@ -303,7 +302,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
     );
     if (!database) {
       await this.clearProgress();
-      void extLogger.log("No database chosen");
+      void this.app.logger.log("No database chosen");
 
       return;
     }
@@ -342,7 +341,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
       });
     } catch (e: unknown) {
       void showAndLogExceptionWithTelemetry(
-        extLogger,
+        this.app.logger,
         redactableError(
           asError(e),
         )`Failed to generate flow model: ${getErrorMessage(e)}`,
@@ -476,7 +475,7 @@ export class DataExtensionsEditorView extends AbstractWebview<
 
       if (e instanceof RequestError && e.status === 429) {
         void showAndLogExceptionWithTelemetry(
-          extLogger,
+          this.app.logger,
           redactableError(e)`Rate limit hit, please try again soon.`,
         );
         return null;

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

@@ -13,7 +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, extLogger } from "../common/logging";
+import { NotificationLogger, showAndLogErrorMessage } from "../common/logging";
 import { containsPath } from "../pure/files";
 
 const maxStep = 3;
@@ -27,12 +27,14 @@ const packNameLength = 128;
 export async function pickExtensionPackModelFile(
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks" | "resolveExtensions">,
   databaseItem: Pick<DatabaseItem, "name" | "language">,
+  logger: NotificationLogger,
   progress: ProgressCallback,
   token: CancellationToken,
 ): Promise<ExtensionPackModelFile | undefined> {
   const extensionPack = await pickExtensionPack(
     cliServer,
     databaseItem,
+    logger,
     progress,
     token,
   );
@@ -60,6 +62,7 @@ export async function pickExtensionPackModelFile(
 async function pickExtensionPack(
   cliServer: Pick<CodeQLCliServer, "resolveQlpacks">,
   databaseItem: Pick<DatabaseItem, "name" | "language">,
+  logger: NotificationLogger,
   progress: ProgressCallback,
   token: CancellationToken,
 ): Promise<ExtensionPack | undefined> {
@@ -85,7 +88,7 @@ async function pickExtensionPack(
       Object.entries(extensionPacksInfo).map(async ([name, paths]) => {
         if (paths.length !== 1) {
           void showAndLogErrorMessage(
-            extLogger,
+            logger,
             `Extension pack ${name} resolves to multiple paths`,
             {
               fullMessage: `Extension pack ${name} resolves to multiple paths: ${paths.join(
@@ -104,7 +107,7 @@ async function pickExtensionPack(
           extensionPack = await readExtensionPack(path);
         } catch (e: unknown) {
           void showAndLogErrorMessage(
-            extLogger,
+            logger,
             `Could not read extension pack ${name}`,
             {
               fullMessage: `Could not read extension pack ${name} at ${path}: ${getErrorMessage(

extensions/ql-vscode/src/databases/code-search-api.ts

@@ -3,8 +3,10 @@ import { throttling } from "@octokit/plugin-throttling";
 import { Octokit } from "@octokit/rest";
 import { Progress, CancellationToken } from "vscode";
 import { Credentials } from "../common/authentication";
-import { showAndLogWarningMessage } from "../common/logging";
-import { extLogger } from "../common";
+import {
+  NotificationLogger,
+  showAndLogWarningMessage,
+} from "../common/logging";
 
 export async function getCodeSearchRepositories(
   query: string,
@@ -14,9 +16,10 @@ export async function getCodeSearchRepositories(
   }>,
   token: CancellationToken,
   credentials: Credentials,
+  logger: NotificationLogger,
 ): Promise<string[]> {
   let nwos: string[] = [];
-  const octokit = await provideOctokitWithThrottling(credentials);
+  const octokit = await provideOctokitWithThrottling(credentials, logger);
 
   for await (const response of octokit.paginate.iterator(
     octokit.rest.search.code,
@@ -44,6 +47,7 @@ export async function getCodeSearchRepositories(
 
 async function provideOctokitWithThrottling(
   credentials: Credentials,
+  logger: NotificationLogger,
 ): Promise<Octokit> {
   const MyOctokit = Octokit.plugin(throttling);
   const auth = await credentials.getAccessToken();
@@ -54,15 +58,15 @@ async function provideOctokitWithThrottling(
     throttle: {
       onRateLimit: (retryAfter: number, options: any): boolean => {
         void showAndLogWarningMessage(
-          extLogger,
+          logger,
           `Rate Limit detected for request ${options.method} ${options.url}. Retrying after ${retryAfter} seconds!`,
         );
 
         return true;
       },
       onSecondaryRateLimit: (_retryAfter: number, options: any): void => {
         void showAndLogWarningMessage(
-          extLogger,
+          logger,
           `Secondary Rate Limit detected for request ${options.method} ${options.url}`,
         );
       },

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

@@ -32,7 +32,6 @@ import {
   isLikelyDatabaseRoot,
   isLikelyDbLanguageFolder,
 } from "./local-databases/db-contents-heuristics";
-import { extLogger } from "../common";
 import { showAndLogExceptionWithTelemetry } from "../common/vscode/logging";
 import {
   importArchiveDatabase,
@@ -251,6 +250,7 @@ export class DatabaseUI extends DisposableObject {
         this.handleUpgradeDatabase.bind(this),
       ),
       "codeQLDatabases.renameDatabase": createSingleSelectionCommand(
+        this.app.logger,
         this.handleRenameDatabase.bind(this),
         "database",
       ),
@@ -279,7 +279,7 @@ export class DatabaseUI extends DisposableObject {
       await this.chooseAndSetDatabase(true, { progress, token });
     } catch (e) {
       void showAndLogExceptionWithTelemetry(
-        extLogger,
+        this.app.logger,
         redactableError(
           asError(e),
         )`Failed to choose and set database: ${getErrorMessage(e)}`,
@@ -372,14 +372,16 @@ export class DatabaseUI extends DisposableObject {
 
   // Public because it's used in tests
   public async handleRemoveOrphanedDatabases(): Promise<void> {
-    void extLogger.log("Removing orphaned databases from workspace storage.");
+    void this.app.logger.log(
+      "Removing orphaned databases from workspace storage.",
+    );
     let dbDirs = undefined;
 
     if (
       !(await pathExists(this.storagePath)) ||
       !(await stat(this.storagePath)).isDirectory()
     ) {
-      void extLogger.log(
+      void this.app.logger.log(
         "Missing or invalid storage directory. Not trying to remove orphaned databases.",
       );
       return;
@@ -404,7 +406,7 @@ export class DatabaseUI extends DisposableObject {
     dbDirs = await asyncFilter(dbDirs, isLikelyDatabaseRoot);
 
     if (!dbDirs.length) {
-      void extLogger.log("No orphaned databases found.");
+      void this.app.logger.log("No orphaned databases found.");
       return;
     }
 
@@ -413,11 +415,11 @@ export class DatabaseUI extends DisposableObject {
     await Promise.all(
       dbDirs.map(async (dbDir) => {
         try {
-          void extLogger.log(`Deleting orphaned database '${dbDir}'.`);
+          void this.app.logger.log(`Deleting orphaned database '${dbDir}'.`);
           await remove(dbDir);
         } catch (e) {
           void showAndLogExceptionWithTelemetry(
-            extLogger,
+            this.app.logger,
             redactableError(
               asError(e),
             )`Failed to delete orphaned database: ${getErrorMessage(e)}`,
@@ -430,7 +432,7 @@ export class DatabaseUI extends DisposableObject {
     if (failures.length) {
       const dirname = path_dirname(failures[0]);
       void showAndLogErrorMessage(
-        extLogger,
+        this.app.logger,
         `Failed to delete unused databases (${failures.join(
           ", ",
         )}).\nTo delete unused databases, please remove them manually from the storage folder ${dirname}.`,
@@ -446,7 +448,7 @@ export class DatabaseUI extends DisposableObject {
       await this.chooseAndSetDatabase(false, { progress, token });
     } catch (e: unknown) {
       void showAndLogExceptionWithTelemetry(
-        extLogger,
+        this.app.logger,
         redactableError(
           asError(e),
         )`Failed to choose and set database: ${getErrorMessage(e)}`,