Add "View Autofixes" feature for variant analysis results

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

@@ -151,10 +151,13 @@ interface SetStateMsg {
 export interface UserSettings {
   /** Whether to display links to the dataflow models that generated particular nodes in a flow path. */
   shouldShowProvenance: boolean;
+  /** Whether to display the "View Autofixes" button. */
+  shouldShowViewAutofixesBtn: boolean;
 }
 
 export const DEFAULT_USER_SETTINGS: UserSettings = {
   shouldShowProvenance: false,
+  shouldShowViewAutofixesBtn: false,
 };
 
 /** Message indicating that the user's configuration settings have changed. */
@@ -527,6 +530,11 @@ interface OpenQueryTextMessage {
   t: "openQueryText";
 }
 
+interface ViewAutofixesMessage {
+  t: "viewAutofixes";
+  filterSort?: RepositoriesFilterSortStateWithIds;
+}
+
 interface CopyRepositoryListMessage {
   t: "copyRepositoryList";
   filterSort?: RepositoriesFilterSortStateWithIds;
@@ -554,13 +562,15 @@ export type ToVariantAnalysisMessage =
   | SetVariantAnalysisMessage
   | SetFilterSortStateMessage
   | SetRepoResultsMessage
-  | SetRepoStatesMessage;
+  | SetRepoStatesMessage
+  | SetUserSettingsMsg;
 
 export type FromVariantAnalysisMessage =
   | CommonFromViewMessages
   | RequestRepositoryResultsMessage
   | OpenQueryFileMessage
   | OpenQueryTextMessage
+  | ViewAutofixesMessage
   | CopyRepositoryListMessage
   | ExportResultsMessage
   | OpenLogsMessage

extensions/ql-vscode/src/compare/compare-view.ts

@@ -119,6 +119,8 @@ export class CompareView extends AbstractWebview<
       t: "setUserSettings",
       userSettings: {
         shouldShowProvenance: isCanary(),
+        // "View Autofixes" button is not supported in compare view
+        shouldShowViewAutofixesBtn: false,
       },
     });
 

extensions/ql-vscode/src/local-queries/results-view.ts

@@ -550,6 +550,8 @@ export class ResultsView extends AbstractWebview<
       userSettings: {
         // Only show provenance info in canary mode for now.
         shouldShowProvenance: isCanary(),
+        // "View Autofixes" button is not supported in results view
+        shouldShowViewAutofixesBtn: false,
       },
     });
 

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/stories/results/AlertTable.stories.tsx

@@ -433,5 +433,6 @@ WithCodeFlows.args = {
   ),
   userSettings: {
     shouldShowProvenance: true,
+    shouldShowViewAutofixesBtn: false, // Not supported in AlertTable
   },
 };

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,22 @@ export class VariantAnalysisManager
     );
   }
 
+  public async viewAutofixes(
+    variantAnalysisId: number,
+    filterSort: RepositoriesFilterSortStateWithIds = defaultFilterSortState,
+  ) {
+    await viewAutofixesForVariantAnalysisResults(
+      variantAnalysisId,
+      filterSort,
+      this.variantAnalyses,
+      this.app.credentials,
+      this.app.logger,
+      this.storagePath,
+      this.app,
+      this.cliServer,
+    );
+  }
+
   public async copyRepoListToClipboard(
     variantAnalysisId: number,
     filterSort: RepositoriesFilterSortStateWithIds = defaultFilterSortState,

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

@@ -1,4 +1,5 @@
-import { ViewColumn } from "vscode";
+import type { ConfigurationChangeEvent } from "vscode";
+import { ViewColumn, workspace } from "vscode";
 import type { WebviewPanelConfig } from "../common/vscode/abstract-webview";
 import { AbstractWebview } from "../common/vscode/abstract-webview";
 import {
@@ -27,6 +28,7 @@ import type { App } from "../common/app";
 import {
   getVariantAnalysisDefaultResultsFilter,
   getVariantAnalysisDefaultResultsSort,
+  isCanary,
 } from "../config";
 
 export class VariantAnalysisView
@@ -46,13 +48,48 @@ export class VariantAnalysisView
     manager.registerView(this);
 
     this.dataFlowPathsView = new DataFlowPathsView(app);
+
+    // Set up configuration change listener
+    this.push(
+      workspace.onDidChangeConfiguration(
+        this.onConfigurationChanged.bind(this),
+      ),
+    );
+  }
+
+  /**
+   * Handler for configuration changes
+   */
+  private onConfigurationChanged(e: ConfigurationChangeEvent): void {
+    // Check if the canary setting has changed
+    if (e.affectsConfiguration("codeQL.canary")) {
+      void this.updateUserSettings();
+    }
+  }
+
+  private async updateUserSettings(): Promise<void> {
+    if (!this.isShowingPanel) {
+      return;
+    }
+
+    await this.postMessage({
+      t: "setUserSettings",
+      userSettings: {
+        // Provenance is not supported in variant analysis view
+        shouldShowProvenance: false,
+        // Only show "View Autofixes" button in canary mode.
+        shouldShowViewAutofixesBtn: isCanary(),
+      },
+    });
   }
 
   public async openView() {
     const panel = await this.getPanel();
     panel.reveal(undefined, true);
 
     await this.waitForPanelLoaded();
+
+    await this.updateUserSettings();
   }
 
   public async updateView(variantAnalysis: VariantAnalysis): Promise<void> {
@@ -135,6 +172,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,