Merge pull request #2206 from github/koesie10/test-ui-typed-commands

Convert test UI commands to typed commands

Author: koesie10

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

@@ -5,6 +5,7 @@ import type { DbTreeViewItem } from "../databases/ui/db-tree-view-item";
 import type { DatabaseItem } from "../local-databases";
 import type { QueryHistoryInfo } from "../query-history/query-history-info";
 import type { RepositoriesFilterSortStateWithIds } from "../pure/variant-analysis-filter-sort";
+import type { TestTreeNode } from "../test-tree-node";
 import type {
   VariantAnalysis,
   VariantAnalysisScannedRepository,
@@ -204,6 +205,11 @@ export type SummaryLanguageSupportCommands = {
   "codeQL.gotoQL": () => Promise<void>;
 };
 
+export type TestUICommands = {
+  "codeQLTests.showOutputDifferences": (node: TestTreeNode) => Promise<void>;
+  "codeQLTests.acceptOutput": (node: TestTreeNode) => Promise<void>;
+};
+
 export type MockGitHubApiServerCommands = {
   "codeQL.mockGitHubApiServer.startRecording": () => Promise<void>;
   "codeQL.mockGitHubApiServer.saveScenario": () => Promise<void>;
@@ -223,6 +229,7 @@ export type AllCommands = BaseCommands &
   PackagingCommands &
   EvalLogViewerCommands &
   SummaryLanguageSupportCommands &
+  Partial<TestUICommands> &
   MockGitHubApiServerCommands;
 
 export type AppCommandManager = CommandManager<AllCommands>;

extensions/ql-vscode/src/extension.ts

@@ -116,6 +116,7 @@ import {
   AllCommands,
   BaseCommands,
   QueryServerCommands,
+  TestUICommands,
 } from "./common/commands";
 import {
   getLocalQueryCommands,
@@ -796,6 +797,7 @@ async function activateWithInstalledDistribution(
   const testExplorerExtension = extensions.getExtension<TestHub>(
     testExplorerExtensionId,
   );
+  let testUiCommands: Partial<TestUICommands> = {};
   if (testExplorerExtension) {
     const testHub = testExplorerExtension.exports;
     const testAdapterFactory = new QLTestAdapterFactory(
@@ -807,6 +809,8 @@ async function activateWithInstalledDistribution(
 
     const testUIService = new TestUIService(testHub);
     ctx.subscriptions.push(testUIService);
+
+    testUiCommands = testUIService.getCommands();
   }
 
   const astViewer = new AstViewer();
@@ -851,6 +855,7 @@ async function activateWithInstalledDistribution(
     }),
     ...evalLogViewer.getCommands(),
     ...summaryLanguageSupport.getCommands(),
+    ...testUiCommands,
     ...mockServer.getCommands(),
   };
 

extensions/ql-vscode/src/packages/commands/CommandManager.ts

@@ -30,7 +30,7 @@ export class CommandManager<
   constructor(
     private readonly commandRegister: <T extends CommandName>(
       commandName: T,
-      fn: Commands[T],
+      fn: NonNullable<Commands[T]>,
     ) => Disposable,
     private readonly commandExecute: <T extends CommandName>(
       commandName: T,
@@ -43,7 +43,7 @@ export class CommandManager<
    */
   register<T extends CommandName>(
     commandName: T,
-    definition: Commands[T],
+    definition: NonNullable<Commands[T]>,
   ): void {
     this.commands.push(this.commandRegister(commandName, definition));
   }

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

@@ -14,9 +14,8 @@ import {
 import { showAndLogWarningMessage } from "./helpers";
 import { TestTreeNode } from "./test-tree-node";
 import { DisposableObject } from "./pure/disposable-object";
-import { UIService } from "./vscode-utils/ui-service";
 import { QLTestAdapter, getExpectedFile, getActualFile } from "./test-adapter";
-import { extLogger } from "./common";
+import { TestUICommands } from "./common/commands";
 
 type VSCodeTestEvent =
   | TestRunStartedEvent
@@ -42,22 +41,23 @@ class QLTestListener extends DisposableObject {
 /**
  * Service that implements all UI and commands for QL tests.
  */
-export class TestUIService extends UIService implements TestController {
+export class TestUIService extends DisposableObject implements TestController {
   private readonly listeners: Map<TestAdapter, QLTestListener> = new Map();
 
   constructor(private readonly testHub: TestHub) {
     super();
 
-    void extLogger.log("Registering CodeQL test panel commands.");
-    this.registerCommand(
-      "codeQLTests.showOutputDifferences",
-      this.showOutputDifferences,
-    );
-    this.registerCommand("codeQLTests.acceptOutput", this.acceptOutput);
-
     testHub.registerTestController(this);
   }
 
+  public getCommands(): TestUICommands {
+    return {
+      "codeQLTests.showOutputDifferences":
+        this.showOutputDifferences.bind(this),
+      "codeQLTests.acceptOutput": this.acceptOutput.bind(this),
+    };
+  }
+
   public dispose(): void {
     this.testHub.unregisterTestController(this);