Merge branch 'main' into robertbrignull/automodel-sort-order

Author: robertbrignull

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

@@ -590,6 +590,14 @@ interface StopGeneratingMethodsFromLlmMessage {
   packageName: string;
 }
 
+interface StartModelEvaluationMessage {
+  t: "startModelEvaluation";
+}
+
+interface StopModelEvaluationMessage {
+  t: "stopModelEvaluation";
+}
+
 interface ModelDependencyMessage {
   t: "modelDependency";
 }
@@ -648,7 +656,9 @@ export type FromModelEditorMessage =
   | StopGeneratingMethodsFromLlmMessage
   | ModelDependencyMessage
   | HideModeledMethodsMessage
-  | SetMultipleModeledMethodsMessage;
+  | SetMultipleModeledMethodsMessage
+  | StartModelEvaluationMessage
+  | StopModelEvaluationMessage;
 
 interface RevealInEditorMessage {
   t: "revealInModelEditor";

extensions/ql-vscode/src/compare/sarif-diff.ts

@@ -1,34 +1,75 @@
-import type { Result } from "sarif";
+import type { Location, Result } from "sarif";
+
+function toCanonicalLocation(location: Location): Location {
+  if (location.physicalLocation?.artifactLocation?.index !== undefined) {
+    const canonicalLocation = {
+      ...location,
+    };
+
+    canonicalLocation.physicalLocation = {
+      ...canonicalLocation.physicalLocation,
+    };
+
+    canonicalLocation.physicalLocation.artifactLocation = {
+      ...canonicalLocation.physicalLocation.artifactLocation,
+    };
+
+    // The index is dependent on the result of the SARIF file and usually doesn't really tell
+    // us anything useful, so we remove it from the comparison.
+    delete canonicalLocation.physicalLocation.artifactLocation.index;
+
+    return canonicalLocation;
+  }
+
+  // Don't create a new object if we don't need to
+  return location;
+}
 
 function toCanonicalResult(result: Result): Result {
   const canonicalResult = {
     ...result,
   };
 
   if (canonicalResult.locations) {
-    canonicalResult.locations = canonicalResult.locations.map((location) => {
-      if (location.physicalLocation?.artifactLocation?.index !== undefined) {
-        const canonicalLocation = {
-          ...location,
-        };
+    canonicalResult.locations =
+      canonicalResult.locations.map(toCanonicalLocation);
+  }
 
-        canonicalLocation.physicalLocation = {
-          ...canonicalLocation.physicalLocation,
-        };
+  if (canonicalResult.relatedLocations) {
+    canonicalResult.relatedLocations =
+      canonicalResult.relatedLocations.map(toCanonicalLocation);
+  }
 
-        canonicalLocation.physicalLocation.artifactLocation = {
-          ...canonicalLocation.physicalLocation.artifactLocation,
-        };
+  if (canonicalResult.codeFlows) {
+    canonicalResult.codeFlows = canonicalResult.codeFlows.map((codeFlow) => {
+      if (codeFlow.threadFlows) {
+        return {
+          ...codeFlow,
+          threadFlows: codeFlow.threadFlows.map((threadFlow) => {
+            if (threadFlow.locations) {
+              return {
+                ...threadFlow,
+                locations: threadFlow.locations.map((threadFlowLocation) => {
+                  if (threadFlowLocation.location) {
+                    return {
+                      ...threadFlowLocation,
+                      location: toCanonicalLocation(
+                        threadFlowLocation.location,
+                      ),
+                    };
+                  }
 
-        // The index is dependent on the result of the SARIF file and usually doesn't really tell
-        // us anything useful, so we remove it from the comparison.
-        delete canonicalLocation.physicalLocation.artifactLocation.index;
+                  return threadFlowLocation;
+                }),
+              };
+            }
 
-        return canonicalLocation;
+            return threadFlow;
+          }),
+        };
       }
 
-      // Don't create a new object if we don't need to
-      return location;
+      return codeFlow;
     });
   }
 

extensions/ql-vscode/src/config.ts

@@ -715,6 +715,7 @@ const LLM_GENERATION_DEV_ENDPOINT = new Setting(
   "llmGenerationDevEndpoint",
   MODEL_SETTING,
 );
+const MODEL_EVALUATION = new Setting("evaluation", MODEL_SETTING);
 const EXTENSIONS_DIRECTORY = new Setting("extensionsDirectory", MODEL_SETTING);
 const ENABLE_PYTHON = new Setting("enablePython", MODEL_SETTING);
 const ENABLE_ACCESS_PATH_SUGGESTIONS = new Setting(
@@ -759,6 +760,10 @@ export class ModelConfigListener extends ConfigListener implements ModelConfig {
     return LLM_GENERATION_DEV_ENDPOINT.getValue<string | undefined>();
   }
 
+  public get modelEvaluation(): boolean {
+    return !!MODEL_EVALUATION.getValue<boolean>();
+  }
+
   public getExtensionsDirectory(languageId: string): string | undefined {
     return EXTENSIONS_DIRECTORY.getValue<string>({
       languageId,

extensions/ql-vscode/src/model-editor/model-editor-view.ts

@@ -337,6 +337,12 @@ export class ModelEditorView extends AbstractWebview<
         this.setModeledMethods(msg.methodSignature, msg.modeledMethods);
         break;
       }
+      case "startModelEvaluation":
+        this.startModelEvaluation();
+        break;
+      case "stopModelEvaluation":
+        this.stopModelEvaluation();
+        break;
       case "telemetry":
         telemetryListener?.sendUIInteraction(msg.action);
         break;
@@ -402,6 +408,8 @@ export class ModelEditorView extends AbstractWebview<
     const showLlmButton =
       this.databaseItem.language === "java" && this.modelConfig.llmGeneration;
 
+    const showEvaluationUi = this.modelConfig.modelEvaluation;
+
     const sourceArchiveAvailable =
       this.databaseItem.hasSourceArchiveInExplorer();
 
@@ -416,6 +424,7 @@ export class ModelEditorView extends AbstractWebview<
         language: this.language,
         showGenerateButton,
         showLlmButton,
+        showEvaluationUi,
         mode: this.modelingStore.getMode(this.databaseItem),
         showModeSwitchButton,
         sourceArchiveAvailable,
@@ -910,4 +919,12 @@ export class ModelEditorView extends AbstractWebview<
     );
     this.modelingStore.addModifiedMethod(this.databaseItem, signature);
   }
+
+  private startModelEvaluation() {
+    // Do nothing for now. This will be fleshed out in the near future.
+  }
+
+  private stopModelEvaluation() {
+    // Do nothing for now. This will be fleshed out in the near future.
+  }
 }

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

@@ -111,19 +111,27 @@ export function modeledMethodSupportsProvenance(
   );
 }
 
-export function isModelAccepted(
+export function isModelPending(
   modeledMethod: ModeledMethod | undefined,
   modelingStatus: ModelingStatus,
+  processedByAutoModel?: boolean,
 ): boolean {
-  if (!modeledMethod) {
+  if (
+    (!modeledMethod || modeledMethod.type === "none") &&
+    processedByAutoModel
+  ) {
     return true;
   }
 
+  if (!modeledMethod) {
+    return false;
+  }
+
   return (
-    modelingStatus !== "unsaved" ||
-    modeledMethod.type === "none" ||
-    !modeledMethodSupportsProvenance(modeledMethod) ||
-    modeledMethod.provenance !== "ai-generated"
+    modelingStatus === "unsaved" &&
+    modeledMethod.type !== "none" &&
+    modeledMethodSupportsProvenance(modeledMethod) &&
+    modeledMethod.provenance === "ai-generated"
   );
 }
 

extensions/ql-vscode/src/model-editor/shared/view-state.ts

@@ -7,6 +7,7 @@ export interface ModelEditorViewState {
   language: QueryLanguage;
   showGenerateButton: boolean;
   showLlmButton: boolean;
+  showEvaluationUi: boolean;
   mode: Mode;
   showModeSwitchButton: boolean;
   sourceArchiveAvailable: boolean;

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

@@ -66,5 +66,5 @@ export const ModelingNotAccepted = Template.bind({});
 ModelingNotAccepted.args = {
   method,
   modeledMethod: generatedModeledMethod,
-  modelingStatus: "unsaved",
+  modelPending: true,
 };

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

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

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

@@ -1,6 +1,7 @@
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import type { Method } from "../../model-editor/method";
 import type { ModeledMethod } from "../../model-editor/modeled-method";
+import { isModelPending } from "../../model-editor/modeled-method";
 import {
   canAddNewModeledMethod,
   canRemoveModeledMethod,
@@ -156,7 +157,10 @@ export const MultipleModeledMethodsPanel = ({
           language={language}
           method={method}
           modeledMethod={modeledMethods[selectedIndex]}
-          modelingStatus={modelingStatus}
+          modelPending={isModelPending(
+            modeledMethods[selectedIndex],
+            modelingStatus,
+          )}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
         />
@@ -165,7 +169,7 @@ export const MultipleModeledMethodsPanel = ({
           language={language}
           method={method}
           modeledMethod={undefined}
-          modelingStatus={modelingStatus}
+          modelPending={false}
           isModelingInProgress={isModelingInProgress}
           onChange={handleChange}
         />

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

@@ -17,7 +17,7 @@ describe(MethodModelingInputs.name, () => {
   const language = QueryLanguage.Java;
   const method = createMethod();
   const modeledMethod = createSinkModeledMethod();
-  const modelingStatus = "unmodeled";
+  const modelPending = false;
   const isModelingInProgress = false;
   const onChange = jest.fn();
 
@@ -26,7 +26,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
-      modelingStatus,
+      modelPending,
       isModelingInProgress,
       onChange,
     });
@@ -53,7 +53,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
-      modelingStatus,
+      modelPending,
       isModelingInProgress,
       onChange,
     });
@@ -76,7 +76,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
-      modelingStatus,
+      modelPending,
       isModelingInProgress,
       onChange,
     });
@@ -91,7 +91,7 @@ describe(MethodModelingInputs.name, () => {
         language={language}
         method={method}
         modeledMethod={updatedModeledMethod}
-        modelingStatus={modelingStatus}
+        modelPending={modelPending}
         isModelingInProgress={isModelingInProgress}
         onChange={onChange}
       />,
@@ -121,7 +121,7 @@ describe(MethodModelingInputs.name, () => {
       language,
       method,
       modeledMethod,
-      modelingStatus,
+      modelPending,
       isModelingInProgress: true,
       onChange,
     });