canary: use separate message for the user settings for the variant analysis view

Author: Jami Cogswell

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

@@ -151,13 +151,10 @@ 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. */
@@ -166,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.
@@ -563,7 +579,7 @@ export type ToVariantAnalysisMessage =
   | SetFilterSortStateMessage
   | SetRepoResultsMessage
   | SetRepoStatesMessage
-  | SetUserSettingsMsg;
+  | SetVariantAnalysisUserSettingsMsg;
 
 export type FromVariantAnalysisMessage =
   | CommonFromViewMessages

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

@@ -119,8 +119,6 @@ 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,8 +550,6 @@ 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/stories/results/AlertTable.stories.tsx

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

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

@@ -49,29 +49,18 @@ export class VariantAnalysisView
     this.dataFlowPathsView = new DataFlowPathsView(app);
   }
 
-  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();
+    await this.postMessage({
+      t: "setVariantAnalysisUserSettings",
+      variantAnalysisUserSettings: {
+        shouldShowViewAutofixesButton: isCanary(),
+      },
+    });
   }
 
   public async updateView(variantAnalysis: VariantAnalysis): Promise<void> {

extensions/ql-vscode/src/view/results/__tests__/AlertTablePathRow.spec.tsx

@@ -24,7 +24,6 @@ describe(AlertTablePathRow.name, () => {
         sourceLocationPrefix="src"
         userSettings={{
           shouldShowProvenance: false,
-          shouldShowViewAutofixesBtn: false,
         }}
         updateSelectionCallback={jest.fn()}
         toggleExpanded={jest.fn()}

extensions/ql-vscode/src/view/results/__tests__/AlertTableResultRow.spec.tsx

@@ -19,7 +19,6 @@ describe(AlertTableResultRow.name, () => {
         sourceLocationPrefix="src"
         userSettings={{
           shouldShowProvenance: false,
-          shouldShowViewAutofixesBtn: false,
         }}
         updateSelectionCallback={jest.fn()}
         toggleExpanded={jest.fn()}

extensions/ql-vscode/src/view/variant-analysis/VariantAnalysis.tsx

@@ -11,13 +11,13 @@ import { VariantAnalysisOutcomePanels } from "./VariantAnalysisOutcomePanels";
 import { VariantAnalysisLoading } from "./VariantAnalysisLoading";
 import type {
   ToVariantAnalysisMessage,
-  UserSettings,
+  VariantAnalysisUserSettings,
 } from "../../common/interface-types";
 import { vscode } from "../vscode-api";
 import { defaultFilterSortState } from "../../variant-analysis/shared/variant-analysis-filter-sort";
 import { sendTelemetry, useTelemetryOnChange } from "../common/telemetry";
 import { useMessageFromExtension } from "../common/useMessageFromExtension";
-import { DEFAULT_USER_SETTINGS } from "../../common/interface-types";
+import { DEFAULT_VARIANT_ANALYSIS_USER_SETTINGS } from "../../common/interface-types";
 
 export type VariantAnalysisProps = {
   variantAnalysis?: VariantAnalysisDomainModel;
@@ -81,9 +81,10 @@ export function VariantAnalysis({
   useTelemetryOnChange(filterSortState, "variant-analysis-filter-sort-state", {
     debounceTimeoutMillis: 1000,
   });
-  const [userSettings, setUserSettings] = useState<UserSettings>(
-    DEFAULT_USER_SETTINGS,
-  );
+  const [variantAnalysisUserSettings, setVariantAnalysisUserSettings] =
+    useState<VariantAnalysisUserSettings>(
+      DEFAULT_VARIANT_ANALYSIS_USER_SETTINGS,
+    );
 
   useMessageFromExtension<ToVariantAnalysisMessage>((msg) => {
     if (msg.t === "setVariantAnalysis") {
@@ -109,8 +110,8 @@ export function VariantAnalysis({
           ...msg.repoStates,
         ];
       });
-    } else if (msg.t === "setUserSettings") {
-      setUserSettings(msg.userSettings);
+    } else if (msg.t === "setVariantAnalysisUserSettings") {
+      setVariantAnalysisUserSettings(msg.variantAnalysisUserSettings);
     }
   }, []);
 
@@ -172,7 +173,7 @@ export function VariantAnalysis({
         onCopyRepositoryListClick={copyRepositoryList}
         onExportResultsClick={exportResults}
         onViewLogsClick={onViewLogsClick}
-        userSettings={userSettings}
+        variantAnalysisUserSettings={variantAnalysisUserSettings}
       />
       <VariantAnalysisOutcomePanels
         variantAnalysis={variantAnalysis}

extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisActions.tsx

@@ -1,7 +1,6 @@
 import { styled } from "styled-components";
 import { VariantAnalysisStatus } from "../../variant-analysis/shared/variant-analysis";
 import { VscodeButton } from "@vscode-elements/react-elements";
-import type { UserSettings } from "../../common/interface-types";
 
 export type VariantAnalysisActionsProps = {
   variantAnalysisStatus: VariantAnalysisStatus;
@@ -20,7 +19,7 @@ export type VariantAnalysisActionsProps = {
   hasSelectedRepositories?: boolean;
   hasFilteredRepositories?: boolean;
 
-  userSettings: UserSettings;
+  showViewAutofixesButton: boolean;
 };
 
 const Container = styled.div`
@@ -68,13 +67,13 @@ export const VariantAnalysisActions = ({
   exportResultsDisabled,
   hasSelectedRepositories,
   hasFilteredRepositories,
-  userSettings,
+  showViewAutofixesButton,
 }: VariantAnalysisActionsProps) => {
   return (
     <Container>
       {showResultActions && (
         <>
-          {userSettings.shouldShowViewAutofixesBtn && (
+          {showViewAutofixesButton && (
             <Button
               secondary
               onClick={onViewAutofixesClick}

extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisHeader.tsx

@@ -22,7 +22,7 @@ import {
   filterAndSortRepositoriesWithResults,
 } from "../../variant-analysis/shared/variant-analysis-filter-sort";
 import { ViewTitle } from "../common";
-import type { UserSettings } from "../../common/interface-types";
+import type { VariantAnalysisUserSettings } from "../../common/interface-types";
 
 type VariantAnalysisHeaderProps = {
   variantAnalysis: VariantAnalysis;
@@ -41,7 +41,7 @@ type VariantAnalysisHeaderProps = {
 
   onViewLogsClick?: () => void;
 
-  userSettings: UserSettings;
+  variantAnalysisUserSettings: VariantAnalysisUserSettings;
 };
 
 const Container = styled.div`
@@ -90,7 +90,7 @@ export const VariantAnalysisHeader = ({
   onCopyRepositoryListClick,
   onExportResultsClick,
   onViewLogsClick,
-  userSettings,
+  variantAnalysisUserSettings,
 }: VariantAnalysisHeaderProps) => {
   const totalScannedRepositoryCount = useMemo(() => {
     return variantAnalysis.scannedRepos?.length ?? 0;
@@ -170,7 +170,9 @@ export const VariantAnalysisHeader = ({
           hasSelectedRepositories={
             selectedRepositoryIds && selectedRepositoryIds.length > 0
           }
-          userSettings={userSettings}
+          showViewAutofixesButton={
+            variantAnalysisUserSettings.shouldShowViewAutofixesButton
+          }
         />
       </Row>
       <VariantAnalysisStats