Remove codeQL.exportRemoteQueryResults command

Author: koesie10

extensions/ql-vscode/src/extension.ts

@@ -110,7 +110,6 @@ import {
 } from "./packaging";
 import { HistoryItemLabelProvider } from "./query-history/history-item-label-provider";
 import {
-  exportRemoteQueryResults,
   exportSelectedRemoteQueryResults,
   exportVariantAnalysisResults,
 } from "./remote-queries/export-results";
@@ -1195,15 +1194,6 @@ async function activateWithInstalledDistribution(
     }),
   );
 
-  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

@@ -1312,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)

extensions/ql-vscode/src/remote-queries/remote-queries-markdown-generation.ts

@@ -3,14 +3,11 @@ import { tryGetRemoteLocation } from "../pure/bqrs-utils";
 import { createRemoteFileRef } from "../pure/location-link-utils";
 import { parseHighlightedLine, shouldHighlightLine } from "../pure/sarif-utils";
 import { convertNonPrintableChars } from "../text-utils";
-import { RemoteQuery } from "./remote-query";
 import {
   AnalysisAlert,
   AnalysisRawResults,
-  AnalysisResults,
   CodeSnippet,
   FileLink,
-  getAnalysisResultCount,
   HighlightedRegion,
 } from "./shared/analysis-result";
 import {
@@ -27,54 +24,6 @@ export interface MarkdownFile {
   content: string[]; // Each array item is a line of the markdown file.
 }
 
-/**
- * Generates markdown files with variant analysis results.
- */
-export function generateMarkdown(
-  query: RemoteQuery,
-  analysesResults: AnalysisResults[],
-  linkType: MarkdownLinkType,
-): MarkdownFile[] {
-  const resultsFiles: MarkdownFile[] = [];
-  // Generate summary file with links to individual files
-  const summaryFile: MarkdownFile = generateMarkdownSummary(query);
-  for (const analysisResult of analysesResults) {
-    const resultsCount = getAnalysisResultCount(analysisResult);
-    if (resultsCount === 0) {
-      continue;
-    }
-
-    // Append nwo and results count to the summary table
-    const nwo = analysisResult.nwo;
-    const fileName = createFileName(nwo);
-    const link = createRelativeLink(fileName, linkType);
-    summaryFile.content.push(
-      `| ${nwo} | [${resultsCount} result(s)](${link}) |`,
-    );
-
-    // Generate individual markdown file for each repository
-    const resultsFileContent = [`### ${analysisResult.nwo}`, ""];
-    for (const interpretedResult of analysisResult.interpretedResults) {
-      const individualResult = generateMarkdownForInterpretedResult(
-        interpretedResult,
-        query.language,
-      );
-      resultsFileContent.push(...individualResult);
-    }
-    if (analysisResult.rawResults) {
-      const rawResultTable = generateMarkdownForRawResults(
-        analysisResult.rawResults,
-      );
-      resultsFileContent.push(...rawResultTable);
-    }
-    resultsFiles.push({
-      fileName,
-      content: resultsFileContent,
-    });
-  }
-  return [summaryFile, ...resultsFiles];
-}
-
 export interface RepositorySummary {
   fileName: string;
   repository: RepositoryWithMetadata;
@@ -153,27 +102,6 @@ export async function generateVariantAnalysisMarkdown(
   };
 }
 
-export function generateMarkdownSummary(query: RemoteQuery): MarkdownFile {
-  const lines: string[] = [];
-  // Title
-  lines.push(`### Results for "${query.queryName}"`, "");
-
-  // Expandable section containing query text
-  const queryCodeBlock = ["```ql", ...query.queryText.split("\n"), "```"];
-  lines.push(...buildExpandableMarkdownSection("Query", queryCodeBlock));
-
-  // Padding between sections
-  lines.push("<br />", "");
-
-  // Summary table
-  lines.push("### Summary", "", "| Repository | Results |", "| --- | --- |");
-  // nwo and result count will be appended to this table
-  return {
-    fileName: "_summary",
-    content: lines,
-  };
-}
-
 export function generateVariantAnalysisMarkdownSummary(
   variantAnalysis: VariantAnalysis,
   summaries: RepositorySummary[],

extensions/ql-vscode/src/remote-queries/remote-queries-view.ts

@@ -4,7 +4,6 @@ import {
   ViewColumn,
   Uri,
   workspace,
-  commands,
 } from "vscode";
 import { basename } from "path";
 
@@ -162,10 +161,6 @@ export class RemoteQueriesView extends AbstractWebview<
         await this.downloadAllAnalysesResults(msg);
         break;
       case "remoteQueryExportResults":
-        await commands.executeCommand(
-          "codeQL.exportRemoteQueryResults",
-          msg.queryId,
-        );
         break;
       case "telemetry":
         telemetryListener?.sendUIInteraction(msg.action);