modal_stack 0.3.0 → 0.4.1

data/app/javascript/modal_stack/orchestrator.js

@@ -2,6 +2,8 @@ import {
   closeAll,
   createStack,
   handlePopstate,
+  pathBack,
+  pathTo,
   pop,
   push,
   replaceTop,
@@ -104,25 +106,65 @@ export class Orchestrator {
     return this.#dispatch(replaceTop(this.state, patch, opts), { html, fragment });
   }
 
+  /**
+   * Append a frame to the top layer's path.
+   * @param {{ url: string, stale?: boolean }} frame
+   * @param {{ html?: string|null, fragment?: DocumentFragment|null, transition?: string|null }} [options]
+   */
+  async pathTo(frame, { html = null, fragment = null, transition = null } = {}) {
+    let resolvedStale = frame?.stale === true;
+    if (fragment == null && html == null && frame?.url) {
+      const meta = await this.#prefetchWithMeta(frame.url);
+      fragment = meta.fragment;
+      // The caller's explicit `stale: true` always wins; if they didn't say,
+      // honor the X-Modal-Stack-Stale response header surfaced by the runtime.
+      if (frame.stale !== true && meta.stale === true) resolvedStale = true;
+    }
+    return this.#dispatch(
+      pathTo(this.state, { url: frame.url, stale: resolvedStale }, { transition }),
+      { html, fragment },
+    );
+  }
+
+  /**
+   * Step back through frames in the top layer's path.
+   * @param {{ steps?: number, transition?: string|null }} [options]
+   */
+  pathBack({ steps = 1, transition = null } = {}) {
+    return this.#dispatch(pathBack(this.state, { steps, transition }));
+  }
+
   async #prefetch(url) {
-    if (typeof this.runtime.fetchFragment !== "function") return null;
+    const meta = await this.#prefetchWithMeta(url);
+    return meta.fragment;
+  }
+
+  async #prefetchWithMeta(url) {
+    if (typeof this.runtime.fetchFragment !== "function") {
+      return { fragment: null, stale: false };
+    }
 
     const cached = this.#fragmentCache.get(url);
     if (cached && Date.now() - cached.ts < this.prefetchTtlMs) {
-      return cloneFragment(cached.fragment);
+      return { fragment: cloneFragment(cached.fragment), stale: cached.stale === true };
     }
 
     const existing = this.#inflight.get(url);
     if (existing) {
       const entry = await existing.promise;
-      return cloneFragment(entry.fragment);
+      return { fragment: cloneFragment(entry.fragment), stale: entry.stale === true };
     }
 
     const controller = supportsAbort() ? new AbortController() : null;
     const fetchPromise = this.runtime
       .fetchFragment(url, controller ? { signal: controller.signal } : undefined)
-      .then((fragment) => {
-        const entry = { fragment, ts: Date.now() };
+      .then((result) => {
+        // BrowserRuntime returns { fragment, stale }; older test fakes
+        // (and prior behavior) returned a bare DocumentFragment — accept
+        // both so we don't lock the runtime contract too tightly.
+        const fragment = result?.fragment ?? result;
+        const stale = result?.stale === true;
+        const entry = { fragment, stale, ts: Date.now() };
         this.#fragmentCache.set(url, entry);
         return entry;
       })
@@ -132,7 +174,7 @@ export class Orchestrator {
 
     this.#inflight.set(url, { controller, promise: fetchPromise });
     const entry = await fetchPromise;
-    return cloneFragment(entry.fragment);
+    return { fragment: cloneFragment(entry.fragment), stale: entry.stale === true };
   }
 
   // Aborts every in-flight prefetch and forgets any cached fragments.
@@ -183,7 +225,11 @@ export class Orchestrator {
   async #dispatch({ state, commands }, payload = {}) {
     this.state = state;
     for (const cmd of commands) {
-      if (cmd.type === "mountLayer" || cmd.type === "morphTopLayer") {
+      if (
+        cmd.type === "mountLayer" ||
+        cmd.type === "morphTopLayer" ||
+        cmd.type === "mountFrame"
+      ) {
         if (payload.html != null) cmd.html = payload.html;
         if (payload.fragment != null) cmd.fragment = payload.fragment;
       }

data/app/javascript/modal_stack/orchestrator.test.js

@@ -23,6 +23,9 @@ function recordingRuntime() {
     "rebuildFromSnapshot",
     "persistSnapshot",
     "clearSnapshot",
+    "mountFrame",
+    "unmountFrame",
+    "clearFrameCache",
   ];
   const runtime = { _calls: calls };
   for (const name of handlerNames) {
@@ -198,6 +201,93 @@ describe("replaceTop", () => {
   });
 });
 
+describe("pathTo", () => {
+  test("appends a frame, dispatches mountFrame + pushHistory + persistSnapshot", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    runtime._calls.length = 0;
+
+    await orchestrator.pathTo({ url: "/wizard/2" });
+    expect(orchestrator.layers[0].frames).toHaveLength(2);
+    const types = runtime._calls.map((c) => c.type);
+    expect(types).toEqual([
+      "mountFrame",
+      "pushHistory",
+      "persistSnapshot",
+    ]);
+    const mount = runtime._calls.find((c) => c.type === "mountFrame");
+    expect(mount).toMatchObject({
+      layerId: "L1",
+      fromFrameIndex: 0,
+      toFrameIndex: 1,
+      url: "/wizard/2",
+      stale: false,
+    });
+  });
+
+  test("explicit stale: true wins over the response header", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    runtime._calls.length = 0;
+
+    await orchestrator.pathTo({ url: "/wizard/2", stale: true });
+    const mount = runtime._calls.find((c) => c.type === "mountFrame");
+    expect(mount.stale).toBe(true);
+    expect(orchestrator.layers[0].frames[1].stale).toBe(true);
+  });
+
+  test("threads transition through to the runtime", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    runtime._calls.length = 0;
+    await orchestrator.pathTo({ url: "/wizard/2" }, { transition: "fade" });
+    expect(runtime._calls.find((c) => c.type === "mountFrame")).toMatchObject({
+      transition: "fade",
+    });
+  });
+});
+
+describe("pathBack", () => {
+  test("on a single-frame layer is a noop (does not close the layer)", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    runtime._calls.length = 0;
+    await orchestrator.pathBack();
+    expect(orchestrator.layers[0].frames).toHaveLength(1);
+    expect(runtime._calls).toEqual([]);
+  });
+
+  test("steps back through frames and walks history", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    await orchestrator.pathTo({ url: "/wizard/2" });
+    await orchestrator.pathTo({ url: "/wizard/3" });
+    runtime._calls.length = 0;
+
+    await orchestrator.pathBack({ steps: 2 });
+    expect(orchestrator.layers[0].frames).toHaveLength(1);
+    const types = runtime._calls.map((c) => c.type);
+    expect(types).toEqual([
+      "unmountFrame",
+      "historyBack",
+      "persistSnapshot",
+    ]);
+    expect(runtime._calls.find((c) => c.type === "historyBack")).toEqual({
+      type: "historyBack",
+      n: 2,
+    });
+  });
+
+  test("guards the popstate that history.go triggers", async () => {
+    await orchestrator.push({ id: "L1", url: "/wizard/1" });
+    await orchestrator.pathTo({ url: "/wizard/2" });
+    runtime._calls.length = 0;
+
+    await orchestrator.pathBack();
+    runtime._calls.length = 0;
+    await orchestrator.onPopstate({
+      historyState: { stackId: STACK_ID, layerId: "L1", depth: 1, frameIndex: 0 },
+      locationHref: "/wizard/1",
+    });
+    expect(runtime._calls).toEqual([]);
+  });
+});
+
 describe("closeAll", () => {
   test("clears layers and increments guard once for the historyBack call", async () => {
     await orchestrator.push({ id: "L1", url: "/x" });
@@ -210,6 +300,8 @@ describe("closeAll", () => {
     expect(types).toEqual([
       "closeDialog",
       "unmountAllLayers",
+      "clearFrameCache",
+      "clearFrameCache",
       "unlockScroll",
       "historyBack",
       "clearSnapshot",
@@ -256,6 +348,9 @@ describe("prefetch cache + abort", () => {
       "rebuildFromSnapshot",
       "persistSnapshot",
       "clearSnapshot",
+      "mountFrame",
+      "unmountFrame",
+      "clearFrameCache",
     ];
     const runtime = { _calls: calls, _fetches: [], _aborts: aborts };
     for (const name of handlerNames) {
@@ -467,6 +562,7 @@ describe("onPopstate", () => {
     expect(types).toEqual([
       "closeDialog",
       "unmountAllLayers",
+      "clearFrameCache",
       "unlockScroll",
       "clearSnapshot",
     ]);

data/app/javascript/modal_stack/runtime.js

@@ -1,8 +1,13 @@
 export const SNAPSHOT_KEY = "modalStackSnapshot";
 export const FRAGMENT_HEADER = "X-Modal-Stack-Request";
+// Server response header that flags the just-rendered frame as stale —
+// the runtime will refetch instead of restoring from the in-memory cache
+// when the user steps back to it.
+export const STALE_HEADER = "X-Modal-Stack-Stale";
 export const SCROLLBAR_WIDTH_VAR = "--modal-stack-scrollbar-width";
 
 const LAYER_SELECTOR = '[data-modal-stack-target="layer"]';
+const FRAME_SELECTOR = "[data-modal-stack-frame]";
 // CSS variable host stylesheets set to declare their leave-transition
 // duration (e.g. "220ms"). When present, the runtime sizes its safety
 // timeout from this value; otherwise it falls back to a conservative cap.
@@ -48,6 +53,10 @@ export class BrowserRuntime {
     this.fetcher = fetcher;
     this.store = store;
     this.document = documentRef;
+    // Cached DocumentFragments for path frames, keyed by `${layerId}#${frameIndex}`.
+    // Populated by mountFrame on the way forward, drained by unmountFrame on
+    // the way back, purged on layer teardown via clearFrameCache.
+    this._frameCache = new Map();
   }
 
   showDialog() {
@@ -93,7 +102,10 @@ export class BrowserRuntime {
     const frag = await this.#resolveFragment({ url, html, fragment });
     const layer = this.document.createElement("div");
     this.#applyLayerAttrs(layer, { layerId, depth, variant, dismissible, size, side, width, height });
-    layer.append(...frag.childNodes);
+    this.#applyFrameDepth(layer, 0);
+    const wrapper = this.#createFrameWrapper({ frameIndex: 0 });
+    wrapper.append(...frag.childNodes);
+    layer.appendChild(wrapper);
     this.dialog.appendChild(layer);
   }
 
@@ -102,7 +114,81 @@ export class BrowserRuntime {
     const layer = this.#topLayer();
     if (!layer) return;
     this.#applyLayerAttrs(layer, { layerId, depth, variant, dismissible, size, side, width, height });
-    layer.replaceChildren(...frag.childNodes);
+    this.#applyFrameDepth(layer, 0);
+    const wrapper = this.#createFrameWrapper({ frameIndex: 0 });
+    wrapper.append(...frag.childNodes);
+    layer.replaceChildren(wrapper);
+  }
+
+  async mountFrame({ layerId, fromFrameIndex, toFrameIndex, url, html, fragment, transition }) {
+    const layer = this.#findLayer(layerId);
+    if (!layer) return;
+    const frag = await this.#resolveFragment({ url, html, fragment });
+
+    // Snapshot the outgoing frame's children for back navigation. We cache
+    // the original nodes (not clones) and detach them from the DOM — the
+    // animateOut below operates on the wrapper, which we'll throw away.
+    const oldFrame = this.#findFrame(layer, fromFrameIndex);
+    if (oldFrame) {
+      const cached = this.document.createDocumentFragment();
+      cached.append(...oldFrame.childNodes);
+      this._frameCache.set(this.#frameKey(layerId, fromFrameIndex), cached);
+    }
+
+    const newFrame = this.#createFrameWrapper({ frameIndex: toFrameIndex, transition, direction: "forward" });
+    newFrame.append(...frag.childNodes);
+    layer.appendChild(newFrame);
+    this.#applyFrameDepth(layer, toFrameIndex);
+
+    // Old frame is removed synchronously. Entering frames carry
+    // data-transition + data-direction so host CSS can drive the *enter*
+    // animation via @starting-style; the leaving frame would need its own
+    // overlapping layout (e.g. position: absolute) to also animate out,
+    // which we leave to the host CSS preset.
+    if (oldFrame) oldFrame.remove();
+
+    // Remove transition attrs once the animation completes so the :has()
+    // rule that clips overflow doesn't persist indefinitely.
+    if (transition) this.#cleanupFrameTransition(newFrame);
+  }
+
+  async unmountFrame({ layerId, fromFrameIndex, toFrameIndex, url, stale, transition }) {
+    const layer = this.#findLayer(layerId);
+    if (!layer) return;
+
+    const cacheKey = this.#frameKey(layerId, toFrameIndex);
+    let restored = stale ? null : this._frameCache.get(cacheKey) ?? null;
+    if (!restored) {
+      const result = await this.fetchFragment(url);
+      restored = result.fragment;
+      this._frameCache.set(cacheKey, cloneFragment(restored, this.document));
+    } else {
+      // Clone so the cache entry remains usable if we step back here again
+      // after another forward.
+      restored = cloneFragment(restored, this.document);
+    }
+
+    const newFrame = this.#createFrameWrapper({ frameIndex: toFrameIndex, transition, direction: "back" });
+    newFrame.append(...restored.childNodes);
+    layer.appendChild(newFrame);
+    this.#applyFrameDepth(layer, toFrameIndex);
+
+    // Drop cache entries for frames that are now gone (anything past the
+    // restored index — we only keep entries for frames still tracked in
+    // state).
+    this.#purgeFrameCacheAbove(layerId, toFrameIndex);
+
+    const oldFrame = this.#findFrame(layer, fromFrameIndex);
+    if (oldFrame) oldFrame.remove();
+
+    if (transition) this.#cleanupFrameTransition(newFrame);
+  }
+
+  clearFrameCache({ layerId }) {
+    const prefix = `${layerId}#`;
+    for (const key of [...this._frameCache.keys()]) {
+      if (key.startsWith(prefix)) this._frameCache.delete(key);
+    }
   }
 
   async unmountTopLayer() {
@@ -197,6 +283,57 @@ export class BrowserRuntime {
     );
   }
 
+  #findFrame(layer, frameIndex) {
+    return layer.querySelector(
+      `${FRAME_SELECTOR}[data-frame-index="${escapeAttr(String(frameIndex))}"]`,
+    );
+  }
+
+  #frameKey(layerId, frameIndex) {
+    return `${layerId}#${frameIndex}`;
+  }
+
+  #purgeFrameCacheAbove(layerId, frameIndex) {
+    const prefix = `${layerId}#`;
+    for (const key of [...this._frameCache.keys()]) {
+      if (!key.startsWith(prefix)) continue;
+      const idx = Number(key.slice(prefix.length));
+      if (Number.isFinite(idx) && idx > frameIndex) {
+        this._frameCache.delete(key);
+      }
+    }
+  }
+
+  // Removes [data-transition] and [data-direction] from a frame once its
+  // enter animation ends. This restores overflow-y:auto on the layer (the
+  // :has([data-transition]) rule in the CSS preset keeps overflow:hidden
+  // while the animation runs to clip off-screen slide frames).
+  #cleanupFrameTransition(frameEl) {
+    let done = false;
+    const cleanup = () => {
+      if (done) return;
+      done = true;
+      frameEl.removeAttribute("data-transition");
+      frameEl.removeAttribute("data-direction");
+    };
+    frameEl.addEventListener("transitionend", cleanup, { once: true });
+    setTimeout(cleanup, this.#leaveTimeoutMs());
+  }
+
+  #createFrameWrapper({ frameIndex, transition = null, direction = null }) {
+    const el = this.document.createElement("div");
+    el.dataset.modalStackFrame = "";
+    el.dataset.frameIndex = String(frameIndex);
+    if (transition) el.dataset.transition = transition;
+    if (direction) el.dataset.direction = direction;
+    return el;
+  }
+
+  #applyFrameDepth(layer, topFrameIndex) {
+    layer.dataset.frameIndex = String(topFrameIndex);
+    layer.dataset.frameDepth = String(topFrameIndex + 1);
+  }
+
   #topLayer() {
     const layers = this.dialog.querySelectorAll(LAYER_SELECTOR);
     return layers[layers.length - 1] ?? null;
@@ -241,13 +378,15 @@ export class BrowserRuntime {
       throw new Error(`modal_stack: fetch ${url} → ${resp.status}`);
     }
     const html = await resp.text();
-    return parseFragment(html, this.document);
+    const stale = parseStaleHeader(resp);
+    return { fragment: parseFragment(html, this.document), stale };
   }
 
   async #resolveFragment({ url, html, fragment }) {
     if (fragment) return fragment;
     if (html != null) return parseFragment(html, this.document);
-    return this.fetchFragment(url);
+    const result = await this.fetchFragment(url);
+    return result.fragment;
   }
 }
 
@@ -259,6 +398,28 @@ function parseFragment(html, doc) {
   return fragment;
 }
 
+function parseStaleHeader(resp) {
+  const headers = resp?.headers;
+  const value =
+    typeof headers?.get === "function"
+      ? headers.get(STALE_HEADER) ?? headers.get(STALE_HEADER.toLowerCase())
+      : null;
+  if (!value) return false;
+  const normalized = String(value).trim().toLowerCase();
+  return normalized === "true" || normalized === "1";
+}
+
+function cloneFragment(fragment, doc) {
+  if (typeof fragment?.cloneNode === "function") {
+    return fragment.cloneNode(true);
+  }
+  const clone = doc.createDocumentFragment();
+  if (fragment?.childNodes) {
+    for (const node of fragment.childNodes) clone.appendChild(node.cloneNode(true));
+  }
+  return clone;
+}
+
 // Marks the layer with [data-leaving] so the host CSS can transition it
 // out, then awaits transitionend (with a hard timeout) before removing
 // the element from the DOM.  If the host CSS doesn't define an exit
@@ -294,5 +455,6 @@ function escapeAttr(value) {
   if (typeof CSS !== "undefined" && typeof CSS.escape === "function") {
     return CSS.escape(value);
   }
-  return String(value).replace(/["\\]/g, "\\$&");
+  // Fallback: escape chars that break CSS attribute selectors ([attr="val"])
+  return String(value).replace(/["\\[\]]/g, "\\$&");
 }

data/app/javascript/modal_stack/runtime.test.js

@@ -4,6 +4,7 @@ import {
   FRAGMENT_HEADER,
   SCROLLBAR_WIDTH_VAR,
   SNAPSHOT_KEY,
+  STALE_HEADER,
 } from "./runtime.js";
 
 function fakeStore() {
@@ -268,4 +269,86 @@ describe("fetch headers", () => {
     expect(captured.opts.headers.Accept).toContain("text/html");
     expect(captured.opts.credentials).toBe("same-origin");
   });
+
+  test("fetchFragment returns { fragment, stale } from response header", async () => {
+    withFakeDOMParser(async () => {
+      const fetcher = () =>
+        Promise.resolve(
+          new Response("<p>frame</p>", {
+            status: 200,
+            headers: { [STALE_HEADER]: "true" },
+          }),
+        );
+      const documentRef = fakeDocument();
+      const rt = new BrowserRuntime(noopRuntimeArgs({ fetcher, documentRef }));
+      const result = await rt.fetchFragment("/x");
+      expect(result.stale).toBe(true);
+      expect(result.fragment).toBeTruthy();
+    });
+  });
+
+  test("fetchFragment.stale is false when header is missing or '0'", async () => {
+    await withFakeDOMParser(async () => {
+      const cases = [
+        new Response("", { status: 200 }),
+        new Response("", { status: 200, headers: { [STALE_HEADER]: "0" } }),
+        new Response("", { status: 200, headers: { [STALE_HEADER]: "false" } }),
+      ];
+      for (const resp of cases) {
+        const documentRef = fakeDocument();
+        const rt = new BrowserRuntime(
+          noopRuntimeArgs({ fetcher: () => Promise.resolve(resp), documentRef }),
+        );
+        const result = await rt.fetchFragment("/x");
+        expect(result.stale).toBe(false);
+      }
+    });
+  });
+});
+
+function fakeDocument() {
+  return {
+    createDocumentFragment: () => {
+      const children = [];
+      return {
+        childNodes: children,
+        append: (...nodes) => children.push(...nodes),
+        appendChild: (n) => children.push(n),
+      };
+    },
+  };
+}
+
+async function withFakeDOMParser(fn) {
+  const original = globalThis.DOMParser;
+  globalThis.DOMParser = class {
+    parseFromString() {
+      return { body: { childNodes: [] } };
+    }
+  };
+  try {
+    return await fn();
+  } finally {
+    if (original) globalThis.DOMParser = original;
+    else delete globalThis.DOMParser;
+  }
+}
+
+describe("frame cache", () => {
+  test("clearFrameCache removes only entries for the given layerId", () => {
+    const rt = new BrowserRuntime(noopRuntimeArgs());
+    rt._frameCache.set("L1#0", "a");
+    rt._frameCache.set("L1#1", "b");
+    rt._frameCache.set("L2#0", "c");
+    rt._frameCache.set("L11#0", "d"); // verify prefix is anchored on `#`
+    rt.clearFrameCache({ layerId: "L1" });
+    expect([...rt._frameCache.keys()].sort()).toEqual(["L11#0", "L2#0"]);
+  });
+
+  test("clearFrameCache is a no-op for unknown layerId", () => {
+    const rt = new BrowserRuntime(noopRuntimeArgs());
+    rt._frameCache.set("L1#0", "a");
+    rt.clearFrameCache({ layerId: "Lz" });
+    expect([...rt._frameCache.keys()]).toEqual(["L1#0"]);
+  });
 });