Update sort order for supported methods and unsaved manual models

Author: robertbrignull

extensions/ql-vscode/src/model-editor/shared/sorting.ts

@@ -1,3 +1,4 @@
+import { canMethodBeModeled } from "../method";
 import type { Method } from "../method";
 import type { ModeledMethod } from "../modeled-method";
 import { Mode } from "./mode";
@@ -32,9 +33,9 @@ export function sortGroupNames(
  * Primarily sorts methods into the following order:
  * - Unsaved positive AutoModel predictions
  * - Negative AutoModel predictions
- * - Unsaved manual models
- * - Umodeled
- * - Modeled and saved (AutoModel and manual)
+ * - Unsaved manual models + unmodeled methods
+ * - Saved models from this model pack (AutoModel and manual)
+ * - Methods not modelable in this model pack
  *
  * Secondary sort order is by number of usages descending, then by method signature ascending.
  */
@@ -48,12 +49,14 @@ export function sortMethods(
   sortedMethods.sort((a, b) => {
     // First sort by the type of method
     const methodAPrimarySortOrdinal = getMethodPrimarySortOrdinal(
-      !!modeledMethodsMap[a.signature]?.length,
+      a,
+      modeledMethodsMap[a.signature] ?? [],
       modifiedSignatures.has(a.signature),
       processedByAutoModelMethods.has(a.signature),
     );
     const methodBPrimarySortOrdinal = getMethodPrimarySortOrdinal(
-      !!modeledMethodsMap[b.signature]?.length,
+      b,
+      modeledMethodsMap[b.signature] ?? [],
       modifiedSignatures.has(b.signature),
       processedByAutoModelMethods.has(b.signature),
     );
@@ -77,23 +80,28 @@ export function sortMethods(
  * Assigns numbers to the following classes of methods:
  * - Unsaved positive AutoModel predictions => 0
  * - Negative AutoModel predictions => 1
- * - Unsaved manual models => 2
- * - Umodeled => 3
- * - Modeled and saved (AutoModel and manual) => 4
+ * - Unsaved manual models + unmodeled methods => 2
+ * - Saved models from this model pack (AutoModel and manual) => 3
+ * - Methods not modelable in this model pack => 4
  */
 function getMethodPrimarySortOrdinal(
-  isModeled: boolean,
-  isModified: boolean,
+  method: Method,
+  modeledMethods: readonly ModeledMethod[],
+  isUnsaved: boolean,
   isProcessedByAutoModel: boolean,
 ): number {
-  if (isModeled && isModified && isProcessedByAutoModel) {
-    return 0;
-  } else if (!isModeled && isProcessedByAutoModel) {
-    return 1;
-  } else if (isModeled && isModified) {
-    return 2;
-  } else if (!isModeled) {
-    return 3;
+  const canBeModeled = canMethodBeModeled(method, modeledMethods, isUnsaved);
+  const isModeled = modeledMethods.length > 0;
+  if (canBeModeled) {
+    if (isModeled && isUnsaved && isProcessedByAutoModel) {
+      return 0;
+    } else if (!isModeled && isProcessedByAutoModel) {
+      return 1;
+    } else if ((isModeled && isUnsaved) || !isModeled) {
+      return 2;
+    } else {
+      return 3;
+    }
   } else {
     return 4;
   }

extensions/ql-vscode/test/unit-tests/model-editor/shared/sorting.test.ts

@@ -12,21 +12,31 @@ describe("sortMethods", () => {
   it("uses primary sort order", () => {
     const unsavedPositiveAutoModelPrediction = createMethod({
       signature: "org.sql2o.Sql2o#open1()",
+      supported: false,
     });
     const negativeAutoModelPrediction = createMethod({
       signature: "org.sql2o.Sql2o#open2()",
+      supported: false,
     });
     const unsavedManualModel = createMethod({
       signature: "org.sql2o.Sql2o#open3()",
+      supported: false,
     });
     const unmodeledMethod = createMethod({
       signature: "org.sql2o.Sql2o#open4()",
+      supported: false,
     });
     const savedAutoModelPrediction = createMethod({
       signature: "org.sql2o.Sql2o#open5()",
+      supported: false,
     });
     const savedManualModel = createMethod({
       signature: "org.sql2o.Sql2o#open6()",
+      supported: false,
+    });
+    const supportedMethod = createMethod({
+      signature: "org.sql2o.Sql2o#open7()",
+      supported: true,
     });
 
     const methods: Method[] = shuffle([
@@ -36,6 +46,7 @@ describe("sortMethods", () => {
       unmodeledMethod,
       savedAutoModelPrediction,
       savedManualModel,
+      supportedMethod,
     ]);
 
     const modeledMethodsMap: Record<string, readonly ModeledMethod[]> = {};
@@ -75,30 +86,36 @@ describe("sortMethods", () => {
       unmodeledMethod,
       savedAutoModelPrediction,
       savedManualModel,
+      supportedMethod,
     ]);
   });
 
   it("uses secondary sort order based on usages and signature", () => {
     const negativeAutoModelPrediction = createMethod({
       signature: "org.sql2o.Sql2o#negative()",
+      supported: false,
       usages: [],
     });
 
     const unmodeledMethodWithTwoUsages = createMethod({
       signature: "org.sql2o.Sql2o#two()",
+      supported: false,
       usages: [createUsage(), createUsage()],
     });
     const unmodeledMethodWithOneUsage = createMethod({
       signature: "org.sql2o.Sql2o#one()",
+      supported: false,
       usages: [createUsage()],
     });
 
     const unmodeledMethodWithEarlierSignature = createMethod({
       signature: "org.sql2o.Sql2o#aaa()",
+      supported: false,
       usages: [],
     });
     const unmodeledMethodWithLaterSignature = createMethod({
       signature: "org.sql2o.Sql2o#bbb()",
+      supported: false,
       usages: [],
     });