Merge pull request #4065 from jcogs33/jcogs33/view-autofixes

Add "View Autofixes" feature for variant analysis results

Author: aeisenberg

extensions/ql-vscode/package.json

@@ -958,6 +958,10 @@
         "command": "codeQLQueryHistory.copyRepoList",
         "title": "Copy Repository List"
       },
+      {
+        "command": "codeQLQueryHistory.viewAutofixes",
+        "title": "View Autofixes"
+      },
       {
         "command": "codeQLQueryResults.down",
         "title": "CodeQL: Navigate Down in Local Result Viewer"
@@ -1296,6 +1300,11 @@
           "group": "1_queryHistory@1",
           "when": "viewItem == remoteResultsItem"
         },
+        {
+          "command": "codeQLQueryHistory.viewAutofixes",
+          "group": "1_queryHistory@2",
+          "when": "viewItem == remoteResultsItem && config.codeQL.canary"
+        },
         {
           "command": "codeQLQueries.runLocalQueryFromQueriesPanel",
           "group": "inline",
@@ -1706,6 +1715,10 @@
           "command": "codeQLQueryHistory.copyRepoList",
           "when": "false"
         },
+        {
+          "command": "codeQLQueryHistory.viewAutofixes",
+          "when": "false"
+        },
         {
           "command": "codeQLQueryHistory.showQueryText",
           "when": "false"

extensions/ql-vscode/src/common/commands.ts

@@ -197,6 +197,7 @@ export type QueryHistoryCommands = {
   "codeQLQueryHistory.itemClicked": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.openOnGithub": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
   "codeQLQueryHistory.copyRepoList": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
+  "codeQLQueryHistory.viewAutofixes": TreeViewContextMultiSelectionCommandFunction<QueryHistoryInfo>;
 
   // Commands in the command palette
   "codeQL.exportSelectedVariantAnalysisResults": () => Promise<void>;

extensions/ql-vscode/src/common/interface-types.ts

@@ -163,6 +163,25 @@ interface SetUserSettingsMsg {
   userSettings: UserSettings;
 }
 
+export interface VariantAnalysisUserSettings {
+  /** Whether to display the "View Autofixes" button. */
+  shouldShowViewAutofixesButton: boolean;
+}
+
+export const DEFAULT_VARIANT_ANALYSIS_USER_SETTINGS: VariantAnalysisUserSettings =
+  {
+    shouldShowViewAutofixesButton: false,
+  };
+
+/**
+ * Message indicating that the user's variant analysis configuration
+ * settings have changed.
+ */
+interface SetVariantAnalysisUserSettingsMsg {
+  t: "setVariantAnalysisUserSettings";
+  variantAnalysisUserSettings: VariantAnalysisUserSettings;
+}
+
 /**
  * Message indicating that the results view should display interpreted
  * results.
@@ -527,6 +546,11 @@ interface OpenQueryTextMessage {
   t: "openQueryText";
 }
 
+interface ViewAutofixesMessage {
+  t: "viewAutofixes";
+  filterSort?: RepositoriesFilterSortStateWithIds;
+}
+
 interface CopyRepositoryListMessage {
   t: "copyRepositoryList";
   filterSort?: RepositoriesFilterSortStateWithIds;
@@ -554,13 +578,15 @@ export type ToVariantAnalysisMessage =
   | SetVariantAnalysisMessage
   | SetFilterSortStateMessage
   | SetRepoResultsMessage
-  | SetRepoStatesMessage;
+  | SetRepoStatesMessage
+  | SetVariantAnalysisUserSettingsMsg;
 
 export type FromVariantAnalysisMessage =
   | CommonFromViewMessages
   | RequestRepositoryResultsMessage
   | OpenQueryFileMessage
   | OpenQueryTextMessage
+  | ViewAutofixesMessage
   | CopyRepositoryListMessage
   | ExportResultsMessage
   | OpenLogsMessage

extensions/ql-vscode/src/config.ts

@@ -954,3 +954,17 @@ export class GitHubDatabaseConfigListener
     await GITHUB_DATABASE_UPDATE.updateValue(value, target);
   }
 }
+
+const AUTOFIX_SETTING = new Setting("autofix", ROOT_SETTING);
+
+export const AUTOFIX_PATH = new Setting("path", AUTOFIX_SETTING);
+
+export function getAutofixPath(): string | undefined {
+  return AUTOFIX_PATH.getValue<string>() || undefined;
+}
+
+export const AUTOFIX_MODEL = new Setting("model", AUTOFIX_SETTING);
+
+export function getAutofixModel(): string | undefined {
+  return AUTOFIX_MODEL.getValue<string>() || undefined;
+}

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

@@ -338,6 +338,11 @@ export class QueryHistoryManager extends DisposableObject {
         this.handleOpenOnGithub.bind(this),
         "query",
       ),
+      "codeQLQueryHistory.viewAutofixes": createSingleSelectionCommand(
+        this.app.logger,
+        this.handleViewAutofixes.bind(this),
+        "query",
+      ),
       "codeQLQueryHistory.copyRepoList": createSingleSelectionCommand(
         this.app.logger,
         this.handleCopyRepoList.bind(this),
@@ -1052,6 +1057,14 @@ export class QueryHistoryManager extends DisposableObject {
     );
   }
 
+  async handleViewAutofixes(item: QueryHistoryInfo) {
+    if (item.t !== "variant-analysis") {
+      return;
+    }
+
+    await this.variantAnalysisManager.viewAutofixes(item.variantAnalysis.id);
+  }
+
   async handleCopyRepoList(item: QueryHistoryInfo) {
     if (item.t !== "variant-analysis") {
       return;

extensions/ql-vscode/src/variant-analysis/variant-analysis-manager.ts

@@ -73,6 +73,7 @@ import type {
   VariantAnalysisCommands,
 } from "../common/commands";
 import { exportVariantAnalysisResults } from "./export-results";
+import { viewAutofixesForVariantAnalysisResults } from "./view-autofixes";
 import {
   readRepoStates,
   REPO_STATES_FILENAME,
@@ -967,6 +968,21 @@ export class VariantAnalysisManager
     );
   }
 
+  public async viewAutofixes(
+    variantAnalysisId: number,
+    filterSort: RepositoriesFilterSortStateWithIds = defaultFilterSortState,
+  ) {
+    await viewAutofixesForVariantAnalysisResults(
+      this,
+      this.variantAnalysisResultsManager,
+      variantAnalysisId,
+      filterSort,
+      this.app.credentials,
+      this.app,
+      this.cliServer,
+    );
+  }
+
   public async copyRepoListToClipboard(
     variantAnalysisId: number,
     filterSort: RepositoriesFilterSortStateWithIds = defaultFilterSortState,

extensions/ql-vscode/src/variant-analysis/variant-analysis-results-manager.ts

@@ -44,6 +44,7 @@ export type LoadResultsOptions = {
 
 export class VariantAnalysisResultsManager extends DisposableObject {
   private static readonly RESULTS_DIRECTORY = "results";
+  private static readonly RESULTS_SARIF_FILENAME = "results.sarif";
 
   private readonly cachedResults: Map<
     CacheKey,
@@ -212,7 +213,10 @@ export class VariantAnalysisResultsManager extends DisposableObject {
       storageDirectory,
       VariantAnalysisResultsManager.RESULTS_DIRECTORY,
     );
-    const sarifPath = join(resultsDirectory, "results.sarif");
+    const sarifPath = join(
+      resultsDirectory,
+      VariantAnalysisResultsManager.RESULTS_SARIF_FILENAME,
+    );
     const bqrsPath = join(resultsDirectory, "results.bqrs");
 
     let interpretedResults: AnalysisAlert[] | undefined;
@@ -294,6 +298,17 @@ export class VariantAnalysisResultsManager extends DisposableObject {
     return join(variantAnalysisStoragePath, fullName);
   }
 
+  public getRepoResultsSarifStoragePath(
+    variantAnalysisStoragePath: string,
+    fullName: string,
+  ): string {
+    return join(
+      this.getRepoStorageDirectory(variantAnalysisStoragePath, fullName),
+      VariantAnalysisResultsManager.RESULTS_DIRECTORY,
+      VariantAnalysisResultsManager.RESULTS_SARIF_FILENAME,
+    );
+  }
+
   private createGitHubFileLinkPrefix(fullName: string, sha: string): string {
     return new URL(
       `/${fullName}/blob/${sha}`,

extensions/ql-vscode/src/variant-analysis/variant-analysis-view-manager.ts

@@ -34,4 +34,8 @@ export interface VariantAnalysisViewManager<
     variantAnalysisId: number,
     filterSort?: RepositoriesFilterSortStateWithIds,
   ): Promise<void>;
+  viewAutofixes(
+    variantAnalysisId: number,
+    filterSort?: RepositoriesFilterSortStateWithIds,
+  ): Promise<void>;
 }

extensions/ql-vscode/src/variant-analysis/variant-analysis-view.ts

@@ -27,6 +27,7 @@ import type { App } from "../common/app";
 import {
   getVariantAnalysisDefaultResultsFilter,
   getVariantAnalysisDefaultResultsSort,
+  isCanary,
 } from "../config";
 
 export class VariantAnalysisView
@@ -53,6 +54,13 @@ export class VariantAnalysisView
     panel.reveal(undefined, true);
 
     await this.waitForPanelLoaded();
+
+    await this.postMessage({
+      t: "setVariantAnalysisUserSettings",
+      variantAnalysisUserSettings: {
+        shouldShowViewAutofixesButton: isCanary(),
+      },
+    });
   }
 
   public async updateView(variantAnalysis: VariantAnalysis): Promise<void> {
@@ -135,6 +143,12 @@ export class VariantAnalysisView
       case "openQueryText":
         await this.manager.openQueryText(this.variantAnalysisId);
         break;
+      case "viewAutofixes":
+        await this.manager.viewAutofixes(
+          this.variantAnalysisId,
+          msg.filterSort,
+        );
+        break;
       case "copyRepositoryList":
         await this.manager.copyRepoListToClipboard(
           this.variantAnalysisId,