Merge pull request #3380 from github/koesie10/processed-method-modeling

Add processed by auto model state to method modeling panel

Author: koesie10

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

@@ -623,6 +623,11 @@ interface SetInProgressMessage {
   inProgress: boolean;
 }
 
+interface SetProcessedByAutoModelMessage {
+  t: "setProcessedByAutoModel";
+  processedByAutoModel: boolean;
+}
+
 interface RevealMethodMessage {
   t: "revealMethod";
   methodSignature: string;
@@ -696,6 +701,7 @@ interface SetSelectedMethodMessage {
   modeledMethods: ModeledMethod[];
   isModified: boolean;
   isInProgress: boolean;
+  processedByAutoModel: boolean;
 }
 
 export type ToMethodModelingMessage =
@@ -705,4 +711,5 @@ export type ToMethodModelingMessage =
   | SetMethodModifiedMessage
   | SetSelectedMethodMessage
   | SetInModelingModeMessage
-  | SetInProgressMessage;
+  | SetInProgressMessage
+  | SetProcessedByAutoModelMessage;

extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-view-provider.ts

@@ -82,6 +82,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
           modeledMethods: selectedMethod.modeledMethods,
           isModified: selectedMethod.isModified,
           isInProgress: selectedMethod.isInProgress,
+          processedByAutoModel: selectedMethod.processedByAutoModel,
         });
       }
 
@@ -200,6 +201,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
             modeledMethods: e.modeledMethods,
             isModified: e.isModified,
             isInProgress: e.isInProgress,
+            processedByAutoModel: e.processedByAutoModel,
           });
         }
       }),
@@ -248,6 +250,21 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
         }
       }),
     );
+
+    this.push(
+      this.modelingEvents.onProcessedByAutoModelMethodsChanged(async (e) => {
+        if (this.method && this.databaseItem) {
+          const dbUri = this.databaseItem.databaseUri.toString();
+          if (e.dbUri === dbUri) {
+            const processedByAutoModel = e.methods.has(this.method.signature);
+            await this.postMessage({
+              t: "setProcessedByAutoModel",
+              processedByAutoModel,
+            });
+          }
+        }
+      }),
+    );
   }
 
   private registerToModelConfigEvents(): void {

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

@@ -114,7 +114,7 @@ export function modeledMethodSupportsProvenance(
 export function isModelPending(
   modeledMethod: ModeledMethod | undefined,
   modelingStatus: ModelingStatus,
-  processedByAutoModel?: boolean,
+  processedByAutoModel: boolean,
 ): boolean {
   if (
     (!modeledMethod || modeledMethod.type === "none") &&

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

@@ -54,6 +54,7 @@ export type MethodModelingProps = {
   method: Method;
   modeledMethods: ModeledMethod[];
   isModelingInProgress: boolean;
+  isProcessedByAutoModel: boolean;
   onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
 };
 
@@ -63,6 +64,7 @@ export const MethodModeling = ({
   modeledMethods,
   method,
   isModelingInProgress,
+  isProcessedByAutoModel,
   onChange,
 }: MethodModelingProps): React.JSX.Element => {
   return (
@@ -81,6 +83,7 @@ export const MethodModeling = ({
         method={method}
         modeledMethods={modeledMethods}
         isModelingInProgress={isModelingInProgress}
+        isProcessedByAutoModel={isProcessedByAutoModel}
         modelingStatus={modelingStatus}
         onChange={onChange}
       />

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

@@ -33,6 +33,9 @@ export function MethodModelingView({
   const [isModelingInProgress, setIsModelingInProgress] =
     useState<boolean>(false);
 
+  const [isProcessedByAutoModel, setIsProcessedByAutoModel] =
+    useState<boolean>(false);
+
   const modelingStatus = useMemo(
     () => getModelingStatus(modeledMethods, isMethodModified),
     [modeledMethods, isMethodModified],
@@ -62,10 +65,15 @@ export function MethodModelingView({
             setMethod(msg.method);
             setModeledMethods(msg.modeledMethods);
             setIsMethodModified(msg.isModified);
+            setIsModelingInProgress(msg.isInProgress);
+            setIsProcessedByAutoModel(msg.processedByAutoModel);
             break;
           case "setInProgress":
             setIsModelingInProgress(msg.inProgress);
             break;
+          case "setProcessedByAutoModel":
+            setIsProcessedByAutoModel(msg.processedByAutoModel);
+            break;
           default:
             assertNever(msg);
         }
@@ -112,6 +120,7 @@ export function MethodModelingView({
       method={method}
       modeledMethods={modeledMethods}
       isModelingInProgress={isModelingInProgress}
+      isProcessedByAutoModel={isProcessedByAutoModel}
       onChange={onChange}
     />
   );

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

@@ -23,6 +23,7 @@ export type MultipleModeledMethodsPanelProps = {
   modeledMethods: ModeledMethod[];
   modelingStatus: ModelingStatus;
   isModelingInProgress: boolean;
+  isProcessedByAutoModel: boolean;
   onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
 };
 
@@ -64,6 +65,7 @@ export const MultipleModeledMethodsPanel = ({
   modeledMethods,
   modelingStatus,
   isModelingInProgress,
+  isProcessedByAutoModel,
   onChange,
 }: MultipleModeledMethodsPanelProps) => {
   const [selectedIndex, setSelectedIndex] = useState<number>(0);
@@ -160,6 +162,7 @@ export const MultipleModeledMethodsPanel = ({
           modelPending={isModelPending(
             modeledMethods[selectedIndex],
             modelingStatus,
+            isProcessedByAutoModel,
           )}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
@@ -169,7 +172,11 @@ export const MultipleModeledMethodsPanel = ({
           language={language}
           method={method}
           modeledMethod={undefined}
-          modelPending={false}
+          modelPending={isModelPending(
+            modeledMethods[selectedIndex],
+            modelingStatus,
+            isProcessedByAutoModel,
+          )}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
         />

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

@@ -13,6 +13,7 @@ describe(MethodModeling.name, () => {
     const method = createMethod();
     const modeledMethod = createSinkModeledMethod();
     const isModelingInProgress = false;
+    const isProcessedByAutoModel = false;
     const onChange = jest.fn();
 
     render({
@@ -21,6 +22,7 @@ describe(MethodModeling.name, () => {
       method,
       modeledMethods: [modeledMethod],
       isModelingInProgress,
+      isProcessedByAutoModel,
       onChange,
     });