@rangojs/router 0.0.0-experimental.8678bb02 → 0.0.0-experimental.87

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/README.md +126 -38
  2. package/dist/bin/rango.js +130 -47
  3. package/dist/vite/index.js +847 -384
  4. package/dist/vite/index.js.bak +5448 -0
  5. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  6. package/package.json +5 -5
  7. package/skills/breadcrumbs/SKILL.md +3 -1
  8. package/skills/handler-use/SKILL.md +362 -0
  9. package/skills/hooks/SKILL.md +28 -20
  10. package/skills/intercept/SKILL.md +20 -0
  11. package/skills/layout/SKILL.md +22 -0
  12. package/skills/links/SKILL.md +91 -17
  13. package/skills/loader/SKILL.md +35 -2
  14. package/skills/middleware/SKILL.md +34 -3
  15. package/skills/migrate-nextjs/SKILL.md +560 -0
  16. package/skills/migrate-react-router/SKILL.md +765 -0
  17. package/skills/parallel/SKILL.md +59 -0
  18. package/skills/prerender/SKILL.md +110 -68
  19. package/skills/rango/SKILL.md +24 -22
  20. package/skills/response-routes/SKILL.md +8 -0
  21. package/skills/route/SKILL.md +24 -0
  22. package/skills/router-setup/SKILL.md +35 -0
  23. package/skills/streams-and-websockets/SKILL.md +283 -0
  24. package/skills/typesafety/SKILL.md +3 -1
  25. package/src/__internal.ts +1 -1
  26. package/src/browser/app-shell.ts +52 -0
  27. package/src/browser/app-version.ts +14 -0
  28. package/src/browser/navigation-bridge.ts +87 -6
  29. package/src/browser/navigation-client.ts +128 -77
  30. package/src/browser/navigation-store.ts +68 -9
  31. package/src/browser/partial-update.ts +60 -7
  32. package/src/browser/prefetch/cache.ts +129 -21
  33. package/src/browser/prefetch/fetch.ts +156 -18
  34. package/src/browser/prefetch/queue.ts +36 -5
  35. package/src/browser/rango-state.ts +53 -13
  36. package/src/browser/react/Link.tsx +72 -8
  37. package/src/browser/react/NavigationProvider.tsx +57 -11
  38. package/src/browser/react/context.ts +7 -2
  39. package/src/browser/react/use-handle.ts +9 -58
  40. package/src/browser/react/use-navigation.ts +22 -2
  41. package/src/browser/react/use-params.ts +11 -1
  42. package/src/browser/react/use-router.ts +29 -9
  43. package/src/browser/rsc-router.tsx +60 -9
  44. package/src/browser/scroll-restoration.ts +10 -8
  45. package/src/browser/segment-reconciler.ts +36 -14
  46. package/src/browser/server-action-bridge.ts +8 -18
  47. package/src/browser/types.ts +33 -5
  48. package/src/build/generate-manifest.ts +6 -6
  49. package/src/build/generate-route-types.ts +3 -0
  50. package/src/build/route-trie.ts +50 -24
  51. package/src/build/route-types/include-resolution.ts +8 -1
  52. package/src/build/route-types/router-processing.ts +211 -72
  53. package/src/build/route-types/scan-filter.ts +8 -1
  54. package/src/cache/cf/cf-cache-store.ts +5 -7
  55. package/src/client.tsx +84 -230
  56. package/src/deps/browser.ts +0 -1
  57. package/src/handle.ts +40 -0
  58. package/src/index.rsc.ts +6 -1
  59. package/src/index.ts +49 -6
  60. package/src/outlet-context.ts +1 -1
  61. package/src/prerender/store.ts +5 -4
  62. package/src/prerender.ts +138 -77
  63. package/src/response-utils.ts +28 -0
  64. package/src/reverse.ts +27 -2
  65. package/src/route-definition/dsl-helpers.ts +210 -35
  66. package/src/route-definition/helpers-types.ts +61 -14
  67. package/src/route-definition/index.ts +3 -0
  68. package/src/route-definition/redirect.ts +9 -1
  69. package/src/route-definition/resolve-handler-use.ts +155 -0
  70. package/src/route-types.ts +18 -0
  71. package/src/router/content-negotiation.ts +100 -1
  72. package/src/router/handler-context.ts +70 -17
  73. package/src/router/intercept-resolution.ts +9 -4
  74. package/src/router/lazy-includes.ts +6 -6
  75. package/src/router/loader-resolution.ts +153 -21
  76. package/src/router/manifest.ts +22 -13
  77. package/src/router/match-api.ts +127 -192
  78. package/src/router/match-middleware/cache-lookup.ts +28 -8
  79. package/src/router/match-middleware/segment-resolution.ts +53 -0
  80. package/src/router/match-result.ts +82 -4
  81. package/src/router/middleware-types.ts +2 -28
  82. package/src/router/middleware.ts +32 -7
  83. package/src/router/navigation-snapshot.ts +182 -0
  84. package/src/router/pattern-matching.ts +60 -9
  85. package/src/router/prerender-match.ts +110 -10
  86. package/src/router/preview-match.ts +30 -102
  87. package/src/router/request-classification.ts +310 -0
  88. package/src/router/route-snapshot.ts +245 -0
  89. package/src/router/router-interfaces.ts +36 -4
  90. package/src/router/router-options.ts +37 -11
  91. package/src/router/segment-resolution/fresh.ts +70 -5
  92. package/src/router/segment-resolution/revalidation.ts +87 -9
  93. package/src/router/trie-matching.ts +10 -4
  94. package/src/router/url-params.ts +49 -0
  95. package/src/router.ts +54 -7
  96. package/src/rsc/handler.ts +478 -399
  97. package/src/rsc/helpers.ts +69 -41
  98. package/src/rsc/loader-fetch.ts +18 -3
  99. package/src/rsc/manifest-init.ts +5 -1
  100. package/src/rsc/progressive-enhancement.ts +14 -3
  101. package/src/rsc/response-route-handler.ts +14 -1
  102. package/src/rsc/rsc-rendering.ts +15 -2
  103. package/src/rsc/server-action.ts +10 -2
  104. package/src/rsc/ssr-setup.ts +2 -2
  105. package/src/rsc/types.ts +6 -4
  106. package/src/segment-content-promise.ts +67 -0
  107. package/src/segment-loader-promise.ts +122 -0
  108. package/src/segment-system.tsx +11 -61
  109. package/src/server/context.ts +65 -5
  110. package/src/server/handle-store.ts +19 -0
  111. package/src/server/loader-registry.ts +9 -8
  112. package/src/server/request-context.ts +142 -55
  113. package/src/ssr/index.tsx +3 -0
  114. package/src/static-handler.ts +18 -6
  115. package/src/types/cache-types.ts +4 -4
  116. package/src/types/handler-context.ts +17 -43
  117. package/src/types/loader-types.ts +37 -11
  118. package/src/types/request-scope.ts +126 -0
  119. package/src/types/route-entry.ts +12 -1
  120. package/src/types/segments.ts +1 -1
  121. package/src/urls/include-helper.ts +24 -14
  122. package/src/urls/path-helper-types.ts +39 -6
  123. package/src/urls/path-helper.ts +47 -12
  124. package/src/urls/pattern-types.ts +12 -0
  125. package/src/urls/response-types.ts +18 -16
  126. package/src/use-loader.tsx +77 -5
  127. package/src/vite/discovery/bundle-postprocess.ts +30 -33
  128. package/src/vite/discovery/discover-routers.ts +5 -1
  129. package/src/vite/discovery/prerender-collection.ts +128 -74
  130. package/src/vite/discovery/state.ts +13 -4
  131. package/src/vite/index.ts +4 -0
  132. package/src/vite/plugin-types.ts +60 -5
  133. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  134. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  135. package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
  136. package/src/vite/plugins/expose-id-utils.ts +12 -0
  137. package/src/vite/plugins/expose-ids/handler-transform.ts +30 -0
  138. package/src/vite/plugins/expose-internal-ids.ts +257 -40
  139. package/src/vite/plugins/performance-tracks.ts +64 -206
  140. package/src/vite/plugins/refresh-cmd.ts +88 -26
  141. package/src/vite/rango.ts +40 -18
  142. package/src/vite/router-discovery.ts +237 -37
  143. package/src/vite/utils/banner.ts +1 -1
  144. package/src/vite/utils/package-resolution.ts +1 -1
  145. package/src/vite/utils/prerender-utils.ts +37 -5
  146. package/src/vite/utils/shared-utils.ts +3 -2
  147. package/src/browser/debug-channel.ts +0 -93
@@ -2,7 +2,12 @@ import type { Plugin, ResolvedConfig } from "vite";
2
2
  import { parseAst } from "vite";
3
3
  import MagicString from "magic-string";
4
4
  import path from "node:path";
5
- import { normalizePath, hashId, detectImports } from "./expose-id-utils.js";
5
+ import {
6
+ normalizePath,
7
+ hashId,
8
+ makeStubId,
9
+ detectImports,
10
+ } from "./expose-id-utils.js";
6
11
  import {
7
12
  transformInlineHandlers,
8
13
  type VirtualHandlerEntry,
@@ -23,6 +28,7 @@ import {
23
28
  getImportedFnNames,
24
29
  collectCreateExportBindings,
25
30
  buildUnsupportedShapeWarning,
31
+ isExportOnlyFile,
26
32
  } from "./expose-ids/export-analysis.js";
27
33
  import {
28
34
  hasCreateLoaderImport,
@@ -34,6 +40,7 @@ import {
34
40
  transformLocationState,
35
41
  generateWholeFileStubs,
36
42
  generateExprStubs,
43
+ stubHandlerExprs,
37
44
  transformHandlerIds,
38
45
  } from "./expose-ids/handler-transform.js";
39
46
 
@@ -385,7 +392,9 @@ ${lazyImports.join(",\n")}
385
392
  if (stubResult) return stubResult;
386
393
  }
387
394
 
388
- // --- PrerenderHandler: non-RSC stub replacement ---
395
+ // --- PrerenderHandler: non-RSC whole-file stub replacement ---
396
+ // When ALL exports are Prerender() calls, replace the entire file.
397
+ // Mixed-export files are handled in the unified pipeline below.
389
398
  if (hasPrerenderHandlerCode && !isRscEnv) {
390
399
  const fnNames = getFnNames(PRERENDER_CONFIG.fnName);
391
400
  const bindings = getBindings(code, fnNames);
@@ -397,16 +406,6 @@ ${lazyImports.join(",\n")}
397
406
  isBuild,
398
407
  );
399
408
  if (wholeFile) return wholeFile;
400
-
401
- const exprStubs = generateExprStubs(
402
- PRERENDER_CONFIG,
403
- bindings,
404
- code,
405
- filePath,
406
- id,
407
- isBuild,
408
- );
409
- if (exprStubs) return exprStubs;
410
409
  }
411
410
 
412
411
  // --- PrerenderHandler: RSC build module tracking ---
@@ -467,7 +466,8 @@ ${lazyImports.join(",\n")}
467
466
  }
468
467
  }
469
468
 
470
- // --- StaticHandler: non-RSC stub replacement ---
469
+ // --- StaticHandler: non-RSC whole-file stub replacement ---
470
+ // When ALL exports are Static() calls, replace the entire file.
471
471
  if (hasStaticHandlerCode && !isRscEnv) {
472
472
  const fnNames = getFnNames(STATIC_CONFIG.fnName);
473
473
  const bindings = getBindings(code, fnNames);
@@ -479,16 +479,212 @@ ${lazyImports.join(",\n")}
479
479
  isBuild,
480
480
  );
481
481
  if (wholeFile) return wholeFile;
482
+ }
482
483
 
483
- const exprStubs = generateExprStubs(
484
- STATIC_CONFIG,
485
- bindings,
486
- code,
487
- filePath,
488
- id,
489
- isBuild,
490
- );
491
- if (exprStubs) return exprStubs;
484
+ // --- Mixed-type whole-file stub replacement (non-RSC) ---
485
+ // When the individual whole-file checks above fail (each only checks
486
+ // one type), the file has mixed exports (e.g. createLoader + Prerender).
487
+ // Gather ALL stub-safe bindings and check if they cover every export.
488
+ // If yes, replace the entire file with stubs — this strips server-only
489
+ // imports (node:fs, DB clients, etc.) that would crash in the browser.
490
+ //
491
+ // Only applies when the file contains Prerender/Static (the handler
492
+ // types that bring server-only code). Files with only loaders, handles,
493
+ // or locationState are handled correctly by the unified pipeline below.
494
+ //
495
+ // Loader, Prerender, and Static exports become plain { __brand, $$id }
496
+ // stubs. createHandle and createLocationState need their create*()
497
+ // functions to execute (collect registration / __rsc_ls_key), so their
498
+ // call expressions are preserved with only a @rangojs/router import.
499
+ // This strips all server-only imports while keeping the correct
500
+ // client contract for every export type.
501
+ if (!isRscEnv && (hasPrerenderHandlerCode || hasStaticHandlerCode)) {
502
+ const prerenderFnNames = hasPrerenderHandlerCode
503
+ ? getFnNames(PRERENDER_CONFIG.fnName)
504
+ : [];
505
+ const staticFnNames = hasStaticHandlerCode
506
+ ? getFnNames(STATIC_CONFIG.fnName)
507
+ : [];
508
+ const loaderFnNames = hasLoaderCode ? getFnNames("createLoader") : [];
509
+ const handleFnNames = hasHandleCode ? getFnNames("createHandle") : [];
510
+ const lsFnNames = hasLocationStateCode
511
+ ? getFnNames("createLocationState")
512
+ : [];
513
+
514
+ // Collect ALL recognized bindings to check export coverage
515
+ const allBindings: CreateExportBinding[] = [];
516
+ for (const fnNames of [
517
+ prerenderFnNames,
518
+ staticFnNames,
519
+ loaderFnNames,
520
+ handleFnNames,
521
+ lsFnNames,
522
+ ]) {
523
+ if (fnNames.length > 0) {
524
+ allBindings.push(...getBindings(code, fnNames));
525
+ }
526
+ }
527
+
528
+ // Check if preserved createHandle/createLocationState calls
529
+ // reference non-exported locals (e.g. helper functions, constants).
530
+ // If so, the whole-file stub would strip those locals, breaking
531
+ // the call. Fall through to the unified pipeline instead.
532
+ let canStubWholeFile =
533
+ allBindings.length > 0 && isExportOnlyFile(code, allBindings);
534
+
535
+ if (
536
+ canStubWholeFile &&
537
+ (handleFnNames.length > 0 || lsFnNames.length > 0)
538
+ ) {
539
+ const exportedLocals = new Set(allBindings.map((b) => b.localName));
540
+ // Collect bindings that would be stripped by whole-file replacement:
541
+ // local declarations and imported bindings from non-@rangojs/router
542
+ // modules. This is a regex-based heuristic — it intentionally skips
543
+ // edge cases (class decls, destructured bindings, combined
544
+ // default+named imports) since those rarely appear in route files.
545
+ const strippedBindings: string[] = [];
546
+
547
+ // Skip React Fast Refresh temporaries (_c, _c2, ...) which are
548
+ // injected by @vitejs/plugin-react in the client environment and
549
+ // would falsely trigger the bailout.
550
+ const localDeclPattern =
551
+ /(?:^|;|\n)\s*(?:const|let|var|function)\s+(\w+)/g;
552
+ let declMatch: RegExpExecArray | null;
553
+ while ((declMatch = localDeclPattern.exec(code)) !== null) {
554
+ const name = declMatch[1];
555
+ if (!exportedLocals.has(name) && !/^_c\d*$/.test(name)) {
556
+ strippedBindings.push(name);
557
+ }
558
+ }
559
+
560
+ const importPattern =
561
+ /import\s*\{([^}]*)\}\s*from\s*["'](?!@rangojs\/router)[^"']*["']/g;
562
+ let importMatch: RegExpExecArray | null;
563
+ while ((importMatch = importPattern.exec(code)) !== null) {
564
+ for (const spec of importMatch[1].split(",")) {
565
+ const m = spec
566
+ .trim()
567
+ .match(/^[A-Za-z_$][\w$]*(?:\s+as\s+([A-Za-z_$][\w$]*))?$/);
568
+ if (m) strippedBindings.push(m[1] || m[0].trim().split(/\s/)[0]);
569
+ }
570
+ }
571
+ const defaultImportPattern =
572
+ /import\s+([A-Za-z_$][\w$]*)\s+from\s*["'](?!@rangojs\/router)[^"']*["']/g;
573
+ while ((importMatch = defaultImportPattern.exec(code)) !== null) {
574
+ strippedBindings.push(importMatch[1]);
575
+ }
576
+ const nsImportPattern =
577
+ /import\s+\*\s+as\s+([A-Za-z_$][\w$]*)\s+from\s*["'](?!@rangojs\/router)[^"']*["']/g;
578
+ while ((importMatch = nsImportPattern.exec(code)) !== null) {
579
+ strippedBindings.push(importMatch[1]);
580
+ }
581
+
582
+ if (strippedBindings.length > 0) {
583
+ const preservedBindings = allBindings.filter((b) => {
584
+ const fc = code.slice(b.callExprStart, b.callOpenParenPos + 1);
585
+ return (
586
+ handleFnNames.some((n) => fc.includes(n)) ||
587
+ lsFnNames.some((n) => fc.includes(n))
588
+ );
589
+ });
590
+ const strippedRe = new RegExp(
591
+ `\\b(?:${strippedBindings.join("|")})\\b`,
592
+ );
593
+ canStubWholeFile = !preservedBindings.some((b) => {
594
+ const expr = code.slice(b.callExprStart, b.callCloseParenPos + 1);
595
+ return strippedRe.test(expr);
596
+ });
597
+ }
598
+ }
599
+
600
+ if (canStubWholeFile) {
601
+ const lines: string[] = [];
602
+ const neededImports: string[] = [];
603
+ if (handleFnNames.length > 0) neededImports.push("createHandle");
604
+ if (lsFnNames.length > 0) neededImports.push("createLocationState");
605
+ if (neededImports.length > 0) {
606
+ lines.push(
607
+ `import { ${neededImports.join(", ")} } from "@rangojs/router";`,
608
+ );
609
+ }
610
+
611
+ for (const binding of allBindings) {
612
+ const fnCall = code.slice(
613
+ binding.callExprStart,
614
+ binding.callOpenParenPos + 1,
615
+ );
616
+ const isHandle = handleFnNames.some((n) => fnCall.includes(n));
617
+ const isLocationState = lsFnNames.some((n) => fnCall.includes(n));
618
+
619
+ // Aliases share the primary name's ID (matches server transforms).
620
+ const primaryName = binding.exportNames[0];
621
+ const stubId = makeStubId(filePath, primaryName, isBuild);
622
+
623
+ if (isHandle || isLocationState) {
624
+ // Rewrite alias to canonical name since the stub file only
625
+ // imports canonical names from @rangojs/router.
626
+ // Strip React Fast Refresh `_c = ` wrappers from args
627
+ // (e.g. `_c = (segments) => ...` → `(segments) => ...`)
628
+ const rawArgs = code
629
+ .slice(binding.callOpenParenPos + 1, binding.callCloseParenPos)
630
+ .replace(/\b_c\d*\s*=\s*/g, "");
631
+ const canonicalName = isHandle
632
+ ? "createHandle"
633
+ : "createLocationState";
634
+ const activeFnNames = isHandle ? handleFnNames : lsFnNames;
635
+
636
+ // Reconstruct the function name (handling aliases + generics)
637
+ let rawCallee = code.slice(
638
+ binding.callExprStart,
639
+ binding.callOpenParenPos,
640
+ );
641
+ for (const alias of activeFnNames) {
642
+ if (alias !== canonicalName && rawCallee.startsWith(alias)) {
643
+ rawCallee = canonicalName + rawCallee.slice(alias.length);
644
+ break;
645
+ }
646
+ }
647
+
648
+ if (isHandle) {
649
+ // createHandle checks __injectedId DURING the call, so $$id
650
+ // must be a parameter, not a post-call property assignment.
651
+ const idParam =
652
+ binding.argCount === 0
653
+ ? `undefined, "${stubId}"`
654
+ : `, "${stubId}"`;
655
+ lines.push(
656
+ `export const ${primaryName} = ${rawCallee}(${rawArgs}${idParam});`,
657
+ );
658
+ lines.push(`${primaryName}.$$id = "${stubId}";`);
659
+ } else {
660
+ lines.push(
661
+ `export const ${primaryName} = ${rawCallee}(${rawArgs});`,
662
+ );
663
+ lines.push(
664
+ `${primaryName}.__rsc_ls_key = "__rsc_ls_${stubId}";`,
665
+ );
666
+ }
667
+ for (const name of binding.exportNames.slice(1)) {
668
+ lines.push(`export const ${name} = ${primaryName};`);
669
+ }
670
+ } else {
671
+ let brand = "loader";
672
+ if (prerenderFnNames.some((n) => fnCall.includes(n))) {
673
+ brand = PRERENDER_CONFIG.brand;
674
+ } else if (staticFnNames.some((n) => fnCall.includes(n))) {
675
+ brand = STATIC_CONFIG.brand;
676
+ }
677
+ lines.push(
678
+ `export const ${primaryName} = { __brand: "${brand}", $$id: "${stubId}" };`,
679
+ );
680
+ for (const name of binding.exportNames.slice(1)) {
681
+ lines.push(`export const ${name} = ${primaryName};`);
682
+ }
683
+ }
684
+ }
685
+
686
+ return { code: lines.join("\n") + "\n", map: null };
687
+ }
492
688
  }
493
689
 
494
690
  // --- StaticHandler: RSC build module tracking ---
@@ -535,27 +731,48 @@ ${lazyImports.join(",\n")}
535
731
  isBuild,
536
732
  ) || changed;
537
733
  }
538
- if (hasPrerenderHandlerCode && isRscEnv) {
734
+ if (hasPrerenderHandlerCode) {
539
735
  const fnNames = getFnNames(PRERENDER_CONFIG.fnName);
540
- changed =
541
- transformHandlerIds(
542
- PRERENDER_CONFIG,
543
- getBindings(code, fnNames),
544
- s,
545
- filePath,
546
- isBuild,
547
- ) || changed;
736
+ const bindings = getBindings(code, fnNames);
737
+ if (isRscEnv) {
738
+ changed =
739
+ transformHandlerIds(
740
+ PRERENDER_CONFIG,
741
+ bindings,
742
+ s,
743
+ filePath,
744
+ isBuild,
745
+ ) || changed;
746
+ } else {
747
+ // Non-RSC mixed-export file: replace Prerender() calls with stubs
748
+ // on the shared MagicString so sourcemaps stay accurate.
749
+ changed =
750
+ stubHandlerExprs(
751
+ PRERENDER_CONFIG,
752
+ bindings,
753
+ s,
754
+ filePath,
755
+ isBuild,
756
+ ) || changed;
757
+ }
548
758
  }
549
- if (hasStaticHandlerCode && isRscEnv) {
759
+ if (hasStaticHandlerCode) {
550
760
  const fnNames = getFnNames(STATIC_CONFIG.fnName);
551
- changed =
552
- transformHandlerIds(
553
- STATIC_CONFIG,
554
- getBindings(code, fnNames),
555
- s,
556
- filePath,
557
- isBuild,
558
- ) || changed;
761
+ const bindings = getBindings(code, fnNames);
762
+ if (isRscEnv) {
763
+ changed =
764
+ transformHandlerIds(
765
+ STATIC_CONFIG,
766
+ bindings,
767
+ s,
768
+ filePath,
769
+ isBuild,
770
+ ) || changed;
771
+ } else {
772
+ changed =
773
+ stubHandlerExprs(STATIC_CONFIG, bindings, s, filePath, isBuild) ||
774
+ changed;
775
+ }
559
776
  }
560
777
 
561
778
  if (!changed) return;
@@ -1,230 +1,88 @@
1
1
  /**
2
- * React Performance Tracks — Vite plugin
2
+ * React Performance Tracks — RSDW client patch
3
3
  *
4
- * Dev-only plugin that enables Chrome DevTools Performance tab integration
5
- * for React Server Components. Creates a bidirectional debug channel per
6
- * RSC request and transports data over Vite's HMR WebSocket.
4
+ * Patches the RSDW client so _debugInfo recovery works for plain-object
5
+ * payloads (our RscPayload shape). Without this, the Server Components
6
+ * track in Chrome DevTools stays empty.
7
7
  *
8
- * Architecture:
9
- * - Server: renderToReadableStream writes timing data to debugChannel.writable
10
- * - Transport: chunks are base64-encoded and sent via HMR custom events
11
- * - Client: createFromFetch reads from debugChannel.readable
12
- *
13
- * Each request gets a unique debugId (UUID) to correlate the two sides.
14
- *
15
- * Uses globalThis to share state between the Vite plugin (main process)
16
- * and the RSC handler (RSC module graph) — they run in the same Node.js
17
- * process but different module evaluation contexts.
8
+ * React's flushComponentPerformance uses splice(0) to empty _debugInfo
9
+ * after resolution, then recovers it from the resolved value — but only
10
+ * for arrays, async iterables, React elements, and lazy types. Since our
11
+ * RscPayload is a plain object, _debugInfo is lost. This patch relaxes
12
+ * the check so _debugInfo is recovered from any object.
18
13
  */
19
14
 
20
15
  import type { Plugin } from "vite";
16
+ import { readFile } from "node:fs/promises";
21
17
 
22
- export const DEBUG_ID_HEADER = "X-RSC-Debug-Id";
23
- const DEBUG_S2C_EVENT = "rango:perf-s2c";
24
- const DEBUG_C2S_EVENT = "rango:perf-c2s";
18
+ const RSDW_PATCH_RE =
19
+ /((?:var|let|const)\s+\w+\s*=\s*root\._children\s*,\s*(\w+)\s*=\s*root\._debugInfo\s*[;,])/;
25
20
 
26
- type DebugPayload =
27
- | { i: string; b: string } // chunk (base64)
28
- | { i: string; d: true }; // done
29
-
30
- interface DebugSession {
31
- cmdController?: ReadableStreamDefaultController<Uint8Array>;
32
- pendingChunks?: Uint8Array[];
33
- ended: boolean;
21
+ function buildPatchReplacement(match: string, debugInfoVar: string): string {
22
+ return `${match}
23
+ if (${debugInfoVar} && 0 === ${debugInfoVar}.length && "fulfilled" === root.status) {
24
+ var _resolved = "function" === typeof resolveLazy ? resolveLazy(root.value) : root.value;
25
+ if ("object" === typeof _resolved && null !== _resolved && isArrayImpl(_resolved._debugInfo)) {
26
+ ${debugInfoVar} = _resolved._debugInfo;
27
+ }
28
+ }`;
34
29
  }
35
30
 
36
- type DebugChannelRegistry = {
37
- channels: Map<
38
- string,
39
- {
40
- readable: ReadableStream<Uint8Array>;
41
- writable: WritableStream<Uint8Array>;
42
- }
43
- >;
44
- sessions: Map<string, DebugSession>;
45
- };
46
-
47
- const GLOBAL_KEY = "__RANGO_DEBUG_CHANNELS__";
31
+ export function patchRsdwClientDebugInfoRecovery(code: string): {
32
+ code: string;
33
+ debugInfoVar: string | null;
34
+ } {
35
+ const match = code.match(RSDW_PATCH_RE);
36
+ if (!match) {
37
+ return { code, debugInfoVar: null };
38
+ }
48
39
 
49
- // Use Node.js `Module` built-in as carrier — Vite's RSC module runner
50
- // uses a separate VM context where both `globalThis` and `process` are
51
- // different objects, but built-in module singletons ARE shared.
52
- import { Module } from "node:module";
53
- function getRegistry(): DebugChannelRegistry {
54
- return ((Module as any)[GLOBAL_KEY] ??= {
55
- channels: new Map(),
56
- sessions: new Map(),
57
- });
40
+ return {
41
+ code: code.replace(match[1]!, buildPatchReplacement(match[1]!, match[2]!)),
42
+ debugInfoVar: match[2]!,
43
+ };
58
44
  }
59
45
 
60
- /**
61
- * Create a debug channel for a given request.
62
- * Called by the RSC handler for each request that has a debugId.
63
- * Returns the { readable, writable } pair for renderToReadableStream.
64
- *
65
- * This works across module graphs because the channel is pre-created
66
- * by the Vite plugin and stored on globalThis.
67
- */
68
- export function createServerDebugChannel(debugId: string): {
69
- readable: ReadableStream<Uint8Array>;
70
- writable: WritableStream<Uint8Array>;
71
- } | null {
72
- const registry = getRegistry();
73
- const channel = registry.channels.get(debugId);
74
- if (channel) {
75
- registry.channels.delete(debugId);
76
- console.log("[perf-tracks] debug channel attached for", debugId);
77
- return channel;
78
- }
79
- console.log(
80
- "[perf-tracks] no channel found for",
81
- debugId,
82
- "channels:",
83
- registry.channels.size,
84
- );
85
- return null;
46
+ export function performanceTracksOptimizeDepsPlugin(): {
47
+ name: string;
48
+ setup(build: any): void;
49
+ } {
50
+ return {
51
+ name: "@rangojs/router:performance-tracks-optimize-deps",
52
+ setup(build: any): void {
53
+ build.onLoad(
54
+ {
55
+ filter:
56
+ /react-server-dom-webpack-client\.browser\.(development|production)\.js$/,
57
+ },
58
+ async (args: { path: string }) => {
59
+ const code = await readFile(args.path, "utf8");
60
+ const patched = patchRsdwClientDebugInfoRecovery(code);
61
+ return {
62
+ contents: patched.code,
63
+ loader: "js",
64
+ };
65
+ },
66
+ );
67
+ },
68
+ };
86
69
  }
87
70
 
88
- const bytesToBase64 = (bytes: Uint8Array) =>
89
- Buffer.from(bytes).toString("base64");
90
-
91
- const base64ToBytes = (base64: string) =>
92
- new Uint8Array(Buffer.from(base64, "base64"));
93
-
94
71
  export function performanceTracksPlugin(): Plugin {
95
72
  return {
96
73
  name: "@rangojs/router:performance-tracks",
97
- // Only configureServer hook — naturally dev-only
98
-
99
- configureServer(server) {
100
- console.log("[perf-tracks] plugin loaded, configureServer called");
101
- const hot = server.environments.client.hot;
102
- const registry = getRegistry();
103
- const sessions = registry.sessions;
104
-
105
- const sendChunk = (debugId: string, chunk: Uint8Array) => {
106
- hot.send(DEBUG_S2C_EVENT, {
107
- i: debugId,
108
- b: bytesToBase64(chunk),
109
- } satisfies DebugPayload);
110
- };
111
-
112
- const cleanupIfEnded = (debugId: string, session: DebugSession) => {
113
- if (session.pendingChunks || !session.ended) return;
114
- sessions.delete(debugId);
115
- hot.send(DEBUG_S2C_EVENT, {
116
- i: debugId,
117
- d: true,
118
- } satisfies DebugPayload);
119
- };
120
-
121
- const registerDebugChannel = (debugId: string) => {
122
- let session = sessions.get(debugId);
123
- if (!session) {
124
- session = { pendingChunks: [], ended: false };
125
- sessions.set(debugId, session);
126
- }
127
-
128
- // Readable: receives client-to-server commands via WS
129
- const readable = new ReadableStream<Uint8Array>({
130
- start(controller) {
131
- session!.cmdController = controller;
132
- },
133
- cancel() {
134
- delete session!.cmdController;
135
- },
136
- });
137
-
138
- // Writable: React writes debug data here, we forward to client via WS
139
- const writable = new WritableStream<Uint8Array>({
140
- write(chunk) {
141
- if (session!.pendingChunks) {
142
- session!.pendingChunks.push(chunk);
143
- } else {
144
- sendChunk(debugId, chunk);
145
- }
146
- },
147
- close() {
148
- session!.ended = true;
149
- cleanupIfEnded(debugId, session!);
150
- },
151
- abort() {
152
- session!.ended = true;
153
- cleanupIfEnded(debugId, session!);
154
- },
155
- });
156
-
157
- // Store on globalThis so the RSC handler can retrieve it
158
- registry.channels.set(debugId, { readable, writable });
159
- };
160
-
161
- // Listen for client-to-server debug messages
162
- // Payload shapes: { i, d: true } (done), { i, b } (chunk), { i } (ready)
163
- hot.on(DEBUG_C2S_EVENT, (raw: unknown) => {
164
- const payload = raw as { i: string; b?: string; d?: true };
165
- const session = sessions.get(payload.i);
166
-
167
- if (payload.d) {
168
- if (session?.cmdController) {
169
- try {
170
- session.cmdController.close();
171
- } catch {
172
- // ignore
173
- }
174
- delete session.cmdController;
175
- }
176
- return;
177
- }
178
-
179
- if (payload.b) {
180
- if (session?.cmdController) {
181
- try {
182
- session.cmdController.enqueue(base64ToBytes(payload.b));
183
- } catch {
184
- delete session!.cmdController;
185
- }
186
- }
187
- return;
188
- }
189
-
190
- // Ready signal — flush pending chunks
191
- if (session) {
192
- if (session.pendingChunks) {
193
- for (const chunk of session.pendingChunks) {
194
- sendChunk(payload.i, chunk);
195
- }
196
- delete session.pendingChunks;
197
- }
198
- cleanupIfEnded(payload.i, session);
199
- } else {
200
- sessions.set(payload.i, { ended: false });
201
- }
202
- });
203
-
204
- // Register middleware for ALL requests — create a debug channel so
205
- // the RSC handler can attach it to renderToReadableStream.
206
- server.middlewares.use((req: any, _res: any, next: any) => {
207
- const existingId = req.headers[DEBUG_ID_HEADER.toLowerCase()] as string;
208
- const debugId = existingId || crypto.randomUUID();
209
-
210
- if (!existingId) {
211
- const lowerName = DEBUG_ID_HEADER.toLowerCase();
212
- req.headers[lowerName] = debugId;
213
- if (req.rawHeaders) {
214
- req.rawHeaders.push(DEBUG_ID_HEADER, debugId);
215
- }
216
- }
217
74
 
218
- registerDebugChannel(debugId);
75
+ transform(code, id) {
76
+ if (!id.includes("react-server-dom") || !id.includes("client")) return;
77
+ const patched = patchRsdwClientDebugInfoRecovery(code);
78
+ if (!patched.debugInfoVar) return;
79
+ if (process.env.INTERNAL_RANGO_DEBUG)
219
80
  console.log(
220
- "[perf-tracks] middleware: channel for",
221
- debugId,
222
- "url:",
223
- req.url?.slice(0, 60),
224
- existingId ? "(client)" : "(server-generated)",
81
+ "[perf-tracks] patched RSDW client (var:",
82
+ patched.debugInfoVar,
83
+ ")",
225
84
  );
226
- next();
227
- });
85
+ return patched.code;
228
86
  },
229
87
  };
230
88
  }