fix(block): order imports by relevance

Author: ApocDev

app/src/server/block-compute.server.ts

@@ -1058,7 +1058,13 @@ export async function computeBlock(rawData: SolveInput) {
   const negativeGoalNames = new Set(
     data.goals.filter((goal) => goal.rate < 0).map((goal) => goal.name),
   );
-  const displayImports = imports.filter((flow) => !negativeGoalNames.has(flow.name));
+  const displayImports = imports
+    .filter((flow) => !negativeGoalNames.has(flow.name))
+    .sort((a, b) => {
+      if (a.name === ELECTRICITY) return -1;
+      if (b.name === ELECTRICITY) return 1;
+      return b.rate - a.rate || byNameAsc(a, b);
+    });
   const fuelItems = [...fuelTotals.keys()]; // for the 🔥 tag in the UI
   const burntItems = [...burntTotals.keys()]; // ash / depleted cells from burning
 

app/src/server/block-compute.test.ts

@@ -71,14 +71,15 @@ describe("module suggestions outside the core solve", () => {
     fx = await makeTestDb();
     fx.db.exec(`
       INSERT INTO items (name, display) VALUES
-        ('ore','Ore'),('plate','Plate'),('prod-module','Productivity module');
+        ('ore','Ore'),('flux','Flux'),('plate','Plate'),('prod-module','Productivity module');
       INSERT INTO recipes
         (name, kind, category, energy_required, allow_productivity, enabled, hidden)
         VALUES
         ('make-plate','real','crafting',1,1,1,0),
         ('craft-prod-module','real','crafting',1,0,1,0);
-      INSERT INTO recipe_ingredients (recipe, idx, kind, name, amount)
-        VALUES ('make-plate',0,'item','ore',1);
+      INSERT INTO recipe_ingredients (recipe, idx, kind, name, amount) VALUES
+        ('make-plate',0,'item','ore',1),
+        ('make-plate',1,'item','flux',2);
       INSERT INTO recipe_products (recipe, idx, kind, name, amount) VALUES
         ('make-plate',0,'item','plate',1),
         ('craft-prod-module',0,'item','prod-module',1);
@@ -113,6 +114,19 @@ describe("module suggestions outside the core solve", () => {
       ]),
     ).toEqual({ "make-plate": ["prod-module", "prod-module"] });
   });
+
+  it("displays electricity first, then imports by descending rate", async () => {
+    const solved = await computeBlock({
+      goals: [{ name: "plate", rate: 1 }],
+      recipes: ["make-plate"],
+    });
+
+    expect(solved.displayImports.map(({ name, rate }) => ({ name, rate }))).toEqual([
+      { name: "pyops-electricity", rate: 0.1 },
+      { name: "flux", rate: 2 },
+      { name: "ore", rate: 1 },
+    ]);
+  });
 });
 
 describe("incidental spoilage stays outside the nominal block solve", () => {

docs/guide/blocks.md

@@ -32,6 +32,7 @@ production appears separately in Factory.
 
 A negative goal is already the block's visible import contract, so Block balance does not
 repeat that good under **Imports**. Other ingredients the block needs still appear there.
+Electricity is listed first, followed by the remaining imports from highest to lowest rate.
 
 ## Add recipes