Merge pull request #2069 from github/koesie10/remove-remote-query-commands

Remove remote queries commands

Author: koesie10

extensions/ql-vscode/src/extension.ts

@@ -4,28 +4,28 @@ import {
   CancellationTokenSource,
   commands,
   Disposable,
+  env,
   ExtensionContext,
   extensions,
   languages,
   ProgressLocation,
   ProgressOptions,
+  ProviderResult,
+  QuickPickItem,
+  Range,
   Uri,
+  version as vscodeVersion,
   window as Window,
-  env,
   window,
-  QuickPickItem,
-  Range,
   workspace,
-  ProviderResult,
-  version as vscodeVersion,
 } from "vscode";
 import { LanguageClient } from "vscode-languageclient/node";
-import { platform, arch } from "os";
+import { arch, platform } from "os";
 import { ensureDir } from "fs-extra";
-import { join, basename } from "path";
+import { basename, join } from "path";
 import { dirSync } from "tmp-promise";
 import { testExplorerExtensionId, TestHub } from "vscode-test-adapter-api";
-import { parse, lt } from "semver";
+import { lt, parse } from "semver";
 
 import { AstViewer } from "./astViewer";
 import {
@@ -47,10 +47,10 @@ import { install } from "./languageSupport";
 import { DatabaseItem, DatabaseManager } from "./databases";
 import { DatabaseUI } from "./databases-ui";
 import {
-  TemplateQueryDefinitionProvider,
-  TemplateQueryReferenceProvider,
   TemplatePrintAstProvider,
   TemplatePrintCfgProvider,
+  TemplateQueryDefinitionProvider,
+  TemplateQueryReferenceProvider,
 } from "./contextual/templateProvider";
 import {
   DEFAULT_DISTRIBUTION_VERSION_RANGE,
@@ -64,22 +64,22 @@ import {
 } from "./distribution";
 import {
   findLanguage,
-  tmpDirDisposal,
-  showBinaryChoiceDialog,
   showAndLogErrorMessage,
-  showAndLogWarningMessage,
+  showAndLogExceptionWithTelemetry,
   showAndLogInformationMessage,
+  showAndLogWarningMessage,
+  showBinaryChoiceDialog,
   showInformationMessageWithAction,
   tmpDir,
-  showAndLogExceptionWithTelemetry,
+  tmpDirDisposal,
 } from "./helpers";
 import { asError, assertNever, getErrorMessage } from "./pure/helpers-pure";
 import { spawnIdeServer } from "./ide-server";
 import { ResultsView } from "./interface";
 import { WebviewReveal } from "./interface-utils";
 import {
-  ideServerLogger,
   extLogger,
+  ideServerLogger,
   ProgressReporter,
   queryServerLogger,
 } from "./common";
@@ -97,25 +97,22 @@ import {
   commandRunner,
   commandRunnerWithProgress,
   ProgressCallback,
-  withProgress,
   ProgressUpdate,
+  withProgress,
 } from "./commandRunner";
 import { CodeQlStatusBarHandler } from "./status-bar";
 
 import { RemoteQueriesManager } from "./remote-queries/remote-queries-manager";
-import { RemoteQueryResult } from "./remote-queries/remote-query-result";
 import { URLSearchParams } from "url";
 import {
   handleDownloadPacks,
   handleInstallPackDependencies,
 } from "./packaging";
 import { HistoryItemLabelProvider } from "./query-history/history-item-label-provider";
 import {
-  exportRemoteQueryResults,
   exportSelectedRemoteQueryResults,
   exportVariantAnalysisResults,
 } from "./remote-queries/export-results";
-import { RemoteQuery } from "./remote-queries/remote-query";
 import { EvalLogViewer } from "./eval-log-viewer";
 import { SummaryLanguageSupport } from "./log-insights/summary-language-support";
 import { JoinOrderScannerProvider } from "./log-insights/join-order";
@@ -1129,21 +1126,6 @@ async function activateWithInstalledDistribution(
     ),
   );
 
-  ctx.subscriptions.push(
-    commandRunner(
-      "codeQL.monitorRemoteQuery",
-      async (queryId: string, query: RemoteQuery, token: CancellationToken) => {
-        await rqm.monitorRemoteQuery(queryId, query, token);
-      },
-    ),
-  );
-
-  ctx.subscriptions.push(
-    commandRunner("codeQL.copyRepoList", async (queryId: string) => {
-      await rqm.copyRemoteQueryRepoListToClipboard(queryId);
-    }),
-  );
-
   ctx.subscriptions.push(
     commandRunner(
       "codeQL.openVariantAnalysisLogs",
@@ -1206,30 +1188,12 @@ async function activateWithInstalledDistribution(
     ),
   );
 
-  ctx.subscriptions.push(
-    commandRunner(
-      "codeQL.autoDownloadRemoteQueryResults",
-      async (queryResult: RemoteQueryResult, token: CancellationToken) => {
-        await rqm.autoDownloadRemoteQueryResults(queryResult, token);
-      },
-    ),
-  );
-
   ctx.subscriptions.push(
     commandRunner("codeQL.exportSelectedVariantAnalysisResults", async () => {
       await exportSelectedRemoteQueryResults(qhm);
     }),
   );
 
-  ctx.subscriptions.push(
-    commandRunner(
-      "codeQL.exportRemoteQueryResults",
-      async (queryId: string) => {
-        await exportRemoteQueryResults(qhm, rqm, queryId, app.credentials);
-      },
-    ),
-  );
-
   ctx.subscriptions.push(
     commandRunnerWithProgress(
       "codeQL.exportVariantAnalysisResults",

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

@@ -539,11 +539,7 @@ export class QueryHistoryManager extends DisposableObject {
     await Promise.all(
       this.treeDataProvider.allHistory.map(async (item) => {
         if (item.t === "remote") {
-          await this.remoteQueriesManager.rehydrateRemoteQuery(
-            item.queryId,
-            item.remoteQuery,
-            item.status,
-          );
+          await this.remoteQueriesManager.rehydrateRemoteQuery(item.queryId);
         }
         if (item.t === "variant-analysis") {
           await this.variantAnalysisManager.rehydrateVariantAnalysis(
@@ -1293,12 +1289,7 @@ export class QueryHistoryManager extends DisposableObject {
       return;
     }
 
-    if (finalSingleItem.t === "remote") {
-      await commands.executeCommand(
-        "codeQL.copyRepoList",
-        finalSingleItem.queryId,
-      );
-    } else if (finalSingleItem.t === "variant-analysis") {
+    if (finalSingleItem.t === "variant-analysis") {
       await commands.executeCommand(
         "codeQL.copyVariantAnalysisRepoList",
         finalSingleItem.variantAnalysis.id,
@@ -1321,10 +1312,7 @@ export class QueryHistoryManager extends DisposableObject {
 
     // Remote queries and variant analysis only
     if (finalSingleItem.t === "remote") {
-      await commands.executeCommand(
-        "codeQL.exportRemoteQueryResults",
-        finalSingleItem.queryId,
-      );
+      // Do nothing. TODO: Remove this case once remote queries are removed.
     } else if (finalSingleItem.t === "variant-analysis") {
       await commands.executeCommand(
         "codeQL.exportVariantAnalysisResults",

extensions/ql-vscode/src/remote-queries/export-results.ts

@@ -2,8 +2,8 @@ import { join } from "path";
 import { ensureDir, writeFile } from "fs-extra";
 
 import {
-  commands,
   CancellationToken,
+  commands,
   Uri,
   ViewColumn,
   window,
@@ -14,15 +14,11 @@ import { showInformationMessageWithAction } from "../helpers";
 import { extLogger } from "../common";
 import { QueryHistoryManager } from "../query-history/query-history-manager";
 import { createGist } from "./gh-api/gh-api-client";
-import { RemoteQueriesManager } from "./remote-queries-manager";
 import {
-  generateMarkdown,
   generateVariantAnalysisMarkdown,
   MarkdownFile,
   RepositorySummary,
 } from "./remote-queries-markdown-generation";
-import { RemoteQuery } from "./remote-query";
-import { AnalysisResults, sumAnalysesResults } from "./shared/analysis-result";
 import { pluralize } from "../pure/word";
 import { VariantAnalysisManager } from "./variant-analysis-manager";
 import { assertNever } from "../pure/helpers-pure";
@@ -52,10 +48,7 @@ export async function exportSelectedRemoteQueryResults(
   }
 
   if (queryHistoryItem.t === "remote") {
-    return commands.executeCommand(
-      "codeQL.exportRemoteQueryResults",
-      queryHistoryItem.queryId,
-    );
+    // Do nothing. TODO: Remove this branch once we stop supporting remote queries.
   } else if (queryHistoryItem.t === "variant-analysis") {
     return commands.executeCommand(
       "codeQL.exportVariantAnalysisResults",
@@ -66,73 +59,6 @@ export async function exportSelectedRemoteQueryResults(
   }
 }
 
-/**
- * Exports the results of the given remote query.
- * The user is prompted to select the export format.
- */
-export async function exportRemoteQueryResults(
-  queryHistoryManager: QueryHistoryManager,
-  remoteQueriesManager: RemoteQueriesManager,
-  queryId: string,
-  credentials: Credentials,
-): Promise<void> {
-  const queryHistoryItem = queryHistoryManager.getRemoteQueryById(queryId);
-  if (!queryHistoryItem) {
-    void extLogger.log(`Could not find query with id ${queryId}`);
-    throw new Error(
-      "There was an error when trying to retrieve variant analysis information",
-    );
-  }
-
-  if (!queryHistoryItem.completed) {
-    throw new Error("Variant analysis results are not yet available.");
-  }
-
-  void extLogger.log(
-    `Exporting variant analysis results for query: ${queryHistoryItem.queryId}`,
-  );
-  const query = queryHistoryItem.remoteQuery;
-  const analysesResults = remoteQueriesManager.getAnalysesResults(
-    queryHistoryItem.queryId,
-  );
-
-  const exportFormat = await determineExportFormat();
-  if (!exportFormat) {
-    return;
-  }
-
-  const exportDirectory =
-    await queryHistoryManager.getQueryHistoryItemDirectory(queryHistoryItem);
-  const exportedResultsDirectory = join(exportDirectory, "exported-results");
-
-  await exportRemoteQueryAnalysisResults(
-    exportedResultsDirectory,
-    query,
-    analysesResults,
-    exportFormat,
-    credentials,
-  );
-}
-
-export async function exportRemoteQueryAnalysisResults(
-  exportedResultsPath: string,
-  query: RemoteQuery,
-  analysesResults: AnalysisResults[],
-  exportFormat: "gist" | "local",
-  credentials: Credentials,
-) {
-  const description = buildGistDescription(query, analysesResults);
-  const markdownFiles = generateMarkdown(query, analysesResults, exportFormat);
-
-  await exportResults(
-    exportedResultsPath,
-    description,
-    markdownFiles,
-    exportFormat,
-    credentials,
-  );
-}
-
 const MAX_VARIANT_ANALYSIS_EXPORT_PROGRESS_STEPS = 2;
 
 /**
@@ -396,22 +322,6 @@ export async function exportToGist(
   }
 }
 
-/**
- * Builds Gist description
- * Ex: Empty Block (Go) x results (y repositories)
- */
-const buildGistDescription = (
-  query: RemoteQuery,
-  analysesResults: AnalysisResults[],
-) => {
-  const resultCount = sumAnalysesResults(analysesResults);
-  const resultLabel = pluralize(resultCount, "result", "results");
-  const repositoryLabel = query.repositoryCount
-    ? `(${pluralize(query.repositoryCount, "repository", "repositories")})`
-    : "";
-  return `${query.queryName} (${query.language}) ${resultLabel} ${repositoryLabel}`;
-};
-
 /**
  * Builds Gist description
  * Ex: Empty Block (Go) x results (y repositories)