@rangojs/router 0.21.0 → 0.22.1

package/src/server/request-context.ts

@@ -46,7 +46,10 @@ import { withDefer } from "../defer.js";
 import { type MetricsStore } from "./context.js";
 import { observePhase, PHASES } from "../router/instrument.js";
 import { getFetchableLoader } from "./fetchable-loader-store.js";
-import type { SegmentCacheStore } from "../cache/types.js";
+import type {
+  SegmentCacheStore,
+  ShellSnapshotHandlesValue,
+} from "../cache/types.js";
 import type { RouterVersions } from "../router-versions.js";
 import type { Theme, ResolvedThemeConfig } from "../theme/types.js";
 import type { ExecutionContext, RequestScope } from "../types/request-scope.js";
@@ -289,6 +292,30 @@ export interface RequestContext<
   /** @internal Cache store for segment caching (optional, used by CacheScope) */
   _cacheStore?: SegmentCacheStore;
 
+  /**
+   * @internal Env-scoped writable prerender store (the durable overlay) plus the
+   * deployment identity for build-scoped keys, resolved per request from the
+   * `prerender` router option. Read by the serve-path overlay lookup before the
+   * bundled build manifest. Absent when no prerender store is configured.
+   */
+  // ResolvedPrerender<any> (not <TEnv>): onRevalidate's contravariant `env` would
+  // otherwise make RequestContext invariant in TEnv, breaking existing
+  // RequestContext<{}> -> RequestContext<unknown> assignments.
+  _prerender?: import("../prerender/on-demand.js").ResolvedPrerender<any>;
+
+  /**
+   * @internal Set only on the requestless on-demand producer's context. When
+   * present, the standalone request-scoped READS — `cookies()`, `headers()`,
+   * `invalidateClientCache()`, `keepClientCache()` — throw a
+   * PrerenderPersonalizationError so a personalized render is skipped rather than
+   * baked into a shared payload. Response MUTATIONS on the producer context
+   * (`ctx.setStatus`/`header`/`setCookie`) stay silent no-op stubs, matching
+   * build-time prerender (the design's "throw or skip" contract permits skip):
+   * they write to a discarded synthetic response, so there is nothing to leak.
+   * Never set on the live request path.
+   */
+  _onDemandProducer?: true;
+
   /**
    * @internal Compiled `cache.searchParams` filter for default cache-key
    * generation (undefined = "all", the byte-stable unfiltered format). Set
@@ -365,6 +392,22 @@ export interface RequestContext<
    */
   _shellForcedMiss?: true;
 
+  /**
+   * @internal This request is a router.prerender() warm
+   * (prerender/warm-request.ts). In `replace` mode every runtime cache read
+   * misses (isWarmReplace); the layers report into the record. A capture's
+   * derived context inherits it through the prototype.
+   */
+  _prerenderWarm?: import("../prerender/warm-request.js").PrerenderWarmRecord;
+
+  /**
+   * @internal Runs a callback in the async context this request entered the
+   * handler with (captureRequestEntryContext). router.prerender() dispatches
+   * a warm through it when called from inside a request. Absent where the
+   * runtime has no AsyncLocalStorage.snapshot.
+   */
+  _runAtRequestEntry?: <T>(fn: () => T) => T;
+
   /**
    * @internal The freshness window of the route cache() records this
    * request read or wrote (cache-scope.ts noteRouteRecordWindow), as ms
@@ -459,6 +502,8 @@ export interface RequestContext<
      * host) and miss the record.
      */
     fixedDocKey?: string;
+    /** @internal The snapshot's `handles` record (ShellSnapshotHandlesValue). */
+    prerenderHandles?: ShellSnapshotHandlesValue;
     /**
      * @internal Set ONLY by matchPartialWithPprReplay on the navigation-replay
      * serve path. Its presence arms the explicit-scope composition in
@@ -808,6 +853,18 @@ export interface RequestContext<
    */
   _renderErrors?: unknown[];
 
+  /**
+   * @internal Rejections of streamed (loading()) handlers that were recovered
+   * into a declared errorBoundary()/notFoundBoundary() fallback, by segment id.
+   * The recovered promise resolves, so Flight reports nothing; cacheRoute
+   * (cache-scope.ts) refuses a write only when one of ITS segments is listed,
+   * the granularity a Flight error row has. The same errors are also pushed to
+   * `_renderErrors` for the document cache and PPR shell capture. A render
+   * under a derived context (shell capture, SWR re-render) owns its own map.
+   * Allocated on the first recovery.
+   */
+  _recoveredHandlerErrors?: Map<string, unknown>;
+
   /**
    * @internal Report a non-fatal background error through the router's
    * onError callback. Wired by the RSC handler / router during request
@@ -926,6 +983,8 @@ export type PublicRequestContext<
   | "_transitionWhenRefs"
   | "_pprReplayPostMatchReason"
   | "_cacheStore"
+  | "_prerender"
+  | "_onDemandProducer"
   | "_searchParamsFilter"
   | "_shellCaptureRun"
   | "_shellImplicitCache"
@@ -936,6 +995,8 @@ export type PublicRequestContext<
   | "_resolvedCacheKeys"
   | "_shellKey"
   | "_shellForcedMiss"
+  | "_prerenderWarm"
+  | "_runAtRequestEntry"
   | "_routeRecordWindow"
   | "_shellFragmentPayload"
   | "_shellCaptureGuardTripped"
@@ -957,6 +1018,7 @@ export type PublicRequestContext<
   | "_inActionRevalidation"
   | "_reportedErrors"
   | "_renderErrors"
+  | "_recoveredHandlerErrors"
   | "_renderBarrier"
   | "_resolveRenderBarrier"
   | "_renderBarrierSegmentOrder"
@@ -1007,6 +1069,22 @@ export const UNTRACKED_BACKGROUND_TASK: unique symbol = Symbol.for(
 // AsyncLocalStorage instance for request context
 const requestContextStorage = new AsyncLocalStorage<RequestContext<any>>();
 
+/**
+ * Capture the current async context (RequestContext._runAtRequestEntry), taken
+ * on handler entry before any router scope, so a nested dispatch (a
+ * router.prerender() warm called from a handler, loader or action) does not
+ * inherit the caller's route-definition, loader and cache-scope state. Per
+ * request: workerd refuses a snapshot outside the request that created it.
+ * See docs/design/prerender-every-route.md.
+ */
+export function captureRequestEntryContext():
+  | (<T>(fn: () => T) => T)
+  | undefined {
+  return typeof AsyncLocalStorage.snapshot === "function"
+    ? AsyncLocalStorage.snapshot()
+    : undefined;
+}
+
 /**
  * Run a function within a request context
  * Used by the RSC handler to provide context to server actions
@@ -1118,6 +1196,12 @@ export interface CreateRequestContextOptions<TEnv> {
   initialResponse?: Response;
   /** Optional cache store for segment caching (used by CacheScope) */
   cacheStore?: SegmentCacheStore;
+  /**
+   * Optional env-scoped writable prerender store + deployment identity (the
+   * durable overlay), resolved per request by the RSC handler from the
+   * `prerender` router option.
+   */
+  prerender?: import("../prerender/on-demand.js").ResolvedPrerender<any>;
   /**
    * Compiled `cache.searchParams` filter from the resolved handler cache
    * config (handler.ts). Stored as _searchParamsFilter.
@@ -1168,6 +1252,7 @@ export function createRequestContext<TEnv>(
     variables,
     initialResponse,
     cacheStore,
+    prerender,
     searchParamsFilter,
     explicitTaggedStores,
     cacheProfiles,
@@ -1543,6 +1628,7 @@ export function createRequestContext<TEnv>(
 
     _handleStore: handleStore,
     _cacheStore: cacheStore,
+    _prerender: prerender,
     _versions: versions,
     _searchParamsFilter: searchParamsFilter,
     _explicitTaggedStores: explicitTaggedStores,

package/src/ssr/ssr-root.tsx

@@ -8,6 +8,7 @@ import {
 import { ThemeProvider } from "../theme/ThemeProvider.js";
 import { NonceContext } from "../browser/react/nonce-context.js";
 import {
+  HydrationBarrierContext,
   LocationStateContext,
   NavigationStoreContext,
 } from "../browser/react/context.js";
@@ -122,9 +123,9 @@ function createSsrEventController(opts: {
     flushRouteState: () => {},
     setHandleData: () => {},
     getHandleState: () => handleState,
-    freezeHydrationHandleState: () => {},
-    // The server render is the state the document is rendered with.
-    getHydrationHandleState: () => undefined,
+    lockHydration: () => {},
+    getHydrationSnapshot: () => undefined,
+    releaseHydrationLock: () => {},
     setRouteSegmentIds: () => {},
     setParams: (nextParams) => {
       params = nextParams;
@@ -286,21 +287,25 @@ export function createSsrRootComponent(opts: SsrRootOptions): React.FC {
     }
 
     // Create SSR context with request-local pathname/params/handles.
-    ssrContextValue ??= {
-      store: null as any,
-      eventController: createSsrEventController({
+    if (!ssrContextValue) {
+      const eventController = createSsrEventController({
         pathname,
         search,
         origin,
         params: resolved.metadata?.params,
         handleData,
         matched: resolved.metadata?.matched,
-      }),
-      navigate: async () => {},
-      refresh: async () => {},
-      version: resolved.metadata?.version,
-      basename: resolved.metadata?.basename,
-    };
+      });
+      ssrContextValue = {
+        store: null as any,
+        eventController,
+        navigate: async () => {},
+        refresh: async () => {},
+        version: resolved.metadata?.version,
+        basename: resolved.metadata?.basename,
+        origin: (eventController.getState().location as URL).origin,
+      };
+    }
 
     // Build content tree from segments.
     // Order must match NavigationProvider: NavigationStoreContext > LocationStateContext > NonceContext > ThemeProvider > content
@@ -338,7 +343,9 @@ export function createSsrRootComponent(opts: SsrRootOptions): React.FC {
     return (
       <NavigationStoreContext.Provider value={ssrContextValue!}>
         <LocationStateContext.Provider value={undefined}>
-          {content}
+          <HydrationBarrierContext.Provider value={0}>
+            {content}
+          </HydrationBarrierContext.Provider>
         </LocationStateContext.Provider>
       </NavigationStoreContext.Provider>
     );

package/src/suspense-audit-react.tsx

@@ -0,0 +1,98 @@
+import { useEffect, useLayoutEffect, useRef, type ReactNode } from "react";
+import {
+  auditCommit,
+  auditFallback,
+  auditHandover,
+  auditMount,
+  auditRead,
+  auditReveal,
+  auditUnmount,
+  createBoundaryAudit,
+  type BoundaryAudit,
+} from "./suspense-audit.js";
+
+// Hooks of the suspense audit (docs/internal/suspense-contract.md), called by
+// dev-only components: React Compiler skips a component with a gated hook.
+
+function useRecord(boundary: string, segmentId: string): BoundaryAudit {
+  const ref = useRef<BoundaryAudit | null>(null);
+  // One position can hold another segment's boundary: its Suspense is keyed.
+  if (ref.current === null || ref.current.boundary !== boundary) {
+    ref.current = createBoundaryAudit(boundary, segmentId);
+  }
+  return ref.current;
+}
+
+// Passive, not layout: React disconnects the layout effects of content a
+// Suspense boundary hides, and that is not an unmount.
+function useMount(rec: BoundaryAudit): void {
+  useEffect(() => {
+    auditMount(rec);
+    return () => auditUnmount(rec);
+  }, [rec]);
+}
+
+/**
+ * One boundary: what each render hands it, what each commit carries, and its
+ * mount. Called above the Suspense, which commits while the content waits.
+ * `streams` and `nodes` are what else its content waits for (I3 only).
+ */
+export function useBoundaryAudit(
+  boundary: string,
+  segmentId: string,
+  value: unknown,
+  streams?: Record<string, unknown>,
+  nodes?: unknown,
+): BoundaryAudit {
+  const rec = useRecord(boundary, segmentId);
+  auditHandover(rec, value);
+  useLayoutEffect(() => {
+    auditCommit(rec, value, streams, nodes);
+  }, [rec, value, streams, nodes]);
+  useMount(rec);
+  return rec;
+}
+
+/** The boundary's content is on screen. */
+export function useRevealAudit(rec: BoundaryAudit): void {
+  useLayoutEffect(() => {
+    auditReveal(rec);
+  }, [rec]);
+}
+
+/**
+ * One `useLoader` read of a per-loader stream (I1, I2 at the read site). A
+ * read that suspends while mounting keeps no record: only a reader on screen
+ * is audited.
+ */
+export function useReadAudit(loaderId: string, stream: unknown): void {
+  const rec = useRecord(`read:${loaderId}`, loaderId);
+  auditHandover(rec, stream);
+  useLayoutEffect(() => {
+    auditRead(rec, stream);
+  }, [rec, stream]);
+}
+
+/** Wraps a boundary's fallback: mounted means the fallback is on screen. */
+export function AuditedFallback({
+  audit,
+  children,
+}: {
+  audit: BoundaryAudit;
+  children: ReactNode;
+}): ReactNode {
+  useLayoutEffect(() => auditFallback(audit), [audit]);
+  return children;
+}
+
+/** Wraps a segment's outlet children: the segment's mount (I4). */
+export function AuditedOutlet({
+  segmentId,
+  children,
+}: {
+  segmentId: string;
+  children: ReactNode;
+}): ReactNode {
+  useMount(useRecord(`outlet:${segmentId}`, segmentId));
+  return children;
+}