@decocms/tanstack 7.22.0 → 7.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/tanstack",
-  "version": "7.22.0",
+  "version": "7.22.1",
   "type": "module",
   "description": "Deco framework binding for TanStack Start + Cloudflare Workers",
   "repository": {
@@ -24,9 +24,9 @@
     "lint:unused": "knip"
   },
   "dependencies": {
-    "@decocms/blocks": "7.22.0",
-    "@decocms/blocks-admin": "7.22.0",
-    "@decocms/blocks-cli": "7.22.0",
+    "@decocms/blocks": "7.22.1",
+    "@decocms/blocks-admin": "7.22.1",
+    "@decocms/blocks-cli": "7.22.1",
     "@deco-cx/warp-node": "^0.3.16",
     "fast-json-patch": "^3.1.0",
     "ws": "^8.18.0"

package/src/sdk/workerEntry.test.ts

@@ -430,3 +430,53 @@ describe("POST /_cache/purge-loaders", () => {
     expect(res.status).toBe(404);
   });
 });
+
+describe("X-Cache-Segment — custom SegmentKey fields (#284)", () => {
+  afterEach(() => {
+    __resetKvHydrationStateForTests();
+    setBlocks({});
+  });
+
+  const HTML_SERVER_ENTRY = {
+    fetch: async (_req: Request) =>
+      new Response("<html>hi</html>", {
+        status: 200,
+        headers: { "content-type": "text/html; charset=utf-8" },
+      }),
+  };
+
+  it("includes a custom segment field in X-Cache-Segment instead of dropping it", async () => {
+    const worker = createDecoWorkerEntry(HTML_SERVER_ENTRY, {
+      observability: false,
+      buildSegment: () => ({ device: "desktop", regionId: "RJ", delivery: "store-42" }),
+    });
+    const res = await worker.fetch(new Request("https://example.com/"), EMPTY_ENV, MOCK_CTX);
+    expect(res.headers.get("X-Cache-Segment")).toBe("desktop|r=RJ|delivery=store-42");
+  });
+
+  it("produces different X-Cache-Segment hashes for requests that only differ by a custom field", async () => {
+    let delivery = "store-1";
+    const worker = createDecoWorkerEntry(HTML_SERVER_ENTRY, {
+      observability: false,
+      buildSegment: () => ({ device: "desktop", delivery }),
+    });
+
+    const first = await worker.fetch(new Request("https://example.com/"), EMPTY_ENV, MOCK_CTX);
+    const firstSegment = first.headers.get("X-Cache-Segment");
+
+    delivery = "store-2";
+    const second = await worker.fetch(new Request("https://example.com/"), EMPTY_ENV, MOCK_CTX);
+    const secondSegment = second.headers.get("X-Cache-Segment");
+
+    expect(firstSegment).not.toBe(secondSegment);
+  });
+
+  it("keeps the existing hash format for segments using only known fields (back-compat)", async () => {
+    const worker = createDecoWorkerEntry(HTML_SERVER_ENTRY, {
+      observability: false,
+      buildSegment: () => ({ device: "desktop", salesChannel: "1", flags: ["b", "a"] }),
+    });
+    const res = await worker.fetch(new Request("https://example.com/"), EMPTY_ENV, MOCK_CTX);
+    expect(res.headers.get("X-Cache-Segment")).toBe("desktop|sc=1|f=a,b");
+  });
+});

package/src/sdk/workerEntry.ts

@@ -172,6 +172,13 @@ export interface SegmentKey {
   regionId?: string;
   /** Sorted list of active A/B flag names for cache cohort splitting. */
   flags?: string[];
+  /**
+   * Custom cache dimensions beyond the known fields above (e.g. a
+   * store/CEP-based delivery selector). `hashSegment` serializes these
+   * automatically — unlike the known fields, there's no dedicated shorthand
+   * key, so don't reuse a name already declared above.
+   */
+  [customField: string]: string | boolean | string[] | undefined;
 }
 
 /**
@@ -983,12 +990,34 @@ export function createDecoWorkerEntry(
     return detectCacheProfile(target);
   }
 
+  const KNOWN_SEGMENT_FIELDS = new Set([
+    "device",
+    "loggedIn",
+    "salesChannel",
+    "regionId",
+    "flags",
+  ]);
+
   function hashSegment(seg: SegmentKey): string {
     const parts: string[] = [seg.device];
     if (seg.loggedIn) parts.push("auth");
     if (seg.salesChannel) parts.push(`sc=${seg.salesChannel}`);
     if (seg.regionId) parts.push(`r=${seg.regionId}`);
     if (seg.flags?.length) parts.push(`f=${seg.flags.sort().join(",")}`);
+    // Custom dimensions (anything beyond the known fields above) are
+    // serialized generically so they aren't silently dropped from the
+    // cache key — see #284.
+    const customKeys = Object.keys(seg)
+      .filter((k) => !KNOWN_SEGMENT_FIELDS.has(k) && seg[k] !== undefined)
+      .sort();
+    for (const k of customKeys) {
+      const v = seg[k];
+      if (v === "" || v === false || (Array.isArray(v) && v.length === 0)) {
+        continue;
+      }
+      const serialized = Array.isArray(v) ? [...v].sort().join(",") : v === true ? "" : String(v);
+      parts.push(serialized ? `${k}=${serialized}` : k);
+    }
     return parts.join("|");
   }