@rangojs/router 0.0.0-experimental.fb6e2f40 → 0.0.0-experimental.fce7fbd1

package/src/testing/e2e/parity.ts

@@ -0,0 +1,306 @@
+// Dev/production parity helpers. `parityDescribe` registers a dev and a
+// production describe from a single body, auto-generating the `(production)`
+// title suffix so a suite can never drift into the wrong dev/prod bucket.
+// `expectParity` runs one intent over the JS and no-JS paths and asserts the
+// observable result is identical (progressive-enhancement parity).
+
+import type { Expect, Page, TestType } from "@playwright/test";
+import type { Fixture, FixtureOptions } from "./fixture.js";
+
+export interface ParityDescribeOptions extends Partial<
+  Omit<FixtureOptions, "mode">
+> {}
+
+export type ParityIntent =
+  | { navigate: string }
+  | { submit: { testId: string; data?: Record<string, string> } };
+
+export interface ExpectParityOptions {
+  /** data-testid values whose text content must match across JS and no-JS. */
+  observe: string[];
+  /** Base URL to resolve a relative `navigate` intent against. */
+  baseURL?: string;
+  /**
+   * Escape hatch invoked after the intent is applied and before the snapshot is
+   * taken, on BOTH the JS and the no-JS transports. When provided for a `submit`
+   * intent it REPLACES the generic settle (the navigation/observed-change wait):
+   * you take responsibility for awaiting the post-submit effect — for example,
+   * awaiting a specific testid to reach a known value, or a network response the
+   * page does not reflect in the observed testids. Receives the page for the
+   * transport being snapshotted.
+   */
+  waitFor?: (page: Page) => Promise<void>;
+}
+
+export interface Parity {
+  /**
+   * Register a dev describe (title `name`) and a production describe (title
+   * `` `${name} (production)` ``) from one body. The `(production)` suffix is
+   * generated here, so the production suite always lands in the production
+   * bucket regardless of how the consumer names things.
+   *
+   * `options.root` is required, either here or as `defaultRoot` passed to the
+   * factory.
+   */
+  parityDescribe: (
+    name: string,
+    body: (f: Fixture) => void,
+    options?: ParityDescribeOptions,
+  ) => void;
+  /**
+   * Run a single `intent` over both the JS path (the given `page`) and a
+   * fresh no-JS context, then assert the observed snapshots are equal.
+   *
+   * PE parity only holds if the consumer's submit target is a real `<form>`
+   * that progressively enhances: with JS disabled the browser performs a native
+   * form POST, and the server must produce the same observable result the
+   * enhanced client path produces. Navigation intents must be plain links/URLs
+   * that resolve server-side without JS.
+   *
+   * For a `submit` intent the helper waits for the action's observable effect
+   * before snapshotting: either a navigation away from the form, or a change to
+   * one of the `observe` testids from its pre-submit value (then a brief
+   * stability confirm). A submit that produces neither within ~5s throws —
+   * include the testid that changes in `observe`, or pass `waitFor` to express
+   * the precise wait. This prevents snapshotting the pre-submit DOM when the
+   * action is slow.
+   *
+   * The snapshot is intentionally strict: it compares the text of every
+   * observed `data-testid`, the resulting `page.url()`, and the cookies visible
+   * via `document.cookie`. No ephemeral-value normalization is applied in v1;
+   * if a consumer's page renders nondeterministic values, exclude that testid
+   * from `observe`.
+   *
+   * LIMITATION: cookie parity is read from `document.cookie`, which by design
+   * EXCLUDES HttpOnly cookies. Session/auth cookies (the typical HttpOnly case)
+   * are therefore NOT compared — a PE/JS divergence in an HttpOnly cookie will
+   * not be caught here. Assert on those via `read_network_requests` / response
+   * Set-Cookie headers in a dedicated test, not expectParity.
+   */
+  expectParity: (
+    page: Page,
+    intent: ParityIntent,
+    opts: ExpectParityOptions,
+  ) => Promise<void>;
+}
+
+interface ParitySnapshot {
+  testIds: Record<string, string | null>;
+  url: string;
+  cookies: string;
+}
+
+async function applyIntent(
+  page: Page,
+  intent: ParityIntent,
+  baseURL?: string,
+): Promise<void> {
+  if ("navigate" in intent) {
+    const target = baseURL
+      ? new URL(intent.navigate, baseURL).href
+      : intent.navigate;
+    await page.goto(target, { waitUntil: "networkidle" });
+    return;
+  }
+  const form = page.locator(`[data-testid="${intent.submit.testId}"]`);
+  if (intent.submit.data) {
+    for (const [name, value] of Object.entries(intent.submit.data)) {
+      await form.locator(`[name="${name}"]`).fill(value);
+    }
+  }
+  // No post-click wait here: a native (no-JS) submit triggers a top-level
+  // navigation while an enhanced (JS) submit usually updates the DOM in place
+  // with no navigation, so a navigation-based wait races the click and can
+  // resolve before the effect lands. The post-action settle in expectParity is
+  // DOM-driven (settleSubmit) and works whether or not a navigation occurs.
+  await form
+    .locator('button[type="submit"], input[type="submit"]')
+    .first()
+    .click();
+}
+
+// Concatenate the observed testids' text into a single comparable string used
+// to detect post-submit change/stability. "\0" marks an absent testid and
+// "\x01" joins parts so two distinct testid layouts can never concatenate to the
+// same string. Written as escaped control chars (not literal bytes) for source
+// readability.
+async function readObserved(page: Page, observe: string[]): Promise<string> {
+  const parts: string[] = [];
+  for (const id of observe) {
+    const text = await page
+      .locator(`[data-testid="${id}"]`)
+      .first()
+      .textContent()
+      .catch(() => null);
+    parts.push(`${id}=${text ?? "\0"}`);
+  }
+  return parts.join("\x01");
+}
+
+// Settle a submit's observable effect. An enhanced (JS) submit mutates the DOM
+// in place with no navigation, while a native (no-JS) submit navigates — so we
+// wait for EITHER a navigation away from the form OR a change in the observed
+// testids from their pre-submit `baseline`, then confirm the new state is stable
+// across two reads. Requiring an observed change (not just stability) closes the
+// gap where a slow action leaves the pre-submit DOM momentarily stable and gets
+// snapshotted as the "result". A submit that produces neither a navigation nor
+// an observed change within the ceiling throws, rather than silently capturing
+// the pre-submit state — pass `waitFor` when the observed set cannot capture the
+// effect.
+async function settleSubmit(
+  page: Page,
+  observe: string[],
+  baseline: string,
+  originUrl: string,
+): Promise<void> {
+  const pollIntervalMs = 50;
+  const maxAttempts = 100; // ~5s ceiling
+  let landed = false;
+  let last = baseline;
+  for (let attempt = 0; attempt < maxAttempts; attempt++) {
+    await page.waitForTimeout(pollIntervalMs);
+    const current = await readObserved(page, observe);
+    if (!landed) {
+      if (page.url() !== originUrl || current !== baseline) {
+        landed = true;
+        last = current;
+      }
+      continue;
+    }
+    if (current === last) return;
+    last = current;
+  }
+  if (!landed) {
+    throw new Error(
+      `expectParity: the submit intent produced no observable effect within 5s — ` +
+        `no navigation away from "${originUrl}" and no change to the observed ` +
+        `testids [${observe.join(", ")}]. Include the testid that changes in ` +
+        `\`observe\`, or pass \`waitFor\` to express the precise post-submit wait.`,
+    );
+  }
+  // Landed but never stabilized within the ceiling: fall through and snapshot
+  // the last-read state; the parity equality assertion surfaces any mismatch.
+}
+
+async function snapshot(
+  page: Page,
+  observe: string[],
+): Promise<ParitySnapshot> {
+  const testIds: Record<string, string | null> = {};
+  for (const id of observe) {
+    testIds[id] = await page.locator(`[data-testid="${id}"]`).textContent();
+  }
+  return {
+    testIds,
+    url: page.url(),
+    cookies: await page.evaluate(() => document.cookie),
+  };
+}
+
+export function createParity({
+  test: _test,
+  expect,
+  useFixture,
+  defaultRoot,
+}: {
+  test: TestType<any, any>;
+  expect: Expect;
+  useFixture: (options: FixtureOptions) => Fixture;
+  defaultRoot?: string;
+}): Parity {
+  function parityDescribe(
+    name: string,
+    body: (f: Fixture) => void,
+    options?: ParityDescribeOptions,
+  ): void {
+    const root = options?.root ?? defaultRoot;
+    if (!root) {
+      throw new Error(
+        `parityDescribe("${name}") requires a root: pass options.root or set defaultRoot in createRangoE2E.`,
+      );
+    }
+    _test.describe(name, () => {
+      const f = useFixture({ ...options, root, mode: "dev" });
+      body(f);
+    });
+    _test.describe(`${name} (production)`, () => {
+      const f = useFixture({ ...options, root, mode: "build" });
+      body(f);
+    });
+  }
+
+  async function expectParity(
+    page: Page,
+    intent: ParityIntent,
+    opts: ExpectParityOptions,
+  ): Promise<void> {
+    // For a submit intent, the form lives on the page the caller already
+    // navigated to; capture that origin URL before the JS submit changes it so
+    // the no-JS path can load the same form, and so settleSubmit can detect a
+    // navigation away from it.
+    const originUrl = page.url();
+
+    // Settle the intent's observable effect before snapshotting. A `navigate`
+    // intent already awaited its navigation in applyIntent (page.goto), so only
+    // `submit` needs the DOM-driven settle, and only when no `waitFor` override
+    // is given. waitFor, when present, replaces the generic settle for submit
+    // and runs after the navigation for navigate — on whichever page is about to
+    // be snapshotted.
+    const settle = async (
+      target: Page,
+      baseline: string,
+      origin: string,
+    ): Promise<void> => {
+      if ("submit" in intent) {
+        if (opts.waitFor) {
+          await opts.waitFor(target);
+        } else {
+          await settleSubmit(target, opts.observe, baseline, origin);
+        }
+      } else if (opts.waitFor) {
+        await opts.waitFor(target);
+      }
+    };
+
+    // JS path: the given page (JS enabled by default). Read the pre-submit
+    // baseline before applying the intent so the settle can require a change.
+    const jsBaseline =
+      "submit" in intent ? await readObserved(page, opts.observe) : "";
+    await applyIntent(page, intent, opts.baseURL);
+    await settle(page, jsBaseline, originUrl);
+    const jsSnapshot = await snapshot(page, opts.observe);
+
+    // No-JS path: a fresh context with scripting disabled.
+    const browser = page.context().browser()!;
+    const noJsContext = await browser.newContext({ javaScriptEnabled: false });
+    try {
+      const noJsPage = await noJsContext.newPage();
+      if (!("navigate" in intent)) {
+        // A submit intent needs the form rendered first; start from the same
+        // URL the JS path observed the form on.
+        await noJsPage.goto(originUrl, { waitUntil: "networkidle" });
+      }
+      const noJsOrigin = noJsPage.url();
+      const noJsBaseline =
+        "submit" in intent ? await readObserved(noJsPage, opts.observe) : "";
+      await applyIntent(noJsPage, intent, opts.baseURL);
+      await settle(noJsPage, noJsBaseline, noJsOrigin);
+      const noJsSnapshot = await snapshot(noJsPage, opts.observe);
+
+      expect(noJsSnapshot.testIds).toEqual(jsSnapshot.testIds);
+      // Compare pathname + search + hash, not pathname alone: a JS vs no-JS flow
+      // that diverges only in query/hash (e.g. /search?q=a vs /search?q=b) would
+      // otherwise pass.
+      const locationOf = (u: string): string => {
+        const url = new URL(u);
+        return url.pathname + url.search + url.hash;
+      };
+      expect(locationOf(noJsSnapshot.url)).toEqual(locationOf(jsSnapshot.url));
+      expect(noJsSnapshot.cookies).toEqual(jsSnapshot.cookies);
+    } finally {
+      await noJsContext.close();
+    }
+  }
+
+  return { parityDescribe, expectParity };
+}

package/src/testing/e2e/server.ts

@@ -0,0 +1,183 @@
+// Node-only server-lifecycle machinery for the e2e harness. Contains no
+// Playwright imports so it can be loaded in a plain-node process. Lifted from
+// the internal e2e/fixture.ts and parameterized for consumer apps.
+
+import { type SpawnOptions, spawn } from "node:child_process";
+import path from "node:path";
+import { stripVTControlCharacters, styleText } from "node:util";
+import { x } from "tinyexec";
+
+export type { SpawnOptions };
+
+export interface RunCliHandle {
+  proc: ReturnType<typeof x>["process"];
+  done: Promise<void>;
+  findPort: (timeoutMs?: number) => Promise<number>;
+  kill: () => void;
+  stdout: () => string;
+  stderr: () => string;
+}
+
+export function runCli(
+  options: { command: string; label?: string } & SpawnOptions,
+): RunCliHandle {
+  const [name, ...args] = options.command.split(" ");
+  // Vite registers `process.stdin.on("end", ...)` as parent-death detection and
+  // calls process.exit() when stdin reaches EOF, unless process.env.CI === "true"
+  // (see vite's setupSIGTERMListener). Servers spawned here receive an stdin that
+  // hits EOF immediately, so without CI=true the dev/preview server shuts itself
+  // down before it finishes starting. Real CI runners set CI=true; mirror that for
+  // locally-spawned servers so they stay alive for the duration of the tests.
+  const child = x(name!, args, {
+    nodeOptions: {
+      ...options,
+      env: { ...process.env, CI: "true", ...options.env },
+    },
+  }).process!;
+  const label = `[${options.label ?? "cli"}]`;
+  let stdout = "";
+  let stderr = "";
+  child.stdout!.on("data", (data) => {
+    stdout += stripVTControlCharacters(String(data));
+    if (process.env.TEST_DEBUG) {
+      console.log(styleText("cyan", label), data.toString());
+    }
+  });
+  child.stderr!.on("data", (data) => {
+    stderr += stripVTControlCharacters(String(data));
+    if (process.env.TEST_DEBUG) {
+      console.log(styleText("magenta", label), data.toString());
+    }
+  });
+  const done = new Promise<void>((resolve) => {
+    child.on("exit", (code) => {
+      if (code !== 0 && code !== 143 && process.platform !== "win32") {
+        console.log(styleText("magenta", `${label}`), `exit code ${code}`);
+      }
+      resolve();
+    });
+  });
+
+  async function findPort(timeoutMs = 60000): Promise<number> {
+    let stdout = "";
+    return new Promise((resolve, reject) => {
+      const timeout = setTimeout(() => {
+        reject(
+          new Error(
+            `Timed out waiting for server to start after ${timeoutMs}ms. Stdout: ${stdout}`,
+          ),
+        );
+      }, timeoutMs);
+
+      child.stdout!.on("data", (data) => {
+        stdout += stripVTControlCharacters(String(data));
+        const match = stdout.match(/http:\/\/localhost:(\d+)/);
+        if (match) {
+          clearTimeout(timeout);
+          resolve(Number(match[1]));
+        }
+      });
+
+      child.on("exit", (code) => {
+        clearTimeout(timeout);
+        if (code !== 0) {
+          reject(
+            new Error(`Server exited with code ${code}. Stdout: ${stdout}`),
+          );
+        }
+      });
+    });
+  }
+
+  function kill() {
+    if (process.platform === "win32") {
+      spawn("taskkill", ["/pid", String(child.pid), "/t", "/f"]);
+    } else {
+      // Kill entire process group (Vite spawns child processes like workerd).
+      // Falls back to direct kill if process group kill fails.
+      try {
+        process.kill(-child.pid!, "SIGTERM");
+      } catch {
+        child.kill();
+      }
+    }
+  }
+
+  return {
+    proc: child,
+    done,
+    findPort,
+    kill,
+    stdout: () => stdout,
+    stderr: () => stderr,
+  };
+}
+
+export function tailOutput(text: string, maxChars = 4000): string {
+  if (!text) return "(empty)";
+  if (text.length <= maxChars) return text;
+  return `...${text.slice(-maxChars)}`;
+}
+
+export function createIsolatedViteCacheDir(
+  cwd: string,
+  projectName: string,
+  mode: "dev" | "build" | undefined,
+): string {
+  const safeProjectName = projectName.replace(/[^a-zA-Z0-9_-]/g, "-");
+  return path.join(
+    cwd,
+    ".vite-isolated",
+    `${safeProjectName}-${mode ?? "server"}-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`,
+  );
+}
+
+export async function waitForReady(
+  url: string,
+  getOutput?: () => { stdout: string; stderr: string },
+  timeoutMs: number = process.env.CI ? 60000 : 30000,
+): Promise<void> {
+  const deadline = Date.now() + timeoutMs;
+  while (Date.now() < deadline) {
+    try {
+      const res = await fetch(url);
+      if (res.ok) return;
+    } catch {}
+    await new Promise((r) => setTimeout(r, 100));
+  }
+  const output = getOutput?.();
+  const details = output
+    ? `\nRecent stdout:\n${tailOutput(output.stdout)}\n\nRecent stderr:\n${tailOutput(output.stderr)}`
+    : "";
+  throw new Error(`Server not ready after ${timeoutMs}ms: ${url}${details}`);
+}
+
+/**
+ * Warm up an isolated dev server by making real SSR requests.
+ * The first SSR request triggers Vite's dep optimizer to discover SSR deps.
+ * After optimization, modules are re-evaluated and in-memory caches reset.
+ * We retry until the server returns a stable 200, absorbing the dep
+ * optimization cycle so subsequent test requests hit a settled server.
+ */
+export async function warmupDevServer(url: string): Promise<void> {
+  const deadline = Date.now() + 30_000;
+  let lastOk = 0;
+  // Need two consecutive OK responses to confirm the server is settled
+  // (first OK may precede dep optimization, second confirms stability).
+  while (Date.now() < deadline && lastOk < 2) {
+    try {
+      const res = await fetch(url, {
+        headers: { accept: "text/html" },
+      });
+      if (res.ok) {
+        await res.text(); // consume body to complete SSR pipeline
+        lastOk++;
+      } else {
+        lastOk = 0;
+      }
+    } catch {
+      lastOk = 0;
+    }
+    await new Promise((r) => setTimeout(r, 1000));
+  }
+}

package/src/testing/flight-matchers.ts

@@ -0,0 +1,104 @@
+/**
+ * Vitest custom matchers for asserting on REAL Flight wire strings produced by
+ * {@link renderToFlightString}. Register with:
+ *
+ *   import { expect } from "vitest";
+ *   import { flightMatchers } from "@rangojs/router/testing/flight-matchers"; // or local path
+ *   expect.extend(flightMatchers);
+ *
+ * Ergonomic shape (vitest `expect` is single-arg, so the matcher receives the
+ * ALREADY-RENDERED Flight string as `received`):
+ *
+ *   const flight = await renderToFlightString(<Greeting name="Ada" />);
+ *   expect(flight).toMatchFlight("Ada");          // substring containment
+ *   expect(flight).toMatchFlightSnapshot();        // normalized snapshot
+ *
+ * `toMatchFlight(expected)` asserts the NORMALIZED Flight string CONTAINS
+ * `expected`. Containment (not equality) is the v1 contract because the Flight
+ * row prefixes/quoting are an internal serializer detail — tests should pin the
+ * rendered text/shape, not the exact framing. For an exact, drift-detecting
+ * assertion of the whole payload, use `toMatchFlightSnapshot()`.
+ *
+ * Both operate on normalized output (see normalizeFlight): the dev-only
+ * `:N<timestamp>` reference row and absolute `file://` paths are scrubbed so
+ * assertions are stable across runs/machines. Run snapshots under
+ * NODE_ENV=production for the cleanest, most stable payloads.
+ *
+ * Scope: server-only / leaf trees (a client component emits an unresolved
+ * `I[...]` import row against the empty client manifest — see flight.ts).
+ */
+
+import { expect } from "vitest";
+import { normalizeFlight } from "./flight.js";
+
+interface MatcherResult {
+  pass: boolean;
+  message: () => string;
+}
+
+/**
+ * Matcher object for `expect.extend(flightMatchers)`.
+ *
+ * - `toMatchFlight(received, expected)` — `received` is a rendered Flight
+ *   string; passes if its normalized form contains `expected`.
+ * - `toMatchFlightSnapshot(received)` — delegates to vitest's snapshot on the
+ *   normalized Flight string.
+ */
+export const flightMatchers: {
+  toMatchFlight(received: string, expected: string): MatcherResult;
+  toMatchFlightSnapshot(received: string): MatcherResult;
+} = {
+  toMatchFlight(received: string, expected: string): MatcherResult {
+    if (typeof received !== "string") {
+      return {
+        pass: false,
+        message: () =>
+          "toMatchFlight expected a rendered Flight string (the result of " +
+          "`await renderToFlightString(...)`), but received " +
+          `${typeof received}. Render the element first: ` +
+          "`expect(await renderToFlightString(<C/>)).toMatchFlight(...)`.",
+      };
+    }
+    const normalized = normalizeFlight(received);
+    const pass = normalized.includes(expected);
+    return {
+      pass,
+      message: () =>
+        pass
+          ? `Expected Flight string not to contain ${JSON.stringify(expected)}.`
+          : `Expected Flight string to contain ${JSON.stringify(expected)}.\n` +
+            `Received (normalized):\n${normalized}`,
+    };
+  },
+
+  toMatchFlightSnapshot(received: string): MatcherResult {
+    // Delegate to vitest's snapshot engine on the normalized string. The
+    // snapshot is keyed by the current test file/title (vitest tracks this via
+    // the active test context), not by this call site, so delegating through a
+    // freshly imported `expect` is reliable.
+    expect(normalizeFlight(received)).toMatchSnapshot();
+    // toMatchSnapshot throws on mismatch; reaching here means it passed.
+    return {
+      pass: true,
+      message: () => "Flight snapshot matched.",
+    };
+  },
+};
+
+/**
+ * Vitest Assertion augmentation so `toMatchFlight` / `toMatchFlightSnapshot`
+ * are typed on `expect(...)`. Imported for its side-effecting type
+ * augmentation; importing flight-matchers (which imports this) is enough.
+ */
+declare module "vitest" {
+  interface Assertion<T = any> {
+    /** Assert the normalized Flight string contains `expected`. */
+    toMatchFlight(expected: string): T;
+    /** Snapshot the normalized Flight string. */
+    toMatchFlightSnapshot(): T;
+  }
+  interface AsymmetricMatchersContaining {
+    toMatchFlight(expected: string): void;
+    toMatchFlightSnapshot(): void;
+  }
+}

package/src/testing/flight-runtime.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Ambient declaration for the vendored react-server-dom serializer shipped
+ * inside @vitejs/plugin-rsc. The package ships no .d.ts for this private
+ * subpath, so we declare the minimal surface renderToFlightString uses.
+ *
+ * Only loadable under the `react-server` export condition (see flight.ts).
+ */
+declare module "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge" {
+  /**
+   * Serialize a server-component payload to a Flight wire stream.
+   *
+   * @param payload The value to serialize (Rango wraps a payload object).
+   * @param clientManifest Client-reference manifest; `{}` for server-only trees.
+   * @param options Render options; `onError` is invoked per render error.
+   */
+  export function renderToReadableStream(
+    payload: unknown,
+    clientManifest: unknown,
+    options?: { onError?: (error: unknown) => string | void },
+  ): ReadableStream<Uint8Array>;
+}

package/src/testing/flight.entry.ts

@@ -0,0 +1,22 @@
+/**
+ * @rangojs/router/testing/flight
+ *
+ * Real React Server Component (Flight) rendering for unit tests. This entry is
+ * SEPARATE from the main ./testing barrel because its serializer (the vendored
+ * react-server-dom build) can only be imported under the `react-server` node
+ * condition; importing it elsewhere throws. Use it only from a Vitest project
+ * configured with that condition (see vitest.rsc.config.ts) — name those test
+ * files `*.rsc-test.{ts,tsx}` and run `pnpm test:unit:rsc`.
+ *
+ * This entry deliberately does NOT pull in Vitest. The `toMatchFlight` /
+ * `toMatchFlightSnapshot` matchers (which import `vitest`) live at the separate
+ * `@rangojs/router/testing/flight-matchers` subpath, so a consumer can import
+ * `renderToFlightString` without taking a hard dependency on Vitest.
+ */
+
+export {
+  renderToFlightString,
+  normalizeFlight,
+  assertFlightRuntimeAvailable,
+} from "./flight.js";
+export type { RenderToFlightStringOptions } from "./flight.js";