@rangojs/router 0.0.0-experimental.2 → 0.0.0-experimental.204030a9

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

@@ -0,0 +1,222 @@
+import { createHash } from "node:crypto";
+import {
+  copyFileSync,
+  existsSync,
+  mkdirSync,
+  rmSync,
+  statSync,
+  writeFileSync,
+} from "node:fs";
+import { resolve } from "node:path";
+
+/**
+ * Escape special RegExp characters in a string for safe interpolation
+ * into new RegExp() patterns.
+ */
+export function escapeRegExp(str: string): string {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+/**
+ * Encode route param values for path interpolation while preserving path
+ * separators for wildcard params (splat-style values can include `/`).
+ */
+export function encodePathParam(value: unknown): string {
+  return String(value)
+    .split("/")
+    .map((segment) => encodeURIComponent(segment))
+    .join("/");
+}
+
+/**
+ * Substitute route params into a pattern, stripping constraint and optional
+ * syntax (:param(a|b)? -> value). Also handles wildcard params (*key).
+ * Optional params not present in `params` are removed from the output.
+ */
+export function substituteRouteParams(
+  pattern: string,
+  params: Record<string, string>,
+  encode: (value: string) => string = encodeURIComponent,
+): string {
+  let result = pattern;
+  let hadOmittedOptional = false;
+
+  // First pass: substitute provided params.
+  // Empty string on an optional placeholder is treated as omitted —
+  // caller-supplied params or `getParams()` shapes may pass `""` for an
+  // absent optional, so letting the second pass strip them keeps slash
+  // cleanup consistent. Empty string on required `:key` or wildcard
+  // `*key` still substitutes, matching prior behaviour.
+  for (const [key, value] of Object.entries(params)) {
+    const escaped = escapeRegExp(key);
+    if (value === "") {
+      // Only replace required placeholders (negative lookahead for `?`);
+      // leave `:key?` for the second pass.
+      result = result.replace(
+        new RegExp(`:${escaped}(\\([^)]*\\))?(?!\\?)`),
+        "",
+      );
+      result = result.replace(`*${key}`, "");
+    } else {
+      result = result.replace(
+        new RegExp(`:${escaped}(\\([^)]*\\))?\\??`),
+        encode(value),
+      );
+      result = result.replace(`*${key}`, encode(value));
+    }
+  }
+
+  // Second pass: strip remaining optional param placeholders not in params
+  result = result.replace(/:([a-zA-Z_][a-zA-Z0-9_]*)(\([^)]*\))?\?/g, () => {
+    hadOmittedOptional = true;
+    return "";
+  });
+
+  // Clean up slashes from omitted optional segments
+  if (hadOmittedOptional) {
+    const hadTrailingSlash = pattern.length > 1 && pattern.endsWith("/");
+    result = result.replace(/\/\/+/g, "/").replace(/\/+$/, "") || "/";
+    if (hadTrailingSlash && !result.endsWith("/")) result += "/";
+  }
+
+  return result;
+}
+
+/**
+ * Run an async function over items with bounded concurrency.
+ * Errors propagate immediately and abort remaining work.
+ */
+export async function runWithConcurrency<T>(
+  items: T[],
+  concurrency: number,
+  fn: (item: T) => Promise<void>,
+): Promise<void> {
+  const limit = Math.max(1, Math.min(concurrency, items.length));
+  if (limit <= 1) {
+    for (const item of items) await fn(item);
+    return;
+  }
+  let nextIndex = 0;
+  async function worker() {
+    while (nextIndex < items.length) {
+      const idx = nextIndex++;
+      await fn(items[idx]);
+    }
+  }
+  await Promise.all(Array.from({ length: limit }, () => worker()));
+}
+
+/**
+ * Group prerender entries by their concurrency setting so each group
+ * can be rendered with the appropriate parallelism.
+ */
+export function groupByConcurrency<T extends { concurrency: number }>(
+  entries: T[],
+): { concurrency: number; entries: T[] }[] {
+  const map = new Map<number, T[]>();
+  for (const entry of entries) {
+    const key = entry.concurrency;
+    let group = map.get(key);
+    if (!group) {
+      group = [];
+      map.set(key, group);
+    }
+    group.push(entry);
+  }
+  return Array.from(map.entries(), ([concurrency, items]) => ({
+    concurrency,
+    entries: items,
+  }));
+}
+
+/**
+ * Notify all routers' onError callbacks about a build-time error.
+ * Uses a synthetic request since there is no real request during build.
+ */
+export function notifyOnError(
+  registry: Map<string, any>,
+  error: unknown,
+  phase: "prerender" | "static",
+  routeKey?: string,
+  pathname?: string,
+  skipped?: boolean,
+): void {
+  for (const [, routerInstance] of registry) {
+    const onError = routerInstance.onError;
+    if (!onError) continue;
+
+    const errorObj = error instanceof Error ? error : new Error(String(error));
+    const syntheticUrl = new URL("http://prerender" + (pathname || "/"));
+    const context = {
+      error: errorObj,
+      phase,
+      request: new Request(syntheticUrl),
+      url: syntheticUrl,
+      pathname: syntheticUrl.pathname,
+      method: "GET",
+      routeKey,
+      metadata: skipped ? { skipped: true } : undefined,
+    };
+
+    try {
+      const result = onError(context);
+      if (result instanceof Promise) {
+        result.catch((cbErr: unknown) => {
+          console.error(`[Build.onError] Callback error:`, cbErr);
+        });
+      }
+    } catch (cbErr) {
+      console.error(`[Build.onError] Callback error:`, cbErr);
+    }
+    break; // Only notify the first router with onError
+  }
+}
+
+function getStagedAssetDir(projectRoot: string): string {
+  return resolve(projectRoot, "node_modules/.rangojs-router-build/rsc-assets");
+}
+
+export function resetStagedBuildAssets(projectRoot: string): void {
+  rmSync(getStagedAssetDir(projectRoot), { recursive: true, force: true });
+}
+
+export function stageBuildAssetModule(
+  projectRoot: string,
+  prefix: "__pr" | "__st",
+  exportValue: string,
+): string {
+  const stagedDir = getStagedAssetDir(projectRoot);
+  mkdirSync(stagedDir, { recursive: true });
+
+  const contentHash = createHash("sha256")
+    .update(exportValue)
+    .digest("hex")
+    .slice(0, 8);
+  const fileName = `${prefix}-${contentHash}.js`;
+  const filePath = resolve(stagedDir, fileName);
+
+  if (!existsSync(filePath)) {
+    writeFileSync(filePath, `export default ${exportValue};\n`);
+  }
+
+  return fileName;
+}
+
+export function copyStagedBuildAssets(
+  projectRoot: string,
+  fileNames: Iterable<string>,
+): number {
+  const stagedDir = getStagedAssetDir(projectRoot);
+  const distAssetsDir = resolve(projectRoot, "dist/rsc/assets");
+  mkdirSync(distAssetsDir, { recursive: true });
+
+  let totalBytes = 0;
+  for (const fileName of new Set(fileNames)) {
+    const stagedPath = resolve(stagedDir, fileName);
+    const distPath = resolve(distAssetsDir, fileName);
+    copyFileSync(stagedPath, distPath);
+    totalBytes += statSync(stagedPath).size;
+  }
+
+  return totalBytes;
+}

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

@@ -0,0 +1,251 @@
+import type { Plugin, ResolvedConfig } from "vite";
+import * as Vite from "vite";
+import { getPublishedPackageName } from "./package-resolution.js";
+import { performanceTracksOptimizeDepsPlugin } from "../plugins/performance-tracks.js";
+import {
+  VIRTUAL_ENTRY_BROWSER,
+  VIRTUAL_ENTRY_SSR,
+  getVirtualEntryRSC,
+  getVirtualVersionContent,
+  VIRTUAL_IDS,
+} from "../plugins/virtual-entries.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.
+export function resolveRscEntryFromConfig(
+  config: ResolvedConfig,
+): string | undefined {
+  const entries = (config.environments as any)?.["rsc"]?.optimizeDeps?.entries;
+  if (typeof entries === "string") return entries;
+  if (Array.isArray(entries) && entries.length > 0) return entries[0];
+  return undefined;
+}
+
+/**
+ * Rolldown plugin to provide the version virtual module during dependency
+ * optimization. Vite 8 optimizes deps with Rolldown (a Rollup-style plugin
+ * pipeline that is separate from the main plugin set), so this is a
+ * resolveId/load plugin under optimizeDeps.rolldownOptions. Any dep pulled into
+ * optimization that imports the version virtual module gets a "dev" stub here;
+ * the real VERSION is injected into runtime modules by the version plugin.
+ */
+const versionRolldownPlugin = {
+  name: "@rangojs/router-version",
+  resolveId(id: string): string | undefined {
+    if (id === VIRTUAL_IDS.version) return "\0" + VIRTUAL_IDS.version;
+    return undefined;
+  },
+  load(id: string): string | undefined {
+    if (id === "\0" + VIRTUAL_IDS.version) {
+      return getVirtualVersionContent("dev");
+    }
+    return undefined;
+  },
+};
+
+/**
+ * Shared Rolldown options for dependency optimization (Vite 8).
+ * Includes the version stub plugin and the performance-tracks RSDW patch.
+ */
+export const sharedRolldownOptions: {
+  plugins: any[];
+} = {
+  plugins: [versionRolldownPlugin, performanceTracksOptimizeDepsPlugin()],
+};
+
+/**
+ * Create a virtual modules plugin for default entry files.
+ * Provides virtual module content when entries use VIRTUAL_IDS (no custom entry configured).
+ */
+export function createVirtualEntriesPlugin(
+  entries: { client: string; ssr: string; rsc?: string },
+  routerPathRef?: { path?: string },
+): Plugin {
+  // Build virtual modules map based on which entries use virtual IDs
+  const virtualModules: Record<string, string> = {};
+
+  if (entries.client === VIRTUAL_IDS.browser) {
+    virtualModules[VIRTUAL_IDS.browser] = VIRTUAL_ENTRY_BROWSER;
+  }
+  if (entries.ssr === VIRTUAL_IDS.ssr) {
+    virtualModules[VIRTUAL_IDS.ssr] = VIRTUAL_ENTRY_SSR;
+  }
+
+  // RSC entry is resolved lazily in load() because routerPath may be
+  // set after plugin creation (e.g. by the auto-discover config() hook).
+  // Track all known virtual IDs for resolveId (content is separate).
+  const knownIds = new Set(Object.keys(virtualModules));
+  if (entries.rsc === VIRTUAL_IDS.rsc) {
+    knownIds.add(VIRTUAL_IDS.rsc);
+  }
+
+  return {
+    name: "@rangojs/router:virtual-entries",
+    enforce: "pre",
+
+    resolveId(id) {
+      if (knownIds.has(id)) {
+        return "\0" + id;
+      }
+      // Handle if the id already has the null prefix (RSC plugin wrapper imports)
+      if (id.startsWith("\0") && knownIds.has(id.slice(1))) {
+        return id;
+      }
+      return null;
+    },
+
+    load(id) {
+      if (id.startsWith("\0virtual:rsc-router/")) {
+        const virtualId = id.slice(1);
+        if (virtualId in virtualModules) {
+          return virtualModules[virtualId];
+        }
+        // Lazy RSC entry: routerPath may have been set by a config() hook
+        if (virtualId === VIRTUAL_IDS.rsc && routerPathRef?.path) {
+          const raw = routerPathRef.path.startsWith(".")
+            ? "/" + routerPathRef.path.slice(2) // ./src/router.tsx -> /src/router.tsx
+            : routerPathRef.path;
+          // Normalize backslashes for Windows (path.join/slice preserve native separators)
+          const absoluteRouterPath = raw.replaceAll("\\", "/");
+          return getVirtualEntryRSC(absoluteRouterPath);
+        }
+      }
+      return null;
+    },
+  };
+}
+
+// Matches rollup's FILE_NAME_CONFLICT message and reports whether the colliding
+// file is a content-hashed asset, e.g.
+//   The emitted file "assets/index-DlGNrvnU.css" overwrites a previously ...
+//   The emitted file "assets/inter-latin-Dx4kXJAl.woff2" overwrites a ...
+// The match is UNANCHORED on purpose: by the time the warning reaches this user
+// onwarn handler, Vite's logger has wrapped rollup's raw message with an ANSI
+// color sequence and a "[CODE] " label, e.g.
+//   "[FILE_NAME_CONFLICT] The emitted file \"...\" overwrites ..."
+// A "^The emitted file" anchor sits behind that prefix and never matches; and
+// Vite also strips the JSON.stringify quotes rollup puts around the filename, so
+// the match is UNANCHORED and quote-OPTIONAL ("?...?"?). The non-whitespace
+// capture stops at the space before "overwrites" (Vite's unquoted display form)
+// or the closing quote (raw rollup form); either way it carries no ANSI.
+// A content-hashed name ends with a "-" separator + a Vite content hash. The
+// hash is a FIXED-LENGTH base64url run ([A-Za-z0-9_-], default 8), so it can
+// itself contain "-"/"_": it CANNOT be located by splitting on the last "-"
+// (that lands inside the hash whenever it carries a dash, e.g. "...-Cabi7G8-" ->
+// "" or "...-CkhJZR-_" -> "_", which let those conflicts leak). Instead take the
+// trailing HASH_LEN chars and require the "-" separator right before them. The
+// hash must hold an uppercase letter or digit (a real hash is never an
+// all-lowercase word), so stable names like "assets/manifest.json" or
+// "assets/loading-skeleton.css" still surface as potential genuine overwrites.
+function isContentHashedAssetConflict(message: string | undefined): boolean {
+  if (!message) return false;
+  const match =
+    /The emitted file "?([^"\s]+)"? overwrites a previously emitted file/.exec(
+      message,
+    );
+  if (!match) return false;
+  const fileName = match[1];
+  const base = fileName.slice(fileName.lastIndexOf("/") + 1);
+  const dot = base.lastIndexOf(".");
+  if (dot <= 0) return false;
+  const stem = base.slice(0, dot);
+  // HASH_LEN tracks Vite's default [hash] width; bump it if an app sets a custom
+  // assetFileNames hash length.
+  const HASH_LEN = 8;
+  if (stem.length < HASH_LEN + 1 || stem[stem.length - HASH_LEN - 1] !== "-") {
+    return false;
+  }
+  const hash = stem.slice(-HASH_LEN);
+  return /^[A-Za-z0-9_-]+$/.test(hash) && /[A-Z0-9]/.test(hash);
+}
+
+/**
+ * Rollup onwarn handler that suppresses known harmless warnings:
+ * - "use client" directives: handled by the RSC plugin, not relevant to Rollup
+ * - sourcemap errors: caused by "use client" directive at line 1:0 confusing sourcemap resolution
+ * - sourcemap incomplete: plugins that transform without generating sourcemaps (router + RSC plugin)
+ * - dynamic/static mixed imports: expected for router internals (e.g. request-context, cache-scope).
+ *   Under Rolldown (Vite 8) this surfaces as the INEFFECTIVE_DYNAMIC_IMPORT code emitted directly
+ *   by the bundler, rather than the vite:reporter message handled below (Rollup/Vite 7 shape).
+ * - empty bundle: @vitejs/plugin-rsc scan build (step 1/5) produces an empty "index" chunk
+ *   because the RSC entry is fully externalized during client-reference analysis
+ * - file name conflicts on content-hashed assets: @vitejs/plugin-rsc copies the rsc
+ *   environment's imported CSS/assets into the client bundle (its assets-manifest
+ *   generateBundle re-emits each via emitFile with an explicit content-hashed
+ *   fileName). When the client bundle already produced that identical asset,
+ *   rollup raises FILE_NAME_CONFLICT even though the bytes are identical (a
+ *   content hash collision IS a content match). Only these are suppressed; a
+ *   collision on a stable name still surfaces. No upstream fix as of
+ *   @vitejs/plugin-rsc@0.5.27; remove when it skips the redundant emit.
+ */
+export function onwarn(
+  warning: Vite.Rollup.RollupLog,
+  defaultHandler: (warning: Vite.Rollup.RollupLog) => void,
+): void {
+  if (
+    warning.code === "MODULE_LEVEL_DIRECTIVE" ||
+    warning.code === "SOURCEMAP_ERROR" ||
+    warning.code === "EMPTY_BUNDLE" ||
+    warning.code === "INEFFECTIVE_DYNAMIC_IMPORT"
+  ) {
+    return;
+  }
+  if (
+    warning.code === "FILE_NAME_CONFLICT" &&
+    isContentHashedAssetConflict(warning.message)
+  ) {
+    return;
+  }
+  // @vitejs/plugin-rsc@0.5.14: rsc:virtual:vite-rsc/assets-manifest renderChunk
+  // returns { code } without map, causing Rollup to warn about incorrect sourcemaps.
+  // This is harmless (simple string replacement). Remove this suppression if a
+  // future version of @vitejs/plugin-rsc fixes the missing sourcemap.
+  if (warning.message?.includes("Sourcemap is likely to be incorrect")) {
+    return;
+  }
+  if (
+    warning.plugin === "vite:reporter" &&
+    warning.message?.includes(
+      "dynamic import will not move module into another chunk",
+    )
+  ) {
+    return;
+  }
+  defaultHandler(warning);
+}
+
+/**
+ * Manual chunks configuration for client build.
+ * Splits React and router packages into separate chunks for better caching.
+ */
+export function getManualChunks(id: string): string | undefined {
+  const normalized = Vite.normalizePath(id);
+
+  if (
+    normalized.includes("node_modules/react/") ||
+    normalized.includes("node_modules/react-dom/") ||
+    normalized.includes("node_modules/react-server-dom-webpack/") ||
+    normalized.includes("node_modules/@vitejs/plugin-rsc/")
+  ) {
+    return "react";
+  }
+  // Use dynamic package name from package.json
+  // Check both npm install path and workspace symlink resolved path.
+  //
+  // The workspace patterns are anchored to the package's own `src`/`dist` so
+  // they match the router runtime but NOT consumer apps that merely live under a
+  // `packages/rangojs-router/` ancestor (the in-repo e2e apps at
+  // `packages/rangojs-router/e2e/<app>/src/...`). Without the anchor those apps'
+  // own client components were force-merged into the shared "router" chunk,
+  // which both misrepresented real-consumer bundles and blocked `clientChunks`
+  // splitting from relocating them.
+  const packageName = getPublishedPackageName();
+  if (
+    normalized.includes(`node_modules/${packageName}/`) ||
+    /\/packages\/(rsc-router|rangojs-router)\/(src|dist)\//.test(normalized)
+  ) {
+    return "router";
+  }
+  return undefined;
+}

package/CLAUDE.md

@@ -1,7 +0,0 @@
-# @rangojs/router
-
-Django-inspired RSC router with composable URL patterns. Read skills in `node_modules/@rangojs/router/skills/` for patterns:
-
-router-setup, route, layout, loader, middleware, intercept, caching, document-cache, theme, hooks, typesafety, parallel
-
-Read the relevant skill before implementing features.

package/src/__tests__/component-utils.test.ts

@@ -1,76 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { isClientComponent, assertClientComponent } from "../component-utils";
-
-describe("component-utils", () => {
-  describe("isClientComponent", () => {
-    it("should return false for regular functions", () => {
-      const ServerComponent = () => null;
-      expect(isClientComponent(ServerComponent)).toBe(false);
-    });
-
-    it("should return false for non-functions", () => {
-      expect(isClientComponent(null)).toBe(false);
-      expect(isClientComponent(undefined)).toBe(false);
-      expect(isClientComponent("string")).toBe(false);
-      expect(isClientComponent(123)).toBe(false);
-      expect(isClientComponent({})).toBe(false);
-    });
-
-    it("should return true for functions with client reference marker", () => {
-      const ClientComponent = () => null;
-      // Simulate what the bundler does for "use client" components
-      (ClientComponent as any).$$typeof = Symbol.for("react.client.reference");
-      (ClientComponent as any).$$id = "src/components/MyComponent.tsx#default";
-
-      expect(isClientComponent(ClientComponent)).toBe(true);
-    });
-
-    it("should return false for functions with wrong $$typeof symbol", () => {
-      const Component = () => null;
-      (Component as any).$$typeof = Symbol.for("react.element");
-
-      expect(isClientComponent(Component)).toBe(false);
-    });
-  });
-
-  describe("assertClientComponent", () => {
-    it("should throw for non-function values", () => {
-      expect(() => assertClientComponent(null, "document")).toThrow(
-        'document must be a client component function with "use client" directive'
-      );
-
-      expect(() => assertClientComponent({}, "document")).toThrow(
-        'document must be a client component function with "use client" directive'
-      );
-    });
-
-    it("should throw for server components (no client marker)", () => {
-      const ServerComponent = () => null;
-
-      expect(() => assertClientComponent(ServerComponent, "document")).toThrow(
-        'document must be a client component with "use client" directive'
-      );
-      expect(() => assertClientComponent(ServerComponent, "document")).toThrow(
-        "cannot be serialized in the RSC payload"
-      );
-    });
-
-    it("should not throw for client components", () => {
-      const ClientComponent = () => null;
-      (ClientComponent as any).$$typeof = Symbol.for("react.client.reference");
-      (ClientComponent as any).$$id = "src/document.tsx#default";
-
-      expect(() =>
-        assertClientComponent(ClientComponent, "document")
-      ).not.toThrow();
-    });
-
-    it("should include component name in error message", () => {
-      const ServerComponent = () => null;
-
-      expect(() => assertClientComponent(ServerComponent, "myLayout")).toThrow(
-        "myLayout must be a client component"
-      );
-    });
-  });
-});

package/src/__tests__/route-definition.test.ts

@@ -1,63 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { route } from "../route-definition";
-
-describe("route()", () => {
-  describe("with nested RouteConfig objects", () => {
-    it("should flatten nested RouteConfig with trailing slash config", () => {
-      const routes = route({
-        index: "/",
-        trailingSlash: {
-          ignore: { path: "/ts-ignore", trailingSlash: "ignore" },
-          always: { path: "/ts-always", trailingSlash: "always" },
-          never: { path: "/ts-never", trailingSlash: "never" },
-        },
-      }) as any;
-
-      // Check routes are flattened correctly
-      expect(routes.index).toBe("/");
-      expect(routes["trailingSlash.ignore"]).toBe("/ts-ignore");
-      expect(routes["trailingSlash.always"]).toBe("/ts-always");
-      expect(routes["trailingSlash.never"]).toBe("/ts-never");
-
-      // Check trailing slash config is attached
-      expect(routes.__trailingSlash).toBeDefined();
-      expect(routes.__trailingSlash["trailingSlash.ignore"]).toBe("ignore");
-      expect(routes.__trailingSlash["trailingSlash.always"]).toBe("always");
-      expect(routes.__trailingSlash["trailingSlash.never"]).toBe("never");
-    });
-
-    it("should be enumerable for Object.entries", () => {
-      const routes = route({
-        index: "/",
-        trailingSlash: {
-          ignore: { path: "/ts-ignore", trailingSlash: "ignore" },
-        },
-      });
-
-      const entries = Object.entries(routes);
-      expect(entries).toContainEqual(["index", "/"]);
-      expect(entries).toContainEqual(["trailingSlash.ignore", "/ts-ignore"]);
-    });
-
-    it("should apply global default to string routes", () => {
-      const routes = route({
-        blog: "/blog",
-        about: "/about",
-      }, { trailingSlash: "never" }) as any;
-
-      expect(routes.__trailingSlash).toBeDefined();
-      expect(routes.__trailingSlash.blog).toBe("never");
-      expect(routes.__trailingSlash.about).toBe("never");
-    });
-
-    it("should let per-route config override global default", () => {
-      const routes = route({
-        blog: "/blog",
-        api: { path: "/api", trailingSlash: "ignore" },
-      }, { trailingSlash: "never" }) as any;
-
-      expect(routes.__trailingSlash.blog).toBe("never");
-      expect(routes.__trailingSlash.api).toBe("ignore");
-    });
-  });
-});