Merge pull request #2357 from github/charisk-nora/query-server-move

Move Query Server files

extensions/ql-vscode/src/contextual/locationFinder.ts

@@ -20,7 +20,7 @@ import {
 } from "./queryResolver";
 import { CancellationToken, LocationLink, Uri } from "vscode";
 import { QueryOutputDir } from "../run-queries-shared";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import { QueryResultType } from "../pure/new-messages";
 
 export const SELECT_QUERY_NAME = "#select";

extensions/ql-vscode/src/contextual/queryResolver.ts

@@ -16,7 +16,7 @@ import { DatabaseItem } from "../local-databases";
 import { extLogger, TeeLogger } from "../common";
 import { CancellationToken } from "vscode";
 import { ProgressCallback } from "../progress";
-import { CoreCompletedQuery, QueryRunner } from "../queryRunner";
+import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { redactableError } from "../pure/errors";
 import { QLPACK_FILENAMES } from "../pure/ql";
 

extensions/ql-vscode/src/contextual/templateProvider.ts

@@ -32,7 +32,7 @@ import {
   runContextualQuery,
 } from "./queryResolver";
 import { isCanary, NO_CACHE_AST_VIEWER } from "../config";
-import { CoreCompletedQuery, QueryRunner } from "../queryRunner";
+import { CoreCompletedQuery, QueryRunner } from "../query-server";
 
 /**
  * Runs templated CodeQL queries to find definitions in

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

@@ -2,7 +2,7 @@ import { ExtensionContext } from "vscode";
 import { DataExtensionsEditorView } from "./data-extensions-editor-view";
 import { DataExtensionsEditorCommands } from "../common/commands";
 import { CliVersionConstraint, CodeQLCliServer } from "../cli";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import { DatabaseManager } from "../local-databases";
 import { ensureDir } from "fs-extra";
 import { join } from "path";

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

@@ -13,7 +13,7 @@ import {
   ToDataExtensionsEditorMessage,
 } from "../pure/interface-types";
 import { ProgressUpdate } from "../progress";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import {
   showAndLogErrorMessage,
   showAndLogExceptionWithTelemetry,

extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts

@@ -1,4 +1,4 @@
-import { CoreCompletedQuery, QueryRunner } from "../queryRunner";
+import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { dir } from "tmp-promise";
 import { writeFile } from "fs-extra";
 import { dump as dumpYaml } from "js-yaml";

extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts

@@ -1,7 +1,7 @@
 import { CancellationToken } from "vscode";
 import { DatabaseItem } from "../local-databases";
 import { join } from "path";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import { CodeQLCliServer } from "../cli";
 import { TeeLogger } from "../common";
 import { extensiblePredicateDefinitions } from "./predicates";

extensions/ql-vscode/src/debugger/debug-session.ts

@@ -14,7 +14,7 @@ import { Disposable } from "vscode";
 import { CancellationTokenSource } from "vscode-jsonrpc";
 import { BaseLogger, LogOptions, queryServerLogger } from "../common";
 import { QueryResultType } from "../pure/new-messages";
-import { CoreQueryResults, CoreQueryRun, QueryRunner } from "../queryRunner";
+import { CoreQueryResults, CoreQueryRun, QueryRunner } from "../query-server";
 import * as CodeQLProtocol from "./debug-protocol";
 import { QuickEvalContext } from "../run-queries-shared";
 import { getErrorMessage } from "../pure/helpers-pure";

extensions/ql-vscode/src/debugger/debugger-factory.ts

@@ -11,7 +11,7 @@ import {
 import { isCanary } from "../config";
 import { LocalQueries } from "../local-queries";
 import { DisposableObject } from "../pure/disposable-object";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import { QLDebugConfigurationProvider } from "./debug-configuration";
 import { QLDebugSession } from "./debug-session";
 

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

@@ -10,7 +10,7 @@ import {
 import { DebuggerCommands } from "../common/commands";
 import { DatabaseManager } from "../local-databases";
 import { DisposableObject } from "../pure/disposable-object";
-import { CoreQueryResults } from "../queryRunner";
+import { CoreQueryResults } from "../query-server";
 import {
   getQuickEvalContext,
   QueryOutputDir,

extensions/ql-vscode/src/extension.ts

@@ -83,8 +83,10 @@ import {
 } from "./common";
 import { QueryHistoryManager } from "./query-history/query-history-manager";
 import { CompletedLocalQueryInfo } from "./query-results";
-import { QueryServerClient as LegacyQueryServerClient } from "./legacy-query-server/queryserver-client";
-import { QueryServerClient } from "./query-server/queryserver-client";
+import {
+  LegacyQueryRunner,
+  QueryServerClient as LegacyQueryServerClient,
+} from "./query-server/legacy";
 import { QLTestAdapterFactory } from "./test-adapter";
 import { TestUIService } from "./test-ui";
 import { CompareView } from "./compare/compare-view";
@@ -97,9 +99,6 @@ import { EvalLogViewer } from "./eval-log-viewer";
 import { SummaryLanguageSupport } from "./log-insights/summary-language-support";
 import { JoinOrderScannerProvider } from "./log-insights/join-order";
 import { LogScannerService } from "./log-insights/log-scanner-service";
-import { LegacyQueryRunner } from "./legacy-query-server/legacyRunner";
-import { NewQueryRunner } from "./query-server/query-runner";
-import { QueryRunner } from "./queryRunner";
 import { VariantAnalysisView } from "./variant-analysis/variant-analysis-view";
 import { VariantAnalysisViewSerializer } from "./variant-analysis/variant-analysis-view-serializer";
 import { VariantAnalysisManager } from "./variant-analysis/variant-analysis-manager";
@@ -127,6 +126,7 @@ import { DataExtensionsEditorModule } from "./data-extensions-editor/data-extens
 import { TestManager } from "./test-manager";
 import { TestRunner } from "./test-runner";
 import { TestManagerBase } from "./test-manager-base";
+import { NewQueryRunner, QueryRunner, QueryServerClient } from "./query-server";
 
 /**
  * extension.ts

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

@@ -41,7 +41,7 @@ import {
   promptImportInternetDatabase,
 } from "./databaseFetcher";
 import { asError, asyncFilter, getErrorMessage } from "./pure/helpers-pure";
-import { QueryRunner } from "./queryRunner";
+import { QueryRunner } from "./query-server";
 import { isCanary } from "./config";
 import { App } from "./common/app";
 import { redactableError } from "./pure/errors";

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

@@ -23,7 +23,7 @@ import {
 import { DisposableObject } from "./pure/disposable-object";
 import { Logger, extLogger } from "./common";
 import { asError, getErrorMessage } from "./pure/helpers-pure";
-import { QueryRunner } from "./queryRunner";
+import { QueryRunner } from "./query-server";
 import { pathsEqual } from "./pure/files";
 import { redactableError } from "./pure/errors";
 import { isCodespacesTemplate } from "./config";

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

@@ -21,7 +21,7 @@ import {
   showBinaryChoiceDialog,
 } from "../helpers";
 import { displayQuickQuery } from "../quick-query";
-import { CoreCompletedQuery, QueryRunner } from "../queryRunner";
+import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { QueryHistoryManager } from "../query-history/query-history-manager";
 import { DatabaseUI } from "../local-databases-ui";
 import { ResultsView } from "../interface";

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

@@ -4,7 +4,7 @@ import {
   showAndLogWarningMessage,
   tryGetQueryMetadata,
 } from "../helpers";
-import { CoreQueryResults } from "../queryRunner";
+import { CoreQueryResults } from "../query-server";
 import { QueryHistoryManager } from "../query-history/query-history-manager";
 import { DatabaseItem } from "../local-databases";
 import {

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

@@ -1,6 +1,6 @@
 import { Uri, window } from "vscode";
 import { CodeQLCliServer } from "./cli";
-import { QueryRunner } from "./queryRunner";
+import { QueryRunner } from "./query-server";
 import { basename, join } from "path";
 import { getErrorMessage } from "./pure/helpers-pure";
 import { redactableError } from "./pure/errors";

extensions/ql-vscode/src/query-history/query-history-manager.ts

@@ -49,7 +49,7 @@ import { EvalLogViewer } from "../eval-log-viewer";
 import EvalLogTreeBuilder from "../eval-log-tree-builder";
 import { EvalLogData, parseViewerData } from "../pure/log-summary-parser";
 import { QueryWithResults } from "../run-queries-shared";
-import { QueryRunner } from "../queryRunner";
+import { QueryRunner } from "../query-server";
 import { VariantAnalysisManager } from "../variant-analysis/variant-analysis-manager";
 import { VariantAnalysisHistoryItem } from "./variant-analysis-history-item";
 import { getTotalResultCount } from "../variant-analysis/shared/variant-analysis";

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

@@ -21,7 +21,7 @@ import {
   QueryEvaluationInfo,
   QueryWithResults,
 } from "./run-queries-shared";
-import { formatLegacyMessage } from "./legacy-query-server/run-queries";
+import { formatLegacyMessage } from "./query-server/legacy";
 import { sarifParser } from "./sarif-parser";
 
 /**

extensions/ql-vscode/src/query-server/index.ts

@@ -0,0 +1,5 @@
+export * from "./new-query-runner";
+export * from "./query-runner";
+export * from "./query-server-client";
+export * from "./run-queries";
+export * from "./server-process";

extensions/ql-vscode/src/query-server/legacy/index.ts

@@ -0,0 +1,4 @@
+export * from "./legacy-query-runner";
+export * from "./query-server-client";
+export * from "./run-queries";
+export * from "./upgrades";

extensions/ql-vscode/src/query-server/legacy/legacy-query-runner.ts

@@ -1,16 +1,20 @@
 import { CancellationToken } from "vscode";
-import { CodeQLCliServer } from "../cli";
-import { ProgressCallback } from "../progress";
-import { Logger } from "../common";
-import { DatabaseItem } from "../local-databases";
+import { CodeQLCliServer } from "../../cli";
+import { ProgressCallback } from "../../progress";
+import { Logger } from "../../common";
+import { DatabaseItem } from "../../local-databases";
 import {
   Dataset,
   deregisterDatabases,
   registerDatabases,
-} from "../pure/legacy-messages";
-import { CoreQueryResults, CoreQueryTarget, QueryRunner } from "../queryRunner";
-import { QueryOutputDir } from "../run-queries-shared";
-import { QueryServerClient } from "./queryserver-client";
+} from "../../pure/legacy-messages";
+import {
+  CoreQueryResults,
+  CoreQueryTarget,
+  QueryRunner,
+} from "../query-runner";
+import { QueryOutputDir } from "../../run-queries-shared";
+import { QueryServerClient } from "./query-server-client";
 import {
   clearCacheInDatabase,
   compileAndRunQueryAgainstDatabaseCore,

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

@@ -1,21 +1,21 @@
 import { ensureFile } from "fs-extra";
 
-import { DisposableObject } from "../pure/disposable-object";
+import { DisposableObject } from "../../pure/disposable-object";
 import { CancellationToken } from "vscode";
 import { createMessageConnection, RequestType } from "vscode-jsonrpc/node";
-import * as cli from "../cli";
-import { QueryServerConfig } from "../config";
-import { Logger, ProgressReporter } from "../common";
+import * as cli from "../../cli";
+import { QueryServerConfig } from "../../config";
+import { Logger, ProgressReporter } from "../../common";
 import {
   completeQuery,
   EvaluationResult,
   progress,
   ProgressMessage,
   WithProgressId,
-} from "../pure/legacy-messages";
-import { ProgressCallback, ProgressTask } from "../progress";
-import { ServerProcess } from "../json-rpc-server";
-import { App } from "../common/app";
+} from "../../pure/legacy-messages";
+import { ProgressCallback, ProgressTask } from "../../progress";
+import { ServerProcess } from "../server-process";
+import { App } from "../../common/app";
 
 type WithProgressReporting = (
   task: (

extensions/ql-vscode/src/query-server/legacy/run-queries.ts

@@ -3,29 +3,29 @@ import { basename } from "path";
 import { CancellationToken, Uri } from "vscode";
 import { LSPErrorCodes, ResponseError } from "vscode-languageclient";
 
-import * as cli from "../cli";
+import * as cli from "../../cli";
 import {
   DatabaseContentsWithDbScheme,
   DatabaseItem,
   DatabaseResolver,
-} from "../local-databases";
+} from "../../local-databases";
 import {
   showAndLogExceptionWithTelemetry,
   showAndLogWarningMessage,
   upgradesTmpDir,
-} from "../helpers";
-import { ProgressCallback } from "../progress";
-import { QueryMetadata } from "../pure/interface-types";
-import { extLogger, Logger } from "../common";
-import * as messages from "../pure/legacy-messages";
-import * as newMessages from "../pure/new-messages";
-import * as qsClient from "./queryserver-client";
-import { asError, getErrorMessage } from "../pure/helpers-pure";
+} from "../../helpers";
+import { ProgressCallback } from "../../progress";
+import { QueryMetadata } from "../../pure/interface-types";
+import { extLogger, Logger } from "../../common";
+import * as messages from "../../pure/legacy-messages";
+import * as newMessages from "../../pure/new-messages";
+import * as qsClient from "./query-server-client";
+import { asError, getErrorMessage } from "../../pure/helpers-pure";
 import { compileDatabaseUpgradeSequence } from "./upgrades";
-import { QueryEvaluationInfo, QueryOutputDir } from "../run-queries-shared";
-import { redactableError } from "../pure/errors";
-import { CoreQueryResults, CoreQueryTarget } from "../queryRunner";
-import { Position } from "../pure/messages-shared";
+import { QueryEvaluationInfo, QueryOutputDir } from "../../run-queries-shared";
+import { redactableError } from "../../pure/errors";
+import { CoreQueryResults, CoreQueryTarget } from "../query-runner";
+import { Position } from "../../pure/messages-shared";
 
 export async function compileQuery(
   qs: qsClient.QueryServerClient,

extensions/ql-vscode/src/query-server/legacy/upgrades.ts

@@ -3,16 +3,16 @@ import {
   getOnDiskWorkspaceFolders,
   showAndLogExceptionWithTelemetry,
   tmpDir,
-} from "../helpers";
-import { ProgressCallback, UserCancellationException } from "../progress";
-import { extLogger } from "../common";
-import * as messages from "../pure/legacy-messages";
-import * as qsClient from "./queryserver-client";
+} from "../../helpers";
+import { ProgressCallback, UserCancellationException } from "../../progress";
+import { extLogger } from "../../common";
+import * as messages from "../../pure/legacy-messages";
+import * as qsClient from "./query-server-client";
 import * as tmp from "tmp-promise";
 import { dirname } from "path";
-import { DatabaseItem } from "../local-databases";
-import { asError, getErrorMessage } from "../pure/helpers-pure";
-import { redactableError } from "../pure/errors";
+import { DatabaseItem } from "../../local-databases";
+import { asError, getErrorMessage } from "../../pure/helpers-pure";
+import { redactableError } from "../../pure/errors";
 
 /**
  * Maximum number of lines to include from database upgrade message,

extensions/ql-vscode/src/query-server/new-query-runner.ts

@@ -0,0 +1,165 @@
+import { CancellationToken } from "vscode";
+import { ProgressCallback, UserCancellationException } from "../progress";
+import { DatabaseItem } from "../local-databases";
+import {
+  clearCache,
+  ClearCacheParams,
+  clearPackCache,
+  deregisterDatabases,
+  registerDatabases,
+  upgradeDatabase,
+} from "../pure/new-messages";
+import { CoreQueryResults, CoreQueryTarget, QueryRunner } from "./query-runner";
+import { QueryServerClient } from "./query-server-client";
+import { compileAndRunQueryAgainstDatabaseCore } from "./run-queries";
+import * as vscode from "vscode";
+import { getOnDiskWorkspaceFolders } from "../helpers";
+import { CodeQLCliServer } from "../cli";
+import { Logger } from "../common";
+import { QueryOutputDir } from "../run-queries-shared";
+
+export class NewQueryRunner extends QueryRunner {
+  constructor(public readonly qs: QueryServerClient) {
+    super();
+  }
+
+  get cliServer(): CodeQLCliServer {
+    return this.qs.cliServer;
+  }
+
+  get customLogDirectory(): string | undefined {
+    return this.qs.config.customLogDirectory;
+  }
+
+  get logger(): Logger {
+    return this.qs.logger;
+  }
+
+  async restartQueryServer(
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void> {
+    await this.qs.restartQueryServer(progress, token);
+  }
+
+  onStart(
+    callBack: (
+      progress: ProgressCallback,
+      token: CancellationToken,
+    ) => Promise<void>,
+  ) {
+    this.qs.onDidStartQueryServer(callBack);
+  }
+
+  async clearCacheInDatabase(
+    dbItem: DatabaseItem,
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void> {
+    if (dbItem.contents === undefined) {
+      throw new Error("Can't clear the cache in an invalid database.");
+    }
+
+    const db = dbItem.databaseUri.fsPath;
+    const params: ClearCacheParams = {
+      dryRun: false,
+      db,
+    };
+    await this.qs.sendRequest(clearCache, params, token, progress);
+  }
+
+  public async compileAndRunQueryAgainstDatabaseCore(
+    dbPath: string,
+    query: CoreQueryTarget,
+    additionalPacks: string[],
+    extensionPacks: string[] | undefined,
+    generateEvalLog: boolean,
+    outputDir: QueryOutputDir,
+    progress: ProgressCallback,
+    token: CancellationToken,
+    templates: Record<string, string> | undefined,
+    logger: Logger,
+  ): Promise<CoreQueryResults> {
+    return await compileAndRunQueryAgainstDatabaseCore(
+      this.qs,
+      dbPath,
+      query,
+      generateEvalLog,
+      additionalPacks,
+      extensionPacks,
+      outputDir,
+      progress,
+      token,
+      templates,
+      logger,
+    );
+  }
+
+  async deregisterDatabase(
+    progress: ProgressCallback,
+    token: CancellationToken,
+    dbItem: DatabaseItem,
+  ): Promise<void> {
+    if (dbItem.contents) {
+      const databases: string[] = [dbItem.databaseUri.fsPath];
+      await this.qs.sendRequest(
+        deregisterDatabases,
+        { databases },
+        token,
+        progress,
+      );
+    }
+  }
+  async registerDatabase(
+    progress: ProgressCallback,
+    token: CancellationToken,
+    dbItem: DatabaseItem,
+  ): Promise<void> {
+    if (dbItem.contents) {
+      const databases: string[] = [dbItem.databaseUri.fsPath];
+      await this.qs.sendRequest(
+        registerDatabases,
+        { databases },
+        token,
+        progress,
+      );
+    }
+  }
+
+  async clearPackCache(): Promise<void> {
+    await this.qs.sendRequest(clearPackCache, {});
+  }
+
+  async upgradeDatabaseExplicit(
+    dbItem: DatabaseItem,
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void> {
+    const yesItem = { title: "Yes", isCloseAffordance: false };
+    const noItem = { title: "No", isCloseAffordance: true };
+    const dialogOptions: vscode.MessageItem[] = [yesItem, noItem];
+
+    const message = `Should the database ${dbItem.databaseUri.fsPath} be destructively upgraded?\n\nThis should not be necessary to run queries
+    as we will non-destructively update it anyway.`;
+    const chosenItem = await vscode.window.showInformationMessage(
+      message,
+      { modal: true },
+      ...dialogOptions,
+    );
+
+    if (chosenItem !== yesItem) {
+      throw new UserCancellationException(
+        "User cancelled the database upgrade.",
+      );
+    }
+    await this.qs.sendRequest(
+      upgradeDatabase,
+      {
+        db: dbItem.databaseUri.fsPath,
+        additionalPacks: getOnDiskWorkspaceFolders(),
+      },
+      token,
+      progress,
+    );
+  }
+}

extensions/ql-vscode/src/query-server/query-runner.ts

@@ -1,74 +1,72 @@
 import { CancellationToken } from "vscode";
-import { ProgressCallback, UserCancellationException } from "../progress";
-import { DatabaseItem } from "../local-databases";
-import {
-  clearCache,
-  ClearCacheParams,
-  clearPackCache,
-  deregisterDatabases,
-  registerDatabases,
-  upgradeDatabase,
-} from "../pure/new-messages";
-import { CoreQueryResults, CoreQueryTarget, QueryRunner } from "../queryRunner";
-import { QueryServerClient } from "./queryserver-client";
-import { compileAndRunQueryAgainstDatabaseCore } from "./run-queries";
-import * as vscode from "vscode";
-import { getOnDiskWorkspaceFolders } from "../helpers";
 import { CodeQLCliServer } from "../cli";
-import { Logger } from "../common";
+import { ProgressCallback } from "../progress";
+import { DatabaseItem } from "../local-databases";
 import { QueryOutputDir } from "../run-queries-shared";
+import { Position, QueryResultType } from "../pure/new-messages";
+import { BaseLogger, Logger } from "../common";
+import { basename, join } from "path";
+import { nanoid } from "nanoid";
 
-export class NewQueryRunner extends QueryRunner {
-  constructor(public readonly qs: QueryServerClient) {
-    super();
-  }
+export interface CoreQueryTarget {
+  /** The full path to the query. */
+  queryPath: string;
+  /**
+   * Optional position of text to be used as QuickEval target. This need not be in the same file as
+   * `query`.
+   */
+  quickEvalPosition?: Position;
+}
 
-  get cliServer(): CodeQLCliServer {
-    return this.qs.cliServer;
-  }
+export interface CoreQueryResults {
+  readonly resultType: QueryResultType;
+  readonly message: string | undefined;
+  readonly evaluationTime: number;
+}
 
-  get customLogDirectory(): string | undefined {
-    return this.qs.config.customLogDirectory;
-  }
+export interface CoreQueryRun {
+  readonly queryTarget: CoreQueryTarget;
+  readonly dbPath: string;
+  readonly id: string;
+  readonly outputDir: QueryOutputDir;
 
-  get logger(): Logger {
-    return this.qs.logger;
-  }
-
-  async restartQueryServer(
+  evaluate(
     progress: ProgressCallback,
     token: CancellationToken,
-  ): Promise<void> {
-    await this.qs.restartQueryServer(progress, token);
-  }
+    logger: BaseLogger,
+  ): Promise<CoreCompletedQuery>;
+}
 
-  onStart(
-    callBack: (
+/** Includes both the results of the query and the initial information from `CoreQueryRun`. */
+export type CoreCompletedQuery = CoreQueryResults &
+  Omit<CoreQueryRun, "evaluate">;
+
+export abstract class QueryRunner {
+  abstract restartQueryServer(
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void>;
+
+  abstract cliServer: CodeQLCliServer;
+  abstract customLogDirectory: string | undefined;
+  abstract logger: Logger;
+
+  abstract onStart(
+    arg0: (
       progress: ProgressCallback,
       token: CancellationToken,
     ) => Promise<void>,
-  ) {
-    this.qs.onDidStartQueryServer(callBack);
-  }
-
-  async clearCacheInDatabase(
+  ): void;
+  abstract clearCacheInDatabase(
     dbItem: DatabaseItem,
     progress: ProgressCallback,
     token: CancellationToken,
-  ): Promise<void> {
-    if (dbItem.contents === undefined) {
-      throw new Error("Can't clear the cache in an invalid database.");
-    }
+  ): Promise<void>;
 
-    const db = dbItem.databaseUri.fsPath;
-    const params: ClearCacheParams = {
-      dryRun: false,
-      db,
-    };
-    await this.qs.sendRequest(clearCache, params, token, progress);
-  }
-
-  public async compileAndRunQueryAgainstDatabaseCore(
+  /**
+   * Overridden in subclasses to evaluate the query via the query server and return the results.
+   */
+  public abstract compileAndRunQueryAgainstDatabaseCore(
     dbPath: string,
     query: CoreQueryTarget,
     additionalPacks: string[],
@@ -78,88 +76,76 @@ export class NewQueryRunner extends QueryRunner {
     progress: ProgressCallback,
     token: CancellationToken,
     templates: Record<string, string> | undefined,
-    logger: Logger,
-  ): Promise<CoreQueryResults> {
-    return await compileAndRunQueryAgainstDatabaseCore(
-      this.qs,
+    logger: BaseLogger,
+  ): Promise<CoreQueryResults>;
+
+  abstract deregisterDatabase(
+    progress: ProgressCallback,
+    token: CancellationToken,
+    dbItem: DatabaseItem,
+  ): Promise<void>;
+
+  abstract registerDatabase(
+    progress: ProgressCallback,
+    token: CancellationToken,
+    dbItem: DatabaseItem,
+  ): Promise<void>;
+
+  abstract upgradeDatabaseExplicit(
+    dbItem: DatabaseItem,
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void>;
+
+  abstract clearPackCache(): Promise<void>;
+
+  /**
+   * Create a `CoreQueryRun` object. This creates an object whose `evaluate()` function can be
+   * called to actually evaluate the query. The returned object also contains information about the
+   * query evaluation that is known even before evaluation starts, including the unique ID of the
+   * evaluation and the path to its output directory.
+   */
+  public createQueryRun(
+    dbPath: string,
+    query: CoreQueryTarget,
+    generateEvalLog: boolean,
+    additionalPacks: string[],
+    extensionPacks: string[] | undefined,
+    queryStorageDir: string,
+    id = `${basename(query.queryPath)}-${nanoid()}`,
+    templates: Record<string, string> | undefined,
+  ): CoreQueryRun {
+    const outputDir = new QueryOutputDir(join(queryStorageDir, id));
+
+    return {
+      queryTarget: query,
       dbPath,
-      query,
-      generateEvalLog,
-      additionalPacks,
-      extensionPacks,
+      id,
       outputDir,
-      progress,
-      token,
-      templates,
-      logger,
-    );
-  }
-
-  async deregisterDatabase(
-    progress: ProgressCallback,
-    token: CancellationToken,
-    dbItem: DatabaseItem,
-  ): Promise<void> {
-    if (dbItem.contents) {
-      const databases: string[] = [dbItem.databaseUri.fsPath];
-      await this.qs.sendRequest(
-        deregisterDatabases,
-        { databases },
-        token,
-        progress,
-      );
-    }
-  }
-  async registerDatabase(
-    progress: ProgressCallback,
-    token: CancellationToken,
-    dbItem: DatabaseItem,
-  ): Promise<void> {
-    if (dbItem.contents) {
-      const databases: string[] = [dbItem.databaseUri.fsPath];
-      await this.qs.sendRequest(
-        registerDatabases,
-        { databases },
-        token,
-        progress,
-      );
-    }
-  }
-
-  async clearPackCache(): Promise<void> {
-    await this.qs.sendRequest(clearPackCache, {});
-  }
-
-  async upgradeDatabaseExplicit(
-    dbItem: DatabaseItem,
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<void> {
-    const yesItem = { title: "Yes", isCloseAffordance: false };
-    const noItem = { title: "No", isCloseAffordance: true };
-    const dialogOptions: vscode.MessageItem[] = [yesItem, noItem];
-
-    const message = `Should the database ${dbItem.databaseUri.fsPath} be destructively upgraded?\n\nThis should not be necessary to run queries
-    as we will non-destructively update it anyway.`;
-    const chosenItem = await vscode.window.showInformationMessage(
-      message,
-      { modal: true },
-      ...dialogOptions,
-    );
-
-    if (chosenItem !== yesItem) {
-      throw new UserCancellationException(
-        "User cancelled the database upgrade.",
-      );
-    }
-    await this.qs.sendRequest(
-      upgradeDatabase,
-      {
-        db: dbItem.databaseUri.fsPath,
-        additionalPacks: getOnDiskWorkspaceFolders(),
+      evaluate: async (
+        progress: ProgressCallback,
+        token: CancellationToken,
+        logger: BaseLogger,
+      ): Promise<CoreCompletedQuery> => {
+        return {
+          id,
+          outputDir,
+          dbPath,
+          queryTarget: query,
+          ...(await this.compileAndRunQueryAgainstDatabaseCore(
+            dbPath,
+            query,
+            additionalPacks,
+            extensionPacks,
+            generateEvalLog,
+            outputDir,
+            progress,
+            token,
+            templates,
+            logger,
+          )),
+        };
       },
-      token,
-      progress,
-    );
+    };
   }
 }

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

@@ -12,7 +12,7 @@ import {
   WithProgressId,
 } from "../pure/new-messages";
 import { ProgressCallback, ProgressTask } from "../progress";
-import { ServerProcess } from "../json-rpc-server";
+import { ServerProcess } from "./server-process";
 import { App } from "../common/app";
 
 type ServerOpts = {

extensions/ql-vscode/src/query-server/run-queries.ts

@@ -2,8 +2,8 @@ import { CancellationToken } from "vscode";
 import { ProgressCallback } from "../progress";
 import * as messages from "../pure/new-messages";
 import { QueryOutputDir } from "../run-queries-shared";
-import * as qsClient from "./queryserver-client";
-import { CoreQueryResults, CoreQueryTarget } from "../queryRunner";
+import * as qsClient from "./query-server-client";
+import { CoreQueryResults, CoreQueryTarget } from "./query-runner";
 import { Logger } from "../common";
 
 /**

extensions/ql-vscode/src/query-server/server-process.ts

@@ -1,4 +1,4 @@
-import { Logger } from "./common";
+import { Logger } from "../common";
 import * as cp from "child_process";
 import { Disposable } from "vscode";
 import { MessageConnection } from "vscode-jsonrpc";

extensions/ql-vscode/src/queryRunner.ts

@@ -1,151 +0,0 @@
-import { CancellationToken } from "vscode";
-import { CodeQLCliServer } from "./cli";
-import { ProgressCallback } from "./progress";
-import { DatabaseItem } from "./local-databases";
-import { QueryOutputDir } from "./run-queries-shared";
-import { Position, QueryResultType } from "./pure/new-messages";
-import { BaseLogger, Logger } from "./common";
-import { basename, join } from "path";
-import { nanoid } from "nanoid";
-
-export interface CoreQueryTarget {
-  /** The full path to the query. */
-  queryPath: string;
-  /**
-   * Optional position of text to be used as QuickEval target. This need not be in the same file as
-   * `query`.
-   */
-  quickEvalPosition?: Position;
-}
-
-export interface CoreQueryResults {
-  readonly resultType: QueryResultType;
-  readonly message: string | undefined;
-  readonly evaluationTime: number;
-}
-
-export interface CoreQueryRun {
-  readonly queryTarget: CoreQueryTarget;
-  readonly dbPath: string;
-  readonly id: string;
-  readonly outputDir: QueryOutputDir;
-
-  evaluate(
-    progress: ProgressCallback,
-    token: CancellationToken,
-    logger: BaseLogger,
-  ): Promise<CoreCompletedQuery>;
-}
-
-/** Includes both the results of the query and the initial information from `CoreQueryRun`. */
-export type CoreCompletedQuery = CoreQueryResults &
-  Omit<CoreQueryRun, "evaluate">;
-
-export abstract class QueryRunner {
-  abstract restartQueryServer(
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<void>;
-
-  abstract cliServer: CodeQLCliServer;
-  abstract customLogDirectory: string | undefined;
-  abstract logger: Logger;
-
-  abstract onStart(
-    arg0: (
-      progress: ProgressCallback,
-      token: CancellationToken,
-    ) => Promise<void>,
-  ): void;
-  abstract clearCacheInDatabase(
-    dbItem: DatabaseItem,
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<void>;
-
-  /**
-   * Overridden in subclasses to evaluate the query via the query server and return the results.
-   */
-  public abstract compileAndRunQueryAgainstDatabaseCore(
-    dbPath: string,
-    query: CoreQueryTarget,
-    additionalPacks: string[],
-    extensionPacks: string[] | undefined,
-    generateEvalLog: boolean,
-    outputDir: QueryOutputDir,
-    progress: ProgressCallback,
-    token: CancellationToken,
-    templates: Record<string, string> | undefined,
-    logger: BaseLogger,
-  ): Promise<CoreQueryResults>;
-
-  abstract deregisterDatabase(
-    progress: ProgressCallback,
-    token: CancellationToken,
-    dbItem: DatabaseItem,
-  ): Promise<void>;
-
-  abstract registerDatabase(
-    progress: ProgressCallback,
-    token: CancellationToken,
-    dbItem: DatabaseItem,
-  ): Promise<void>;
-
-  abstract upgradeDatabaseExplicit(
-    dbItem: DatabaseItem,
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<void>;
-
-  abstract clearPackCache(): Promise<void>;
-
-  /**
-   * Create a `CoreQueryRun` object. This creates an object whose `evaluate()` function can be
-   * called to actually evaluate the query. The returned object also contains information about the
-   * query evaluation that is known even before evaluation starts, including the unique ID of the
-   * evaluation and the path to its output directory.
-   */
-  public createQueryRun(
-    dbPath: string,
-    query: CoreQueryTarget,
-    generateEvalLog: boolean,
-    additionalPacks: string[],
-    extensionPacks: string[] | undefined,
-    queryStorageDir: string,
-    id = `${basename(query.queryPath)}-${nanoid()}`,
-    templates: Record<string, string> | undefined,
-  ): CoreQueryRun {
-    const outputDir = new QueryOutputDir(join(queryStorageDir, id));
-
-    return {
-      queryTarget: query,
-      dbPath,
-      id,
-      outputDir,
-      evaluate: async (
-        progress: ProgressCallback,
-        token: CancellationToken,
-        logger: BaseLogger,
-      ): Promise<CoreCompletedQuery> => {
-        return {
-          id,
-          outputDir,
-          dbPath,
-          queryTarget: query,
-          ...(await this.compileAndRunQueryAgainstDatabaseCore(
-            dbPath,
-            query,
-            additionalPacks,
-            extensionPacks,
-            generateEvalLog,
-            outputDir,
-            progress,
-            token,
-            templates,
-            logger,
-          )),
-        };
-      },
-    };
-  }
-}

extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debug-controller.ts

@@ -10,7 +10,7 @@ import {
 import * as CodeQLProtocol from "../../../../src/debugger/debug-protocol";
 import { DisposableObject } from "../../../../src/pure/disposable-object";
 import { QueryResultType } from "../../../../src/pure/legacy-messages";
-import { CoreCompletedQuery } from "../../../../src/queryRunner";
+import { CoreCompletedQuery } from "../../../../src/query-server/query-runner";
 import { QueryOutputDir } from "../../../../src/run-queries-shared";
 import {
   QLDebugArgs,

extensions/ql-vscode/test/vscode-tests/cli-integration/legacy-query.test.ts

@@ -4,11 +4,11 @@ import { dirSync } from "tmp";
 import { pathToFileURL } from "url";
 import { CancellationTokenSource } from "vscode-jsonrpc";
 import * as messages from "../../../src/pure/legacy-messages";
-import * as qsClient from "../../../src/legacy-query-server/queryserver-client";
+import * as qsClient from "../../../src/query-server/legacy/query-server-client";
 import * as cli from "../../../src/cli";
 import { CellValue } from "../../../src/pure/bqrs-cli-types";
 import { describeWithCodeQL } from "../cli";
-import { QueryServerClient } from "../../../src/legacy-query-server/queryserver-client";
+import { QueryServerClient } from "../../../src/query-server/legacy/query-server-client";
 import { extLogger, ProgressReporter } from "../../../src/common";
 import { createMockApp } from "../../__mocks__/appMock";
 import { getActivatedExtension } from "../global.helper";

extensions/ql-vscode/test/vscode-tests/cli-integration/new-query.test.ts

@@ -2,11 +2,11 @@ import { join, basename } from "path";
 import { dirSync } from "tmp";
 import { CancellationTokenSource } from "vscode-jsonrpc";
 import * as messages from "../../../src/pure/new-messages";
-import * as qsClient from "../../../src/query-server/queryserver-client";
+import * as qsClient from "../../../src/query-server/query-server-client";
 import * as cli from "../../../src/cli";
 import { CellValue } from "../../../src/pure/bqrs-cli-types";
 import { describeWithCodeQL } from "../cli";
-import { QueryServerClient } from "../../../src/query-server/queryserver-client";
+import { QueryServerClient } from "../../../src/query-server/query-server-client";
 import { extLogger, ProgressReporter } from "../../../src/common";
 import { QueryResultType } from "../../../src/pure/new-messages";
 import { ensureTestDatabase, getActivatedExtension } from "../global.helper";

extensions/ql-vscode/test/vscode-tests/cli-integration/queries.test.ts

@@ -17,7 +17,10 @@ import {
 } from "../global.helper";
 import { CliVersionConstraint, CodeQLCliServer } from "../../../src/cli";
 import { describeWithCodeQL } from "../cli";
-import { CoreCompletedQuery, QueryRunner } from "../../../src/queryRunner";
+import {
+  CoreCompletedQuery,
+  QueryRunner,
+} from "../../../src/query-server/query-runner";
 import { SELECT_QUERY_NAME } from "../../../src/contextual/locationFinder";
 import { LocalQueries } from "../../../src/local-queries";
 import { QueryResultType } from "../../../src/pure/new-messages";

extensions/ql-vscode/test/vscode-tests/minimal-workspace/local-databases.test.ts

@@ -20,7 +20,7 @@ import {
   encodeSourceArchiveUri,
 } from "../../../src/archive-filesystem-provider";
 import { testDisposeHandler } from "../test-dispose-handler";
-import { QueryRunner } from "../../../src/queryRunner";
+import { QueryRunner } from "../../../src/query-server/query-runner";
 import * as helpers from "../../../src/helpers";
 import { Setting } from "../../../src/config";
 import { QlPackGenerator } from "../../../src/qlpack-generator";

extensions/ql-vscode/test/vscode-tests/no-workspace/query-history/history-tree-data-provider.test.ts

@@ -9,7 +9,7 @@ import { tmpDir } from "../../../../src/helpers";
 import { HistoryItemLabelProvider } from "../../../../src/query-history/history-item-label-provider";
 import { ResultsView } from "../../../../src/interface";
 import { EvalLogViewer } from "../../../../src/eval-log-viewer";
-import { QueryRunner } from "../../../../src/queryRunner";
+import { QueryRunner } from "../../../../src/query-server/query-runner";
 import { VariantAnalysisManager } from "../../../../src/variant-analysis/variant-analysis-manager";
 import { QueryHistoryInfo } from "../../../../src/query-history/query-history-info";
 import {

extensions/ql-vscode/test/vscode-tests/no-workspace/query-history/query-history-manager.test.ts

@@ -10,7 +10,7 @@ import { tmpDir } from "../../../../src/helpers";
 import { HistoryItemLabelProvider } from "../../../../src/query-history/history-item-label-provider";
 import { ResultsView } from "../../../../src/interface";
 import { EvalLogViewer } from "../../../../src/eval-log-viewer";
-import { QueryRunner } from "../../../../src/queryRunner";
+import { QueryRunner } from "../../../../src/query-server/query-runner";
 import { VariantAnalysisManager } from "../../../../src/variant-analysis/variant-analysis-manager";
 import { QueryHistoryInfo } from "../../../../src/query-history/query-history-info";
 import {

extensions/ql-vscode/test/vscode-tests/no-workspace/query-history/store/query-history-store.test.ts

@@ -13,7 +13,7 @@ import { DatabaseInfo } from "../../../../../src/pure/interface-types";
 import { CancellationTokenSource, Uri } from "vscode";
 import { tmpDir } from "../../../../../src/helpers";
 import { QueryResultType } from "../../../../../src/pure/legacy-messages";
-import { QueryInProgress } from "../../../../../src/legacy-query-server/run-queries";
+import { QueryInProgress } from "../../../../../src/query-server/legacy";
 import { VariantAnalysisHistoryItem } from "../../../../../src/query-history/variant-analysis-history-item";
 import { QueryHistoryInfo } from "../../../../../src/query-history/query-history-info";
 import { createMockVariantAnalysisHistoryItem } from "../../../../factories/query-history/variant-analysis-history-item";

extensions/ql-vscode/test/vscode-tests/no-workspace/query-history/variant-analysis-history.test.ts

@@ -16,7 +16,7 @@ import { testDisposeHandler } from "../../test-dispose-handler";
 import { HistoryItemLabelProvider } from "../../../../src/query-history/history-item-label-provider";
 import { ResultsView } from "../../../../src/interface";
 import { EvalLogViewer } from "../../../../src/eval-log-viewer";
-import { QueryRunner } from "../../../../src/queryRunner";
+import { QueryRunner } from "../../../../src/query-server/query-runner";
 import { VariantAnalysisManager } from "../../../../src/variant-analysis/variant-analysis-manager";
 import { QueryHistoryManager } from "../../../../src/query-history/query-history-manager";
 import { mockedObject } from "../../utils/mocking.helpers";

extensions/ql-vscode/test/vscode-tests/no-workspace/query-results.test.ts

@@ -24,7 +24,7 @@ import { tmpDir } from "../../../src/helpers";
 import {
   formatLegacyMessage,
   QueryInProgress,
-} from "../../../src/legacy-query-server/run-queries";
+} from "../../../src/query-server/legacy/run-queries";
 import {
   EvaluationResult,
   QueryResultType,

extensions/ql-vscode/test/vscode-tests/no-workspace/run-queries.test.ts

@@ -10,14 +10,16 @@ import {
 } from "../../../src/pure/legacy-messages";
 import * as config from "../../../src/config";
 import { tmpDir } from "../../../src/helpers";
-import { QueryServerClient } from "../../../src/legacy-query-server/queryserver-client";
 import { CodeQLCliServer } from "../../../src/cli";
 import { SELECT_QUERY_NAME } from "../../../src/contextual/locationFinder";
 import {
   QueryInProgress,
   compileQuery as compileQueryLegacy,
-} from "../../../src/legacy-query-server/run-queries";
-import { LegacyQueryRunner } from "../../../src/legacy-query-server/legacyRunner";
+} from "../../../src/query-server/legacy/run-queries";
+import {
+  LegacyQueryRunner,
+  QueryServerClient,
+} from "../../../src/query-server/legacy";
 import { DatabaseItem } from "../../../src/local-databases";
 import { DeepPartial, mockedObject } from "../utils/mocking.helpers";
 import { BqrsKind } from "../../../src/pure/bqrs-cli-types";