@ivogt/rsc-router 0.0.0-experimental.1

package/src/vite/expose-action-id.ts

@@ -0,0 +1,344 @@
+import type { Plugin, ResolvedConfig } from "vite";
+import MagicString from "magic-string";
+import path from "node:path";
+import fs from "node:fs";
+
+/**
+ * Type for the RSC plugin's manager API
+ */
+interface RscPluginManager {
+  serverReferenceMetaMap: Record<
+    string,
+    {
+      importId: string;
+      referenceKey: string;
+      exportNames: string[];
+    }
+  >;
+  config: ResolvedConfig;
+}
+
+interface RscPluginApi {
+  manager: RscPluginManager;
+}
+
+/**
+ * Get the RSC plugin's API from Vite config
+ */
+function getRscPluginApi(config: ResolvedConfig): RscPluginApi | undefined {
+  // Try by name first
+  let plugin = config.plugins.find((p) => p.name === "rsc:minimal");
+
+  // Fallback: find by API structure if name lookup fails
+  if (!plugin) {
+    plugin = config.plugins.find(
+      (p) =>
+        (p.api as RscPluginApi | undefined)?.manager?.serverReferenceMetaMap !==
+        undefined
+    );
+    if (plugin) {
+      console.warn(
+        `[rsc-router:expose-action-id] RSC plugin found by API structure (name: "${plugin.name}"). ` +
+          `Consider updating the name lookup if the plugin was renamed.`
+      );
+    }
+  }
+
+  return plugin?.api as RscPluginApi | undefined;
+}
+
+/**
+ * Normalize path to forward slashes
+ */
+function normalizePath(p: string): string {
+  return p.split(path.sep).join("/");
+}
+
+/**
+ * Check if a file is a "use server" module (has the directive at the module level).
+ * This distinguishes module-level server action files from files with inline actions.
+ *
+ * Module-level "use server" files should have their hash replaced with file paths
+ * for revalidation matching. Inline actions (defined in RSC components) should
+ * keep their hashed IDs for client security.
+ */
+function isUseServerModule(filePath: string): boolean {
+  try {
+    const content = fs.readFileSync(filePath, "utf-8");
+    // Remove leading comments and whitespace to find the first meaningful content
+    const trimmed = content
+      .replace(/^\s*\/\/[^\n]*\n/gm, "") // Remove single-line comments
+      .replace(/^\s*\/\*[\s\S]*?\*\/\s*/gm, "") // Remove multi-line comments
+      .trimStart();
+
+    // Check if the file starts with "use server" directive
+    return (
+      trimmed.startsWith('"use server"') || trimmed.startsWith("'use server'")
+    );
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Transform code to expose action IDs on createServerReference calls.
+ * Wraps each call with an IIFE that attaches $id to the returned function.
+ *
+ * @param code - The source code to transform
+ * @param sourceId - The source file identifier (for sourcemap)
+ * @param hashToFileMap - Optional mapping from hash to file path (for server bundles)
+ */
+function transformServerReferences(
+  code: string,
+  sourceId?: string,
+  hashToFileMap?: Map<string, string>
+): { code: string; map: ReturnType<MagicString["generateMap"]> } | null {
+  if (!code.includes("createServerReference(")) {
+    return null;
+  }
+
+  // Match: createServerReference("hash#actionName", ...) or $$ReactClient.createServerReference(...)
+  // The RSC plugin uses $$ReactClient namespace in transformed code
+  const pattern =
+    /((?:\$\$\w+\.)?createServerReference)\(("[^"]+#[^"]+")([^)]*)\)/g;
+
+  const s = new MagicString(code);
+  let hasChanges = false;
+  let match: RegExpExecArray | null;
+
+  while ((match = pattern.exec(code)) !== null) {
+    hasChanges = true;
+    const [fullMatch, fnCall, idArg, rest] = match;
+    const start = match.index;
+    const end = start + fullMatch.length;
+
+    // Parse the ID to potentially replace hash with file path
+    let finalIdArg = idArg;
+    if (hashToFileMap) {
+      // idArg is like '"hash#actionName"', extract the parts
+      const idValue = idArg.slice(1, -1); // Remove quotes
+      const hashMatch = idValue.match(/^([^#]+)#(.+)$/);
+      if (hashMatch) {
+        const [, hash, actionName] = hashMatch;
+        const filePath = hashToFileMap.get(hash);
+        if (filePath) {
+          // Replace hash with file path for server-side
+          finalIdArg = `"${filePath}#${actionName}"`;
+        }
+      }
+    }
+
+    // Wrap the createServerReference call to attach $$id to the returned function
+    const replacement = `(function(fn) { fn.$$id = ${finalIdArg}; return fn; })(${fnCall}(${idArg}${rest}))`;
+    s.overwrite(start, end, replacement);
+  }
+
+  if (!hasChanges) {
+    return null;
+  }
+
+  return {
+    code: s.toString(),
+    map: s.generateMap({ source: sourceId, includeContent: true }),
+  };
+}
+
+/**
+ * Transform registerServerReference calls in server bundles to use file paths instead of hashes.
+ * Pattern: registerServerReference(fn, "hash", "exportName")
+ * React's registerServerReference sets $$id = hash + "#" + exportName
+ * By replacing the hash with file path, $$id will contain the file path for revalidation matching.
+ *
+ * Only actions from module-level "use server" files are transformed.
+ * Inline actions (defined in RSC components with "use server" inside a function) are NOT in
+ * hashToFileMap and keep their hashed IDs. This is intentional for client security:
+ * - Module-level "use server" files: shared action modules, file path helps revalidation
+ * - Inline actions: one-off actions in RSC, hash ID prevents file path exposure to client
+ *
+ * @param code - The source code to transform
+ * @param sourceId - The source file identifier (for sourcemap)
+ * @param hashToFileMap - Mapping from hash to file path (only module-level "use server" files)
+ */
+function transformRegisterServerReference(
+  code: string,
+  sourceId?: string,
+  hashToFileMap?: Map<string, string>
+): { code: string; map: ReturnType<MagicString["generateMap"]> } | null {
+  if (!hashToFileMap || !code.includes("registerServerReference(")) {
+    return null;
+  }
+
+  // Match: registerServerReference(fn, "hash", "exportName")
+  // The hash is the second argument, exportName is the third
+  const pattern = /registerServerReference\(([^,]+),\s*"([^"]+)",\s*"([^"]+)"\)/g;
+
+  const s = new MagicString(code);
+  let hasChanges = false;
+  let match: RegExpExecArray | null;
+
+  while ((match = pattern.exec(code)) !== null) {
+    const [fullMatch, fnArg, hash, exportName] = match;
+    const start = match.index;
+    const end = start + fullMatch.length;
+
+    // Look up the file path for this hash
+    const filePath = hashToFileMap.get(hash);
+    if (filePath) {
+      hasChanges = true;
+      // WRAP the call to add $id property with file path
+      // Keep the original hash for React's action registry (so loadServerAction works)
+      // Add $id (single dollar) with file path for revalidation matching
+      // Note: We use $id instead of $$id because React's registerServerReference
+      // sets $$id as a non-writable property
+      const filePathId = `${filePath}#${exportName}`;
+      const replacement = `(function(fn) { fn.$id = "${filePathId}"; return fn; })(registerServerReference(${fnArg}, "${hash}", "${exportName}"))`;
+      s.overwrite(start, end, replacement);
+    }
+  }
+
+  if (!hasChanges) {
+    return null;
+  }
+
+  return {
+    code: s.toString(),
+    map: s.generateMap({ source: sourceId, includeContent: true }),
+  };
+}
+
+/**
+ * Vite plugin that exposes action IDs on server reference functions.
+ *
+ * When React Server Components creates server references via createServerReference(),
+ * the action ID (format: "hash#actionName") is passed as the first argument but not
+ * exposed on the returned function. This plugin transforms the output to attach
+ * the $id property to each server reference function, enabling the router to
+ * identify which action was called during revalidation.
+ *
+ * Server bundles (RSC/SSR) get file paths in $id for filtering (e.g., "src/actions.ts#add").
+ * Client bundles keep hashed IDs for security (e.g., "ec387bc704d4#add").
+ *
+ * Works in:
+ * - Build mode: uses renderChunk to transform bundled chunks
+ * - Dev mode: uses transform with enforce:"post" to transform after RSC plugin
+ */
+export function exposeActionId(): Plugin {
+  let config: ResolvedConfig;
+  let isBuild = false;
+  let hashToFileMap: Map<string, string> | undefined;
+  let rscPluginApi: RscPluginApi | undefined;
+
+  return {
+    name: "rsc-router:expose-action-id",
+    // Run after all other plugins (including RSC plugin's transforms)
+    enforce: "post",
+
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+      isBuild = config.command === "build";
+
+      // Get RSC plugin API - rsc-router requires @vitejs/plugin-rsc
+      rscPluginApi = getRscPluginApi(config);
+    },
+
+    buildStart() {
+      // Verify RSC plugin is present at build start (after all config hooks have run)
+      // This allows rsc-router:rsc-integration to dynamically add the RSC plugin
+      if (!rscPluginApi) {
+        rscPluginApi = getRscPluginApi(config);
+      }
+
+      if (!rscPluginApi) {
+        throw new Error(
+          "[rsc-router] Could not find @vitejs/plugin-rsc. " +
+            "rsc-router requires the Vite RSC plugin.\n" +
+            "The RSC plugin should be included automatically. If you disabled it with\n" +
+            "rscRouter({ rsc: false }), add rsc() before rscRouter() in your config."
+        );
+      }
+
+      if (!isBuild) return;
+
+      hashToFileMap = new Map();
+      const { serverReferenceMetaMap } = rscPluginApi.manager;
+
+      for (const [absolutePath, meta] of Object.entries(
+        serverReferenceMetaMap
+      )) {
+        // Only include module-level "use server" files
+        // Inline actions (defined in RSC components) should keep hashed IDs for client security
+        if (!isUseServerModule(absolutePath)) {
+          continue;
+        }
+
+        const relativePath = normalizePath(
+          path.relative(config.root, absolutePath)
+        );
+
+        // The referenceKey in build mode is the hash
+        // Map hash -> relative file path
+        hashToFileMap.set(meta.referenceKey, relativePath);
+      }
+    },
+
+
+    // Dev mode only: transform hook runs after RSC plugin creates server references
+    // In dev mode, IDs already contain file paths, not hashes
+    transform(code, id) {
+      // Skip in build mode - renderChunk handles it
+      if (isBuild) {
+        return;
+      }
+
+      // Quick bail-out: only process if code has createServerReference
+      if (!code.includes("createServerReference(")) {
+        return;
+      }
+
+      // Skip node_modules
+      if (id.includes("/node_modules/")) {
+        return;
+      }
+
+      // Dev mode: no hash-to-file mapping needed (IDs are already file paths)
+      return transformServerReferences(code, id);
+    },
+
+    // Build mode: renderChunk runs after all transforms and bundling complete
+    renderChunk(code, chunk) {
+      // Only RSC bundle should get file paths for revalidation matching
+      // SSR bundle must NOT use file paths because client components run there
+      // and need to match the client bundle during hydration (otherwise: error #418)
+      const isRscEnv = this.environment?.name === "rsc";
+
+      // Only use file path mapping for RSC environment
+      const effectiveMap = isRscEnv ? hashToFileMap : undefined;
+
+      // Transform createServerReference calls (client-side)
+      const result = transformServerReferences(
+        code,
+        chunk.fileName,
+        effectiveMap
+      );
+
+      // For RSC bundles, also transform registerServerReference calls
+      // This replaces hashed IDs with file paths so $id contains the actual path
+      if (isRscEnv && hashToFileMap) {
+        const codeToTransform = result ? result.code : code;
+        const registerResult = transformRegisterServerReference(
+          codeToTransform,
+          chunk.fileName,
+          hashToFileMap
+        );
+        if (registerResult) {
+          return { code: registerResult.code, map: registerResult.map };
+        }
+      }
+
+      if (result) {
+        return { code: result.code, map: result.map };
+      }
+      return null;
+    },
+  };
+}

package/src/vite/expose-handle-id.ts

@@ -0,0 +1,209 @@
+import type { Plugin, ResolvedConfig } from "vite";
+import MagicString from "magic-string";
+import path from "node:path";
+import crypto from "node:crypto";
+
+/**
+ * Normalize path to forward slashes
+ */
+function normalizePath(p: string): string {
+  return p.split(path.sep).join("/");
+}
+
+/**
+ * Generate a short hash for a handle ID
+ * Uses first 8 chars of SHA-256 hash for uniqueness while keeping IDs short
+ * Appends export name for easier debugging: "abc123#Breadcrumbs"
+ */
+function hashHandleId(filePath: string, exportName: string): string {
+  const input = `${filePath}#${exportName}`;
+  const hash = crypto.createHash("sha256").update(input).digest("hex");
+  return `${hash.slice(0, 8)}#${exportName}`;
+}
+
+/**
+ * Check if file imports createHandle from rsc-router
+ */
+function hasCreateHandleImport(code: string): boolean {
+  // Match: import { createHandle } from "rsc-router" or "rsc-router/..."
+  const pattern =
+    /import\s*\{[^}]*\bcreateHandle\b[^}]*\}\s*from\s*["']rsc-router(?:\/[^"']+)?["']/;
+  return pattern.test(code);
+}
+
+/**
+ * Analyze createHandle arguments to determine injection strategy
+ * Returns: { hasArgs: boolean, firstArgIsString: boolean, firstArgIsFunction: boolean }
+ */
+function analyzeCreateHandleArgs(
+  code: string,
+  startPos: number,
+  endPos: number
+): { hasArgs: boolean; firstArgIsString: boolean; firstArgIsFunction: boolean } {
+  // Extract the content between parentheses
+  const content = code.slice(startPos, endPos).trim();
+
+  if (!content) {
+    return { hasArgs: false, firstArgIsString: false, firstArgIsFunction: false };
+  }
+
+  // Check if first arg starts with a quote (string literal)
+  const firstArgIsString = /^["']/.test(content);
+
+  // Check if first arg starts with ( for arrow function or function keyword
+  const firstArgIsFunction =
+    content.startsWith("(") ||
+    content.startsWith("function") ||
+    // Check for identifier that could be a collect function reference
+    /^[a-zA-Z_$][a-zA-Z0-9_$]*\s*(?:,|$)/.test(content);
+
+  return { hasArgs: true, firstArgIsString, firstArgIsFunction };
+}
+
+/**
+ * Transform export const X = createHandle(...) patterns to inject $$id
+ *
+ * Handles these cases:
+ * 1. createHandle() - no args -> inject (undefined, "id")
+ * 2. createHandle("name") - string name -> inject (, "id") after existing arg
+ * 3. createHandle(collectFn) - collect function -> inject (collectFn, "id")
+ * 4. createHandle("name", collectFn) - both -> inject (, "id") after existing args
+ */
+function transformHandleExports(
+  code: string,
+  filePath: string,
+  sourceId?: string,
+  isBuild: boolean = false
+): { code: string; map: ReturnType<MagicString["generateMap"]> } | null {
+  // Quick bail-out
+  if (!code.includes("createHandle")) {
+    return null;
+  }
+
+  // Must have direct import from rsc-router
+  if (!hasCreateHandleImport(code)) {
+    return null;
+  }
+
+  // Match: export const X = createHandle<...>(
+  // Captures the export name (X)
+  const pattern = /export\s+const\s+(\w+)\s*=\s*createHandle\s*(?:<[^>]*>)?\s*\(/g;
+
+  const s = new MagicString(code);
+  let hasChanges = false;
+  let match: RegExpExecArray | null;
+
+  while ((match = pattern.exec(code)) !== null) {
+    const exportName = match[1];
+    const matchEnd = match.index + match[0].length;
+
+    // Find the end of the createHandle(...) call
+    let parenDepth = 1;
+    let i = matchEnd;
+    while (i < code.length && parenDepth > 0) {
+      if (code[i] === "(") parenDepth++;
+      if (code[i] === ")") parenDepth--;
+      i++;
+    }
+
+    // i now points just after the closing )
+    const closeParenPos = i - 1;
+
+    // Analyze what arguments exist
+    const args = analyzeCreateHandleArgs(code, matchEnd, closeParenPos);
+
+    // Find the semicolon or end of statement
+    let statementEnd = i;
+    while (statementEnd < code.length && /\s/.test(code[statementEnd])) {
+      statementEnd++;
+    }
+    if (code[statementEnd] === ";") {
+      statementEnd++;
+    }
+
+    // Generate ID: hashed in production, readable in dev
+    const handleId = isBuild
+      ? hashHandleId(filePath, exportName)
+      : `${filePath}#${exportName}`;
+
+    // Inject $$id as the last parameter
+    let paramInjection: string;
+    if (!args.hasArgs) {
+      // No args: createHandle() -> createHandle(undefined, "id")
+      paramInjection = `undefined, "${handleId}"`;
+    } else {
+      // Has args: createHandle(x) -> createHandle(x, "id")
+      paramInjection = `, "${handleId}"`;
+    }
+    s.appendLeft(closeParenPos, paramInjection);
+
+    // Also set $$id property for external access
+    const propInjection = `\n${exportName}.$$id = "${handleId}";`;
+    s.appendRight(statementEnd, propInjection);
+    hasChanges = true;
+  }
+
+  if (!hasChanges) {
+    return null;
+  }
+
+  return {
+    code: s.toString(),
+    map: s.generateMap({ source: sourceId, includeContent: true }),
+  };
+}
+
+/**
+ * Vite plugin that exposes $$id on createHandle calls.
+ *
+ * When users create handles with createHandle(), this plugin:
+ * 1. Injects a $$id as the last parameter (used as the handle name)
+ * 2. Sets $$id property on the exported constant for external access
+ *
+ * This allows handles to be created without explicit names:
+ * - Before: export const Breadcrumbs = createHandle<Item>("breadcrumbs")
+ * - After:  export const Breadcrumbs = createHandle<Item>()
+ *
+ * The name is auto-generated from file path + export name.
+ *
+ * Requirements:
+ * - Must use direct import: import { createHandle } from "rsc-router"
+ * - Must use named export: export const MyHandle = createHandle(...)
+ */
+export function exposeHandleId(): Plugin {
+  let config: ResolvedConfig;
+  let isBuild = false;
+
+  return {
+    name: "rsc-router:expose-handle-id",
+    enforce: "post",
+
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+      isBuild = config.command === "build";
+    },
+
+    transform(code, id) {
+      // Skip node_modules
+      if (id.includes("/node_modules/")) {
+        return;
+      }
+
+      // Quick bail-out
+      if (!code.includes("createHandle")) {
+        return;
+      }
+
+      // Must have direct import from rsc-router
+      if (!hasCreateHandleImport(code)) {
+        return;
+      }
+
+      // Get relative path for the ID
+      const relativePath = normalizePath(path.relative(config.root, id));
+
+      // Transform: inject $$id
+      return transformHandleExports(code, relativePath, id, isBuild);
+    },
+  };
+}