Merge pull request #3094 from github/koesie10/remove-legacy-query-server

Remove the legacy query server

Author: koesie10

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -2,7 +2,7 @@ import { EOL } from "os";
 import { spawn } from "child-process-promise";
 import * as child_process from "child_process";
 import { readFile } from "fs-extra";
-import { dirname, join, delimiter } from "path";
+import { delimiter, dirname, join } from "path";
 import * as sarif from "sarif";
 import { SemVer } from "semver";
 import { Readable } from "stream";
@@ -15,7 +15,7 @@ import {
   DecodedBqrs,
   DecodedBqrsChunk,
 } from "../common/bqrs-cli-types";
-import { allowCanaryQueryServer, CliConfig } from "../config";
+import { CliConfig } from "../config";
 import {
   DistributionProvider,
   FindDistributionResultKind,
@@ -1772,11 +1772,6 @@ export class CliVersionConstraint {
     return (await this.cli.getVersion()).compare(v) >= 0;
   }
 
-  async supportsNewQueryServer() {
-    // This allows users to explicitly opt-out of the new query server.
-    return allowCanaryQueryServer();
-  }
-
   async supportsQlpacksKind() {
     return this.isVersionAtLeast(
       CliVersionConstraint.CLI_VERSION_WITH_QLPACKS_KIND,

extensions/ql-vscode/src/config.ts

@@ -461,20 +461,6 @@ export function isCanary() {
   return !!CANARY_FEATURES.getValue<boolean>();
 }
 
-/**
- * Enables the experimental query server
- */
-export const CANARY_QUERY_SERVER = new Setting(
-  "canaryQueryServer",
-  ROOT_SETTING,
-);
-
-// The default value for this setting is now `true`
-export function allowCanaryQueryServer() {
-  const value = CANARY_QUERY_SERVER.getValue<boolean>();
-  return value === undefined ? true : !!value;
-}
-
 const LOG_INSIGHTS_SETTING = new Setting("logInsights", ROOT_SETTING);
 export const JOIN_ORDER_WARNING_THRESHOLD = new Setting(
   "joinOrderWarningThreshold",

extensions/ql-vscode/src/extension.ts

@@ -13,7 +13,7 @@ import {
   workspace,
 } from "vscode";
 import { LanguageClient } from "vscode-languageclient/node";
-import { arch, platform, homedir } from "os";
+import { arch, homedir, platform } from "os";
 import { ensureDir } from "fs-extra";
 import { join } from "path";
 import { dirSync } from "tmp-promise";
@@ -35,13 +35,13 @@ import {
 } from "./config";
 import {
   AstViewer,
-  install,
+  createIDEServer,
   getQueryEditorCommands,
+  install,
   TemplatePrintAstProvider,
   TemplatePrintCfgProvider,
   TemplateQueryDefinitionProvider,
   TemplateQueryReferenceProvider,
-  createIDEServer,
 } from "./language-support";
 import { DatabaseManager } from "./databases/local-databases";
 import { DatabaseUI } from "./databases/local-databases-ui";
@@ -68,15 +68,15 @@ import {
   getErrorStack,
 } from "./common/helpers-pure";
 import {
-  ResultsView,
-  WebviewReveal,
   LocalQueries,
   QuickEvalCodeLensProvider,
+  ResultsView,
+  WebviewReveal,
 } from "./local-queries";
 import {
   BaseLogger,
-  showAndLogExceptionWithTelemetry,
   showAndLogErrorMessage,
+  showAndLogExceptionWithTelemetry,
   showAndLogInformationMessage,
   showAndLogWarningMessage,
 } from "./common/logging";
@@ -88,10 +88,6 @@ import {
 } from "./common/logging/vscode";
 import { QueryHistoryManager } from "./query-history/query-history-manager";
 import { CompletedLocalQueryInfo } from "./query-results";
-import {
-  LegacyQueryRunner,
-  QueryServerClient as LegacyQueryServerClient,
-} from "./query-server/legacy";
 import { QLTestAdapterFactory } from "./query-testing/test-adapter";
 import { TestUIService } from "./query-testing/test-ui";
 import { CompareView } from "./compare/compare-view";
@@ -1242,29 +1238,17 @@ async function createQueryServer(
       { title: "CodeQL query server", location: ProgressLocation.Window },
       task,
     );
-  if (await cliServer.cliConstraints.supportsNewQueryServer()) {
-    const qs = new QueryServerClient(
-      app,
-      qlConfigurationListener,
-      cliServer,
-      qsOpts,
-      progressCallback,
-    );
-    ctx.subscriptions.push(qs);
-    await qs.startQueryServer();
-    return new NewQueryRunner(qs);
-  } else {
-    const qs = new LegacyQueryServerClient(
-      app,
-      qlConfigurationListener,
-      cliServer,
-      qsOpts,
-      progressCallback,
-    );
-    ctx.subscriptions.push(qs);
-    await qs.startQueryServer();
-    return new LegacyQueryRunner(qs);
-  }
+
+  const qs = new QueryServerClient(
+    app,
+    qlConfigurationListener,
+    cliServer,
+    qsOpts,
+    progressCallback,
+  );
+  ctx.subscriptions.push(qs);
+  await qs.startQueryServer();
+  return new NewQueryRunner(qs);
 }
 
 function getContextStoragePath(ctx: ExtensionContext) {

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

@@ -22,8 +22,8 @@ import {
   QueryOutputDir,
   QueryWithResults,
 } from "./run-queries-shared";
-import { formatLegacyMessage } from "./query-server/legacy";
 import { sarifParser } from "./common/sarif-parser";
+import { formatLegacyMessage } from "./query-server/format-legacy-message";
 
 /**
  * query-results.ts

extensions/ql-vscode/src/query-server/format-legacy-message.ts

@@ -0,0 +1,23 @@
+import * as legacyMessages from "./legacy-messages";
+
+// Used for formatting the result of a legacy query which might still be in the
+// user's query history.
+export function formatLegacyMessage(result: legacyMessages.EvaluationResult) {
+  switch (result.resultType) {
+    case legacyMessages.QueryResultType.CANCELLATION:
+      return `cancelled after ${Math.round(
+        result.evaluationTime / 1000,
+      )} seconds`;
+    case legacyMessages.QueryResultType.OOM:
+      return "out of memory";
+    case legacyMessages.QueryResultType.SUCCESS:
+      return `finished in ${Math.round(result.evaluationTime / 1000)} seconds`;
+    case legacyMessages.QueryResultType.TIMEOUT:
+      return `timed out after ${Math.round(
+        result.evaluationTime / 1000,
+      )} seconds`;
+    case legacyMessages.QueryResultType.OTHER_ERROR:
+    default:
+      return result.message ? `failed: ${result.message}` : "failed";
+  }
+}