@rangojs/router 0.19.1 → 0.21.0

package/src/testing/build-versions.ts

@@ -0,0 +1,64 @@
+/**
+ * Testing primitive for the per-router cache versions.
+ *
+ * A production build gives every `createRouter()` a data version and a
+ * document version (docs/design/per-app-cache-version.md) and ships them as a
+ * table in the `@rangojs/router:version` module. A test has no build, so the
+ * module is a stub and every router serves unversioned. `setBuildVersions`
+ * installs a table in its place; the request handler, `dispatch` and the cache
+ * stores then resolve versions through the same code path the built app uses.
+ * Calling it again is a deploy: the next request is served by a handler that
+ * resolved the new versions.
+ */
+import { installRouterVersionsTable } from "../server/build-version-table.js";
+import {
+  DEFAULT_ROUTER_VERSIONS_KEY,
+  type RouterVersions,
+  type RouterVersionsTable,
+} from "../router-versions.js";
+
+export type { RouterVersions };
+
+/**
+ * The versions a simulated build ships.
+ *
+ * - `data` and `document`: the versions of every router the test does not list
+ *   under `routers` (the build's whole-build pair).
+ * - `routers`: versions per router id (`router.id`), as a host-router build
+ *   computes them.
+ */
+export interface BuildVersions extends RouterVersions {
+  routers?: Record<string, RouterVersions>;
+}
+
+/**
+ * Install the cache versions of a simulated build, or remove them with no
+ * argument (routers serve unversioned again, the default in tests).
+ *
+ * A router that sets `createRouter({ version })` keeps that value for both
+ * versions, exactly as in production.
+ *
+ * @example A deploy that changes the client only keeps cached data
+ * ```ts
+ * setBuildVersions({ data: "d1", document: "h1" });
+ * await serveShellRequest(router, "/product/1", { cacheStore });
+ * setBuildVersions({ data: "d1", document: "h2" });
+ * const { shellStatus } = await serveShellRequest(router, "/product/1", {
+ *   cacheStore,
+ * });
+ * // shellStatus is "MISS": the stored HTML was keyed by document version h1.
+ * ```
+ */
+export function setBuildVersions(versions?: BuildVersions): void {
+  if (!versions) {
+    installRouterVersionsTable(undefined);
+    return;
+  }
+  const table: Record<string, readonly [string, string]> = {
+    [DEFAULT_ROUTER_VERSIONS_KEY]: [versions.data, versions.document],
+  };
+  for (const [routerId, pair] of Object.entries(versions.routers ?? {})) {
+    table[routerId] = [pair.data, pair.document];
+  }
+  installRouterVersionsTable(table satisfies RouterVersionsTable);
+}

package/src/testing/dispatch.ts

@@ -106,6 +106,7 @@ import {
   runWithRequestContext,
   setRequestContextParams,
 } from "../server/request-context.js";
+import { resolveRouterVersions } from "../server/build-version-table.js";
 import { executeMiddleware, matchMiddleware } from "../router/middleware.js";
 import type {
   MiddlewareEntry,
@@ -166,6 +167,8 @@ import { applyStreamIdleTimeout } from "../rsc/stream-idle.js";
 interface DispatchableRouter<TEnv> {
   id?: string;
   routerId?: string;
+  /** createRouter({ version }), the consumer-set version. */
+  version?: string;
   routeMap: Record<string, unknown>;
   middleware: MiddlewareEntry<TEnv>[];
   onError?: OnErrorCallback<TEnv>;
@@ -411,6 +414,9 @@ export async function dispatch<TEnv = any>(
     cacheStore,
     searchParamsFilter,
     cacheProfiles: router.cacheProfiles,
+    // The store keys with the router's versions, resolved as the production
+    // handler resolves them (rsc/handler.ts).
+    versions: resolveRouterVersions(routerId, router.version),
   });
   // Wire background error reporting so cache degradation (reportCacheError ->
   // _reportBackgroundError) reaches the router's onError, mirroring the production

package/src/testing/dom.entry.ts

@@ -18,5 +18,6 @@ export type {
   RenderRouteOptions,
   TestRouterHandle,
   RenderRouteResult,
+  RenderRouteHydrateResult,
   HandleDataSeed,
 } from "./render-route.js";

package/src/testing/flight.entry.ts

@@ -63,4 +63,5 @@ export {
 export type {
   ServeShellRequestOptions,
   ServeShellRequestResult,
+  ShellRequestHandles,
 } from "./serve-shell-request.js";

package/src/testing/index.ts

@@ -98,6 +98,9 @@ export type {
   ShellStatusTarget,
 } from "./shell-status.js";
 
+export { setBuildVersions } from "./build-versions.js";
+export type { BuildVersions, RouterVersions } from "./build-versions.js";
+
 export { collectHandle } from "./collect-handle.js";
 
 export { withLocationStateKey } from "./location-state-key.js";

package/src/testing/internal/context.ts

@@ -19,6 +19,7 @@ import { normalizeBasename } from "../../router/basename.js";
 import {
   seedVariables,
   resolveSeededStateCookieName,
+  seededVersions,
   type VarsInit,
   type StateCookieSeed,
 } from "./seed-vars.js";
@@ -164,7 +165,7 @@ export function createTestRequestContext<TEnv>(
     cacheStore: opts.cacheStore,
     cacheProfiles: opts.cacheProfiles,
     stateCookieName,
-    version: opts.stateCookie?.version,
+    versions: seededVersions(opts.stateCookie),
   });
   if (opts.basename !== undefined)
     ctx._basename = normalizeBasename(opts.basename);

package/src/testing/internal/seed-vars.ts

@@ -8,6 +8,7 @@
  */
 import { contextSet, type ContextVar } from "../../context-var.js";
 import { resolveStateCookieName } from "../../router/state-cookie-name.js";
+import { uniformVersions, type RouterVersions } from "../../router-versions.js";
 
 export interface StateCookieSeed {
   /**
@@ -22,8 +23,10 @@ export interface StateCookieSeed {
    */
   routerId?: string;
   /**
-   * Build version used as the rotated value's prefix (`{version}:{timestamp}`).
-   * Defaults to `"0"` (resolved inside createRequestContext).
+   * The app's version, as `createRouter({ version })` would set it: the
+   * rotated value's prefix (`{version}:{timestamp}`) and the version a cache
+   * store keys with. Defaults to `"0"` for the prefix (resolved inside
+   * createRequestContext) and to the build versions for the store.
    */
   version?: string;
 }
@@ -32,6 +35,15 @@ export function resolveSeededStateCookieName(seed?: StateCookieSeed): string {
   return resolveStateCookieName(seed?.prefix, seed?.routerId ?? "router_0");
 }
 
+/** The request context's `versions` for a seeded `stateCookie.version`. */
+export function seededVersions(
+  seed?: StateCookieSeed,
+): RouterVersions | undefined {
+  return seed?.version === undefined
+    ? undefined
+    : uniformVersions(seed.version);
+}
+
 export type VarsInit =
   | Record<string, unknown>
   | ReadonlyArray<readonly [ContextVar<unknown> | string, unknown]>;

package/src/testing/location-state-key.ts

@@ -1,12 +1,11 @@
 import {
+  isLocationStateKey,
+  LOCATION_STATE_KEY_PREFIX,
+  LOCATION_STATE_KEY_SUFFIX_SEPARATOR,
   peekLocationStateKey,
   type LocationStateDefinition,
 } from "../browser/react/location-state-shared.js";
 
-// Typed history.state slots must carry this prefix: buildHistoryState spreads
-// only `__rsc_ls_*` keys onto history.state (history-state.ts).
-const KEY_PREFIX = "__rsc_ls_";
-
 let syntheticKeyCounter = 0;
 
 /**
@@ -16,11 +15,15 @@ let syntheticKeyCounter = 0;
  * use (`MyState(value)`, `useLocationState(MyState)`, `.read()`).
  *
  * - `withLocationStateKey(GridState, "GridState")` sets `__rsc_ls_GridState`
- *   (a name that already starts with `__rsc_ls_` is used as-is).
+ *   (a name that already starts with `__rsc_ls_` is used as-is). A definition
+ *   with `clearOnReload` appends its suffix, so read the stored key back from
+ *   `GridState.__rsc_ls_key` (`__rsc_ls_GridState~r`).
  * - Without a name, a key already set (by the plugin or an earlier call) is
  *   kept; otherwise the definition gets a synthetic `__rsc_ls_test_<n>` key,
  *   which then stays on it.
  *
+ * A name may not contain "~": that separator is reserved for the suffix.
+ *
  * Returns the definition.
  *
  * @example
@@ -35,11 +38,18 @@ export function withLocationStateKey<
   TDefinition extends LocationStateDefinition<any, any>,
 >(definition: TDefinition, name?: string): TDefinition {
   if (name !== undefined) {
-    definition.__rsc_ls_key = name.startsWith(KEY_PREFIX)
+    if (name.includes(LOCATION_STATE_KEY_SUFFIX_SEPARATOR)) {
+      throw new Error(
+        `withLocationStateKey: "${name}" contains "${LOCATION_STATE_KEY_SUFFIX_SEPARATOR}", ` +
+          "which is reserved for the key suffix of the `clearOnReload` option. " +
+          "Pass the name without a suffix; the definition appends its own.",
+      );
+    }
+    definition.__rsc_ls_key = isLocationStateKey(name)
       ? name
-      : KEY_PREFIX + name;
+      : LOCATION_STATE_KEY_PREFIX + name;
   } else if (!peekLocationStateKey(definition)) {
-    definition.__rsc_ls_key = `${KEY_PREFIX}test_${syntheticKeyCounter++}`;
+    definition.__rsc_ls_key = `${LOCATION_STATE_KEY_PREFIX}test_${syntheticKeyCounter++}`;
   }
   return definition;
 }

package/src/testing/render-handler.ts

@@ -37,6 +37,7 @@ import type { LoaderDefinition } from "../types.js";
 import {
   seedVariables,
   resolveSeededStateCookieName,
+  seededVersions,
   type VarsInit,
   type StateCookieSeed,
 } from "./internal/seed-vars.js";
@@ -253,7 +254,7 @@ export async function renderHandler<TEnv = any>(
     variables: seedVariables({}, opts.vars),
     build: opts.build,
     stateCookieName,
-    version: opts.stateCookie?.version,
+    versions: seededVersions(opts.stateCookie),
     cacheStore: opts.cacheStore,
     cacheProfiles: opts.cacheProfiles,
     themeConfig: