@decocms/blocks-cli 7.14.0 → 7.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/blocks-cli",
-  "version": "7.14.0",
+  "version": "7.15.0",
   "type": "module",
   "description": "Deco codegen (generate-blocks, generate-schema, generate-invoke) and Fresh-to-TanStack migration tooling",
   "repository": {
@@ -30,7 +30,7 @@
     "lint:unused": "knip"
   },
   "dependencies": {
-    "@decocms/blocks": "7.14.0",
+    "@decocms/blocks": "7.15.0",
     "ts-morph": "^27.0.0",
     "tsx": "^4.22.5"
   },

package/scripts/generate-loaders.test.ts

@@ -0,0 +1,64 @@
+/**
+ * Verifies the generated `.deco/loaders.gen.ts` shape: loaders route through
+ * `createLoaderEntry` (so their cache/cacheKey exports drive dedup) while
+ * actions stay plain pass-throughs (never cached/deduped).
+ *
+ * The script is spawned as a subprocess (`npx tsx generate-loaders.ts`) exactly
+ * how sites invoke it.
+ */
+import * as cp from "node:child_process";
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import { afterAll, beforeAll, describe, expect, it } from "vitest";
+
+const SCRIPT = path.resolve(__dirname, "generate-loaders.ts");
+
+function run(cwd: string): { stdout: string; stderr: string; code: number } {
+  const r = cp.spawnSync("npx", ["tsx", SCRIPT], { encoding: "utf8", cwd });
+  return { stdout: r.stdout || "", stderr: r.stderr || "", code: r.status ?? -1 };
+}
+
+describe("generate-loaders — loader vs action emit", () => {
+  let dir: string;
+  let out: string;
+
+  beforeAll(() => {
+    dir = fs.mkdtempSync(path.join(os.tmpdir(), "generate-loaders-"));
+    const write = (rel: string, content: string) => {
+      const abs = path.join(dir, rel);
+      fs.mkdirSync(path.dirname(abs), { recursive: true });
+      fs.writeFileSync(abs, content);
+    };
+    write("src/loaders/related.ts", "export default async () => [];\n");
+    write("src/actions/addToCart.ts", "export default async () => ({});\n");
+
+    const r = run(dir);
+    expect(r.code).toBe(0);
+    out = fs.readFileSync(path.join(dir, ".deco/loaders.gen.ts"), "utf8");
+  });
+
+  afterAll(() => {
+    fs.rmSync(dir, { recursive: true, force: true });
+  });
+
+  it("imports createLoaderEntry when any loader is present", () => {
+    expect(out).toContain(
+      'import { createLoaderEntry } from "@decocms/blocks/sdk/cachedLoader";',
+    );
+  });
+
+  it("wraps loaders (both alias keys) with createLoaderEntry under the non-.ts name", () => {
+    expect(out).toContain(
+      '"site/loaders/related": createLoaderEntry("site/loaders/related", () => import(',
+    );
+    expect(out).toContain(
+      '"site/loaders/related.ts": createLoaderEntry("site/loaders/related", () => import(',
+    );
+  });
+
+  it("keeps actions as plain pass-throughs — never routed through createLoaderEntry", () => {
+    expect(out).toContain('"site/actions/addToCart": async (props: any, request?: Request) => {');
+    expect(out).not.toContain('createLoaderEntry("site/actions/addToCart"');
+  });
+});

package/scripts/generate-loaders.ts

@@ -158,6 +158,12 @@ function isReferenced(key: string): boolean {
 interface LoaderEntry {
   key: string;
   importPath: string;
+  /**
+   * Loaders route through `createLoaderEntry` so their `cache`/`cacheKey`
+   * exports drive single-flight dedup. Actions MUST NOT be cached/deduped
+   * (they mutate) — they stay plain pass-throughs.
+   */
+  kind: "loader" | "action";
 }
 
 const entries: LoaderEntry[] = [];
@@ -175,6 +181,7 @@ for (const filePath of walkDir(loadersDir)) {
   entries.push({
     key,
     importPath: relativeImportPath(outFile, filePath),
+    kind: "loader",
   });
 }
 
@@ -190,33 +197,56 @@ for (const filePath of walkDir(actionsDir)) {
   entries.push({
     key,
     importPath: relativeImportPath(outFile, filePath),
+    kind: "action",
   });
 }
 
 entries.sort((a, b) => a.key.localeCompare(b.key));
 
+const hasLoaderEntries = entries.some((e) => e.kind === "loader");
+
 const lines: string[] = [
   "// Auto-generated by @decocms/blocks-cli/scripts/generate-loaders.ts",
   "// Do not edit manually. Run `npm run generate:loaders` to update.",
   "//",
-  "// Pass-through loader/action entries for COMMERCE_LOADERS.",
-  "// Custom-wired entries should be excluded via --exclude and added manually in setup.ts.",
+  "// Loader entries route through createLoaderEntry so their cache/cacheKey",
+  "// exports drive single-flight dedup (concurrent identical calls in one",
+  "// render collapse to one upstream call). Actions stay plain pass-throughs",
+  "// (never cached/deduped). Custom-wired entries should be excluded via",
+  "// --exclude and added manually in setup.ts.",
   "",
-  "export const siteLoaders: Record<string, (props: any, request?: Request) => Promise<any>> = {",
 ];
+if (hasLoaderEntries) {
+  lines.push('import { createLoaderEntry } from "@decocms/blocks/sdk/cachedLoader";');
+  lines.push("");
+}
+lines.push(
+  "export const siteLoaders: Record<string, (props: any, request?: Request) => Promise<any>> = {",
+);
 
 // Cast the dynamic-import default to `any` so legacy 3-arg
 // `(props, req, ctx)` Fresh/Deno loaders still type-check. Any ctx-dependent
 // path in the loader body throws at runtime and must be refactored.
 for (const entry of entries) {
-  lines.push(`  "${entry.key}": async (props: any, request?: Request) => {`);
-  lines.push(`    const mod = await import("${entry.importPath}");`);
-  lines.push("    return (mod.default as any)(props, request);");
-  lines.push("  },");
-  lines.push(`  "${entry.key}.ts": async (props: any, request?: Request) => {`);
-  lines.push(`    const mod = await import("${entry.importPath}");`);
-  lines.push("    return (mod.default as any)(props, request);");
-  lines.push("  },");
+  if (entry.kind === "loader") {
+    // Both alias keys share the same dedup namespace (the non-.ts name) so a
+    // render that references either collapses onto one in-flight call.
+    lines.push(
+      `  "${entry.key}": createLoaderEntry("${entry.key}", () => import("${entry.importPath}")),`,
+    );
+    lines.push(
+      `  "${entry.key}.ts": createLoaderEntry("${entry.key}", () => import("${entry.importPath}")),`,
+    );
+  } else {
+    lines.push(`  "${entry.key}": async (props: any, request?: Request) => {`);
+    lines.push(`    const mod = await import("${entry.importPath}");`);
+    lines.push("    return (mod.default as any)(props, request);");
+    lines.push("  },");
+    lines.push(`  "${entry.key}.ts": async (props: any, request?: Request) => {`);
+    lines.push(`    const mod = await import("${entry.importPath}");`);
+    lines.push("    return (mod.default as any)(props, request);");
+    lines.push("  },");
+  }
 }
 
 lines.push("};");

package/scripts/migrate/transforms/dead-code.ts

@@ -4,59 +4,19 @@ import type { TransformResult } from "../types";
  * Removes dead code patterns from the old Deco stack that don't work
  * in TanStack Start:
  *
- * - `export const cache = "stale-while-revalidate"` (old cache system)
- * - `export const cacheKey = ...` (old cache key generation)
  * - `crypto.subtle.digestSync(...)` (Deno-only sync API)
+ * - non-active platform branches (see `stripNonPlatformCode`)
  *
+ * NOTE: `export const cache` / `export const cacheKey` are KEPT — they are no
+ * longer dead. `@decocms/blocks` wires them via `createLoaderEntry` so
+ * `cache: "stale-while-revalidate"` drives single-flight dedup keyed by
+ * `cacheKey(props, req)` (the #339 N+1 fix). Only flagged in the notes so the
+ * author verifies the `(props, req)` signature.
  * NOTE: `export const loader` is kept — it's a server-side function the CMS calls.
  * NOTE: invoke.* calls are NOT migrated — they are RPC calls to the server
  * where the CMS config (API keys, etc.) is available. The runtime.ts invoke
  * proxy handles routing them to /deco/invoke/*.
  */
-/**
- * Remove an `export const <name> = ...` block using brace-counting
- * so nested `{}` (for loops, if/else) don't cause premature truncation.
- */
-function removeExportConstBlock(src: string, name: string): string {
-  const pattern = new RegExp(`^export\\s+const\\s+${name}\\s*=`, "m");
-  const match = pattern.exec(src);
-  if (!match) return src;
-
-  // Find the arrow `=>` first, then the opening `{` of the body.
-  // This avoids matching destructuring braces in parameters like
-  // `export const loader = ({ groups }: Props) => { ... }`
-  let pos = match.index + match[0].length;
-  // Look for `=>`
-  const arrowIdx = src.indexOf("=>", pos);
-  if (arrowIdx === -1) {
-    // No arrow function — try simple brace from current position
-    while (pos < src.length && src[pos] !== "{") pos++;
-  } else {
-    // Start searching for `{` after the arrow
-    pos = arrowIdx + 2;
-    while (pos < src.length && src[pos] !== "{") pos++;
-  }
-  if (pos >= src.length) return src; // no brace body, skip
-
-  // Count braces to find the matching closing brace
-  let depth = 0;
-  const start = match.index;
-  for (; pos < src.length; pos++) {
-    if (src[pos] === "{") depth++;
-    else if (src[pos] === "}") {
-      depth--;
-      if (depth === 0) {
-        // Skip optional semicolon and trailing newline
-        let end = pos + 1;
-        if (end < src.length && src[end] === ";") end++;
-        if (end < src.length && src[end] === "\n") end++;
-        return src.slice(0, start) + src.slice(end);
-      }
-    }
-  }
-  return src; // unbalanced braces, don't touch
-}
-
 const ALL_PLATFORMS = ["vtex", "shopify", "linx", "vnda", "wake", "nuvemshop"];
 
 /**
@@ -169,36 +129,22 @@ export function transformDeadCode(content: string, platform?: string): Transform
   let changed = false;
   let result = content;
 
-  // Remove old cache export: export const cache = "stale-while-revalidate" or { maxAge: ... }
+  // KEEP `export const cache` / `export const cacheKey`. These are NO LONGER
+  // dead: `@decocms/blocks` wires them via `createLoaderEntry` (generated in
+  // `.deco/loaders.gen.ts`) so `cache: "stale-while-revalidate"` opts the loader
+  // into single-flight dedup keyed by `cacheKey(props, req)`. Stripping them
+  // would silently reintroduce the #339 N+1 (same loader run once per section).
+  // Flag them so the author verifies the `(props, req)` signature — old
+  // `deco-cx/apps` `cacheKey(props, req, ctx)` loses its 3rd `ctx` arg here.
   if (/^export\s+const\s+cache\s*=/m.test(result)) {
-    // String form: export const cache = "stale-while-revalidate";
-    result = result.replace(
-      /^export\s+const\s+cache\s*=\s*["'][^"']*["'];?\s*\n?/gm,
-      "",
-    );
-    // Object form: export const cache = { maxAge: 60 * 10 };
-    result = result.replace(
-      /^export\s+const\s+cache\s*=\s*\{[^}]*\};?\s*\n?/gm,
-      "",
+    notes.push(
+      "KEPT `export const cache` — now drives single-flight dedup via createLoaderEntry (run `generate` to wire it).",
     );
-    // Multiline object form (use brace-counting)
-    if (/^export\s+const\s+cache\s*=/m.test(result)) {
-      result = removeExportConstBlock(result, "cache");
-    }
-    changed = true;
-    notes.push("Removed dead `export const cache` (old caching system)");
   }
-
-  // Remove old cacheKey export (can be multiline with brace-counting)
   if (/^export\s+const\s+cacheKey\s*=/m.test(result)) {
-    result = removeExportConstBlock(result, "cacheKey");
-    // Also handle simpler inline forms
-    result = result.replace(
-      /^export\s+const\s+cacheKey\s*=[^;]*;\s*\n?/gm,
-      "",
+    notes.push(
+      "MANUAL: `export const cacheKey` is kept and now active — verify its signature is `(props, req)`; the old `ctx` 3rd arg is no longer passed.",
     );
-    changed = true;
-    notes.push("Removed dead `export const cacheKey` (old caching system)");
   }
 
   // NOTE: `export const loader` is kept — these are server-side functions