@timber-js/app 0.2.0-alpha.184 → 0.2.0-alpha.186

package/src/shared/base-path.ts

@@ -0,0 +1,80 @@
+/**
+ * Deployment base path — Vite's resolved `base`, as it applies to the URLs
+ * timber addresses at runtime.
+ *
+ * A static build deployed under a sub-path (`base: '/repo/'`, the GitHub
+ * Pages project-site layout) serves every generated file below that prefix:
+ * the document for `/about` lives at `/repo/about/index.html`, its flight
+ * payload at `/repo/_rsc/about/index.rsc`. The client works in *route space* — the
+ * paths the app declares — so both a strip (browser URL → route path) and a
+ * prefix (route-space path → URL) are needed, and this module owns both.
+ *
+ * Pure functions, no state: the caller supplies the base. `client/rsc-fetch.ts`
+ * holds the client's copy, set at bootstrap from `virtual:timber-config`.
+ *
+ * See design/11-platform.md §"Deploying under a non-root base" (TIM-1261).
+ */
+
+/** `https://cdn.example.com/`, `//cdn.example.com/` — a base pointing off-origin. */
+function isAbsoluteUrlBase(base: string): boolean {
+  return base.startsWith('//') || /^[a-z][a-z0-9+.-]*:\/\//i.test(base);
+}
+
+/**
+ * True when `base` is document-relative (`'./'`, `'foo/'`) — it makes asset
+ * URLs resolve against whatever document loaded them, which says nothing
+ * about where the deployment sits, so no prefix can be computed from it.
+ */
+export function isRelativeBase(base: string | undefined): boolean {
+  if (!base) return false;
+  return !base.startsWith('/') && !isAbsoluteUrlBase(base);
+}
+
+/**
+ * Normalize Vite's `base` into a path prefix. Always returns a value with a
+ * leading and trailing slash.
+ *
+ * Two forms carry no usable deployment prefix and normalize to `/`:
+ *
+ * - **An absolute-URL base** points *assets* at a CDN. The HTML documents and
+ *   `.rsc` payloads are still served from the deployment origin, so their
+ *   URLs stay root-relative. This is correct, not a degradation.
+ * - **A relative base** — see `isRelativeBase`. The static build warns,
+ *   because SPA navigation then only works at the domain root.
+ */
+export function normalizeBasePath(base: string | undefined): string {
+  if (!base) return '/';
+  if (isAbsoluteUrlBase(base) || isRelativeBase(base)) return '/';
+  return base.endsWith('/') ? base : `${base}/`;
+}
+
+/**
+ * Strip the base prefix from a browser pathname, returning the route-space
+ * path. With base `/repo/`: `/repo/about` → `/about`, `/repo/` and `/repo`
+ * → `/`.
+ *
+ * A pathname outside the base is returned unchanged. It cannot be served by
+ * this deployment at all, so there is no better answer than letting the
+ * resulting fetch 404 and the router hard-navigate — visibly wrong beats
+ * silently rewritten.
+ *
+ * @param base A normalized base (see `normalizeBasePath`).
+ */
+export function stripBasePath(base: string, pathname: string): string {
+  if (base === '/') return pathname;
+  const withoutTrailingSlash = base.slice(0, -1);
+  if (pathname === withoutTrailingSlash) return '/';
+  if (!pathname.startsWith(base)) return pathname;
+  return pathname.slice(withoutTrailingSlash.length);
+}
+
+/**
+ * Prefix a route-space, root-relative path with the base.
+ * `/_rsc/about/index.rsc` → `/repo/_rsc/about/index.rsc`.
+ *
+ * @param base A normalized base (see `normalizeBasePath`).
+ */
+export function withBasePath(base: string, path: string): string {
+  if (base === '/') return path;
+  return path.startsWith('/') ? base.slice(0, -1) + path : `${base}${path}`;
+}

package/src/shared/param-value.ts

@@ -0,0 +1,244 @@
+/**
+ * The canonical form of a segment param value.
+ *
+ * `getSegmentParams()` on the server and `useSegmentParams()` on the client
+ * must return the same value — same prototype, same own properties. This
+ * module is how that is guaranteed, and the mechanism matters:
+ *
+ * **Both sides are images of one normalizer.** A codec's output is deep-cloned
+ * into a closed canonical domain at coercion time, and *that clone* is what the
+ * server returns and what goes on the wire. Server and client agree by
+ * construction, because neither holds the codec's original.
+ *
+ * That replaces predicting what React Flight would do to an arbitrary value.
+ * Prediction is what the previous design attempted and it cannot be finished:
+ * the question "will Flight's decode output be observably identical to this
+ * input?" ranges over every way a JS object can carry state that is not in its
+ * serialization — own keys, enumerability, symbols, holes, accessors,
+ * subclassing, exotic objects — and a `Proxy` defeats it outright, since a
+ * lying `getPrototypeOf` trap makes any static check unsound. Twelve review
+ * findings on PR #992 were each one more case of that set, and the set does
+ * not close.
+ *
+ * Normalizing closes it. The only remaining question is whether Flight
+ * round-trips the normalizer's *output range* — a finite domain we defined,
+ * covered by `tests/e2e/segment-params.test.ts` against the real serializer.
+ *
+ * ## The domain
+ *
+ * - `undefined`, `null`, `string`, `number`, `boolean`, `bigint`
+ * - null-prototype objects, own enumerable string keys only
+ * - dense arrays
+ * - `Date`, `Map`, `Set` — rebuilt, never the codec's instance
+ *
+ * ...and it is a **tree**: no value appears twice, and nothing is cyclic.
+ * That is not a simplification, it is the last prediction being removed.
+ * Flight encodes a `Date` by value at each occurrence but tracks plain objects
+ * for reference dedup, so preserving aliasing would carry it across for some
+ * types and drop it for others — and knowing which is exactly the kind of
+ * guess this design exists to stop making (codex, PR #992). A tree has no
+ * sharing to preserve or lose, so what Flight does about it is unobservable.
+ *
+ * Anything else throws, naming the param and what it was. Note what is *not*
+ * a rejection: a `Date` subclass normalizes to a `Date`, a decorated array to
+ * a plain one, a sparse array to a dense one, a getter to the value it
+ * returned. Those used to be twelve separate checks. They are not divergences
+ * any more, because the normalization happens once and both sides see its
+ * result — so they need no checks at all.
+ *
+ * Own properties that Flight would drop (non-enumerable, symbol-keyed) are
+ * dropped here instead, symmetrically. Prototype pollution is handled by the
+ * same pass: `__proto__` is never copied, and every object is
+ * `Object.create(null)` (design/13-security.md #36b/#36c, TIM-873).
+ *
+ * ## The prototype flip
+ *
+ * Flight refuses to serialize a null-prototype object, so the canonical form
+ * cannot go on the wire as-is. `toPlainRecord` and `toNullProtoRecord` flip
+ * the prototype on the way out and back. They are exact inverses and both
+ * total, because they only ever see canonical values — there is nothing to
+ * validate and no shape to special-case.
+ *
+ * See design/41-global-params.md §"Transport".
+ */
+
+/** Types the canonical form rebuilds rather than rejects. */
+const REBUILT = ['Date', 'Map', 'Set'] as const;
+
+/** The domain, for error messages. Derived, never a second hand-written list. */
+const DOMAIN = `a string, number, boolean, bigint, null, undefined, a plain object, an array, or ${REBUILT.join('/')}`;
+
+function reject(path: string, was: string, hint: string): never {
+  throw new Error(
+    `[timber] Segment param "${path || '(root)'}" was coerced to ${was}, which cannot ` +
+      `cross to the client. A param value may be ${DOMAIN}.\n` +
+      `  ${hint}\n` +
+      `  See design/41-global-params.md §"Transport".`
+  );
+}
+
+function describe(value: object): string {
+  return (value as { constructor?: { name?: string } }).constructor?.name ?? 'an object';
+}
+
+/**
+ * Deep-clone a codec's output into the canonical form, or throw.
+ *
+ * `seen` accumulates every object the walk has entered, and a second encounter
+ * is rejected. That is one rule for two things — a shared reference and a cycle
+ * are both "this object again" — and it is what keeps the result a tree.
+ */
+export function normalizeParamValue(value: unknown, path = ''): unknown {
+  return normalize(value, path, new Set());
+}
+
+function normalize(value: unknown, path: string, seen: Set<object>): unknown {
+  if (value === null) return null;
+
+  const kind = typeof value;
+  if (kind === 'string' || kind === 'number' || kind === 'boolean' || kind === 'bigint') {
+    return value;
+  }
+  if (kind === 'undefined') return undefined;
+  if (kind === 'function') {
+    reject(path, 'a function', 'Return the data it would produce, not the function.');
+  }
+  if (kind === 'symbol') {
+    reject(path, 'a symbol', 'Return a string instead — a symbol has no wire representation.');
+  }
+
+  const object = value as object;
+  if (seen.has(object)) {
+    throw new Error(
+      `[timber] Segment param "${path || '(root)'}" is a value that already appears ` +
+        `elsewhere in the same param — a shared reference or a cycle. A param value is a ` +
+        `tree: React Flight carries a repeated \`Date\` by value and a repeated object by ` +
+        `reference, so sharing would survive for some types and not others.\n` +
+        `  Return separate values, or move the shared part outside the params.\n` +
+        `  See design/41-global-params.md §"Transport".`
+    );
+  }
+  seen.add(object);
+
+  if (Array.isArray(object)) {
+    // Read by index, so holes become `undefined` — on both sides, which is
+    // the point. A subclass and any own properties are left behind for the
+    // same reason: the clone is a plain, dense array either way.
+    const out: unknown[] = [];
+    for (let index = 0; index < object.length; index++) {
+      out.push(normalize((object as unknown[])[index], `${path}[${index}]`, seen));
+    }
+    return out;
+  }
+
+  if (object instanceof Date) {
+    // A fresh Date, so a subclass or an attached property cannot travel half
+    // way and be dropped by the wire.
+    return new Date(object.getTime());
+  }
+
+  if (object instanceof Map) {
+    const out = new Map<unknown, unknown>();
+    for (const [key, entry] of object) {
+      out.set(
+        normalize(key, `${path}<key>`, seen),
+        normalize(entry, `${path}.get(${keyLabel(key)})`, seen)
+      );
+    }
+    return out;
+  }
+
+  if (object instanceof Set) {
+    const out = new Set<unknown>();
+    let index = 0;
+    for (const entry of object) out.add(normalize(entry, `${path}[${index++}]`, seen));
+    return out;
+  }
+
+  // Everything else is judged by its prototype. A `Proxy` can lie here, and
+  // that is fine: whatever it answers, the clone below reads through it once
+  // and both sides see the same snapshot.
+  const prototype = Object.getPrototypeOf(object);
+  if (prototype !== null && prototype !== Object.prototype) {
+    reject(
+      path,
+      `a ${describe(object)} instance`,
+      'Return a plain object with the fields you need.'
+    );
+  }
+
+  // Own *enumerable string* keys only — the rest is what Flight would drop,
+  // so dropping it here keeps the two sides identical. `__proto__` is skipped
+  // rather than copied: it has a language-level setter that would change the
+  // prototype chain of the copy (TIM-655, TIM-855, TIM-873).
+  const out: Record<string, unknown> = Object.create(null);
+  for (const key of Object.keys(object)) {
+    if (key === '__proto__') continue;
+    out[key] = normalize(
+      (object as Record<string, unknown>)[key],
+      path ? `${path}.${key}` : key,
+      seen
+    );
+  }
+  return out;
+}
+
+function keyLabel(key: unknown): string {
+  return typeof key === 'string' ? JSON.stringify(key) : String(key);
+}
+
+// ─── Prototype flip ──────────────────────────────────────────────
+
+/**
+ * Canonical form → wire form. React Flight rejects a null prototype
+ * ("Classes or null prototypes are not supported"), so objects cross as plain
+ * ones and are restored on arrival.
+ */
+export function toPlainRecord<T>(value: T): T {
+  return reproto(value, {}) as T;
+}
+
+/** Wire form → canonical form. The exact inverse of `toPlainRecord`. */
+export function toNullProtoRecord<T>(value: T): T {
+  return reproto(value, null) as T;
+}
+
+/**
+ * Rebuild a canonical value with objects on `proto`.
+ *
+ * Total by construction: its input is always canonical, so the cases are the
+ * domain and nothing else. No validation, no shape it might not have seen, and
+ * no cycle to guard — a canonical value is a tree. That is what moving the
+ * checking to `normalizeParamValue` bought.
+ */
+function reproto(value: unknown, proto: object | null): unknown {
+  if (value === null || typeof value !== 'object') return value;
+
+  const object = value as object;
+
+  // A Date carries no nested values, so it crosses as itself.
+  if (object instanceof Date) return object;
+
+  if (Array.isArray(object)) {
+    return (object as unknown[]).map((item) => reproto(item, proto));
+  }
+
+  if (object instanceof Map) {
+    const out = new Map<unknown, unknown>();
+    for (const [key, entry] of object) out.set(reproto(key, proto), reproto(entry, proto));
+    return out;
+  }
+
+  if (object instanceof Set) {
+    const out = new Set<unknown>();
+    for (const entry of object) out.add(reproto(entry, proto));
+    return out;
+  }
+
+  const out: Record<string, unknown> = proto === null ? Object.create(null) : {};
+  for (const key of Object.keys(object)) {
+    if (key === '__proto__') continue;
+    out[key] = reproto((object as Record<string, unknown>)[key], proto);
+  }
+  return out;
+}

package/src/shared/payload-root.ts

@@ -0,0 +1,151 @@
+/**
+ * The shape of an RSC payload's root row.
+ *
+ * Every tree the server sends the browser is serialized as
+ * `{ tree, params, slotParams }` — the route's element tree, plus the coerced
+ * params it rendered with, as *siblings* rather than as a wrapper around the
+ * tree. See design/41-global-params.md §"Transport".
+ *
+ * Two reasons it is a sibling field rather than a provider inside the payload
+ * (TIM-1297, which is TIM-1294's mechanism corrected):
+ *
+ * 1. **A provider inside the payload cannot serve a partial navigation.** The
+ *    client keeps the previous tree and splices the new payload in at the
+ *    first updated `SegmentOutlet`, so the payload's own provider lands
+ *    *below* the retained region — and the retained region's root is the
+ *    *departing* route's provider, which therefore wins for every reader in a
+ *    skipped layout. Wrapping something above it does not help: context
+ *    resolves to the nearest provider, and the departing one is nearer.
+ *    Params belong to the *navigation*, so the provider has to be owned by the
+ *    client, above the merge point, and there must be exactly one.
+ *
+ * 2. **Element props are not readable at the instant the root resolves.**
+ *    Flight outlines a React element's props and fills the record in after the
+ *    root row resolves, so a reader that unblocks on the root sees `{}` — and
+ *    since the object is filled *in place*, its identity never changes and any
+ *    memo keyed on it caches the empty snapshot permanently. A plain model
+ *    field has no such window: the root chunk stays blocked until everything
+ *    it references has resolved.
+ *
+ * This module is the single declaration of that shape. The server builds roots
+ * through `server/publish-params.ts` and the client reads them through the
+ * helpers here — producer and consumer do not each describe the payload.
+ */
+
+import type { SlotParamsRecord } from './slot-params.js';
+
+/** The params published beside a tree. */
+export interface PublishedParams {
+  /** The main route's coerced params. */
+  params: Record<string, string | string[]>;
+  /** Per-slot params, or null when the route rendered no slots with params. */
+  slotParams: SlotParamsRecord | null;
+}
+
+/**
+ * Params ready to publish: settled, or a promise the root provider suspends on.
+ *
+ * Both forms exist on purpose. The hydration path cannot await — `hydrateRoot`
+ * has to be called before the inline Flight stream has necessarily produced
+ * the root row — so it hands over the promise and suspends exactly where React
+ * was already going to suspend on the tree. Every other path settles it inside
+ * the navigation transition first, which is what keeps a decode failure inside
+ * the app's own error boundaries instead of above them (TIM-1297).
+ */
+export type ParamsSource = PublishedParams | Promise<PublishedParams>;
+
+/** The root row of an RSC payload. */
+export interface RscPayloadRoot extends PublishedParams {
+  /** The route's element tree. */
+  tree: unknown;
+}
+
+/**
+ * What a reader gets when the value it was handed is not a payload root.
+ *
+ * In the browser this is unreachable for a real response: all four producers
+ * of a route payload go through `withPublishedParams`, and a client talking to
+ * a different build is answered with 204 at Stage 1c
+ * (`server/pipeline-phases.ts`) before any payload exists. It is reachable in
+ * the router's test/fallback path, where `decodeRsc` is absent and the
+ * "payload" is the raw response text.
+ */
+export const NO_PUBLISHED_PARAMS: PublishedParams = { params: {}, slotParams: null };
+
+/** True when `value` carries published params — a root, or a read of one. */
+function hasPublishedParams(value: unknown): value is PublishedParams {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    'params' in value &&
+    typeof (value as PublishedParams).params === 'object' &&
+    (value as PublishedParams).params !== null
+  );
+}
+
+/**
+ * Read the params published beside a tree.
+ *
+ * Accepts a payload root *or* a `PublishedParams` already split off one, so
+ * the client can pre-resolve on the navigation path and still hand the same
+ * value to the same provider. Never throws.
+ */
+export function readPublishedParams(source: unknown): PublishedParams {
+  if (!hasPublishedParams(source)) return NO_PUBLISHED_PARAMS;
+  return { params: source.params, slotParams: source.slotParams ?? null };
+}
+
+/**
+ * Read the renderable tree out of a payload root.
+ *
+ * Returns the value unchanged when it is not a root — the router's fallback
+ * path stores raw response text under the same name, and a test asserting on
+ * that text should see the text.
+ */
+export function readPayloadTree(root: unknown): unknown {
+  if (typeof root === 'object' && root !== null && 'tree' in root && hasPublishedParams(root)) {
+    return (root as RscPayloadRoot).tree;
+  }
+  return root;
+}
+
+/** A decoded payload, split into the two things the client does with it. */
+export interface SplitPayload {
+  /** The renderable tree — an element, or a thenable React suspends on. */
+  tree: unknown;
+  /**
+   * The params published beside it. Settled when the root already is, so the
+   * hydration path can render without an extra await.
+   *
+   * **Never rejects.** A decode failure has to surface where React renders
+   * `tree`, so the error boundary *around the tree* catches it. Rejecting here
+   * too would take down the provider above every boundary in the app, turning
+   * a contained failure into a blank page (TIM-1297).
+   */
+  params: ParamsSource;
+}
+
+/**
+ * Split a decoded payload root into its tree and its params.
+ *
+ * Accepts a settled root or a thenable of one, and preserves which it was: a
+ * settled root splits synchronously, so no code path gains a suspend point it
+ * did not already have.
+ */
+export function splitPayloadRoot(root: unknown): SplitPayload {
+  if (
+    typeof root !== 'object' ||
+    root === null ||
+    typeof (root as PromiseLike<unknown>).then !== 'function'
+  ) {
+    return { tree: readPayloadTree(root), params: readPublishedParams(root) };
+  }
+  const settled = root as PromiseLike<unknown>;
+  const tree = Promise.resolve(settled).then(readPayloadTree);
+  // The rejection still reaches React through its own read of `tree`; this
+  // only marks it handled for the case where nothing renders it (a partial
+  // navigation whose segment update finds no matching outlet).
+  tree.catch(() => {});
+  const params = Promise.resolve(settled).then(readPublishedParams, () => NO_PUBLISHED_PARAMS);
+  return { tree, params };
+}