Merge pull request #3059 from github/charisk/accepted-models

Differentiate between suggestions and accepted models

Author: charisk

extensions/ql-vscode/src/model-editor/modeled-method.ts

@@ -1,4 +1,5 @@
 import { MethodSignature } from "./method";
+import { ModelingStatus } from "./shared/modeling-status";
 
 export type ModeledMethodType =
   | "none"
@@ -109,3 +110,19 @@ export function modeledMethodSupportsProvenance(
     modeledMethod.type === "neutral"
   );
 }
+
+export function isModelAccepted(
+  modeledMethod: ModeledMethod | undefined,
+  modelingStatus: ModelingStatus,
+): boolean {
+  if (!modeledMethod) {
+    return true;
+  }
+
+  return (
+    modelingStatus !== "unsaved" ||
+    modeledMethod.type === "none" ||
+    !modeledMethodSupportsProvenance(modeledMethod) ||
+    modeledMethod.provenance !== "ai-generated"
+  );
+}

extensions/ql-vscode/src/stories/method-modeling/MethodModeling.stories.tsx

@@ -52,17 +52,17 @@ MultipleModelingsUnmodeled.args = {
   language,
   method,
   modeledMethods: [],
-  showMultipleModels: true,
   modelingStatus: "saved",
+  showMultipleModels: true,
 };
 
 export const MultipleModelingsModeledSingle = Template.bind({});
 MultipleModelingsModeledSingle.args = {
   language,
   method,
   modeledMethods: [createSinkModeledMethod(method)],
-  showMultipleModels: true,
   modelingStatus: "saved",
+  showMultipleModels: true,
 };
 
 export const MultipleModelingsModeledMultiple = Template.bind({});
@@ -78,8 +78,8 @@ MultipleModelingsModeledMultiple.args = {
       kind: "remote",
     }),
   ],
-  showMultipleModels: true,
   modelingStatus: "saved",
+  showMultipleModels: true,
 };
 
 export const MultipleModelingsValidationFailedNeutral = Template.bind({});
@@ -90,8 +90,8 @@ MultipleModelingsValidationFailedNeutral.args = {
     createSinkModeledMethod(method),
     createNeutralModeledMethod(method),
   ],
-  showMultipleModels: true,
   modelingStatus: "unsaved",
+  showMultipleModels: true,
 };
 
 export const MultipleModelingsValidationFailedDuplicate = Template.bind({});
@@ -107,6 +107,6 @@ MultipleModelingsValidationFailedDuplicate.args = {
     }),
     createSinkModeledMethod(method),
   ],
-  showMultipleModels: true,
   modelingStatus: "unsaved",
+  showMultipleModels: true,
 };

extensions/ql-vscode/src/stories/method-modeling/MethodModelingInputs.stories.tsx

@@ -60,3 +60,13 @@ ModelingInProgress.args = {
   modeledMethod,
   isModelingInProgress: true,
 };
+
+const generatedModeledMethod = createSinkModeledMethod({
+  provenance: "ai-generated",
+});
+export const ModelingNotAccepted = Template.bind({});
+ModelingNotAccepted.args = {
+  method,
+  modeledMethod: generatedModeledMethod,
+  modelingStatus: "unsaved",
+};

extensions/ql-vscode/src/view/method-modeling/MethodModeling.tsx

@@ -85,6 +85,7 @@ export const MethodModeling = ({
         modeledMethods={modeledMethods}
         showMultipleModels={showMultipleModels}
         isModelingInProgress={isModelingInProgress}
+        modelingStatus={modelingStatus}
         onChange={onChange}
       />
       <ReviewInEditorButton method={method} />

extensions/ql-vscode/src/view/method-modeling/MethodModelingInputs.tsx

@@ -8,6 +8,7 @@ import { ModelOutputDropdown } from "../model-editor/ModelOutputDropdown";
 import { ModelKindDropdown } from "../model-editor/ModelKindDropdown";
 import { InProgressDropdown } from "../model-editor/InProgressDropdown";
 import { QueryLanguage } from "../../common/query-language";
+import { ModelingStatus } from "../../model-editor/shared/modeling-status";
 
 const Container = styled.div`
   padding-top: 0.5rem;
@@ -27,6 +28,7 @@ export type MethodModelingInputsProps = {
   language: QueryLanguage;
   method: Method;
   modeledMethod: ModeledMethod | undefined;
+  modelingStatus: ModelingStatus;
   isModelingInProgress: boolean;
   onChange: (modeledMethod: ModeledMethod) => void;
 };
@@ -35,13 +37,15 @@ export const MethodModelingInputs = ({
   language,
   method,
   modeledMethod,
+  modelingStatus,
   isModelingInProgress,
   onChange,
 }: MethodModelingInputsProps): JSX.Element => {
   const inputProps = {
     language,
     method,
     modeledMethod,
+    modelingStatus,
     onChange,
   };
 

extensions/ql-vscode/src/view/method-modeling/ModeledMethodsPanel.tsx

@@ -7,11 +7,13 @@ import { styled } from "styled-components";
 import { MultipleModeledMethodsPanel } from "./MultipleModeledMethodsPanel";
 import { convertToLegacyModeledMethod } from "../../model-editor/shared/modeled-methods-legacy";
 import { QueryLanguage } from "../../common/query-language";
+import { ModelingStatus } from "../../model-editor/shared/modeling-status";
 
 export type ModeledMethodsPanelProps = {
   language: QueryLanguage;
   method: Method;
   modeledMethods: ModeledMethod[];
+  modelingStatus: ModelingStatus;
   isModelingInProgress: boolean;
   showMultipleModels: boolean;
   onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
@@ -25,6 +27,7 @@ export const ModeledMethodsPanel = ({
   language,
   method,
   modeledMethods,
+  modelingStatus,
   isModelingInProgress,
   showMultipleModels,
   onChange,
@@ -42,6 +45,7 @@ export const ModeledMethodsPanel = ({
         language={language}
         method={method}
         modeledMethod={convertToLegacyModeledMethod(modeledMethods)}
+        modelingStatus={modelingStatus}
         isModelingInProgress={isModelingInProgress}
         onChange={handleSingleChange}
       />
@@ -53,6 +57,7 @@ export const ModeledMethodsPanel = ({
       language={language}
       method={method}
       modeledMethods={modeledMethods}
+      modelingStatus={modelingStatus}
       isModelingInProgress={isModelingInProgress}
       onChange={onChange}
     />

extensions/ql-vscode/src/view/method-modeling/MultipleModeledMethodsPanel.tsx

@@ -15,11 +15,13 @@ import { ModeledMethodAlert } from "./ModeledMethodAlert";
 import { QueryLanguage } from "../../common/query-language";
 import { createEmptyModeledMethod } from "../../model-editor/modeled-method-empty";
 import { sendTelemetry } from "../common/telemetry";
+import { ModelingStatus } from "../../model-editor/shared/modeling-status";
 
 export type MultipleModeledMethodsPanelProps = {
   language: QueryLanguage;
   method: Method;
   modeledMethods: ModeledMethod[];
+  modelingStatus: ModelingStatus;
   isModelingInProgress: boolean;
   onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
 };
@@ -60,6 +62,7 @@ export const MultipleModeledMethodsPanel = ({
   language,
   method,
   modeledMethods,
+  modelingStatus,
   isModelingInProgress,
   onChange,
 }: MultipleModeledMethodsPanelProps) => {
@@ -154,6 +157,7 @@ export const MultipleModeledMethodsPanel = ({
           language={language}
           method={method}
           modeledMethod={modeledMethods[selectedIndex]}
+          modelingStatus={modelingStatus}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
         />
@@ -162,6 +166,7 @@ export const MultipleModeledMethodsPanel = ({
           language={language}
           method={method}
           modeledMethod={undefined}
+          modelingStatus={modelingStatus}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
         />

extensions/ql-vscode/src/view/method-modeling/__tests__/MethodModelingInputs.spec.tsx

@@ -20,6 +20,7 @@ describe(MethodModelingInputs.name, () => {
   const language = QueryLanguage.Java;
   const method = createMethod();
   const modeledMethod = createSinkModeledMethod();
+  const modelingStatus = "unmodeled";
   const isModelingInProgress = false;
   const onChange = jest.fn();
 
@@ -28,6 +29,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
+      modelingStatus,
       isModelingInProgress,
       onChange,
     });
@@ -54,6 +56,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
+      modelingStatus,
       isModelingInProgress,
       onChange,
     });
@@ -76,6 +79,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
+      modelingStatus,
       isModelingInProgress,
       onChange,
     });
@@ -90,6 +94,7 @@ describe(MethodModelingInputs.name, () => {
         language={language}
         method={method}
         modeledMethod={updatedModeledMethod}
+        modelingStatus={modelingStatus}
         isModelingInProgress={isModelingInProgress}
         onChange={onChange}
       />,
@@ -119,6 +124,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
+      modelingStatus,
       isModelingInProgress: true,
       onChange,
     });

extensions/ql-vscode/src/view/method-modeling/__tests__/ModeledMethodsPanel.spec.tsx

@@ -15,6 +15,7 @@ describe(ModeledMethodsPanel.name, () => {
   const language = QueryLanguage.Java;
   const method = createMethod();
   const modeledMethods = [createSinkModeledMethod(), createSinkModeledMethod()];
+  const modelingStatus = "unmodeled";
   const isModelingInProgress = false;
   const onChange = jest.fn();
 
@@ -27,6 +28,7 @@ describe(ModeledMethodsPanel.name, () => {
         method,
         modeledMethods,
         isModelingInProgress,
+        modelingStatus,
         onChange,
         showMultipleModels,
       });
@@ -40,6 +42,7 @@ describe(ModeledMethodsPanel.name, () => {
         method,
         modeledMethods,
         isModelingInProgress,
+        modelingStatus,
         onChange,
         showMultipleModels,
       });
@@ -60,6 +63,7 @@ describe(ModeledMethodsPanel.name, () => {
         method,
         modeledMethods,
         isModelingInProgress,
+        modelingStatus,
         onChange,
         showMultipleModels,
       });
@@ -73,6 +77,7 @@ describe(ModeledMethodsPanel.name, () => {
         method,
         modeledMethods,
         isModelingInProgress,
+        modelingStatus,
         onChange,
         showMultipleModels,
       });