@timber-js/app 0.2.0-alpha.18 → 0.2.0-alpha.180

package/src/client/navigation-root.tsx

@@ -0,0 +1,355 @@
+/**
+ * NavigationRoot — Wrapper component for transition-based rendering.
+ *
+ * Solves the "new boundary has no old content" problem for client-side
+ * navigation. When React renders a completely new Suspense boundary via
+ * root.render(), it shows the fallback immediately — root.render() is
+ * always an urgent update regardless of startTransition.
+ *
+ * NavigationRoot holds the current element in React state. Navigation
+ * updates call startTransition(() => setState(newElement)), which IS
+ * a transition update. React keeps the old committed tree visible while
+ * any new Suspense boundaries in the transition resolve.
+ *
+ * Also manages `pendingUrl` as React state with an urgent/transition split:
+ * - Navigation START: `setPendingUrl(url)` is an urgent update — React
+ *   commits it before the next paint, showing the spinner immediately.
+ * - Navigation END: `setPendingUrl(null)` is inside `startTransition`
+ *   alongside `setElement(newTree)` — both commit atomically, so the
+ *   spinner disappears in the same frame as the new content appears.
+ *
+ * Hard navigation guard: When a hard navigation is triggered (500 error,
+ * version skew), the component throws an unresolved thenable AFTER all
+ * hooks to suspend forever — preventing React from rendering children
+ * during page teardown. The throw must come after hooks to satisfy
+ * React's rules (same hook count every render) while still preventing
+ * child renders that could hit hook count mismatches in components
+ * whose positions shift during teardown. This pattern is borrowed from
+ * Next.js (app-router.tsx pushRef.mpaNavigation — also after hooks).
+ *
+ * See design/05-streaming.md §"deferSuspenseFor"
+ * See design/19-client-navigation.md §"NavigationContext"
+ */
+
+import { createElement, Fragment, startTransition, useState, type ReactNode } from 'react';
+import { PendingNavigationProvider } from './navigation-context.js';
+import { TopLoader, type TopLoaderConfig } from './top-loader.js';
+
+// ─── Navigation Transition Counter ──────────────────────────────
+// Monotonically increasing counter that increments each time
+// navigateTransition() is called. Used to detect stale transitions:
+// if a newer transition started while the current one's perform()
+// was in flight, the current transition is stale and should reject.
+//
+// Separate from the link-pending navId (which only increments on
+// link clicks). This counter covers all navigation types: link clicks,
+// programmatic navigate(), refresh(), and handlePopState().
+//
+// Uses globalThis for singleton guarantee across chunks — same pattern
+// as NavigationContext and the link pending store.
+
+const NAV_TRANSITION_KEY = Symbol.for('__timber_nav_transition_counter');
+
+function getTransitionCounter(): { id: number } {
+  const g = globalThis as Record<symbol, unknown>;
+  if (!g[NAV_TRANSITION_KEY]) {
+    g[NAV_TRANSITION_KEY] = { id: 0 };
+  }
+  return g[NAV_TRANSITION_KEY] as { id: number };
+}
+
+/**
+ * Invalidate all in-flight navigation transitions. Any navigateTransition()
+ * call whose perform() has not yet committed will reject with AbortError
+ * instead of committing its element.
+ *
+ * Called by the router when a render supersedes in-flight navigations
+ * WITHOUT going through navigateTransition() — the cached popstate replay
+ * renders via transitionRender(), which doesn't bump the counter, so a
+ * stale forward navigation's setElement would otherwise pass the
+ * `counter.id !== transId` guard and commit the forward page over the
+ * replayed back page (TIM-1022).
+ */
+export function supersedeNavigationTransitions(): void {
+  getTransitionCounter().id += 1;
+}
+
+// ─── Hard Navigation Guard ──────────────────────────────────────
+
+/**
+ * Module-level flag indicating a hard (MPA) navigation is in progress.
+ *
+ * When true:
+ * - NavigationRoot throws an unresolved thenable to suspend forever,
+ *   preventing React from rendering children during page teardown
+ *   (avoids "Rendered more hooks" crashes).
+ * - The Navigation API handler skips interception, letting the browser
+ *   perform a full page load (prevents infinite loops where
+ *   window.location.href → navigate event → router.navigate → 500 →
+ *   window.location.href → ...).
+ *
+ * Uses globalThis for singleton guarantee across chunks (same pattern
+ * as NavigationContext). See design/19-client-navigation.md §"Singleton
+ * Guarantee via globalThis".
+ */
+const HARD_NAV_KEY = Symbol.for('__timber_hard_navigating');
+
+function getHardNavStore(): { value: boolean } {
+  const g = globalThis as Record<symbol, unknown>;
+  if (!g[HARD_NAV_KEY]) {
+    g[HARD_NAV_KEY] = { value: false };
+  }
+  return g[HARD_NAV_KEY] as { value: boolean };
+}
+
+/**
+ * Set the hard-navigating flag. Call this BEFORE setting
+ * window.location.href or window.location.reload() to prevent:
+ * 1. React from rendering children during page teardown
+ * 2. Navigation API from intercepting the hard navigation
+ */
+export function setHardNavigating(value: boolean): void {
+  getHardNavStore().value = value;
+}
+
+/**
+ * Check if a hard navigation is in progress.
+ * Used by NavigationRoot (throw unresolvedThenable) and by the
+ * Navigation API handler (skip interception).
+ */
+export function isHardNavigating(): boolean {
+  return getHardNavStore().value;
+}
+
+/**
+ * A thenable that never resolves. When thrown during React render,
+ * it causes the component to suspend forever — React keeps the
+ * old committed tree visible and never attempts to render children.
+ *
+ * This is the same pattern Next.js uses in app-router.tsx for MPA
+ * navigations (pushRef.mpaNavigation → throw unresolvedThenable).
+ */
+// for React's Suspense mechanism. Same pattern as Next.js's unresolvedThenable.
+// eslint-disable-next-line unicorn/no-thenable -- Intentionally a never-resolving thenable
+const unresolvedThenable = { then() {} } as PromiseLike<never>;
+
+// ─── Module-level functions ──────────────────────────────────────
+
+/**
+ * Module-level reference to the state setter wrapped in startTransition.
+ * Used for non-navigation renders (applyRevalidation, popstate replay).
+ */
+let _transitionRender: ((element: ReactNode) => void) | null = null;
+
+/**
+ * Module-level reference to the navigation transition function.
+ * Wraps a full navigation (fetch + render) in a single startTransition
+ * with the pending URL.
+ */
+let _navigateTransition:
+  | ((
+      pendingUrl: string,
+      perform: () => Promise<{ element: ReactNode; decodePromise: Promise<void> | null }>
+    ) => Promise<void>)
+  | null = null;
+
+// ─── Component ───────────────────────────────────────────────────
+
+/**
+ * Root wrapper component that enables transition-based rendering.
+ *
+ * Renders PendingNavigationProvider around children for the pending URL
+ * context. The DOM tree matches the server-rendered HTML during hydration
+ * (the provider renders no extra DOM elements).
+ *
+ * Usage in browser-entry.ts:
+ *   const rootEl = createElement(NavigationRoot, { initial: wrapped });
+ *   reactRoot = hydrateRoot(document, rootEl);
+ *
+ * Subsequent navigations:
+ *   navigateTransition(url, async () => { fetch; return wrappedElement; });
+ *
+ * Non-navigation renders:
+ *   transitionRender(newWrappedElement);
+ */
+export function NavigationRoot({
+  initial,
+  topLoaderConfig,
+}: {
+  initial: ReactNode;
+  topLoaderConfig?: TopLoaderConfig;
+}): ReactNode {
+  const [element, setElement] = useState<ReactNode>(initial);
+  const [pendingUrl, setPendingUrl] = useState<string | null>(null);
+
+  // NOTE: We use standalone `startTransition` (imported from 'react'),
+  // NOT `useTransition`. The `useTransition` hook's `startTransition`
+  // is tied to a single fiber and tracks one async callback at a time.
+  // When two navigations overlap (click slow-page, then click dashboard),
+  // calling useTransition's startTransition twice with concurrent async
+  // callbacks corrupts React's internal hook tracking — causing
+  // "Rendered more hooks than during the previous render."
+  //
+  // Standalone `startTransition` creates independent transition lanes
+  // for each call, so concurrent navigations don't interfere. We don't
+  // need useTransition's `isPending` — we track pending state via our
+  // own `pendingUrl` useState.
+  //
+  // This matches the Next.js pattern (TIM-625): "No useTransition in
+  // the router at all — only standalone startTransition."
+
+  // Non-navigation render (revalidation, popstate cached replay).
+  _transitionRender = (newElement: ReactNode) => {
+    startTransition(() => {
+      setElement(newElement);
+    });
+  };
+
+  // Full navigation transition.
+  // setPendingUrl(url) is an URGENT update — React commits it before the next
+  // paint, so the pending spinner appears immediately when navigation starts.
+  // Inside startTransition: the async fetch + setElement + setPendingUrl(null)
+  // are deferred. When the transition commits, the new tree and pendingUrl=null
+  // both apply in the same React commit — making the pending→active transition
+  // atomic (no frame where pending is false but the old tree is still visible).
+  _navigateTransition = (
+    url: string,
+    perform: () => Promise<{ element: ReactNode; decodePromise: Promise<void> | null }>
+  ) => {
+    // Increment the transition counter SYNCHRONOUSLY (before startTransition
+    // schedules the async work). Each call gets a unique transId; the counter
+    // is the same globalThis singleton, so a newer call always has a higher id.
+    const counter = getTransitionCounter();
+    const transId = ++counter.id;
+
+    // NO urgent setPendingUrl here. Per-link pending state is driven by
+    // Link's own useTransition — only the clicked Link re-renders for
+    // isPending. setPendingUrl is set INSIDE startTransition so the
+    // TopLoader activates as a transition update (no full-tree re-render).
+
+    return new Promise<void>((resolve, reject) => {
+      startTransition(async () => {
+        setPendingUrl(url);
+        try {
+          const { element, decodePromise } = await perform();
+          if (counter.id !== transId) {
+            decodePromise?.catch(() => {});
+            reject(new DOMException('Navigation superseded', 'AbortError'));
+            return;
+          }
+          setElement(element);
+          if (decodePromise) await decodePromise;
+          if (counter.id === transId) {
+            setPendingUrl(null);
+            resolve();
+          } else {
+            reject(new DOMException('Navigation superseded', 'AbortError'));
+          }
+        } catch (err) {
+          if (counter.id === transId) {
+            setPendingUrl(null);
+          }
+          reject(err);
+        }
+      });
+    });
+  };
+
+  // ─── Hard navigation guard ─────────────────────────────────
+  // When a hard navigation is in progress (500 error, version skew),
+  // suspend forever to prevent React from rendering children during
+  // page teardown. This avoids "Rendered more hooks" crashes in
+  // CHILD components whose hook counts may shift during teardown.
+  //
+  // CRITICAL: This throw MUST come AFTER all hooks (the two
+  // useState calls above). React requires the same hooks to run on
+  // every render. If we threw before hooks, React would see 0 hooks
+  // on the re-render vs 2 hooks on the initial render — triggering
+  // the exact "Rendered more hooks" error we're trying to prevent.
+  //
+  // By placing it after hooks but before the return, all hooks
+  // satisfy React's rules, but the thrown thenable prevents any
+  // children from rendering. Same pattern as Next.js app-router.tsx
+  // (pushRef.mpaNavigation — also placed after all hooks).
+  if (isHardNavigating()) {
+    throw unresolvedThenable;
+  }
+
+  // Inject TopLoader alongside the element tree inside PendingNavigationProvider.
+  // The TopLoader reads pendingUrl from context to show/hide the progress bar.
+  // It is rendered only when not explicitly disabled via config.
+  const showTopLoader = topLoaderConfig?.enabled !== false;
+  const children = showTopLoader
+    ? createElement(Fragment, null, createElement(TopLoader, { config: topLoaderConfig }), element)
+    : element;
+  return createElement(PendingNavigationProvider, { value: pendingUrl }, children);
+}
+
+// ─── Public API ──────────────────────────────────────────────────
+
+/**
+ * Trigger a transition render for non-navigation updates.
+ * React keeps the old committed tree visible while any new Suspense
+ * boundaries in the update resolve.
+ *
+ * Used for: applyRevalidation, popstate replay with cached payload.
+ */
+export function transitionRender(element: ReactNode): void {
+  if (_transitionRender) {
+    _transitionRender(element);
+  }
+}
+
+/**
+ * Run a full navigation inside a React transition with optimistic pending URL.
+ *
+ * The `perform` callback runs inside `startTransition` — it should fetch the
+ * RSC payload, update router state, and return the wrapped React element.
+ * The pending URL shows immediately (urgent update) and reverts
+ * to null when the transition commits (atomic with the new tree).
+ *
+ * Returns a Promise that resolves when the async work completes (note: the
+ * React transition may not have committed yet, but all state updates are done).
+ *
+ * Used for: navigate(), refresh(), popstate with fetch.
+ */
+export function navigateTransition(
+  pendingUrl: string,
+  perform: () => Promise<{ element: ReactNode; decodePromise: Promise<void> | null }>
+): Promise<void> {
+  if (_navigateTransition) {
+    return _navigateTransition(pendingUrl, perform);
+  }
+  // Fallback: no NavigationRoot mounted (shouldn't happen in production)
+  return perform().then(() => {});
+}
+
+/**
+ * Install one-shot deferred callbacks for the no-RSC bootstrap path (TIM-600).
+ *
+ * When there's no RSC payload, we can't create a React root immediately —
+ * `createRoot(document).render(...)` would blank the SSR HTML. Instead,
+ * this sets up `_transitionRender` and `_navigateTransition` so that the
+ * first client navigation triggers root creation via `createAndMount`.
+ *
+ * After `createAndMount` runs, NavigationRoot renders and overwrites these
+ * callbacks with its real `startTransition`-based implementations.
+ */
+export function installDeferredNavigation(createAndMount: (initial: ReactNode) => void): void {
+  let mounted = false;
+  const mountOnce = (element: ReactNode) => {
+    if (mounted) return;
+    mounted = true;
+    createAndMount(element);
+  };
+  _transitionRender = (element: ReactNode) => {
+    mountOnce(element);
+  };
+  _navigateTransition = async (
+    _pendingUrl: string,
+    perform: () => Promise<{ element: ReactNode; decodePromise: Promise<void> | null }>
+  ) => {
+    const { element } = await perform();
+    mountOnce(element);
+  };
+}

package/src/client/nuqs-adapter.tsx

@@ -20,6 +20,7 @@ import {
   type unstable_AdapterOptions as AdapterOptions,
 } from 'nuqs/adapters/custom';
 import { getRouter } from './router-ref.js';
+import { getNavigationApi } from './navigation-api.js';
 
 // ─── Adapter Hook ─────────────────────────────────────────────────
 
@@ -59,9 +60,21 @@ function useTimberAdapter(_watchKeys: string[]): AdapterInterface {
 
       if (options.shallow) {
         // Shallow: update URL only, no server roundtrip.
-        const method =
-          options.history === 'push' ? window.history.pushState : window.history.replaceState;
-        method.call(window.history, window.history.state, '', url.toString());
+        // When Navigation API is available, use navigation.navigate() with
+        // info: { shallow: true } so the navigate event handler knows to
+        // skip interception. Without this, the navigate event fired by
+        // history.pushState/replaceState would trigger a full RSC fetch.
+        const nav = getNavigationApi();
+        if (nav) {
+          nav.navigate(url.toString(), {
+            history: options.history === 'push' ? 'push' : 'replace',
+            info: { shallow: true },
+          });
+        } else {
+          const method =
+            options.history === 'push' ? window.history.pushState : window.history.replaceState;
+          method.call(window.history, window.history.state, '', url.toString());
+        }
 
         // Update local state to reflect the new URL
         setSearchParams(new URLSearchParams(url.search));

package/src/client/router-ref.ts

@@ -18,7 +18,7 @@ export function setGlobalRouter(router: RouterInstance): void {
 
 /**
  * Get the global router instance. Throws if called before bootstrap.
- * Used by client-side hooks (useNavigationPending, etc.)
+ * Used by client-side hooks (usePendingNavigation, etc.)
  */
 export function getRouter(): RouterInstance {
   if (!globalRouter) {