Use only one command

Author: norascheuch

extensions/ql-vscode/package.json

@@ -405,10 +405,6 @@
         "command": "codeQL.runQueryContextEditor",
         "title": "CodeQL: Run Query on Selected Database"
       },
-      {
-        "command": "codeQLQueries.runLocalQueryFromQueriesPanel",
-        "title": "Run Query on Selected Database"
-      },
       {
         "command": "codeQL.debugQuery",
         "title": "CodeQL: Debug Query"
@@ -506,7 +502,7 @@
         "title": "CodeQL: Copy Version Information"
       },
       {
-        "command": "codeQLQueries.runLocalQueryContextInline",
+        "command": "codeQL.runLocalQueryFromQueriesPanel",
         "title": "Run local query",
         "icon": "$(run)"
       },
@@ -1105,7 +1101,7 @@
           "when": "viewItem == remoteResultsItem"
         },
         {
-          "command": "codeQLQueries.runLocalQueryContextInline",
+          "command": "codeQL.runLocalQueryFromQueriesPanel",
           "group": "inline",
           "when": "view == codeQLQueries && viewItem == queryFile && codeQL.currentDatabaseItem"
         },
@@ -1169,7 +1165,7 @@
           "when": "resourceLangId == ql && resourceExtname == .ql"
         },
         {
-          "command": "codeQLQueries.runLocalQueryFromQueriesPanel",
+          "command": "codeQL.runLocalQueryFromQueriesPanel",
           "when": "false"
         },
         {
@@ -1292,10 +1288,6 @@
           "command": "codeQL.openDataExtensionsEditor",
           "when": "config.codeQL.canary && config.codeQL.dataExtensions.editor"
         },
-        {
-          "command": "codeQLQueries.runLocalQueryContextInline",
-          "when": "false"
-        },
         {
           "command": "codeQLVariantAnalysisRepositories.openConfigFile",
           "when": "false"

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

@@ -3,7 +3,7 @@ import { Disposable } from "./disposable-object";
 import { AppEventEmitter } from "./events";
 import { NotificationLogger } from "./logging";
 import { Memento } from "./memento";
-import { AppCommandManager, QueryServerCommandManager } from "./commands";
+import { AppCommandManager } from "./commands";
 import { AppTelemetry } from "./telemetry";
 
 export interface App {
@@ -18,7 +18,6 @@ export interface App {
   readonly workspaceState: Memento;
   readonly credentials: Credentials;
   readonly commands: AppCommandManager;
-  readonly queryServerCommands: QueryServerCommandManager;
   readonly environment: EnvironmentContext;
 }
 

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

@@ -130,7 +130,7 @@ export type LocalQueryCommands = {
   "codeQL.runQueryOnMultipleDatabasesContextEditor": (
     uri?: Uri,
   ) => Promise<void>;
-  "codeQLQueries.runLocalQueryFromQueriesPanel": (uri?: Uri) => Promise<void>;
+  "codeQL.runLocalQueryFromQueriesPanel": TreeViewContextSingleSelectionCommandFunction<QueryTreeViewItem>;
   "codeQL.runQueries": ExplorerSelectionCommandFunction<Uri>;
   "codeQL.quickEval": (uri: Uri) => Promise<void>;
   "codeQL.quickEvalContextEditor": (uri: Uri) => Promise<void>;
@@ -266,10 +266,6 @@ export type VariantAnalysisCommands = {
   "codeQL.runVariantAnalysisContextEditor": (uri?: Uri) => Promise<void>;
 };
 
-export type QueriesPanelCommands = {
-  "codeQLQueries.runLocalQueryContextInline": TreeViewContextSingleSelectionCommandFunction<QueryTreeViewItem>;
-};
-
 export type DatabasePanelCommands = {
   "codeQLVariantAnalysisRepositories.openConfigFile": () => Promise<void>;
   "codeQLVariantAnalysisRepositories.addNewDatabase": () => Promise<void>;
@@ -339,7 +335,6 @@ export type AllExtensionCommands = BaseCommands &
   QueryHistoryCommands &
   LocalDatabasesCommands &
   DebuggerCommands &
-  QueriesPanelCommands &
   VariantAnalysisCommands &
   DatabasePanelCommands &
   AstCfgCommands &

extensions/ql-vscode/src/extension.ts

@@ -779,7 +779,7 @@ async function activateWithInstalledDistribution(
   );
   ctx.subscriptions.push(databaseUI);
 
-  const queriesModule = QueriesModule.initialize(app, cliServer);
+  QueriesModule.initialize(app, cliServer);
 
   void extLogger.log("Initializing evaluator log viewer.");
   const evalLogViewer = new EvalLogViewer();
@@ -1011,7 +1011,6 @@ async function activateWithInstalledDistribution(
     }),
     ...localQueryResultsView.getCommands(),
     ...qhm.getCommands(),
-    ...queriesModule.getCommands(),
     ...variantAnalysisManager.getCommands(),
     ...databaseUI.getCommands(),
     ...dbModule.getCommands(),

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

@@ -48,6 +48,7 @@ import { SkeletonQueryWizard } from "../skeleton-query-wizard";
 import { LocalQueryRun } from "./local-query-run";
 import { createMultiSelectionCommand } from "../common/vscode/selection-commands";
 import { findLanguage } from "../codeql-cli/query-language";
+import { QueryTreeViewItem } from "../queries-panel/query-tree-view-item";
 
 interface DatabaseQuickPickItem extends QuickPickItem {
   databaseItem: DatabaseItem;
@@ -100,7 +101,8 @@ export class LocalQueries extends DisposableObject {
         this.runQueryOnMultipleDatabases.bind(this),
       "codeQL.runQueryOnMultipleDatabasesContextEditor":
         this.runQueryOnMultipleDatabases.bind(this),
-      "codeQLQueries.runLocalQueryFromQueriesPanel": this.runQuery.bind(this),
+      "codeQL.runLocalQueryFromQueriesPanel":
+        this.runQueryFromQueriesPanel.bind(this),
       "codeQL.runQueries": createMultiSelectionCommand(
         this.runQueries.bind(this),
       ),
@@ -119,6 +121,12 @@ export class LocalQueries extends DisposableObject {
     };
   }
 
+  private async runQueryFromQueriesPanel(
+    queryTreeViewItem: QueryTreeViewItem,
+  ): Promise<void> {
+    await this.runQuery(Uri.file(queryTreeViewItem.path));
+  }
+
   private async runQuery(uri: Uri | undefined): Promise<void> {
     await withProgress(
       async (progress, token) => {

extensions/ql-vscode/src/queries-panel/queries-module.ts

@@ -6,7 +6,6 @@ import { DisposableObject } from "../common/disposable-object";
 import { QueriesPanel } from "./queries-panel";
 import { QueryDiscovery } from "./query-discovery";
 import { QueryPackDiscovery } from "./query-pack-discovery";
-import { QueriesPanelCommands } from "../common/commands";
 
 export class QueriesModule extends DisposableObject {
   private queriesPanel: QueriesPanel | undefined;
@@ -26,24 +25,10 @@ export class QueriesModule extends DisposableObject {
     return queriesModule;
   }
 
-  public getCommands(): QueriesPanelCommands {
-    if (!this.shouldInitializeQueriesPanel()) {
-      return {
-        "codeQLQueries.runLocalQueryContextInline": () => Promise.resolve(),
-      };
-    }
-
-    if (!this.queriesPanel) {
-      throw new Error("Queries panel not initialized");
-    }
-
-    return {
-      ...this.queriesPanel.getCommands(),
-    };
-  }
-
   private initialize(app: App, cliServer: CodeQLCliServer): void {
-    if (!this.shouldInitializeQueriesPanel) {
+    // Currently, we only want to expose the new panel when we are in canary mode
+    // and the user has enabled the "Show queries panel" flag.
+    if (!isCanary() || !showQueriesPanel()) {
       return;
     }
     void extLogger.log("Initializing queries panel.");
@@ -59,13 +44,7 @@ export class QueriesModule extends DisposableObject {
     this.push(queryDiscovery);
     void queryDiscovery.initialRefresh();
 
-    this.queriesPanel = new QueriesPanel(app, queryDiscovery);
+    this.queriesPanel = new QueriesPanel(queryDiscovery);
     this.push(this.queriesPanel);
   }
-
-  private shouldInitializeQueriesPanel(): boolean {
-    // Currently, we only want to expose the new panel when we are in canary mode
-    // and the user has enabled the "Show queries panel" flag.
-    return isCanary() && showQueriesPanel();
-  }
 }

extensions/ql-vscode/src/queries-panel/queries-panel.ts

@@ -1,16 +1,10 @@
 import { DisposableObject } from "../common/disposable-object";
 import { QueryTreeDataProvider } from "./query-tree-data-provider";
 import { QueryDiscovery } from "./query-discovery";
-import { QueriesPanelCommands } from "../common/commands";
-import { QueryTreeViewItem } from "./query-tree-view-item";
-import { App } from "../common/app";
-import { Uri, window } from "vscode";
+import { window } from "vscode";
 
 export class QueriesPanel extends DisposableObject {
-  public constructor(
-    private readonly app: App,
-    queryDiscovery: QueryDiscovery,
-  ) {
+  public constructor(queryDiscovery: QueryDiscovery) {
     super();
 
     const dataProvider = new QueryTreeDataProvider(queryDiscovery);
@@ -20,19 +14,4 @@ export class QueriesPanel extends DisposableObject {
     });
     this.push(treeView);
   }
-
-  public getCommands(): QueriesPanelCommands {
-    return {
-      "codeQLQueries.runLocalQueryContextInline": this.runLocalQuery.bind(this),
-    };
-  }
-
-  private async runLocalQuery(
-    queryTreeViewItem: QueryTreeViewItem,
-  ): Promise<void> {
-    await this.app.queryServerCommands.execute(
-      "codeQLQueries.runLocalQueryFromQueriesPanel",
-      Uri.file(queryTreeViewItem.path),
-    );
-  }
 }

extensions/ql-vscode/test/__mocks__/appMock.ts

@@ -6,10 +6,7 @@ import { createMockLogger } from "./loggerMock";
 import { createMockMemento } from "../mock-memento";
 import { testCredentialsWithStub } from "../factories/authentication";
 import { Credentials } from "../../src/common/authentication";
-import {
-  AppCommandManager,
-  QueryServerCommandManager,
-} from "../../src/common/commands";
+import { AppCommandManager } from "../../src/common/commands";
 import { createMockCommandManager } from "./commandsMock";
 import { NotificationLogger } from "../../src/common/logging";
 import { AppTelemetry } from "../../src/common/telemetry";
@@ -23,7 +20,6 @@ export function createMockApp({
   workspaceState = createMockMemento(),
   credentials = testCredentialsWithStub(),
   commands = createMockCommandManager(),
-  queryServerCommands = createMockCommandManager(),
   environment = createMockEnvironmentContext(),
   logger = createMockLogger(),
   telemetry = createMockTelemetryReporter(),
@@ -35,7 +31,6 @@ export function createMockApp({
   workspaceState?: Memento;
   credentials?: Credentials;
   commands?: AppCommandManager;
-  queryServerCommands?: QueryServerCommandManager;
   environment?: EnvironmentContext;
   logger?: NotificationLogger;
   telemetry?: AppTelemetry;
@@ -52,7 +47,6 @@ export function createMockApp({
     createEventEmitter,
     credentials,
     commands,
-    queryServerCommands,
     environment,
   };
 }

extensions/ql-vscode/test/__mocks__/commandsMock.ts

@@ -1,14 +1,13 @@
+import { AppCommandManager } from "../../src/common/commands";
 import { CommandFunction, CommandManager } from "../../src/packages/commands";
 import { Disposable } from "../../src/packages/commands/Disposable";
 
-export function createMockCommandManager<
-  Commands extends Record<string, CommandFunction>,
->({
+export function createMockCommandManager({
   registerCommand = jest.fn(),
   executeCommand = jest.fn(),
 }: {
   registerCommand?: (commandName: string, fn: CommandFunction) => Disposable;
   executeCommand?: (commandName: string, ...args: any[]) => Promise<any>;
-} = {}): CommandManager<Commands> {
-  return new CommandManager<Commands>(registerCommand, executeCommand);
+} = {}): AppCommandManager {
+  return new CommandManager(registerCommand, executeCommand);
 }

extensions/ql-vscode/test/unit-tests/command-lint.test.ts

@@ -41,7 +41,6 @@ describe("commands declared in package.json", () => {
       command.match(/^codeQLDatabases\./) ||
       command.match(/^codeQLVariantAnalysisRepositories\./) ||
       command.match(/^codeQLQueryHistory\./) ||
-      command.match(/^codeQLQueries\./) ||
       command.match(/^codeQLAstViewer\./) ||
       command.match(/^codeQLEvalLogViewer\./) ||
       command.match(/^codeQLTests\./)