@rangojs/router 0.0.0-experimental.0f44aca1

package/src/cache/document-cache.ts

@@ -0,0 +1,369 @@
+/**
+ * Document-Level Cache Middleware
+ *
+ * Caches full HTTP responses at the edge based on Cache-Control headers.
+ * Routes opt-in to caching by setting s-maxage or stale-while-revalidate headers.
+ *
+ * Flow:
+ * 1. Check cache for existing response
+ * 2. If fresh hit → return cached response
+ * 3. If stale hit (within SWR window) → return cached, revalidate in background
+ * 4. If miss → run handler, cache if response has cache headers
+ */
+
+import type { MiddlewareFn, MiddlewareContext } from "../router/middleware.js";
+import { getRequestContext } from "../server/request-context.js";
+import { sortedSearchString } from "./cache-key-utils.js";
+import { runBackground } from "./background-task.js";
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+/** Header indicating cache status for debugging */
+const CACHE_STATUS_HEADER = "x-document-cache-status";
+
+/**
+ * Simple hash function for segment IDs.
+ * Creates a short, deterministic hash to differentiate cache keys
+ * based on which segments the client already has.
+ */
+function hashSegmentIds(segmentIds: string): string {
+  if (!segmentIds) return "";
+
+  let hash = 0;
+  for (let i = 0; i < segmentIds.length; i++) {
+    const char = segmentIds.charCodeAt(i);
+    hash = ((hash << 5) - hash + char) | 0;
+  }
+  // Convert to base36 for shorter string, take absolute value
+  return Math.abs(hash).toString(36);
+}
+
+// ============================================================================
+// Cache Control Parsing
+// ============================================================================
+
+interface CacheDirectives {
+  sMaxAge?: number;
+  staleWhileRevalidate?: number;
+}
+
+/**
+ * Parse Cache-Control header for s-maxage and stale-while-revalidate directives
+ */
+function parseCacheControl(header: string | null): CacheDirectives | null {
+  if (!header) return null;
+
+  const directives: CacheDirectives = {};
+
+  // Parse s-maxage
+  const sMaxAgeMatch = header.match(/s-maxage\s*=\s*(\d+)/i);
+  if (sMaxAgeMatch) {
+    directives.sMaxAge = parseInt(sMaxAgeMatch[1], 10);
+  }
+
+  // Parse stale-while-revalidate
+  const swrMatch = header.match(/stale-while-revalidate\s*=\s*(\d+)/i);
+  if (swrMatch) {
+    directives.staleWhileRevalidate = parseInt(swrMatch[1], 10);
+  }
+
+  // Only return if we have at least s-maxage (required for document caching)
+  if (directives.sMaxAge !== undefined) {
+    return directives;
+  }
+
+  return null;
+}
+
+/**
+ * Check if response should be cached based on Cache-Control headers
+ */
+function shouldCacheResponse(response: Response): CacheDirectives | null {
+  // Only cache successful responses
+  if (response.status !== 200) {
+    return null;
+  }
+
+  const cacheControl = response.headers.get("Cache-Control");
+  return parseCacheControl(cacheControl);
+}
+
+// ============================================================================
+// Response Helpers
+// ============================================================================
+
+/**
+ * Add cache status header to response for debugging
+ */
+function addCacheStatusHeader(
+  response: Response,
+  status: "HIT" | "STALE" | "MISS",
+): Response {
+  const headers = new Headers(response.headers);
+  headers.set(CACHE_STATUS_HEADER, status);
+
+  return new Response(response.body, {
+    status: response.status,
+    statusText: response.statusText,
+    headers,
+  });
+}
+
+/**
+ * Drain and run onResponse callbacks registered on the request context.
+ * Mirrors the drain semantics of finalizeResponse() in rsc/helpers.ts:
+ * callbacks are spliced out so they fire at most once per request.
+ */
+function drainOnResponseCallbacks(
+  response: Response,
+  requestCtx:
+    | { _onResponseCallbacks: Array<(r: Response) => Response> }
+    | undefined,
+): Response {
+  if (!requestCtx || requestCtx._onResponseCallbacks.length === 0) {
+    return response;
+  }
+  const callbacks = requestCtx._onResponseCallbacks;
+  requestCtx._onResponseCallbacks = [];
+  let result = response;
+  for (const callback of callbacks) {
+    result = callback(result) ?? result;
+  }
+  return result;
+}
+
+// ============================================================================
+// Document Cache Middleware
+// ============================================================================
+
+export interface DocumentCacheOptions<TEnv = any> {
+  /**
+   * Skip caching for specific paths (e.g., API routes)
+   */
+  skipPaths?: string[];
+
+  /**
+   * Custom cache key generator
+   */
+  keyGenerator?: (url: URL) => string;
+
+  /**
+   * Callback to determine if caching should be enabled for this request.
+   * Receives the middleware context and returns true to enable caching.
+   * If not provided, caching is enabled by default.
+   *
+   * @example
+   * ```typescript
+   * createDocumentCacheMiddleware({
+   *   isEnabled: (ctx) => !ctx.request.headers.has('x-skip-cache'),
+   * })
+   * ```
+   */
+  isEnabled?: (ctx: MiddlewareContext<TEnv>) => boolean | Promise<boolean>;
+
+  /**
+   * Enable debug logging for cache operations.
+   * Logs HIT, MISS, STALE, and REVALIDATED events.
+   * Defaults to false.
+   */
+  debug?: boolean;
+}
+
+/**
+ * Create document cache middleware
+ *
+ * Add this middleware to your router to enable document-level caching.
+ * It uses the cache store's getResponse/putResponse methods for caching.
+ * Routes opt-in by setting Cache-Control headers with s-maxage.
+ *
+ * @example
+ * ```typescript
+ * // Add middleware to router
+ * const router = createRouter<AppEnv>()
+ *   .use(createDocumentCacheMiddleware({
+ *     isEnabled: (ctx) => ctx.url.pathname !== '/admin',
+ *   }))
+ *   .route("home", (ctx) => {
+ *     ctx.headers.set("Cache-Control", "s-maxage=60, stale-while-revalidate=300");
+ *     return <HomePage />;
+ *   });
+ * ```
+ */
+export function createDocumentCacheMiddleware<TEnv = any>(
+  options: DocumentCacheOptions<TEnv> = {},
+): MiddlewareFn<TEnv> {
+  const { skipPaths = [], keyGenerator, isEnabled, debug = false } = options;
+
+  const log = debug ? (message: string) => console.log(message) : () => {};
+
+  return async function documentCacheMiddleware(
+    ctx: MiddlewareContext<TEnv>,
+    next: () => Promise<Response>,
+  ): Promise<Response> {
+    const url = ctx.url;
+
+    // Only cache GET requests — mutations and other methods must not be cached
+    if (ctx.request.method !== "GET") {
+      return next();
+    }
+
+    // Skip RSC action requests (mutations shouldn't be cached)
+    if (url.searchParams.has("_rsc_action")) {
+      return next();
+    }
+
+    // Skip loader requests (have their own caching)
+    if (url.searchParams.has("_rsc_loader")) {
+      return next();
+    }
+
+    // Skip configured paths
+    if (skipPaths.some((path) => url.pathname.startsWith(path))) {
+      return next();
+    }
+
+    // Check if caching is enabled for this request
+    if (isEnabled) {
+      const enabled = await isEnabled(ctx);
+      if (!enabled) {
+        return next();
+      }
+    }
+
+    // Get request context and cache store
+    const requestCtx = getRequestContext();
+    const store = requestCtx?._cacheStore;
+
+    // Skip if no cache store or store doesn't support response caching
+    if (!store?.getResponse || !store?.putResponse) {
+      return next();
+    }
+
+    // Determine request type for cache key differentiation
+    const isPartial = url.searchParams.has("_rsc_partial");
+    const typeLabel = isPartial ? "RSC" : "HTML";
+
+    // Track whether next() has been called so the catch block knows
+    // whether it is safe to fall through to the handler.
+    let handlerCalled = false;
+
+    try {
+      // Generate cache key inside try so a throwing keyGenerator degrades
+      // gracefully to the origin handler instead of rejecting the request.
+      // This is a deliberate fail-open-to-origin policy: the fallback is
+      // "serve uncached from origin", not "use a different cache key".
+      const clientSegments = url.searchParams.get("_rsc_segments") || "";
+      const segmentHash =
+        isPartial && clientSegments ? `:${hashSegmentIds(clientSegments)}` : "";
+      const typeSuffix = isPartial ? ":rsc" : ":html";
+
+      let searchSuffix = "";
+      if (!keyGenerator) {
+        const sorted = sortedSearchString(url.searchParams);
+        if (sorted) {
+          searchSuffix = `?${sorted}`;
+        }
+      }
+
+      const cacheKey = keyGenerator
+        ? keyGenerator(url) + segmentHash + typeSuffix
+        : `${url.pathname}${searchSuffix}${segmentHash}${typeSuffix}`;
+      // 1. Check cache
+      const cached = await store.getResponse(cacheKey);
+
+      if (cached && cached.response.status === 200) {
+        if (!cached.shouldRevalidate) {
+          // Fresh hit - return immediately
+          log(`[DocumentCache] HIT ${typeLabel}: ${url.pathname}`);
+          return drainOnResponseCallbacks(
+            addCacheStatusHeader(cached.response, "HIT"),
+            requestCtx,
+          );
+        }
+
+        // Stale hit - return cached response, revalidate in background
+        log(
+          `[DocumentCache] STALE ${typeLabel}: ${url.pathname} (revalidating)`,
+        );
+
+        runBackground(requestCtx, async () => {
+          try {
+            const fresh = await next();
+            const directives = shouldCacheResponse(fresh);
+
+            if (directives) {
+              await store.putResponse!(
+                cacheKey,
+                fresh,
+                directives.sMaxAge!,
+                directives.staleWhileRevalidate,
+              );
+              log(`[DocumentCache] REVALIDATED ${typeLabel}: ${url.pathname}`);
+            }
+          } catch (error) {
+            console.error(`[DocumentCache] Revalidation failed:`, error);
+          }
+        });
+
+        return drainOnResponseCallbacks(
+          addCacheStatusHeader(cached.response, "STALE"),
+          requestCtx,
+        );
+      }
+
+      // 2. Cache miss - run handler
+      handlerCalled = true;
+      const originalResponse = await next();
+
+      // 3. Cache if response has appropriate headers
+      const directives = shouldCacheResponse(originalResponse);
+
+      if (directives) {
+        log(
+          `[DocumentCache] MISS ${typeLabel}: ${url.pathname} (caching with s-maxage=${directives.sMaxAge})`,
+        );
+
+        // If the response has no body (e.g., 200 with empty body), skip caching
+        if (!originalResponse.body) {
+          return originalResponse;
+        }
+
+        // Tee the body so we can return one stream and cache the other
+        const [returnStream, cacheStream] = originalResponse.body.tee();
+
+        // Clone response for caching (non-blocking)
+        runBackground(requestCtx, async () => {
+          try {
+            await store.putResponse!(
+              cacheKey,
+              new Response(cacheStream, originalResponse),
+              directives.sMaxAge!,
+              directives.staleWhileRevalidate,
+            );
+          } catch (error) {
+            console.error(`[DocumentCache] Cache write failed:`, error);
+          }
+        });
+
+        return addCacheStatusHeader(
+          new Response(returnStream, originalResponse),
+          "MISS",
+        );
+      }
+
+      // No cache headers - pass through
+      return originalResponse;
+    } catch (error) {
+      console.error(`[DocumentCache] Error:`, error);
+      if (handlerCalled) {
+        // Post-handler failure (e.g. body.tee()): do not call next() again
+        // as that would re-run handler side effects.
+        throw error;
+      }
+      // Pre-handler failure (cache lookup): degrade gracefully to origin
+      return next();
+    }
+  };
+}

package/src/cache/handle-capture.ts

@@ -0,0 +1,81 @@
+/**
+ * Handle Capture
+ *
+ * Captures handle pushes during cached function execution.
+ * Extracted from cache-runtime.ts so tests can import without
+ * pulling in @vitejs/plugin-rsc/rsc dependencies.
+ */
+
+import type { HandleStore } from "../server/handle-store.js";
+import type { SegmentHandleData } from "./types.js";
+
+export interface HandleCapture {
+  data: Record<string, SegmentHandleData>;
+}
+
+/**
+ * Active capture tokens per HandleStore.
+ *
+ * Instead of mutating handleStore.push (which breaks when overlapping
+ * captures finish out of order), we install a single interceptor on
+ * first use and manage a set of active capture tokens. Each push fans
+ * out to every active token. Stopping a capture simply removes the
+ * token — order does not matter.
+ */
+const activeCapturesMap = new WeakMap<HandleStore, Set<HandleCapture>>();
+
+/**
+ * One-time interceptor installation. Wraps the original push so every
+ * call fans out to all active capture tokens. Installed once per
+ * HandleStore instance; subsequent startHandleCapture calls on the
+ * same store just add tokens to the Set.
+ */
+function ensureInterceptorInstalled(handleStore: HandleStore): void {
+  if (activeCapturesMap.has(handleStore)) return;
+
+  const captures = new Set<HandleCapture>();
+  activeCapturesMap.set(handleStore, captures);
+
+  const originalPush = handleStore.push.bind(handleStore);
+  handleStore.push = (
+    handleName: string,
+    segmentId: string,
+    value: unknown,
+  ) => {
+    for (const capture of captures) {
+      if (!capture.data[segmentId]) {
+        capture.data[segmentId] = {};
+      }
+      if (!capture.data[segmentId][handleName]) {
+        capture.data[segmentId][handleName] = [];
+      }
+      capture.data[segmentId][handleName].push(value);
+    }
+    originalPush(handleName, segmentId, value);
+  };
+}
+
+/**
+ * Start capturing handle pushes for a cached function execution.
+ *
+ * Concurrency-safe: multiple overlapping captures on the same
+ * HandleStore are independent. Each capture registers a token in a
+ * Set; stopping removes it. No ordering requirement (LIFO not needed).
+ */
+export function startHandleCapture(handleStore: HandleStore): {
+  capture: HandleCapture;
+  stop: () => void;
+} {
+  ensureInterceptorInstalled(handleStore);
+
+  const capture: HandleCapture = { data: {} };
+  const captures = activeCapturesMap.get(handleStore)!;
+  captures.add(capture);
+
+  return {
+    capture,
+    stop() {
+      captures.delete(capture);
+    },
+  };
+}

package/src/cache/handle-snapshot.ts

@@ -0,0 +1,41 @@
+/**
+ * Handle Snapshot
+ *
+ * Capture and restore handle data for cached segments.
+ * Handle data (breadcrumbs, metadata from ctx.use(Handle)) is collected
+ * during segment resolution and stored alongside cached segments.
+ */
+
+import type { ResolvedSegment } from "../types.js";
+import type { HandleStore } from "../server/handle-store.js";
+import type { SegmentHandleData } from "./types.js";
+
+/**
+ * Capture handle data for a set of segments from the handle store.
+ * Used when caching segments to preserve their handle data.
+ */
+export function captureHandles(
+  segments: ResolvedSegment[],
+  handleStore: HandleStore,
+): Record<string, SegmentHandleData> {
+  const handles: Record<string, SegmentHandleData> = {};
+  for (const seg of segments) {
+    handles[seg.id] = handleStore.getDataForSegment(seg.id);
+  }
+  return handles;
+}
+
+/**
+ * Restore handle data from a cached snapshot into the handle store.
+ * Used when serving cached segments to replay their handle data.
+ */
+export function restoreHandles(
+  handles: Record<string, SegmentHandleData>,
+  handleStore: HandleStore,
+): void {
+  for (const [segId, segHandles] of Object.entries(handles)) {
+    if (Object.keys(segHandles).length > 0) {
+      handleStore.replaySegmentData(segId, segHandles);
+    }
+  }
+}

package/src/cache/index.ts

@@ -0,0 +1,43 @@
+/**
+ * Cache Store
+ *
+ * Server-side caching for RSC segments and loader data.
+ *
+ * Main exports for users:
+ * - SegmentCacheStore - Interface for implementing custom cache stores
+ * - MemorySegmentCacheStore - In-memory cache for development/testing
+ * - CFCacheStore - Cloudflare edge cache store for production
+ * - CacheScope / createCacheScope - Request-scoped cache provider
+ */
+
+// Segment cache store types and implementations
+export type {
+  SegmentCacheStore,
+  SegmentCacheProvider,
+  CachedEntryData,
+  CachedEntryResult,
+  CacheGetResult,
+  SerializedSegmentData,
+  SegmentHandleData,
+  CacheConfig,
+  CacheConfigOrFactory,
+} from "./types.js";
+
+export { MemorySegmentCacheStore } from "./memory-segment-store.js";
+
+// Cloudflare cache store
+export {
+  CFCacheStore,
+  type CFCacheStoreOptions,
+  CACHE_STALE_AT_HEADER,
+  CACHE_STATUS_HEADER,
+} from "./cf/index.js";
+
+// Cache scope
+export { CacheScope, createCacheScope } from "./cache-scope.js";
+
+// Document-level cache middleware
+export {
+  createDocumentCacheMiddleware,
+  type DocumentCacheOptions,
+} from "./document-cache.js";