@rangojs/router 0.20.0 → 0.21.0

package/src/vite/plugins/version.d.ts

@@ -5,8 +5,23 @@
 
 declare module "@rangojs/router:version" {
   /**
-   * Auto-generated version string for cache invalidation.
-   * Changes on server restart (dev) or build (prod).
+   * The build's version string.
+   *
+   * - Dev: a stamp that changes on server start and on every RSC module edit.
+   * - Production: the whole-build document version, a hash of the server
+   *   output and the client asset names. The same source builds to the same
+   *   value; any change to any router changes it.
+   *
+   * A router serves with its own versions (`ROUTER_VERSIONS`), not this one.
    */
   export const VERSION: string;
+
+  /**
+   * Per-router cache versions computed at build time: router id to
+   * `[data, document]`, with `"*"` holding the whole-build pair.
+   * `undefined` in dev, where `VERSION` is used for both.
+   */
+  export const ROUTER_VERSIONS:
+    | Readonly<Record<string, readonly [data: string, document: string]>>
+    | undefined;
 }

package/src/vite/plugins/virtual-entries.ts

@@ -1,4 +1,5 @@
 import type { HeadScriptsOption } from "../plugin-types.js";
+import { DEFAULT_ROUTER_VERSIONS_KEY } from "../../router-versions.js";
 
 export const VIRTUAL_ENTRY_BROWSER: string = `
 import {
@@ -164,7 +165,7 @@ export const resumeShellHTML = createShellResumeHandler({
  *   registered for the _rsc_loader endpoint and fail in production.
  *
  * Single source of truth: both the generated virtual RSC entry below and the
- * custom-entry injector (version-injector) consume this list, so a new
+ * custom-entry injector (entry-bootstrap-injector) consume this list, so a new
  * bootstrap manifest cannot be added to one path and forgotten on the other.
  * That exact drift (loader-manifest present here but missing from the injector)
  * is what left fetchable loaders unresolved on custom worker entries.
@@ -197,12 +198,11 @@ import {
 // consults them at router-module evaluation. Router-first would silently push
 // every clientUrls() app onto the deferred-subscription path and change mount
 // registration order with no error. The custom-entry injector keeps the same
-// guarantee by PREPENDING this list at file top (version-injector.ts).
+// guarantee by PREPENDING this list at file top (entry-bootstrap-injector.ts).
 ${bootstrapImports}
 
 import { router } from "${routerPath}";
 import { createRSCHandler } from "@rangojs/router/internal/rsc-handler";
-import { VERSION } from "@rangojs/router:version";
 
 // Lazily create the handler on first request so that ESM live bindings
 // have resolved by the time we read \`router\`. During HMR the module may
@@ -212,7 +212,6 @@ export default function handler(request, env) {
   if (!_handler) {
     _handler = createRSCHandler({
       router,
-      version: VERSION,
       // Forward the router's CSP nonce provider. createRSCHandler reads the
       // provider only from options.nonce; without this, createRouter({ nonce })
       // is silently dropped on the Node preset (the Cloudflare path wires it via
@@ -314,6 +313,33 @@ export const VIRTUAL_IDS = {
   version: "@rangojs/router:version",
 } as const;
 
+/** Dev: one stamp for both versions of every router, bumped on RSC edits. */
 export function getVirtualVersionContent(version: string): string {
-  return `export const VERSION = ${JSON.stringify(version)};`;
+  return [
+    `export const VERSION = ${JSON.stringify(version)};`,
+    `export const ROUTER_VERSIONS = undefined;`,
+  ].join("\n");
+}
+
+/**
+ * Free identifier the production version module ships in place of the table.
+ * The versions are hashes of the built server code, so they cannot be part of
+ * it: the buildApp post hook (router-discovery.ts) replaces this token in the
+ * written chunk once the hashes are final (runRouterVersionsPhase,
+ * discovery/router-versions-phase.ts). An unreplaced token throws a ReferenceError
+ * when the module evaluates, so a build that skipped the step cannot serve
+ * with a constant version.
+ */
+export const ROUTER_VERSIONS_PLACEHOLDER = "__RANGO_ROUTER_VERSIONS__";
+
+/**
+ * Production: byte-identical in every build, so it never moves the hashes it
+ * is later filled with. VERSION is the whole-build document version (the
+ * table's "*" entry).
+ */
+export function getVirtualBuildVersionContent(): string {
+  return [
+    `export const ROUTER_VERSIONS = ${ROUTER_VERSIONS_PLACEHOLDER};`,
+    `export const VERSION = ROUTER_VERSIONS[${JSON.stringify(DEFAULT_ROUTER_VERSIONS_KEY)}][1];`,
+  ].join("\n");
 }

package/src/vite/rango.ts

@@ -2,7 +2,10 @@ import { type PluginOption } from "vite";
 import { readFileSync, existsSync } from "node:fs";
 import { resolve } from "node:path";
 import { exposeActionId } from "./plugins/expose-action-id.js";
-import { defineEncryptionKeyExpr } from "./encryption-key.js";
+import {
+  configureEncryptionKey,
+  defineEncryptionKeyExpr,
+} from "./encryption-key.js";
 import {
   createLoaderDirectiveGuardPlugin,
   createLoaderScanStubPlugin,
@@ -12,6 +15,7 @@ import {
 import { useCacheTransform } from "./plugins/use-cache-transform.js";
 import { transitionWhenHoistPlugin } from "./plugins/transition-when-hoist.js";
 import { clientRefDedup } from "./plugins/client-ref-dedup.js";
+import { stableRscOutput } from "./plugins/stable-rsc-output.js";
 import { VIRTUAL_IDS } from "./plugins/virtual-entries.js";
 import {
   getExcludeDeps,
@@ -43,7 +47,7 @@ import type {
 } from "./plugin-types.js";
 import { createVercelOutputPlugin } from "./plugins/vercel-output.js";
 import { printBanner, rangoVersion } from "./utils/banner.js";
-import { createVersionInjectorPlugin } from "./plugins/version-injector.js";
+import { createEntryBootstrapInjectorPlugin } from "./plugins/entry-bootstrap-injector.js";
 import { createCjsToEsmPlugin } from "./plugins/cjs-to-esm.js";
 import { createRouterDiscoveryPlugin } from "./router-discovery.js";
 import { performanceTracksPlugin } from "./plugins/performance-tracks.js";
@@ -76,6 +80,20 @@ const debugConfig = createRangoDebugger(NS.config);
  */
 const SERVER_BUILD_TARGET = "esnext";
 
+/**
+ * Entry-signature mode for the node/vercel RSC build, the one
+ * `@cloudflare/vite-plugin` forces on its worker entry.
+ *
+ * Vite's default for a server build, "allow-extension", lets the bundler park
+ * modules shared with lazy chunks in the entry chunk. Under a host router that
+ * put the router runtime (80 modules, measured on e2e/test-app/.host-fixture
+ * and examples/vercel-multi-router) and every sub-app's route names into
+ * `index.js`, which every sub-app chunk imported back and which names each
+ * sub-app chunk by its content hash: no router's cache version was independent
+ * of the others (discovery/build-versions.ts hashes a router's chunks).
+ */
+const RSC_ENTRY_SIGNATURES = "strict";
+
 // The leading-directive 'use client' sniff is shared with version-plugin's
 // getClientModuleSignature so the two cannot drift. Imported for local use by the
 // HMR transform below and re-exported because the E8 sniff test imports it from
@@ -111,6 +129,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
   const rangoStart = performance.now();
   const resolvedOptions: RangoOptions = options ?? { preset: "node" };
   const preset = resolvedOptions.preset ?? "node";
+  // Before any plugin-rsc instance (this build's, the discovery temp server's)
+  // reads the key, and so an invalid key fails the config load.
+  configureEncryptionKey(resolvedOptions.encryptionKey);
   const showBanner = resolvedOptions.banner ?? true;
   const clientChunksOption = resolvedOptions.clientChunks ?? true;
   const useBuiltInClientChunks = clientChunksOption === true;
@@ -467,6 +488,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
               ...(vercelServerEnv ?? {}),
               build: {
                 target: SERVER_BUILD_TARGET,
+                rollupOptions: {
+                  preserveEntrySignatures: RSC_ENTRY_SIGNATURES,
+                },
               },
               optimizeDeps: {
                 entries: [VIRTUAL_IDS.rsc],
@@ -539,6 +563,7 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
     plugins.push(clientRefDedup());
   }
   plugins.push(clientChunksReport());
+  plugins.push(stableRscOutput());
 
   plugins.push({
     name: "@rangojs/router:client-component-hmr",
@@ -583,7 +608,7 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
   const discoveryRouterRef = preset !== "cloudflare" ? routerRef : undefined;
 
   if (preset === "cloudflare") {
-    plugins.push(createVersionInjectorPlugin(undefined));
+    plugins.push(createEntryBootstrapInjectorPlugin(undefined));
   }
 
   plugins.push(createCjsToEsmPlugin());

package/src/vite/router-discovery.ts

@@ -8,8 +8,8 @@
 
 import type { Plugin, ViteDevServer } from "vite";
 import { createServer as createViteServer } from "vite";
-import { resolve } from "node:path";
-import { readFileSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { existsSync, readFileSync } from "node:fs";
 import { createRequire, register } from "node:module";
 import { pathToFileURL } from "node:url";
 import {
@@ -34,6 +34,7 @@ import {
   internalDebugNoCacheMiddleware,
 } from "./inject-client-debug.js";
 import { createVersionPlugin } from "./plugins/version-plugin.js";
+import { uniformVersions } from "../router-versions.js";
 import { getVirtualEntrySSR, VIRTUAL_IDS } from "./plugins/virtual-entries.js";
 import { createVirtualStubPlugin } from "./plugins/virtual-stub-plugin.js";
 import {
@@ -64,6 +65,13 @@ import {
   refreshRecordedClientUrlProjections,
 } from "./discovery/client-urls-projection.js";
 import { runShellPrerenderPhase } from "./discovery/shell-prerender-phase.js";
+import { runRouterVersionsPhase } from "./discovery/router-versions-phase.js";
+import {
+  recordBundleFiles,
+  recordClientGraph,
+  recordServerGraph,
+  recordVersionModuleFiles,
+} from "./discovery/build-versions.js";
 import { describeDiscoveryFailure } from "./discovery/discovery-errors.js";
 import { findTransitionWhenError } from "../transition-when-ref.js";
 import { transitionWhenHoistPlugin } from "./plugins/transition-when-hoist.js";
@@ -320,11 +328,44 @@ import type {
   BuildEnvResult,
 } from "./plugin-types.js";
 
+const WRANGLER_CONFIG_NAMES: readonly string[] = [
+  "wrangler.json",
+  "wrangler.jsonc",
+  "wrangler.toml",
+];
+
+/**
+ * getPlatformProxy() looks for the wrangler config from process.cwd() and
+ * resolves its default persist path against cwd, so building from another
+ * directory dropped the app's bindings (#1037). Search upward from the Vite
+ * root with wrangler's own file names and order. Persisted state goes under
+ * the Vite root, where @cloudflare/vite-plugin reads it in dev and preview
+ * (its getPersistenceRoot), also when the config sits above the root. No
+ * config found: no options, wrangler's own lookup.
+ */
+function wranglerProxyOptions(
+  root: string,
+): Record<string, unknown> | undefined {
+  const viteRoot = resolve(root);
+  for (let dir = viteRoot; ; dir = dirname(dir)) {
+    for (const name of WRANGLER_CONFIG_NAMES) {
+      const configPath = join(dir, name);
+      if (existsSync(configPath)) {
+        return {
+          configPath,
+          persist: { path: join(viteRoot, ".wrangler", "state", "v3") },
+        };
+      }
+    }
+    if (dirname(dir) === dir) return undefined;
+  }
+}
+
 /**
  * Resolve the buildEnv option into a concrete { env, dispose? } result.
  * Handles all four input shapes: false, "auto", factory, plain object.
  */
-async function resolveBuildEnv(
+export async function resolveBuildEnv(
   option: BuildEnvOption | undefined,
   factoryCtx: BuildEnvFactoryContext,
 ): Promise<BuildEnvResult | null> {
@@ -348,7 +389,9 @@ async function resolveBuildEnv(
       )) as {
         getPlatformProxy: (opts?: any) => Promise<any>;
       };
-      const proxy = await getPlatformProxy();
+      const proxy = await getPlatformProxy(
+        wranglerProxyOptions(factoryCtx.root),
+      );
       return {
         env: proxy.env as Record<string, unknown>,
         dispose: proxy.dispose,
@@ -410,6 +453,7 @@ function resetPrerenderCollection(s: DiscoveryState): void {
   s.staticManifestEntries = null;
   s.shellCandidates = null;
   s.prerenderPayloadValues = null;
+  s.buildData = [];
 }
 
 /**
@@ -1533,7 +1577,7 @@ export function createRouterDiscoveryPlugin(
               maxSnapshotBytes,
               captureTimeout,
               buildEnv: s.resolvedBuildEnv,
-              buildVersion: version,
+              versions: uniformVersions(version),
               captureShellHTML: ssrModule.captureShellHTML,
               debug: !!debugDiscovery,
             });
@@ -2261,18 +2305,27 @@ export function createRouterDiscoveryPlugin(
       }
     },
 
-    // Post-build PPR shell capture (producer B, #699): runs after EVERY
-    // environment bundle is written — the shell prelude embeds built client
-    // asset URLs (bootstrap entry), which do not exist at buildStart. The
-    // kept temp server and the buildEnv were deferred AS A PAIR in
-    // buildStart's finally; this finally is the pair's success-path owner
-    // (buildEnd below owns the aborted-build path) — the phase itself is a
-    // pure producer and tears down only the globals it installs.
+    // Post-build phases, after EVERY environment bundle is written.
+    //
+    // 1. Cache versions (discovery/router-versions-phase.ts): hashes the
+    //    server output as postprocessBundle left it and writes the per-router
+    //    table into the built version module. First, because phase 2 stamps
+    //    its entries with these versions and reads the same RSC out dir.
+    // 2. PPR shell capture (producer B, #699): the shell prelude embeds built
+    //    client asset URLs (bootstrap entry), which do not exist at
+    //    buildStart. The kept temp server and the buildEnv were deferred AS A
+    //    PAIR in buildStart's finally; this finally is the pair's success-path
+    //    owner (buildEnd below owns the aborted-build path) — the phase itself
+    //    is a pure producer and tears down only the globals it installs.
     buildApp: {
       order: "post",
       async handler(builder) {
         try {
-          await runShellPrerenderPhase(s, builder as any);
+          await runShellPrerenderPhase(
+            s,
+            builder as any,
+            runRouterVersionsPhase(s, builder as any),
+          );
         } finally {
           if (s.isBuildMode) {
             const tempServer = s.shellPhaseTempServer;
@@ -2387,6 +2440,22 @@ export function createRouterDiscoveryPlugin(
     // Record handler chunk metadata and RSC entry filename during RSC build.
     // Used by closeBundle for handler code eviction and prerender data injection.
     generateBundle(_options: any, bundle: any) {
+      // Inputs of the per-router cache versions (discovery/build-versions.ts).
+      // Each pass overwrites its slot: plugin-rsc runs the RSC and SSR builds
+      // twice, and the real pass comes last.
+      if (s.isBuildMode) {
+        const envName = this.environment?.name;
+        if (envName) {
+          s.versionModuleFiles.set(envName, recordVersionModuleFiles(bundle));
+        }
+        if (envName === "rsc") {
+          s.serverBuildGraph = recordServerGraph(this, bundle);
+        } else if (envName === "client") {
+          s.clientBuildGraph = recordClientGraph(this, bundle);
+        } else if (envName === "ssr") {
+          s.ssrBundle = recordBundleFiles(bundle);
+        }
+      }
       if (this.environment?.name !== "rsc") return;
       const genStart = debugBuild ? performance.now() : 0;
 

package/src/vite/utils/client-chunks.ts

@@ -206,8 +206,12 @@ export function resolveClientChunks(
   return option;
 }
 
+/** @vitejs/plugin-rsc's client-reference map; its group modules sit under it. */
+export const CLIENT_REFERENCES_MODULE_ID =
+  "\0virtual:vite-rsc/client-references";
+
 /** Module-id prefix of the per-group virtual module @vitejs/plugin-rsc emits. */
-const CLIENT_GROUP_PREFIX = "\0virtual:vite-rsc/client-references/group/";
+const CLIENT_GROUP_PREFIX = `${CLIENT_REFERENCES_MODULE_ID}/group/`;
 
 /**
  * Build-end group report under `DEBUG=rango:chunks`: one line per client

package/src/vite/utils/compare-strings.ts

@@ -0,0 +1,9 @@
+/**
+ * Code-unit order, the same on every machine. Generated modules and the cache
+ * version inputs are sorted with it: `localeCompare` depends on the build
+ * machine's ICU data, and build output has to be byte-identical across machines
+ * (discovery/build-versions.ts hashes it).
+ */
+export function compareStrings(a: string, b: string): number {
+  return a < b ? -1 : a > b ? 1 : 0;
+}

package/src/vite/utils/package-resolution.ts

@@ -72,11 +72,20 @@ export function getPackageAliases(): Record<string, string> {
   return aliases;
 }
 
+/**
+ * @vitejs/plugin-rsc puts these vendor specifiers in `optimizeDeps.include`,
+ * and Vite resolves them from the app root, where pnpm's strict layout does
+ * not link the plugin unless the app lists it (#1050). Aliased to the copy
+ * the router resolves, which therefore also wins over an app's own
+ * @vitejs/plugin-rsc. Must hold every vendor entry the plugin includes:
+ * optimize-deps-vendor-resolution.test.ts checks the resolved config.
+ */
 export function getVendorAliases(): Record<string, string> {
   const specs = [
     "@vitejs/plugin-rsc/vendor/react-server-dom/client.browser",
     "@vitejs/plugin-rsc/vendor/react-server-dom/client.edge",
     "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge",
+    "@vitejs/plugin-rsc/vendor/react-server-dom/static.edge",
   ];
   const aliases: Record<string, string> = {};
   for (const spec of specs) {

package/src/vite/utils/prerender-utils.ts

@@ -199,8 +199,11 @@ export function resolvePrerenderError(
   throw error;
 }
 
+/** Build scratch space, relative to the project root. Never shipped. */
+export const RANGO_BUILD_DIR = "node_modules/.rangojs-router-build";
+
 function getStagedAssetDir(projectRoot: string): string {
-  return resolve(projectRoot, "node_modules/.rangojs-router-build/rsc-assets");
+  return resolve(projectRoot, RANGO_BUILD_DIR, "rsc-assets");
 }
 
 export function resetStagedBuildAssets(projectRoot: string): void {

package/src/vite/utils/shared-utils.ts

@@ -15,7 +15,7 @@ import type { HeadScriptsOption } from "../plugin-types.js";
 
 // Cloudflare preset: @cloudflare/vite-plugin sets optimizeDeps.entries (string
 // or array) on the rsc environment. Single source for both the discovery plugin
-// and the version injector so they target the same entry.
+// and the entry bootstrap injector so they target the same entry.
 export function resolveRscEntryFromConfig(
   config: ResolvedConfig,
 ): string | undefined {