Merge pull request #2209 from github/koesie10/query-editor-typed-commands

Convert query editing commands to typed commands

Author: koesie10

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

@@ -39,6 +39,18 @@ export type BaseCommands = {
   "codeQL.restartQueryServer": () => Promise<void>;
 };
 
+// Commands used when working with queries in the editor
+export type QueryEditorCommands = {
+  "codeQL.openReferencedFile": (selectedQuery: Uri) => Promise<void>;
+  "codeQL.openReferencedFileContextEditor": (
+    selectedQuery: Uri,
+  ) => Promise<void>;
+  "codeQL.openReferencedFileContextExplorer": (
+    selectedQuery: Uri,
+  ) => Promise<void>;
+  "codeQL.previewQueryHelp": (selectedQuery: Uri) => Promise<void>;
+};
+
 // Commands used for running local queries
 export type LocalQueryCommands = {
   "codeQL.runQuery": (uri?: Uri) => Promise<void>;
@@ -219,6 +231,7 @@ export type MockGitHubApiServerCommands = {
 };
 
 export type AllCommands = BaseCommands &
+  QueryEditorCommands &
   ResultsViewCommands &
   QueryHistoryCommands &
   LocalDatabasesCommands &

extensions/ql-vscode/src/extension.ts

@@ -11,13 +11,12 @@ import {
   Uri,
   version as vscodeVersion,
   window as Window,
-  window,
   workspace,
 } from "vscode";
 import { LanguageClient } from "vscode-languageclient/node";
 import { arch, platform } from "os";
 import { ensureDir } from "fs-extra";
-import { basename, join } from "path";
+import { join } from "path";
 import { dirSync } from "tmp-promise";
 import { testExplorerExtensionId, TestHub } from "vscode-test-adapter-api";
 import { lt, parse } from "semver";
@@ -111,7 +110,6 @@ import { ExtensionApp } from "./common/vscode/vscode-app";
 import { DbModule } from "./databases/db-module";
 import { redactableError } from "./pure/errors";
 import { QueryHistoryDirs } from "./query-history/query-history-dirs";
-import { DirResult } from "tmp";
 import {
   AllCommands,
   BaseCommands,
@@ -123,6 +121,7 @@ import {
   showResultsForCompletedQuery,
 } from "./local-queries";
 import { getAstCfgCommands } from "./ast-cfg-commands";
+import { getQueryEditorCommands } from "./query-editor";
 
 /**
  * extension.ts
@@ -834,6 +833,11 @@ async function activateWithInstalledDistribution(
 
   const allCommands: AllCommands = {
     ...getCommands(cliServer, qs),
+    ...getQueryEditorCommands({
+      queryRunner: qs,
+      cliServer,
+      qhelpTmpDir: qhelpTmpDir.name,
+    }),
     ...localQueryResultsView.getCommands(),
     ...qhm.getCommands(),
     ...variantAnalysisManager.getCommands(),
@@ -883,38 +887,6 @@ async function activateWithInstalledDistribution(
     );
   }
 
-  ctx.subscriptions.push(
-    commandRunner("codeQL.openReferencedFile", async (selectedQuery: Uri) => {
-      await openReferencedFile(qs, cliServer, selectedQuery);
-    }),
-  );
-
-  // Since we are tracking extension usage through commands, this command mirrors the "codeQL.openReferencedFile" command
-  ctx.subscriptions.push(
-    commandRunner(
-      "codeQL.openReferencedFileContextEditor",
-      async (selectedQuery: Uri) => {
-        await openReferencedFile(qs, cliServer, selectedQuery);
-      },
-    ),
-  );
-
-  // Since we are tracking extension usage through commands, this command mirrors the "codeQL.openReferencedFile" command
-  ctx.subscriptions.push(
-    commandRunner(
-      "codeQL.openReferencedFileContextExplorer",
-      async (selectedQuery: Uri) => {
-        await openReferencedFile(qs, cliServer, selectedQuery);
-      },
-    ),
-  );
-
-  ctx.subscriptions.push(
-    commandRunner("codeQL.previewQueryHelp", async (selectedQuery: Uri) => {
-      await previewQueryHelp(cliServer, qhelpTmpDir, selectedQuery);
-    }),
-  );
-
   ctx.subscriptions.push(
     commandRunner("codeQL.copyVersion", async () => {
       const text = `CodeQL extension version: ${
@@ -1020,51 +992,6 @@ async function showResultsForComparison(
   }
 }
 
-async function previewQueryHelp(
-  cliServer: CodeQLCliServer,
-  qhelpTmpDir: DirResult,
-  selectedQuery: Uri,
-): Promise<void> {
-  // selectedQuery is unpopulated when executing through the command palette
-  const pathToQhelp = selectedQuery
-    ? selectedQuery.fsPath
-    : window.activeTextEditor?.document.uri.fsPath;
-  if (pathToQhelp) {
-    // Create temporary directory
-    const relativePathToMd = `${basename(pathToQhelp, ".qhelp")}.md`;
-    const absolutePathToMd = join(qhelpTmpDir.name, relativePathToMd);
-    const uri = Uri.file(absolutePathToMd);
-    try {
-      await cliServer.generateQueryHelp(pathToQhelp, absolutePathToMd);
-      await commands.executeCommand("markdown.showPreviewToSide", uri);
-    } catch (e) {
-      const errorMessage = getErrorMessage(e).includes(
-        "Generating qhelp in markdown",
-      )
-        ? redactableError`Could not generate markdown from ${pathToQhelp}: Bad formatting in .qhelp file.`
-        : redactableError`Could not open a preview of the generated file (${absolutePathToMd}).`;
-      void showAndLogExceptionWithTelemetry(errorMessage, {
-        fullMessage: `${errorMessage}\n${getErrorMessage(e)}`,
-      });
-    }
-  }
-}
-
-async function openReferencedFile(
-  qs: QueryRunner,
-  cliServer: CodeQLCliServer,
-  selectedQuery: Uri,
-): Promise<void> {
-  // If no file is selected, the path of the file in the editor is selected
-  const path =
-    selectedQuery?.fsPath || window.activeTextEditor?.document.uri.fsPath;
-  if (qs !== undefined && path) {
-    const resolved = await cliServer.resolveQlref(path);
-    const uri = Uri.file(resolved.resolvedPath);
-    await window.showTextDocument(uri, { preview: false });
-  }
-}
-
 function addUnhandledRejectionListener() {
   const handler = (error: unknown) => {
     // This listener will be triggered for errors from other extensions as

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

@@ -0,0 +1,79 @@
+import { commands, Uri, window } from "vscode";
+import { CodeQLCliServer } from "./cli";
+import { QueryRunner } from "./queryRunner";
+import { basename, join } from "path";
+import { getErrorMessage } from "./pure/helpers-pure";
+import { redactableError } from "./pure/errors";
+import { showAndLogExceptionWithTelemetry } from "./helpers";
+import { QueryEditorCommands } from "./common/commands";
+
+type QueryEditorOptions = {
+  queryRunner: QueryRunner;
+  cliServer: CodeQLCliServer;
+
+  qhelpTmpDir: string;
+};
+
+export function getQueryEditorCommands({
+  queryRunner,
+  cliServer,
+  qhelpTmpDir,
+}: QueryEditorOptions): QueryEditorCommands {
+  const openReferencedFileCommand = async (selectedQuery: Uri) =>
+    await openReferencedFile(queryRunner, cliServer, selectedQuery);
+
+  return {
+    "codeQL.openReferencedFile": openReferencedFileCommand,
+    // Since we are tracking extension usage through commands, this command mirrors the "codeQL.openReferencedFile" command
+    "codeQL.openReferencedFileContextEditor": openReferencedFileCommand,
+    // Since we are tracking extension usage through commands, this command mirrors the "codeQL.openReferencedFile" command
+    "codeQL.openReferencedFileContextExplorer": openReferencedFileCommand,
+    "codeQL.previewQueryHelp": async (selectedQuery: Uri) =>
+      await previewQueryHelp(cliServer, qhelpTmpDir, selectedQuery),
+  };
+}
+
+async function previewQueryHelp(
+  cliServer: CodeQLCliServer,
+  qhelpTmpDir: string,
+  selectedQuery: Uri,
+): Promise<void> {
+  // selectedQuery is unpopulated when executing through the command palette
+  const pathToQhelp = selectedQuery
+    ? selectedQuery.fsPath
+    : window.activeTextEditor?.document.uri.fsPath;
+  if (pathToQhelp) {
+    // Create temporary directory
+    const relativePathToMd = `${basename(pathToQhelp, ".qhelp")}.md`;
+    const absolutePathToMd = join(qhelpTmpDir, relativePathToMd);
+    const uri = Uri.file(absolutePathToMd);
+    try {
+      await cliServer.generateQueryHelp(pathToQhelp, absolutePathToMd);
+      await commands.executeCommand("markdown.showPreviewToSide", uri);
+    } catch (e) {
+      const errorMessage = getErrorMessage(e).includes(
+        "Generating qhelp in markdown",
+      )
+        ? redactableError`Could not generate markdown from ${pathToQhelp}: Bad formatting in .qhelp file.`
+        : redactableError`Could not open a preview of the generated file (${absolutePathToMd}).`;
+      void showAndLogExceptionWithTelemetry(errorMessage, {
+        fullMessage: `${errorMessage}\n${getErrorMessage(e)}`,
+      });
+    }
+  }
+}
+
+async function openReferencedFile(
+  qs: QueryRunner,
+  cliServer: CodeQLCliServer,
+  selectedQuery: Uri,
+): Promise<void> {
+  // If no file is selected, the path of the file in the editor is selected
+  const path =
+    selectedQuery?.fsPath || window.activeTextEditor?.document.uri.fsPath;
+  if (qs !== undefined && path) {
+    const resolved = await cliServer.resolveQlref(path);
+    const uri = Uri.file(resolved.resolvedPath);
+    await window.showTextDocument(uri, { preview: false });
+  }
+}