Merge pull request #2071 from github/koesie10/remove-remote-queries-history-item

Remove remote queries history item

Author: koesie10

extensions/ql-vscode/src/extension.ts

@@ -652,7 +652,6 @@ async function activateWithInstalledDistribution(
 
   void extLogger.log("Initializing query history.");
   const qhm = new QueryHistoryManager(
-    app,
     qs,
     dbm,
     localQueryResultsView,

extensions/ql-vscode/src/query-history/history-item-label-provider.ts

@@ -7,7 +7,6 @@ import {
   getRawQueryName,
   QueryHistoryInfo,
 } from "./query-history-info";
-import { RemoteQueryHistoryItem } from "../remote-queries/remote-query-history-item";
 import { VariantAnalysisHistoryItem } from "./variant-analysis-history-item";
 import { assertNever } from "../pure/helpers-pure";
 import { pluralize } from "../pure/word";
@@ -34,9 +33,6 @@ export class HistoryItemLabelProvider {
       case "local":
         replacements = this.getLocalInterpolateReplacements(item);
         break;
-      case "remote":
-        replacements = this.getRemoteInterpolateReplacements(item);
-        break;
       case "variant-analysis":
         replacements = this.getVariantAnalysisInterpolateReplacements(item);
         break;
@@ -92,25 +88,6 @@ export class HistoryItemLabelProvider {
     };
   }
 
-  private getRemoteInterpolateReplacements(
-    item: RemoteQueryHistoryItem,
-  ): InterpolateReplacements {
-    const resultCount = item.resultCount
-      ? `(${pluralize(item.resultCount, "result", "results")})`
-      : "";
-    return {
-      t: new Date(item.remoteQuery.executionStartTime).toLocaleString(
-        env.language,
-      ),
-      q: `${item.remoteQuery.queryName} (${item.remoteQuery.language})`,
-      d: buildRepoLabel(item),
-      r: resultCount,
-      s: humanizeQueryStatus(item.status),
-      f: basename(item.remoteQuery.queryFilePath),
-      "%": "%",
-    };
-  }
-
   private getVariantAnalysisInterpolateReplacements(
     item: VariantAnalysisHistoryItem,
   ): InterpolateReplacements {

extensions/ql-vscode/src/query-history/history-tree-data-provider.ts

@@ -236,8 +236,6 @@ export class HistoryTreeDataProvider
     switch (item.t) {
       case "local":
         return item.initialInfo.start.getTime();
-      case "remote":
-        return item.remoteQuery.executionStartTime;
       case "variant-analysis":
         return item.variantAnalysis.executionStartTime;
       default:

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

@@ -1,4 +1,3 @@
-import { RemoteQueryHistoryItem } from "../remote-queries/remote-query-history-item";
 import { VariantAnalysisHistoryItem } from "./variant-analysis-history-item";
 import { LocalQueryInfo } from "../query-results";
 import { assertNever } from "../pure/helpers-pure";
@@ -8,17 +7,12 @@ import {
   getActionsWorkflowRunUrl as getVariantAnalysisActionsWorkflowRunUrl,
 } from "../remote-queries/shared/variant-analysis";
 
-export type QueryHistoryInfo =
-  | LocalQueryInfo
-  | RemoteQueryHistoryItem
-  | VariantAnalysisHistoryItem;
+export type QueryHistoryInfo = LocalQueryInfo | VariantAnalysisHistoryItem;
 
 export function getRawQueryName(item: QueryHistoryInfo): string {
   switch (item.t) {
     case "local":
       return item.getQueryName();
-    case "remote":
-      return item.remoteQuery.queryName;
     case "variant-analysis":
       return item.variantAnalysis.query.name;
     default:
@@ -37,8 +31,6 @@ export function getQueryId(item: QueryHistoryInfo): string {
   switch (item.t) {
     case "local":
       return item.initialInfo.id;
-    case "remote":
-      return item.queryId;
     case "variant-analysis":
       return item.variantAnalysis.id.toString();
     default:
@@ -50,56 +42,30 @@ export function getQueryText(item: QueryHistoryInfo): string {
   switch (item.t) {
     case "local":
       return item.initialInfo.queryText;
-    case "remote":
-      return item.remoteQuery.queryText;
     case "variant-analysis":
       return item.variantAnalysis.query.text;
     default:
       assertNever(item);
   }
 }
 
-export function buildRepoLabel(
-  item: RemoteQueryHistoryItem | VariantAnalysisHistoryItem,
-): string {
-  if (item.t === "remote") {
-    // Return the number of repositories queried if available. Otherwise, use the controller repository name.
-    const repositoryCount = item.remoteQuery.repositoryCount;
-
-    if (repositoryCount) {
-      return pluralize(repositoryCount, "repository", "repositories");
-    }
-    return `${item.remoteQuery.controllerRepository.owner}/${item.remoteQuery.controllerRepository.name}`;
-  } else if (item.t === "variant-analysis") {
-    const totalScannedRepositoryCount =
-      item.variantAnalysis.scannedRepos?.length ?? 0;
-    const completedRepositoryCount =
-      item.variantAnalysis.scannedRepos?.filter((repo) =>
-        hasRepoScanCompleted(repo),
-      ).length ?? 0;
+export function buildRepoLabel(item: VariantAnalysisHistoryItem): string {
+  const totalScannedRepositoryCount =
+    item.variantAnalysis.scannedRepos?.length ?? 0;
+  const completedRepositoryCount =
+    item.variantAnalysis.scannedRepos?.filter((repo) =>
+      hasRepoScanCompleted(repo),
+    ).length ?? 0;
 
-    return `${completedRepositoryCount}/${pluralize(
-      totalScannedRepositoryCount,
-      "repository",
-      "repositories",
-    )}`; // e.g. "2/3 repositories"
-  } else {
-    assertNever(item);
-  }
+  return `${completedRepositoryCount}/${pluralize(
+    totalScannedRepositoryCount,
+    "repository",
+    "repositories",
+  )}`; // e.g. "2/3 repositories"
 }
 
 export function getActionsWorkflowRunUrl(
-  item: RemoteQueryHistoryItem | VariantAnalysisHistoryItem,
+  item: VariantAnalysisHistoryItem,
 ): string {
-  if (item.t === "remote") {
-    const {
-      actionsWorkflowRunId: workflowRunId,
-      controllerRepository: { owner, name },
-    } = item.remoteQuery;
-    return `https://github.com/${owner}/${name}/actions/runs/${workflowRunId}`;
-  } else if (item.t === "variant-analysis") {
-    return getVariantAnalysisActionsWorkflowRunUrl(item.variantAnalysis);
-  } else {
-    assertNever(item);
-  }
+  return getVariantAnalysisActionsWorkflowRunUrl(item.variantAnalysis);
 }

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

@@ -53,8 +53,6 @@ import {
 import { pathExists } from "fs-extra";
 import { CliVersionConstraint } from "../cli";
 import { HistoryItemLabelProvider } from "./history-item-label-provider";
-import { cancelRemoteQuery } from "../remote-queries/gh-api/gh-actions-api-client";
-import { RemoteQueryHistoryItem } from "../remote-queries/remote-query-history-item";
 import { ResultsView } from "../interface";
 import { WebviewReveal } from "../interface-utils";
 import { EvalLogViewer } from "../eval-log-viewer";
@@ -65,7 +63,6 @@ import { QueryRunner } from "../queryRunner";
 import { VariantAnalysisManager } from "../remote-queries/variant-analysis-manager";
 import { VariantAnalysisHistoryItem } from "./variant-analysis-history-item";
 import { getTotalResultCount } from "../remote-queries/shared/variant-analysis";
-import { App } from "../common/app";
 import { HistoryTreeDataProvider } from "./history-tree-data-provider";
 import { redactableError } from "../pure/errors";
 
@@ -137,7 +134,6 @@ export class QueryHistoryManager extends DisposableObject {
   readonly onDidCompleteQuery = this._onDidCompleteQuery.event;
 
   constructor(
-    private readonly app: App,
     private readonly qs: QueryRunner,
     private readonly dbm: DatabaseManager,
     private readonly localQueriesResultsView: ResultsView,
@@ -525,9 +521,6 @@ export class QueryHistoryManager extends DisposableObject {
       case "local":
         queryPath = finalSingleItem.initialInfo.queryPath;
         break;
-      case "remote":
-        queryPath = finalSingleItem.remoteQuery.queryFilePath;
-        break;
       default:
         assertNever(finalSingleItem);
     }
@@ -553,12 +546,6 @@ export class QueryHistoryManager extends DisposableObject {
     return this.treeDataProvider.getCurrent();
   }
 
-  getRemoteQueryById(queryId: string): RemoteQueryHistoryItem | undefined {
-    return this.treeDataProvider.allHistory.find(
-      (i) => i.t === "remote" && i.queryId === queryId,
-    ) as RemoteQueryHistoryItem;
-  }
-
   async removeDeletedQueries() {
     await Promise.all(
       this.treeDataProvider.allHistory.map(async (item) => {
@@ -595,8 +582,6 @@ export class QueryHistoryManager extends DisposableObject {
             // We need to delete it from disk as well.
             await item.completedQuery?.query.deleteQuery();
           }
-        } else if (item.t === "remote") {
-          // Do nothing. TODO: Remove once remote queries are no longer supported.
         } else if (item.t === "variant-analysis") {
           await this.removeVariantAnalysis(item);
         } else {
@@ -808,8 +793,6 @@ export class QueryHistoryManager extends DisposableObject {
       if (queryHistoryItem.completedQuery) {
         return queryHistoryItem.completedQuery.query.querySaveDir;
       }
-    } else if (queryHistoryItem.t === "remote") {
-      return join(this.queryStorageDir, queryHistoryItem.queryId);
     } else if (queryHistoryItem.t === "variant-analysis") {
       return this.variantAnalysisManager.getVariantAnalysisStorageLocation(
         queryHistoryItem.variantAnalysis.id,
@@ -840,12 +823,6 @@ export class QueryHistoryManager extends DisposableObject {
           "timestamp",
         );
       }
-    } else if (finalSingleItem.t === "remote") {
-      externalFilePath = join(
-        this.queryStorageDir,
-        finalSingleItem.queryId,
-        "timestamp",
-      );
     } else if (finalSingleItem.t === "variant-analysis") {
       externalFilePath = join(
         this.variantAnalysisManager.getVariantAnalysisStorageLocation(
@@ -1012,11 +989,6 @@ export class QueryHistoryManager extends DisposableObject {
       if (item.status === QueryStatus.InProgress) {
         if (item.t === "local") {
           item.cancel();
-        } else if (item.t === "remote") {
-          void showAndLogInformationMessage(
-            "Cancelling variant analysis. This may take a while.",
-          );
-          await cancelRemoteQuery(this.app.credentials, item.remoteQuery);
         } else if (item.t === "variant-analysis") {
           await commands.executeCommand(
             "codeQL.cancelVariantAnalysis",
@@ -1239,10 +1211,8 @@ export class QueryHistoryManager extends DisposableObject {
       return;
     }
 
-    // Remote queries and variant analysis only
-    if (finalSingleItem.t === "remote") {
-      // Do nothing. TODO: Remove this case once remote queries are removed.
-    } else if (finalSingleItem.t === "variant-analysis") {
+    // Variant analysis only
+    if (finalSingleItem.t === "variant-analysis") {
       await commands.executeCommand(
         "codeQL.exportVariantAnalysisResults",
         finalSingleItem.variantAnalysis.id,
@@ -1475,8 +1445,6 @@ the file in the file explorer and dragging it into the workspace.`,
         WebviewReveal.Forced,
         false,
       );
-    } else if (item.t === "remote") {
-      // Do nothing. TODO: Remove when remote queries is no longer supported.
     } else if (item.t === "variant-analysis") {
       await this.variantAnalysisManager.showView(item.variantAnalysis.id);
     } else {

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

@@ -10,7 +10,6 @@ import {
 } from "./pure/helpers-pure";
 import { CompletedQueryInfo, LocalQueryInfo } from "./query-results";
 import { QueryHistoryInfo } from "./query-history/query-history-info";
-import { QueryStatus } from "./query-status";
 import { QueryEvaluationInfo } from "./run-queries-shared";
 import { QueryResultType } from "./pure/legacy-messages";
 import { redactableError } from "./pure/errors";
@@ -33,58 +32,57 @@ export async function deserializeQueryHistory(
     }
 
     const queries = obj.queries;
-    const parsedQueries = queries.map((q: QueryHistoryInfo) => {
-      // Need to explicitly set prototype since reading in from JSON will not
-      // do this automatically. Note that we can't call the constructor here since
-      // the constructor invokes extra logic that we don't want to do.
-      if (q.t === "local") {
-        Object.setPrototypeOf(q, LocalQueryInfo.prototype);
+    const parsedQueries = queries
+      // Remove remote queries, which are not supported anymore.
+      .filter((q: QueryHistoryInfo | { t: "remote" }) => q.t !== "remote")
+      .map((q: QueryHistoryInfo) => {
+        // Need to explicitly set prototype since reading in from JSON will not
+        // do this automatically. Note that we can't call the constructor here since
+        // the constructor invokes extra logic that we don't want to do.
+        if (q.t === "local") {
+          Object.setPrototypeOf(q, LocalQueryInfo.prototype);
 
-        // Date instances are serialized as strings. Need to
-        // convert them back to Date instances.
-        (q.initialInfo as any).start = new Date(q.initialInfo.start);
-        if (q.completedQuery) {
-          // Again, need to explicitly set prototypes.
-          Object.setPrototypeOf(q.completedQuery, CompletedQueryInfo.prototype);
-          Object.setPrototypeOf(
-            q.completedQuery.query,
-            QueryEvaluationInfo.prototype,
-          );
-          // deserialized queries do not need to be disposed
-          q.completedQuery.dispose = () => {
-            /**/
-          };
+          // Date instances are serialized as strings. Need to
+          // convert them back to Date instances.
+          (q.initialInfo as any).start = new Date(q.initialInfo.start);
+          if (q.completedQuery) {
+            // Again, need to explicitly set prototypes.
+            Object.setPrototypeOf(
+              q.completedQuery,
+              CompletedQueryInfo.prototype,
+            );
+            Object.setPrototypeOf(
+              q.completedQuery.query,
+              QueryEvaluationInfo.prototype,
+            );
+            // deserialized queries do not need to be disposed
+            q.completedQuery.dispose = () => {
+              /**/
+            };
 
-          // Previously, there was a typo in the completedQuery type. There was a field
-          // `sucessful` and it was renamed to `successful`. We need to handle this case.
-          if ("sucessful" in q.completedQuery) {
-            (q.completedQuery as any).successful = (
-              q.completedQuery as any
-            ).sucessful;
-            delete (q.completedQuery as any).sucessful;
-          }
+            // Previously, there was a typo in the completedQuery type. There was a field
+            // `sucessful` and it was renamed to `successful`. We need to handle this case.
+            if ("sucessful" in q.completedQuery) {
+              (q.completedQuery as any).successful = (
+                q.completedQuery as any
+              ).sucessful;
+              delete (q.completedQuery as any).sucessful;
+            }
 
-          if (!("successful" in q.completedQuery)) {
-            (q.completedQuery as any).successful =
-              q.completedQuery.result?.resultType === QueryResultType.SUCCESS;
+            if (!("successful" in q.completedQuery)) {
+              (q.completedQuery as any).successful =
+                q.completedQuery.result?.resultType === QueryResultType.SUCCESS;
+            }
           }
         }
-      } else if (q.t === "remote") {
-        // A bug was introduced that didn't set the completed flag in query history
-        // items. The following code makes sure that the flag is set in order to
-        // "patch" older query history items.
-        if (q.status === QueryStatus.Completed) {
-          q.completed = true;
-        }
-      }
-      return q;
-    });
+        return q;
+      });
 
     // filter out queries that have been deleted on disk
     // most likely another workspace has deleted them because the
     // queries aged out.
     return asyncFilter(parsedQueries, async (q) => {
-      if (q.t === "remote" || q.t === "variant-analysis") {
+      if (q.t === "variant-analysis") {
         // the deserializer doesn't know where the remote queries are stored
         // so we need to assume here that they exist. Later, we check to
         // see if they exist on disk.

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

@@ -47,9 +47,7 @@ export async function exportSelectedRemoteQueryResults(
     );
   }
 
-  if (queryHistoryItem.t === "remote") {
-    // Do nothing. TODO: Remove this branch once we stop supporting remote queries.
-  } else if (queryHistoryItem.t === "variant-analysis") {
+  if (queryHistoryItem.t === "variant-analysis") {
     return commands.executeCommand(
       "codeQL.exportVariantAnalysisResults",
       queryHistoryItem.variantAnalysis.id,