modal_stack 0.2.0 → 0.4.1

data/app/javascript/modal_stack/runtime.js

@@ -1,11 +1,22 @@
 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"]';
-// Hard cap: never wait longer than this for an exit transition to fire,
-// even if the host CSS forgot to transition the leaving state.
-const LEAVE_TIMEOUT_MS = 600;
+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.
+const DURATION_CSS_VAR = "--modal-stack-duration";
+// Floor for the safety timeout — even very short CSS transitions need
+// enough headroom for transitionend to fire on slow devices.
+const LEAVE_TIMEOUT_FLOOR_MS = 300;
+// Used when no CSS variable is exposed (host CSS missing, JSDOM tests).
+const LEAVE_TIMEOUT_FALLBACK_MS = 600;
 
 /**
  * The only file that touches `<dialog>`, `history`, `fetch`, and
@@ -42,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() {
@@ -87,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);
   }
 
@@ -96,18 +114,93 @@ 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() {
     const layer = this.#topLayer();
     if (!layer) return;
-    await animateOut(layer);
+    await animateOut(layer, this.#leaveTimeoutMs());
   }
 
   async unmountAllLayers() {
     const layers = [...this.dialog.querySelectorAll(LAYER_SELECTOR)];
-    await Promise.all(layers.map(animateOut));
+    const timeout = this.#leaveTimeoutMs();
+    await Promise.all(layers.map((l) => animateOut(l, timeout)));
   }
 
   pushHistory({ url, historyState }) {
@@ -156,12 +249,91 @@ export class BrowserRuntime {
     }
   }
 
+  // Reads --modal-stack-duration from the dialog's computed style and
+  // returns 1.5× that as the safety timeout (in ms). Cached after the
+  // first successful read since the variable is host-CSS-defined and
+  // shouldn't change at runtime. Returns LEAVE_TIMEOUT_FALLBACK_MS when
+  // getComputedStyle is unavailable (tests) or the variable is missing.
+  #leaveTimeoutMs() {
+    if (this._cachedLeaveTimeoutMs != null) return this._cachedLeaveTimeoutMs;
+
+    const get = globalThis.getComputedStyle;
+    if (typeof get !== "function" || !this.dialog?.ownerDocument) {
+      return LEAVE_TIMEOUT_FALLBACK_MS;
+    }
+
+    let parsed = NaN;
+    try {
+      const raw = get(this.dialog).getPropertyValue(DURATION_CSS_VAR);
+      parsed = parseDurationMs(raw);
+    } catch {
+      // getComputedStyle can throw in detached/foreign documents.
+    }
+
+    const ms = Number.isFinite(parsed)
+      ? Math.max(Math.ceil(parsed * 1.5), LEAVE_TIMEOUT_FLOOR_MS)
+      : LEAVE_TIMEOUT_FALLBACK_MS;
+    this._cachedLeaveTimeoutMs = ms;
+    return ms;
+  }
+
   #findLayer(layerId) {
     return this.dialog.querySelector(
       `${LAYER_SELECTOR}[data-layer-id="${escapeAttr(layerId)}"]`,
     );
   }
 
+  #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;
@@ -193,25 +365,28 @@ export class BrowserRuntime {
     }
   }
 
-  async fetchFragment(url) {
+  async fetchFragment(url, { signal } = {}) {
     const resp = await this.fetcher(url, {
       headers: {
         Accept: "text/html, text/vnd.turbo-stream.html",
         [FRAGMENT_HEADER]: "1",
       },
       credentials: "same-origin",
+      signal,
     });
     if (!resp.ok) {
       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;
   }
 }
 
@@ -223,11 +398,33 @@ 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
 // transition, the timeout still fires and the layer is removed cleanly.
-function animateOut(layer) {
+function animateOut(layer, timeoutMs = LEAVE_TIMEOUT_FALLBACK_MS) {
   return new Promise((resolve) => {
     let done = false;
     const finish = () => {
@@ -239,13 +436,25 @@ function animateOut(layer) {
     };
     layer.addEventListener("transitionend", finish, { once: true });
     layer.dataset.leaving = "";
-    setTimeout(finish, LEAVE_TIMEOUT_MS);
+    setTimeout(finish, timeoutMs);
   });
 }
 
+// Parses a CSS time token ("220ms", "0.22s", "  220 ms ") to milliseconds.
+// Returns NaN when the input is empty or unparseable so callers can fall back.
+function parseDurationMs(raw) {
+  if (typeof raw !== "string") return NaN;
+  const value = raw.trim();
+  if (!value) return NaN;
+  const num = parseFloat(value);
+  if (!Number.isFinite(num)) return NaN;
+  return /m?s$/i.test(value) && !/ms$/i.test(value) ? num * 1000 : num;
+}
+
 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() {
@@ -179,6 +180,74 @@ describe("scroll lock", () => {
   });
 });
 
+describe("leave timeout from CSS variable", () => {
+  function rtWithDuration(raw) {
+    const ownerDocument = {};
+    const dialog = {
+      ownerDocument,
+      querySelectorAll: () => [],
+    };
+    const documentRef = { documentElement: {}, body: {} };
+    const original = globalThis.getComputedStyle;
+    globalThis.getComputedStyle = () => ({
+      getPropertyValue: (name) =>
+        name === "--modal-stack-duration" ? raw : "",
+    });
+    const rt = new BrowserRuntime(
+      noopRuntimeArgs({ dialog, documentRef }),
+    );
+    return { rt, restore: () => (globalThis.getComputedStyle = original) };
+  }
+
+  async function trigger(rt) {
+    // unmountAllLayers reads the timeout once (querying [] layers, so it
+    // resolves immediately) and stashes the result on _cachedLeaveTimeoutMs.
+    await rt.unmountAllLayers();
+  }
+
+  test("derives 1.5x of the CSS variable, with a 300ms floor", async () => {
+    const { rt, restore } = rtWithDuration("220ms");
+    try {
+      await trigger(rt);
+      // 220ms × 1.5 = 330ms
+      expect(rt._cachedLeaveTimeoutMs).toBe(330);
+    } finally {
+      restore();
+    }
+  });
+
+  test("floors the timeout at 300ms for very fast transitions", async () => {
+    const { rt, restore } = rtWithDuration("100ms");
+    try {
+      await trigger(rt);
+      expect(rt._cachedLeaveTimeoutMs).toBe(300);
+    } finally {
+      restore();
+    }
+  });
+
+  test("falls back to 600 when the variable is empty", async () => {
+    const { rt, restore } = rtWithDuration("");
+    try {
+      await trigger(rt);
+      expect(rt._cachedLeaveTimeoutMs).toBe(600);
+    } finally {
+      restore();
+    }
+  });
+
+  test("supports seconds units (e.g. 0.4s)", async () => {
+    const { rt, restore } = rtWithDuration("0.4s");
+    try {
+      await trigger(rt);
+      // 400ms × 1.5 = 600ms
+      expect(rt._cachedLeaveTimeoutMs).toBe(600);
+    } finally {
+      restore();
+    }
+  });
+});
+
 describe("fetch headers", () => {
   test("sends Accept and X-Modal-Stack-Request headers", async () => {
     let captured = null;
@@ -200,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"]);
+  });
 });