Merge pull request #2217 from github/robertbrignull/use_app_commands_1

Convert call sites to use typed commands (part 1)

Author: robertbrignull

extensions/ql-vscode/src/cli.ts

@@ -9,7 +9,7 @@ import { Readable } from "stream";
 import { StringDecoder } from "string_decoder";
 import tk from "tree-kill";
 import { promisify } from "util";
-import { CancellationToken, commands, Disposable, Uri } from "vscode";
+import { CancellationToken, Disposable, Uri } from "vscode";
 
 import { BQRSInfo, DecodedBqrsChunk } from "./pure/bqrs-cli-types";
 import { allowCanaryQueryServer, CliConfig } from "./config";
@@ -1375,7 +1375,7 @@ export class CodeQLCliServer implements Disposable {
     if (!this._version) {
       this._version = this.refreshVersion();
       // this._version is only undefined upon config change, so we reset CLI-based context key only when necessary.
-      await commands.executeCommand(
+      await this.app.commands.execute(
         "setContext",
         "codeql.supportsEvalLog",
         await this.cliConstraints.supportsPerQueryEvalLog(),

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

@@ -1,5 +1,5 @@
 import type { CommandManager } from "../packages/commands";
-import type { Uri, Range } from "vscode";
+import type { Uri, Range, TextDocumentShowOptions } from "vscode";
 import type { AstItem } from "../astViewer";
 import type { DbTreeViewItem } from "../databases/ui/db-tree-view-item";
 import type { DatabaseItem } from "../local-databases";
@@ -35,12 +35,22 @@ export type SingleSelectionCommandFunction<Item> = (
 // Builtin commands where the implementation is provided by VS Code and not by this extension.
 // See https://code.visualstudio.com/api/references/commands
 export type BuiltInVsCodeCommands = {
+  // The codeQLDatabases.focus command is provided by VS Code because we've registered the custom view
+  "codeQLDatabases.focus": () => Promise<void>;
   "markdown.showPreviewToSide": (uri: Uri) => Promise<void>;
   setContext: (
     key: `${"codeql" | "codeQL"}${string}`,
     value: unknown,
   ) => Promise<void>;
   "workbench.action.reloadWindow": () => Promise<void>;
+  "vscode.diff": (
+    leftSideResource: Uri,
+    rightSideResource: Uri,
+    title?: string,
+    columnOrOptions?: TextDocumentShowOptions,
+  ) => Promise<void>;
+  "vscode.open": (uri: Uri) => Promise<void>;
+  "vscode.openFolder": (uri: Uri) => Promise<void>;
 };
 
 // Commands that are available before the extension is fully activated.

extensions/ql-vscode/src/databaseFetcher.ts

@@ -1,7 +1,7 @@
 import fetch, { Response } from "node-fetch";
 import { zip } from "zip-a-folder";
 import { Open } from "unzipper";
-import { Uri, CancellationToken, commands, window } from "vscode";
+import { Uri, CancellationToken, window } from "vscode";
 import { CodeQLCliServer } from "./cli";
 import {
   ensureDir,
@@ -26,6 +26,7 @@ import {
   isValidGitHubNwo,
 } from "./common/github-url-identifier-helper";
 import { Credentials } from "./common/authentication";
+import { AppCommandManager } from "./common/commands";
 
 /**
  * Prompts a user to fetch a database from a remote location. Database is assumed to be an archive file.
@@ -34,6 +35,7 @@ import { Credentials } from "./common/authentication";
  * @param storagePath where to store the unzipped database.
  */
 export async function promptImportInternetDatabase(
+  commandManager: AppCommandManager,
   databaseManager: DatabaseManager,
   storagePath: string,
   progress: ProgressCallback,
@@ -61,7 +63,7 @@ export async function promptImportInternetDatabase(
   );
 
   if (item) {
-    await commands.executeCommand("codeQLDatabases.focus");
+    await commandManager.execute("codeQLDatabases.focus");
     void showAndLogInformationMessage(
       "Database downloaded and imported successfully.",
     );
@@ -78,6 +80,7 @@ export async function promptImportInternetDatabase(
  * @param storagePath where to store the unzipped database.
  */
 export async function promptImportGithubDatabase(
+  commandManager: AppCommandManager,
   databaseManager: DatabaseManager,
   storagePath: string,
   credentials: Credentials | undefined,
@@ -141,7 +144,7 @@ export async function promptImportGithubDatabase(
     cli,
   );
   if (item) {
-    await commands.executeCommand("codeQLDatabases.focus");
+    await commandManager.execute("codeQLDatabases.focus");
     void showAndLogInformationMessage(
       "Database downloaded and imported successfully.",
     );
@@ -158,6 +161,7 @@ export async function promptImportGithubDatabase(
  * @param storagePath where to store the unzipped database.
  */
 export async function importArchiveDatabase(
+  commandManager: AppCommandManager,
   databaseUrl: string,
   databaseManager: DatabaseManager,
   storagePath: string,
@@ -177,7 +181,7 @@ export async function importArchiveDatabase(
       cli,
     );
     if (item) {
-      await commands.executeCommand("codeQLDatabases.focus");
+      await commandManager.execute("codeQLDatabases.focus");
       void showAndLogInformationMessage(
         "Database unzipped and imported successfully.",
       );

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

@@ -43,7 +43,7 @@ export class DbModule extends DisposableObject {
 
     await this.dbConfigStore.initialize();
 
-    this.dbPanel = new DbPanel(this.dbManager, app.credentials);
+    this.dbPanel = new DbPanel(app, this.dbManager);
 
     this.push(this.dbPanel);
     this.push(this.dbConfigStore);

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

@@ -1,5 +1,4 @@
 import {
-  commands,
   QuickPickItem,
   TreeView,
   TreeViewExpansionEvent,
@@ -31,8 +30,8 @@ import { DbTreeViewItem } from "./db-tree-view-item";
 import { getGitHubUrl } from "./db-tree-view-item-action";
 import { getControllerRepo } from "../../variant-analysis/run-remote-query";
 import { getErrorMessage } from "../../pure/helpers-pure";
-import { Credentials } from "../../common/authentication";
 import { DatabasePanelCommands } from "../../common/commands";
+import { App } from "../../common/app";
 
 export interface RemoteDatabaseQuickPickItem extends QuickPickItem {
   kind: string;
@@ -47,8 +46,8 @@ export class DbPanel extends DisposableObject {
   private readonly treeView: TreeView<DbTreeViewItem>;
 
   public constructor(
+    private readonly app: App,
     private readonly dbManager: DbManager,
-    private readonly credentials: Credentials,
   ) {
     super();
 
@@ -369,13 +368,13 @@ export class DbPanel extends DisposableObject {
       );
     }
 
-    await commands.executeCommand("vscode.open", Uri.parse(githubUrl));
+    await this.app.commands.execute("vscode.open", Uri.parse(githubUrl));
   }
 
   private async setupControllerRepository(): Promise<void> {
     try {
       // This will also validate that the controller repository is valid
-      await getControllerRepo(this.credentials);
+      await getControllerRepo(this.app.credentials);
     } catch (e: unknown) {
       if (e instanceof UserCancellationException) {
         return;

extensions/ql-vscode/src/extension.ts

@@ -575,7 +575,7 @@ async function installOrUpdateThenTryActivate(
   await installOrUpdateDistribution(ctx, app, distributionManager, config);
 
   try {
-    await prepareCodeTour();
+    await prepareCodeTour(app.commands);
   } catch (e: unknown) {
     void extLogger.log(
       `Could not open tutorial workspace automatically: ${getErrorMessage(e)}`,
@@ -669,7 +669,12 @@ async function activateWithInstalledDistribution(
   ctx.subscriptions.push(statusBar);
 
   void extLogger.log("Initializing query server client.");
-  const qs = await createQueryServer(qlConfigurationListener, cliServer, ctx);
+  const qs = await createQueryServer(
+    app,
+    qlConfigurationListener,
+    cliServer,
+    ctx,
+  );
 
   for (const glob of PACK_GLOBS) {
     const fsWatcher = workspace.createFileSystemWatcher(glob);
@@ -680,7 +685,7 @@ async function activateWithInstalledDistribution(
   }
 
   void extLogger.log("Initializing database manager.");
-  const dbm = new DatabaseManager(ctx, qs, cliServer, extLogger);
+  const dbm = new DatabaseManager(ctx, app, qs, cliServer, extLogger);
 
   // Let this run async.
   void dbm.loadPersistedState();
@@ -853,7 +858,7 @@ async function activateWithInstalledDistribution(
     );
     ctx.subscriptions.push(testAdapterFactory);
 
-    const testUIService = new TestUIService(testHub);
+    const testUIService = new TestUIService(app, testHub);
     ctx.subscriptions.push(testUIService);
 
     testUiCommands = testUIService.getCommands();
@@ -881,6 +886,7 @@ async function activateWithInstalledDistribution(
   const allCommands: AllExtensionCommands = {
     ...getCommands(app, cliServer, qs),
     ...getQueryEditorCommands({
+      commandManager: app.commands,
       queryRunner: qs,
       cliServer,
       qhelpTmpDir: qhelpTmpDir.name,
@@ -1046,6 +1052,7 @@ function addUnhandledRejectionListener() {
 }
 
 async function createQueryServer(
+  app: ExtensionApp,
   qlConfigurationListener: QueryServerConfigListener,
   cliServer: CodeQLCliServer,
   ctx: ExtensionContext,
@@ -1076,6 +1083,7 @@ async function createQueryServer(
     return new NewQueryRunner(qs);
   } else {
     const qs = new LegacyQueryServerClient(
+      app,
       qlConfigurationListener,
       cliServer,
       qsOpts,

extensions/ql-vscode/src/helpers.ts

@@ -16,7 +16,6 @@ import {
   window as Window,
   workspace,
   env,
-  commands,
 } from "vscode";
 import { CodeQLCliServer, QlpacksInfo } from "./cli";
 import { UserCancellationException } from "./progress";
@@ -27,6 +26,7 @@ import { RedactableError } from "./pure/errors";
 import { getQlPackPath } from "./pure/ql";
 import { dbSchemeToLanguage } from "./common/query-language";
 import { isCodespacesTemplate } from "./config";
+import { AppCommandManager } from "./common/commands";
 
 // Shared temporary folder for the extension.
 export const tmpDir = dirSync({
@@ -271,7 +271,9 @@ export function isFolderAlreadyInWorkspace(folderName: string) {
 /** Check if the current workspace is the CodeTour and open the workspace folder.
  * Without this, we can't run the code tour correctly.
  **/
-export async function prepareCodeTour(): Promise<void> {
+export async function prepareCodeTour(
+  commandManager: AppCommandManager,
+): Promise<void> {
   if (workspace.workspaceFolders?.length) {
     const currentFolder = workspace.workspaceFolders[0].uri.fsPath;
 
@@ -308,7 +310,7 @@ export async function prepareCodeTour(): Promise<void> {
         `In prepareCodeTour() method, going to open the tutorial workspace file: ${tutorialWorkspacePath}`,
       );
 
-      await commands.executeCommand("vscode.openFolder", tutorialWorkspaceUri);
+      await commandManager.execute("vscode.openFolder", tutorialWorkspaceUri);
     }
   }
 }

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

@@ -1,7 +1,7 @@
 import { ensureFile } from "fs-extra";
 
 import { DisposableObject } from "../pure/disposable-object";
-import { CancellationToken, commands } from "vscode";
+import { CancellationToken } from "vscode";
 import { createMessageConnection, RequestType } from "vscode-jsonrpc/node";
 import * as cli from "../cli";
 import { QueryServerConfig } from "../config";
@@ -15,6 +15,7 @@ import {
 } from "../pure/legacy-messages";
 import { ProgressCallback, ProgressTask } from "../progress";
 import { ServerProcess } from "../json-rpc-server";
+import { App } from "../common/app";
 
 type WithProgressReporting = (
   task: (
@@ -56,6 +57,7 @@ export class QueryServerClient extends DisposableObject {
   public activeQueryLogger: Logger;
 
   constructor(
+    app: App,
     readonly config: QueryServerConfig,
     readonly cliServer: cli.CodeQLCliServer,
     readonly opts: ServerOpts,
@@ -69,7 +71,7 @@ export class QueryServerClient extends DisposableObject {
     if (config.onDidChangeConfiguration !== undefined) {
       this.push(
         config.onDidChangeConfiguration(() =>
-          commands.executeCommand("codeQL.restartQueryServer"),
+          app.commands.execute("codeQL.restartQueryServer"),
         ),
       );
     }

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

@@ -451,6 +451,7 @@ export class DatabaseUI extends DisposableObject {
     return withProgress(
       async (progress, token) => {
         await promptImportInternetDatabase(
+          this.app.commands,
           this.databaseManager,
           this.storagePath,
           progress,
@@ -470,6 +471,7 @@ export class DatabaseUI extends DisposableObject {
         const credentials = isCanary() ? this.app.credentials : undefined;
 
         await promptImportGithubDatabase(
+          this.app.commands,
           this.databaseManager,
           this.storagePath,
           credentials,
@@ -607,6 +609,7 @@ export class DatabaseUI extends DisposableObject {
           // Assume user has selected an archive if the file has a .zip extension
           if (uri.path.endsWith(".zip")) {
             await importArchiveDatabase(
+              this.app.commands,
               uri.toString(true),
               this.databaseManager,
               this.storagePath,
@@ -762,6 +765,7 @@ export class DatabaseUI extends DisposableObject {
       // we are selecting a database archive. Must unzip into a workspace-controlled area
       // before importing.
       return await importArchiveDatabase(
+        this.app.commands,
         uri.toString(true),
         this.databaseManager,
         this.storagePath,

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

@@ -28,6 +28,7 @@ import { redactableError } from "./pure/errors";
 import { isCodespacesTemplate } from "./config";
 import { QlPackGenerator } from "./qlpack-generator";
 import { QueryLanguage } from "./common/query-language";
+import { App } from "./common/app";
 
 /**
  * databases.ts
@@ -593,6 +594,7 @@ export class DatabaseManager extends DisposableObject {
 
   constructor(
     private readonly ctx: ExtensionContext,
+    private readonly app: App,
     private readonly qs: QueryRunner,
     private readonly cli: cli.CodeQLCliServer,
     public logger: Logger,
@@ -875,7 +877,7 @@ export class DatabaseManager extends DisposableObject {
       this._currentDatabaseItem = item;
       this.updatePersistedCurrentDatabaseItem();
 
-      await vscode.commands.executeCommand(
+      await this.app.commands.execute(
         "setContext",
         "codeQL.currentDatabaseItem",
         item?.name,