@rangojs/router 0.0.0-experimental.002d056c

package/src/server/context.ts

@@ -0,0 +1,591 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+import type { ReactNode } from "react";
+import type {
+  PartialCacheOptions,
+  ErrorBoundaryHandler,
+  Handler,
+  LoaderDefinition,
+  MiddlewareFn,
+  NotFoundBoundaryHandler,
+  ShouldRevalidateFn,
+  TransitionConfig,
+} from "../types";
+import { invariant } from "../errors";
+import type { DefaultRouteName } from "../types/global-namespace.js";
+
+// ============================================================================
+//  Performance Metrics Types
+// ============================================================================
+
+/**
+ * Performance metric entry for a single measured operation
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export interface PerformanceMetric {
+  label: string; // e.g., "route-matching", "loader:UserLoader"
+  duration: number; // milliseconds
+  startTime: number; // relative to request start
+  depth?: number; // nesting level for hierarchical display (0 = top-level)
+}
+
+/**
+ * Request-scoped metrics store
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export interface MetricsStore {
+  enabled: boolean;
+  requestStart: number;
+  metrics: PerformanceMetric[];
+}
+// ============================================================================
+//  RSC Router Context
+// ============================================================================
+
+/**
+ * Cache configuration for an entry
+ * When set, this entry and its children will use this cache config
+ * unless overridden by a nested cache() call.
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type EntryCacheConfig = {
+  /** Cache options (false means caching disabled for this entry) - ttl is optional, uses defaults */
+  options: PartialCacheOptions | false;
+};
+
+/**
+ * Entry data structure for manifest
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type EntryPropCommon = {
+  id: string;
+  shortCode: string; // Short identifier for network efficiency (e.g., "L0", "P1", "R2")
+  parent: EntryData | null;
+  /** Cache configuration for this entry (set by cache() DSL) */
+  cache?: EntryCacheConfig;
+  /** URL prefix from include() scope, used for MountContext on client */
+  mountPath?: string;
+};
+
+/**
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type EntryPropDatas = {
+  middleware: MiddlewareFn<any, any>[];
+  revalidate: ShouldRevalidateFn<any, any>[];
+  errorBoundary: (ReactNode | ErrorBoundaryHandler)[];
+  notFoundBoundary: (ReactNode | NotFoundBoundaryHandler)[];
+};
+
+/**
+ * Loader entry stored in EntryData
+ * Contains the loader definition and its revalidation rules
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type LoaderEntry = {
+  loader: LoaderDefinition<any>;
+  revalidate: ShouldRevalidateFn<any, any>[];
+  /** Cache config for this specific loader (loaders are NOT cached by default) */
+  cache?: EntryCacheConfig;
+};
+
+/**
+ * Segments state for intercept context
+ * Matches the structure from useSegments() for consistency
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type InterceptSegmentsState = {
+  /** URL path segments (e.g., /shop/products/123 → ["shop", "products", "123"]) */
+  path: readonly string[];
+  /** Matched segment IDs in order (layouts and routes only, e.g., ["L0", "L0L1", "L0L1R0"]) */
+  ids: readonly string[];
+};
+
+/**
+ * Context passed to intercept selector functions (when())
+ * Contains navigation context to determine if interception should occur.
+ *
+ * Note: when() is evaluated during route matching, BEFORE middleware runs.
+ * So ctx.get()/ctx.use() are not available, but env (platform bindings) is.
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type InterceptSelectorContext<TEnv = any> = {
+  from: URL; // Source URL (where user is coming from)
+  to: URL; // Destination URL (where user is navigating to)
+  params: Record<string, string>; // Matched route params
+  request: Request; // The HTTP request object
+  env: TEnv; // Platform bindings (Cloudflare env, etc.)
+  segments: InterceptSegmentsState; // Client's current segments (where navigating FROM)
+  fromRouteName?: DefaultRouteName; // Named route being navigated away from (undefined for unnamed routes)
+  toRouteName?: DefaultRouteName; // Named route being navigated to (undefined for unnamed routes)
+};
+
+/**
+ * Selector function for conditional interception
+ * Returns true to intercept, false to skip and fall through to route handler
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type InterceptWhenFn<TEnv = any> = (
+  ctx: InterceptSelectorContext<TEnv>,
+) => boolean;
+
+/**
+ * Intercept entry stored in EntryData
+ * Contains the slot name, route to intercept, and handler
+ *
+ * @internal This type is an implementation detail and may change without notice.
+ */
+export type InterceptEntry = {
+  slotName: `@${string}`; // e.g., "@modal"
+  routeName: string; // e.g., "card"
+  handler: ReactNode | Handler<any, any, any>;
+  middleware: MiddlewareFn<any, any>[];
+  revalidate: ShouldRevalidateFn<any, any>[];
+  errorBoundary: (ReactNode | ErrorBoundaryHandler)[];
+  notFoundBoundary: (ReactNode | NotFoundBoundaryHandler)[];
+  loader: LoaderEntry[];
+  loading?: ReactNode | false;
+  transition?: TransitionConfig;
+  layout?: ReactNode | Handler<any, any, any>; // Wrapper layout with <Outlet /> for content
+  when: InterceptWhenFn[]; // Selector conditions - all must return true to intercept
+};
+
+export type EntryPropSegments = {
+  loader: LoaderEntry[];
+  layout: EntryData[];
+  parallel: EntryData[]; // type: "parallel" entries with their own loaders/revalidate/loading
+  intercept: InterceptEntry[]; // intercept definitions for soft navigation
+};
+
+export type EntryData =
+  | ({
+      type: "route";
+      handler: Handler<any, any, any>;
+      loading?: ReactNode | false;
+      transition?: TransitionConfig;
+      /** URL pattern for this route (used by path() in urls()) */
+      pattern?: string;
+      /** Set when handler is a Prerender definition */
+      isPrerender?: true;
+      /** Original PrerenderHandlerDefinition (for build-time getParams access) */
+      prerenderDef?: {
+        getParams?: (ctx: any) => Promise<any[]> | any[];
+        options?: { passthrough?: boolean };
+      };
+      /** Set when handler is a Static definition (build-time only) */
+      isStaticPrerender?: true;
+      /** Static handler $$id for build-time store lookup */
+      staticHandlerId?: string;
+      /** Response type for non-RSC routes (json, text, image, any) */
+      responseType?: string;
+    } & EntryPropCommon &
+      EntryPropDatas &
+      EntryPropSegments)
+  | ({
+      type: "layout";
+      handler: ReactNode | Handler<any, any, any>;
+      loading?: ReactNode | false;
+      transition?: TransitionConfig;
+      /** Set when handler is a Static definition (build-time only) */
+      isStaticPrerender?: true;
+      /** Static handler $$id for build-time store lookup */
+      staticHandlerId?: string;
+    } & EntryPropCommon &
+      EntryPropDatas &
+      EntryPropSegments)
+  | ({
+      type: "parallel";
+      handler: Record<`@${string}`, Handler<any, any, any> | ReactNode>;
+      loading?: ReactNode | false;
+      transition?: TransitionConfig;
+      /** Set when any parallel slot is a Static definition */
+      isStaticPrerender?: true;
+      /** Per-slot static handler $$ids for build-time store lookup */
+      staticHandlerIds?: Record<string, string>;
+    } & EntryPropCommon &
+      EntryPropDatas &
+      EntryPropSegments)
+  | ({
+      type: "cache";
+      /** Cache entries create cache boundaries and render like layouts (with Outlet) */
+      handler: ReactNode | Handler<any, any, any>;
+      loading?: ReactNode | false;
+      transition?: TransitionConfig;
+    } & EntryPropCommon &
+      EntryPropDatas &
+      EntryPropSegments);
+
+/**
+ * Tracked include info for build-time manifest generation
+ */
+export interface TrackedInclude {
+  prefix: string;
+  fullPrefix: string;
+  namePrefix?: string;
+  patterns: unknown; // UrlPatterns
+  lazy: boolean;
+}
+
+/**
+ * Context stored in AsyncLocalStorage
+ */
+interface HelperContext {
+  manifest: Map<string, EntryData>;
+  namespace: string;
+  parent: EntryData | null;
+  counters: Record<string, number>;
+  forRoute?: string;
+  mountIndex?: number;
+  metrics?: MetricsStore;
+  /** True when rendering for SSR (document requests) */
+  isSSR?: boolean;
+  /** URL patterns map for path() routes (route name -> pattern) */
+  patterns?: Map<string, string>;
+  /** URL patterns grouped by include prefix for separate entry creation */
+  patternsByPrefix?: Map<string, Map<string, string>>;
+  /** Trailing slash config per route name */
+  trailingSlash?: Map<string, "never" | "always" | "ignore">;
+  /** Search param schemas per route name */
+  searchSchemas?: Map<string, Record<string, string>>;
+  /** URL prefix from include() - applied to all path() patterns */
+  urlPrefix?: string;
+  /** Name prefix from include() - applied to all named routes */
+  namePrefix?: string;
+  /** True when this scope is at root level (no named include boundary above).
+   *  Routes at root scope allow dot-local reverse to fall back to bare names. */
+  rootScoped?: boolean;
+  /** Run helper for cleaner middleware code */
+  run?: <T>(fn: () => T | Promise<T>) => T | Promise<T>;
+  /** Tracked includes for build-time manifest generation */
+  trackedIncludes?: TrackedInclude[];
+  /** Cache profiles for DSL-time cache("profileName") resolution */
+  cacheProfiles?: Record<
+    string,
+    import("../cache/profile-registry.js").CacheProfile
+  >;
+}
+// Use a global symbol key so the AsyncLocalStorage instance survives HMR
+// module re-evaluation. Without this, Vite's RSC module runner may create
+// a new instance when context.ts is re-evaluated, while other modules still
+// hold references to the old instance — causing getStore() to return
+// undefined even inside a run() callback.
+const RSC_CONTEXT_KEY = Symbol.for("rangojs-router:rsc-context");
+export const RSCRouterContext: AsyncLocalStorage<HelperContext> = ((
+  globalThis as any
+)[RSC_CONTEXT_KEY] ??= new AsyncLocalStorage<HelperContext>());
+
+export const getContext = (): {
+  context: AsyncLocalStorage<HelperContext>;
+  getStore: () => HelperContext;
+  getParent: () => EntryData | null;
+  getOrCreateStore: (forRoute?: string) => HelperContext;
+  getNextIndex: (
+    type: (string & {}) | "layout" | "parallel" | "middleware" | "revalidate",
+  ) => string;
+  getShortCode: (
+    type: "layout" | "parallel" | "route" | "loader" | "cache",
+  ) => string;
+  run: <T>(
+    namespace: string,
+    parent: EntryData | null,
+    callback: (...args: any[]) => T,
+  ) => T;
+  runWithStore: <T>(
+    store: HelperContext,
+    namespace: string,
+    parent: EntryData | null,
+    callback: (...args: any[]) => T,
+  ) => T;
+} => {
+  const context = RSCRouterContext;
+
+  return {
+    context,
+    getOrCreateStore: (forRoute?: string): HelperContext => {
+      let store = RSCRouterContext.getStore();
+      if (!store) {
+        store = {
+          manifest: new Map<string, EntryData>(),
+          namespace: "",
+          parent: null,
+          forRoute,
+          counters: {},
+          patterns: new Map<string, string>(),
+          patternsByPrefix: new Map<string, Map<string, string>>(),
+          trailingSlash: new Map<string, "never" | "always" | "ignore">(),
+          searchSchemas: new Map<string, Record<string, string>>(),
+        } satisfies HelperContext;
+      }
+      return store;
+    },
+    getStore: (): HelperContext => {
+      const store = context.getStore();
+      if (!store) {
+        throw new Error(
+          "RSC Router context store is not available. Make sure to run within RSC Router context.",
+        );
+      }
+      return store;
+    },
+    getParent: (): EntryData | null => {
+      const store = context.getStore();
+      if (!store) {
+        return null;
+      }
+
+      return store.parent;
+    },
+    getNextIndex: (
+      type: (string & {}) | "layout" | "parallel" | "middleware" | "revalidate",
+    ) => {
+      const store = context.getStore();
+      invariant(store, "No context RSCRouterContext available");
+      store.counters[type] ??= 0;
+      const index = store.counters[type];
+      store.counters[type] = index + 1;
+      return `$${type}.${index}`;
+    },
+    getShortCode: (
+      type: "layout" | "parallel" | "route" | "loader" | "cache",
+    ) => {
+      const store = context.getStore();
+      invariant(store, "No context RSCRouterContext available");
+
+      const parent = store.parent;
+      const prefix =
+        type === "layout"
+          ? "L"
+          : type === "parallel"
+            ? "P"
+            : type === "loader"
+              ? "D"
+              : type === "cache"
+                ? "C"
+                : "R";
+      const mountPrefix =
+        store.mountIndex !== undefined ? `M${store.mountIndex}` : "";
+
+      if (!parent) {
+        // Root entry: prefix with mount index and use mount-scoped counter
+        const counterKey = mountPrefix
+          ? `${mountPrefix}_root_${type}`
+          : `root_${type}`;
+        store.counters[counterKey] ??= 0;
+        const index = store.counters[counterKey];
+        store.counters[counterKey] = index + 1;
+        return `${mountPrefix}${prefix}${index}`;
+      } else {
+        // Child entry: use parent-scoped counter (parent already has M prefix)
+        const counterKey = `${parent.shortCode}_${type}`;
+        store.counters[counterKey] ??= 0;
+        const index = store.counters[counterKey];
+        store.counters[counterKey] = index + 1;
+        return `${parent.shortCode}${prefix}${index}`;
+      }
+    },
+    runWithStore: <T>(
+      store: HelperContext,
+      namespace: string,
+      parent: EntryData | null,
+      callback: (...args: any[]) => T,
+    ): T => {
+      return context.run(
+        {
+          manifest: store.manifest,
+          namespace,
+          parent: parent || null,
+          counters: store.counters,
+          forRoute: store.forRoute,
+          mountIndex: store.mountIndex,
+          metrics: store.metrics,
+          isSSR: store.isSSR,
+          patterns: store.patterns,
+          trailingSlash: store.trailingSlash,
+          searchSchemas: store.searchSchemas,
+          urlPrefix: store.urlPrefix,
+          namePrefix: store.namePrefix,
+          rootScoped: store.rootScoped,
+          trackedIncludes: store.trackedIncludes,
+          cacheProfiles: store.cacheProfiles,
+        },
+        callback,
+      );
+    },
+    run: <T>(
+      namespace: string,
+      parent: EntryData | null,
+      callback: (...args: any[]) => T,
+    ) => {
+      const store = context.getStore();
+      // Preserve parent counters to ensure globally unique shortCodes
+      const counters = store?.counters || {};
+      const manifest = store ? store.manifest : new Map<string, EntryData>();
+      const patterns = store?.patterns || new Map<string, string>();
+      const patternsByPrefix = store?.patternsByPrefix;
+      const trailingSlash =
+        store?.trailingSlash ||
+        new Map<string, "never" | "always" | "ignore">();
+      const searchSchemas =
+        store?.searchSchemas || new Map<string, Record<string, string>>();
+      return context.run(
+        {
+          manifest,
+          namespace,
+          parent: parent || null,
+          counters,
+          forRoute: store?.forRoute,
+          mountIndex: store?.mountIndex,
+          metrics: store?.metrics,
+          isSSR: store?.isSSR,
+          patterns,
+          patternsByPrefix,
+          trailingSlash,
+          searchSchemas,
+          urlPrefix: store?.urlPrefix,
+          namePrefix: store?.namePrefix,
+          rootScoped: store?.rootScoped,
+          trackedIncludes: store?.trackedIncludes,
+          cacheProfiles: store?.cacheProfiles,
+        },
+        callback,
+      );
+    },
+  };
+};
+
+/**
+ * Run a callback with specific URL and name prefixes
+ * Used by include() to apply prefixes to nested patterns
+ */
+export function runWithPrefixes<T>(
+  urlPrefix: string,
+  namePrefix: string | undefined,
+  callback: () => T,
+): T {
+  const store = RSCRouterContext.getStore();
+  if (!store) {
+    throw new Error("runWithPrefixes must be called within router context");
+  }
+
+  // Combine prefixes if there are existing ones, avoiding double slashes
+  let combinedUrlPrefix: string;
+  if (store.urlPrefix) {
+    if (store.urlPrefix.endsWith("/") && urlPrefix.startsWith("/")) {
+      combinedUrlPrefix = store.urlPrefix + urlPrefix.slice(1);
+    } else {
+      combinedUrlPrefix = store.urlPrefix + urlPrefix;
+    }
+  } else {
+    combinedUrlPrefix = urlPrefix;
+  }
+  const combinedNamePrefix =
+    namePrefix !== undefined
+      ? namePrefix === ""
+        ? store.namePrefix
+        : store.namePrefix
+          ? `${store.namePrefix}.${namePrefix}`
+          : namePrefix
+      : store.namePrefix;
+
+  // Track root scope for dot-local reverse resolution.
+  //
+  // The flag answers: "can this route reach bare names at root scope?"
+  // It propagates through the include chain:
+  //
+  //   { name: "" }    — transparent: inherit parent, default true
+  //   { name: "foo" } — inherit parent if already set, else create boundary (false)
+  //   no name          — inherit parent unchanged
+  //
+  // This means { name: "" } + nested { name: "sub" } keeps rootScoped=true
+  // (the outer transparent include establishes root access, and the inner
+  // named include inherits it). But a direct { name: "sub" } at root gets
+  // rootScoped=false (no prior root-access grant, so it creates a boundary).
+  const combinedRootScoped =
+    namePrefix === ""
+      ? (store.rootScoped ?? true)
+      : namePrefix !== undefined
+        ? (store.rootScoped ?? false)
+        : store.rootScoped;
+
+  return RSCRouterContext.run(
+    {
+      ...store,
+      urlPrefix: combinedUrlPrefix,
+      namePrefix: combinedNamePrefix,
+      rootScoped: combinedRootScoped,
+    },
+    callback,
+  );
+}
+
+/**
+ * Get current URL prefix from context
+ */
+export function getUrlPrefix(): string {
+  const store = RSCRouterContext.getStore();
+  return store?.urlPrefix || "";
+}
+
+/**
+ * Get current name prefix from context
+ */
+export function getNamePrefix(): string | undefined {
+  const store = RSCRouterContext.getStore();
+  return store?.namePrefix;
+}
+
+/**
+ * Get whether the current scope is at root level (no named include boundary above).
+ * Returns true at root or inside { name: "" } includes, false inside named includes.
+ */
+export function getRootScoped(): boolean {
+  const store = RSCRouterContext.getStore();
+  return store?.rootScoped ?? true;
+}
+
+// Export HelperContext type for use in other modules
+export type { HelperContext };
+
+// ============================================================================
+//  Performance Metrics Helpers
+// ============================================================================
+
+/**
+ * Track performance of a code block (no-op if metrics not enabled)
+ * Returns a done() callback to mark completion and record duration
+ *
+ * @example
+ * ```typescript
+ * const done = track("route-matching");
+ * // ... do work ...
+ * done(); // Records duration
+ * ```
+ */
+export function track(label: string, depth?: number): () => void {
+  const store = RSCRouterContext.getStore();
+
+  // No-op if context unavailable or metrics not enabled
+  if (!store?.metrics?.enabled) {
+    return () => {};
+  }
+
+  const startTime = performance.now() - store.metrics.requestStart;
+
+  return () => {
+    const duration =
+      performance.now() - store.metrics!.requestStart - startTime;
+    store.metrics!.metrics.push({
+      label,
+      duration,
+      startTime,
+      ...(depth != null ? { depth } : {}),
+    });
+  };
+}