@rangojs/router 0.0.0-experimental.bd6e11bc → 0.0.0-experimental.bdaf10aa
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.
- package/AGENTS.md +8 -4
- package/README.md +296 -887
- package/dist/bin/rango.js +459 -91
- package/dist/testing/vitest.js +36 -2
- package/dist/vite/index.js +1708 -414
- package/package.json +35 -10
- package/skills/api-client/SKILL.md +211 -0
- package/skills/breadcrumbs/SKILL.md +82 -5
- package/skills/bundle-analysis/SKILL.md +2 -2
- package/skills/cache-guide/SKILL.md +14 -9
- package/skills/caching/SKILL.md +221 -12
- package/skills/catalog.json +271 -0
- package/skills/comparison/SKILL.md +50 -0
- package/skills/comparison/agents/openai.yaml +4 -0
- package/skills/comparison/references/framework-comparison.md +837 -0
- package/skills/composability/SKILL.md +83 -2
- package/skills/css/SKILL.md +76 -0
- package/skills/debug-manifest/SKILL.md +5 -3
- package/skills/defer-hydration/SKILL.md +235 -0
- package/skills/document-cache/SKILL.md +11 -3
- package/skills/fonts/SKILL.md +1 -1
- package/skills/handler-use/SKILL.md +9 -9
- package/skills/hooks/SKILL.md +73 -900
- package/skills/hooks/data.md +273 -0
- package/skills/hooks/handle-and-actions.md +103 -0
- package/skills/hooks/navigation.md +110 -0
- package/skills/hooks/outlets.md +41 -0
- package/skills/hooks/state.md +228 -0
- package/skills/hooks/urls.md +135 -0
- package/skills/host-router/SKILL.md +84 -7
- package/skills/i18n/SKILL.md +1 -1
- package/skills/intercept/SKILL.md +51 -17
- package/skills/layout/SKILL.md +38 -16
- package/skills/links/SKILL.md +1 -1
- package/skills/loader/SKILL.md +48 -20
- package/skills/middleware/SKILL.md +11 -5
- package/skills/migrate-nextjs/SKILL.md +203 -20
- package/skills/migrate-react-router/SKILL.md +59 -675
- package/skills/migrate-react-router/cloudflare-workers.md +129 -0
- package/skills/migrate-react-router/component-migration.md +196 -0
- package/skills/migrate-react-router/data-and-actions.md +225 -0
- package/skills/migrate-react-router/route-mapping.md +271 -0
- package/skills/mime-routes/SKILL.md +3 -3
- package/skills/observability/SKILL.md +70 -5
- package/skills/parallel/SKILL.md +32 -8
- package/skills/ppr/SKILL.md +622 -0
- package/skills/prerender/SKILL.md +59 -28
- package/skills/rango/SKILL.md +124 -50
- package/skills/response-routes/SKILL.md +78 -46
- package/skills/route/SKILL.md +85 -6
- package/skills/router-setup/SKILL.md +41 -6
- package/skills/scripts/SKILL.md +179 -0
- package/skills/server-actions/SKILL.md +28 -3
- package/skills/shell-manifest/SKILL.md +185 -0
- package/skills/streams-and-websockets/SKILL.md +1 -1
- package/skills/tailwind/SKILL.md +28 -4
- package/skills/testing/SKILL.md +68 -654
- package/skills/testing/bindings.md +103 -0
- package/skills/testing/cache-prerender.md +127 -0
- package/skills/testing/client-components.md +124 -0
- package/skills/testing/e2e-parity.md +125 -0
- package/skills/testing/flight.md +91 -0
- package/skills/testing/handles.md +131 -0
- package/skills/testing/loader.md +128 -0
- package/skills/testing/middleware.md +99 -0
- package/skills/testing/render-handler.md +122 -0
- package/skills/testing/response-routes.md +95 -0
- package/skills/testing/reverse-and-types.md +85 -0
- package/skills/testing/server-actions.md +107 -0
- package/skills/testing/server-tree.md +128 -0
- package/skills/testing/setup.md +123 -0
- package/skills/theme/SKILL.md +1 -1
- package/skills/typesafety/SKILL.md +45 -918
- package/skills/typesafety/env-and-bindings.md +254 -0
- package/skills/typesafety/generated-files-and-cli.md +335 -0
- package/skills/typesafety/params-and-search.md +153 -0
- package/skills/typesafety/route-types.md +209 -0
- package/skills/use-cache/SKILL.md +47 -17
- package/skills/vercel/SKILL.md +128 -0
- package/skills/view-transitions/SKILL.md +44 -1
- package/src/__augment-tests__/augmented.check.ts +2 -3
- package/src/__internal.ts +0 -65
- package/src/browser/action-coordinator.ts +1 -1
- package/src/browser/action-fence.ts +47 -0
- package/src/browser/app-shell.ts +14 -27
- package/src/browser/connection-warmup.ts +134 -0
- package/src/browser/cookie-name.ts +140 -0
- package/src/browser/event-controller.ts +178 -100
- package/src/browser/invalidate-client-cache.ts +52 -0
- package/src/browser/logging.ts +28 -0
- package/src/browser/merge-segment-loaders.ts +6 -4
- package/src/browser/navigation-bridge.ts +81 -68
- package/src/browser/navigation-client.ts +115 -70
- package/src/browser/navigation-store-handle.ts +38 -0
- package/src/browser/navigation-store.ts +153 -88
- package/src/browser/navigation-transaction.ts +0 -32
- package/src/browser/network-error-handler.ts +34 -7
- package/src/browser/partial-update.ts +157 -144
- package/src/browser/prefetch/cache.ts +148 -81
- package/src/browser/prefetch/fetch.ts +231 -51
- package/src/browser/prefetch/queue.ts +25 -7
- package/src/browser/rango-state.ts +157 -115
- package/src/browser/react/Link.tsx +40 -7
- package/src/browser/react/NavigationProvider.tsx +140 -99
- package/src/browser/react/ScrollRestoration.tsx +10 -6
- package/src/browser/react/filter-segment-order.ts +17 -2
- package/src/browser/react/index.ts +0 -51
- package/src/browser/react/location-state-shared.ts +14 -15
- package/src/browser/react/location-state.ts +0 -1
- package/src/browser/react/use-action.ts +6 -15
- package/src/browser/react/use-handle.ts +0 -5
- package/src/browser/react/use-href.tsx +8 -1
- package/src/browser/react/use-link-status.ts +33 -8
- package/src/browser/react/use-navigation.ts +10 -5
- package/src/browser/react/use-params.ts +0 -2
- package/src/browser/react/use-router.ts +6 -4
- package/src/browser/react/use-search-params.ts +0 -5
- package/src/browser/react/use-segments.ts +0 -13
- package/src/browser/response-adapter.ts +74 -8
- package/src/browser/rsc-router.tsx +97 -22
- package/src/browser/scroll-restoration.ts +15 -8
- package/src/browser/segment-reconciler.ts +31 -21
- package/src/browser/server-action-bridge.ts +216 -38
- package/src/browser/types.ts +94 -22
- package/src/browser/validate-redirect-origin.ts +43 -16
- package/src/build/generate-manifest.ts +155 -131
- package/src/build/generate-route-types.ts +1 -1
- package/src/build/index.ts +11 -5
- package/src/build/prefix-tree-utils.ts +123 -0
- package/src/build/route-trie.ts +152 -22
- package/src/build/route-types/ast-route-extraction.ts +15 -8
- package/src/build/route-types/codegen.ts +12 -1
- package/src/build/route-types/include-resolution.ts +455 -61
- package/src/build/route-types/param-extraction.ts +6 -3
- package/src/build/route-types/per-module-writer.ts +15 -2
- package/src/build/route-types/router-processing.ts +77 -41
- package/src/build/route-types/source-scan.ts +105 -7
- package/src/build/runtime-discovery.ts +4 -1
- package/src/cache/cache-error.ts +104 -0
- package/src/cache/cache-key-utils.ts +58 -13
- package/src/cache/cache-policy.ts +108 -34
- package/src/cache/cache-runtime.ts +454 -101
- package/src/cache/cache-scope.ts +159 -54
- package/src/cache/cache-tag.ts +149 -0
- package/src/cache/cf/cf-base64.ts +33 -0
- package/src/cache/cf/cf-cache-constants.ts +127 -0
- package/src/cache/cf/cf-cache-store.ts +2170 -377
- package/src/cache/cf/cf-cache-types.ts +349 -0
- package/src/cache/cf/cf-kv-utils.ts +46 -0
- package/src/cache/cf/cf-tag-marker-memo.ts +105 -0
- package/src/cache/cf/index.ts +6 -16
- package/src/cache/document-cache.ts +126 -41
- package/src/cache/handle-snapshot.ts +70 -0
- package/src/cache/index.ts +23 -20
- package/src/cache/memory-segment-store.ts +243 -37
- package/src/cache/profile-registry.ts +46 -31
- package/src/cache/read-through-swr.ts +56 -12
- package/src/cache/segment-codec.ts +13 -21
- package/src/cache/shell-snapshot.ts +417 -0
- package/src/cache/tag-invalidation.ts +230 -0
- package/src/cache/types.ts +194 -99
- package/src/cache/vercel/index.ts +11 -0
- package/src/cache/vercel/vercel-cache-store.ts +1132 -0
- package/src/client.rsc.tsx +39 -22
- package/src/client.tsx +28 -58
- package/src/cloudflare/index.ts +11 -0
- package/src/cloudflare/tracing.ts +108 -0
- package/src/component-utils.ts +19 -0
- package/src/components/DefaultDocument.tsx +8 -2
- package/src/context-var.ts +13 -1
- package/src/decode-loader-results.ts +18 -2
- package/src/defer.ts +185 -0
- package/src/deps/ssr.ts +0 -1
- package/src/encode-kv.ts +49 -0
- package/src/errors.ts +0 -3
- package/src/escape-script.ts +52 -0
- package/src/handle.ts +57 -40
- package/src/handles/MetaTags.tsx +24 -53
- package/src/handles/Scripts.tsx +183 -0
- package/src/handles/breadcrumbs.ts +35 -8
- package/src/handles/deferred-resolution.ts +127 -0
- package/src/handles/is-thenable.ts +18 -0
- package/src/handles/meta.ts +14 -40
- package/src/handles/script.ts +244 -0
- package/src/host/cookie-handler.ts +9 -60
- package/src/host/errors.ts +13 -22
- package/src/host/index.ts +7 -0
- package/src/host/pattern-matcher.ts +23 -52
- package/src/host/router.ts +1 -65
- package/src/host/testing.ts +40 -27
- package/src/host/types.ts +6 -2
- package/src/href-client.ts +7 -12
- package/src/index.rsc.ts +88 -8
- package/src/index.ts +90 -16
- package/src/internal-debug.ts +11 -10
- package/src/loader.rsc.ts +19 -9
- package/src/loader.ts +12 -4
- package/src/outlet-provider.tsx +1 -5
- package/src/prerender/param-hash.ts +16 -16
- package/src/prerender/store.ts +32 -37
- package/src/prerender.ts +75 -7
- package/src/redirect-origin.ts +114 -0
- package/src/regex-escape.ts +8 -0
- package/src/render-error-thrower.tsx +20 -0
- package/src/response-utils.ts +25 -0
- package/src/root-error-boundary.tsx +1 -19
- package/src/route-content-wrapper.tsx +13 -49
- package/src/route-definition/dsl-helpers.ts +60 -53
- package/src/route-definition/helper-factories.ts +0 -2
- package/src/route-definition/helpers-types.ts +46 -46
- package/src/route-definition/index.ts +1 -2
- package/src/route-definition/redirect.ts +44 -11
- package/src/route-definition/resolve-handler-use.ts +6 -1
- package/src/route-definition/use-item-types.ts +3 -6
- package/src/route-map-builder.ts +41 -20
- package/src/route-types.ts +0 -5
- package/src/router/content-negotiation.ts +58 -23
- package/src/router/error-handling.ts +44 -17
- package/src/router/find-match.ts +129 -30
- package/src/router/handler-context.ts +6 -1
- package/src/router/instrument.ts +355 -0
- package/src/router/intercept-resolution.ts +35 -2
- package/src/router/lazy-includes.ts +79 -56
- package/src/router/loader-resolution.ts +151 -73
- package/src/router/logging.ts +0 -6
- package/src/router/manifest.ts +74 -40
- package/src/router/match-api.ts +76 -52
- package/src/router/match-context.ts +0 -22
- package/src/router/match-handlers.ts +181 -178
- package/src/router/match-middleware/background-revalidation.ts +40 -24
- package/src/router/match-middleware/cache-lookup.ts +115 -194
- package/src/router/match-middleware/cache-store.ts +61 -50
- package/src/router/match-middleware/intercept-resolution.ts +0 -22
- package/src/router/match-middleware/segment-resolution.ts +0 -22
- package/src/router/match-pipelines.ts +1 -42
- package/src/router/match-result.ts +36 -67
- package/src/router/metrics.ts +0 -34
- package/src/router/middleware-types.ts +0 -116
- package/src/router/middleware.ts +231 -120
- package/src/router/navigation-snapshot.ts +7 -56
- package/src/router/params-util.ts +23 -0
- package/src/router/parse-pattern.ts +115 -0
- package/src/router/pattern-matching.ts +99 -152
- package/src/router/prefetch-cache-ttl.ts +51 -0
- package/src/router/prefetch-limits.ts +37 -0
- package/src/router/prerender-match.ts +111 -66
- package/src/router/preview-match.ts +3 -1
- package/src/router/request-classification.ts +47 -42
- package/src/router/revalidation.ts +75 -81
- package/src/router/route-snapshot.ts +14 -3
- package/src/router/router-context.ts +6 -29
- package/src/router/router-interfaces.ts +70 -8
- package/src/router/router-options.ts +126 -4
- package/src/router/segment-resolution/fresh.ts +104 -80
- package/src/router/segment-resolution/helpers.ts +86 -6
- package/src/router/segment-resolution/loader-cache.ts +155 -39
- package/src/router/segment-resolution/loader-mask.ts +60 -0
- package/src/router/segment-resolution/loader-snapshot.ts +259 -0
- package/src/router/segment-resolution/mask-nested.ts +83 -0
- package/src/router/segment-resolution/revalidation.ts +215 -304
- package/src/router/segment-resolution/static-store.ts +19 -5
- package/src/router/segment-resolution/streamed-handler-telemetry.ts +52 -0
- package/src/router/segment-resolution/view-transition-default.ts +35 -15
- package/src/router/segment-resolution.ts +5 -1
- package/src/router/segment-wrappers.ts +6 -5
- package/src/router/state-cookie-name.ts +33 -0
- package/src/router/substitute-pattern-params.ts +54 -35
- package/src/router/telemetry-otel.ts +160 -200
- package/src/router/telemetry.ts +9 -23
- package/src/router/timeout.ts +0 -20
- package/src/router/tracing.ts +215 -0
- package/src/router/trie-matching.ts +171 -64
- package/src/router/types.ts +1 -63
- package/src/router/url-params.ts +13 -5
- package/src/router.ts +119 -48
- package/src/rsc/full-payload.ts +70 -0
- package/src/rsc/handler-context.ts +1 -0
- package/src/rsc/handler.ts +267 -152
- package/src/rsc/helpers.ts +78 -4
- package/src/rsc/index.ts +1 -4
- package/src/rsc/json-route-result.ts +38 -0
- package/src/rsc/loader-fetch.ts +114 -38
- package/src/rsc/manifest-init.ts +29 -42
- package/src/rsc/nonce.ts +10 -1
- package/src/rsc/origin-guard.ts +11 -15
- package/src/rsc/progressive-enhancement.ts +120 -13
- package/src/rsc/redirect-guard.ts +100 -0
- package/src/rsc/response-cache-serve.ts +238 -0
- package/src/rsc/response-error.ts +79 -12
- package/src/rsc/response-route-handler.ts +58 -141
- package/src/rsc/rsc-rendering.ts +492 -49
- package/src/rsc/runtime-warnings.ts +14 -0
- package/src/rsc/server-action.ts +268 -82
- package/src/rsc/shell-capture.ts +1190 -0
- package/src/rsc/shell-serve.ts +181 -0
- package/src/rsc/transition-gate.ts +89 -0
- package/src/rsc/types.ts +45 -3
- package/src/runtime-env.ts +18 -0
- package/src/search-params.ts +31 -26
- package/src/segment-loader-promise.ts +49 -4
- package/src/segment-system.tsx +260 -95
- package/src/server/context.ts +99 -9
- package/src/server/cookie-parse.ts +32 -0
- package/src/server/cookie-store.ts +125 -2
- package/src/server/handle-store.ts +21 -38
- package/src/server/loader-registry.ts +33 -42
- package/src/server/request-context.ts +379 -138
- package/src/ssr/index.tsx +491 -182
- package/src/ssr/inject-rsc-eager.ts +167 -0
- package/src/ssr/ssr-root.tsx +228 -0
- package/src/static-handler.ts +10 -13
- package/src/testing/cache-status.ts +44 -48
- package/src/testing/collect-handle.ts +14 -31
- package/src/testing/dispatch.ts +533 -160
- package/src/testing/e2e/fixture.ts +45 -11
- package/src/testing/e2e/index.ts +1 -22
- package/src/testing/e2e/matchers.ts +0 -16
- package/src/testing/e2e/parity.ts +85 -4
- package/src/testing/e2e/server.ts +12 -0
- package/src/testing/flight-matchers.ts +7 -14
- package/src/testing/flight-normalize.ts +11 -0
- package/src/testing/flight-runtime.d.ts +36 -0
- package/src/testing/flight-tree.ts +682 -0
- package/src/testing/flight.entry.ts +30 -0
- package/src/testing/flight.ts +145 -70
- package/src/testing/generated-routes.ts +26 -50
- package/src/testing/index.ts +18 -19
- package/src/testing/internal/context.ts +184 -68
- package/src/testing/internal/flight-client-globals.ts +30 -0
- package/src/testing/internal/seed-vars.ts +54 -0
- package/src/testing/render-handler.ts +357 -0
- package/src/testing/render-route.tsx +134 -115
- package/src/testing/run-loader.ts +140 -51
- package/src/testing/run-middleware.ts +59 -33
- package/src/testing/run-transition-when.ts +164 -0
- package/src/testing/vitest-stubs/cloudflare-email.ts +1 -1
- package/src/testing/vitest-stubs/cloudflare-workers.ts +1 -1
- package/src/testing/vitest.ts +138 -16
- package/src/theme/ThemeProvider.tsx +56 -84
- package/src/theme/ThemeScript.tsx +7 -9
- package/src/theme/constants.ts +52 -13
- package/src/theme/index.ts +0 -7
- package/src/theme/theme-context.ts +1 -5
- package/src/theme/theme-script.ts +22 -21
- package/src/theme/use-theme.ts +0 -3
- package/src/types/boundaries.ts +0 -35
- package/src/types/cache-types.ts +13 -4
- package/src/types/error-types.ts +30 -90
- package/src/types/global-namespace.ts +15 -15
- package/src/types/handler-context.ts +45 -15
- package/src/types/index.ts +2 -10
- package/src/types/loader-types.ts +6 -3
- package/src/types/request-scope.ts +8 -22
- package/src/types/route-config.ts +20 -52
- package/src/types/route-entry.ts +0 -6
- package/src/types/segments.ts +100 -13
- package/src/urls/include-helper.ts +10 -12
- package/src/urls/include-provider.ts +71 -0
- package/src/urls/index.ts +2 -8
- package/src/urls/path-helper-types.ts +52 -14
- package/src/urls/path-helper.ts +5 -54
- package/src/urls/pattern-types.ts +36 -0
- package/src/urls/type-extraction.ts +76 -42
- package/src/urls/urls-function.ts +0 -14
- package/src/use-loader.tsx +0 -186
- package/src/vercel/index.ts +11 -0
- package/src/vercel/tracing.ts +88 -0
- package/src/vite/discovery/bundle-postprocess.ts +2 -1
- package/src/vite/discovery/dev-prerender-cache.ts +117 -0
- package/src/vite/discovery/discover-routers.ts +34 -43
- package/src/vite/discovery/discovery-errors.ts +61 -0
- package/src/vite/discovery/prerender-collection.ts +33 -46
- package/src/vite/discovery/state.ts +12 -1
- package/src/vite/discovery/virtual-module-codegen.ts +1 -11
- package/src/vite/index.ts +9 -0
- package/src/vite/inject-client-debug.ts +88 -0
- package/src/vite/plugin-types.ts +143 -10
- package/src/vite/plugins/cjs-to-esm.ts +8 -12
- package/src/vite/plugins/client-ref-dedup.ts +0 -11
- package/src/vite/plugins/client-ref-hashing.ts +0 -10
- package/src/vite/plugins/cloudflare-protocol-stub.ts +0 -20
- package/src/vite/plugins/expose-action-id.ts +2 -73
- package/src/vite/plugins/expose-id-utils.ts +85 -56
- package/src/vite/plugins/expose-ids/export-analysis.ts +30 -43
- package/src/vite/plugins/expose-ids/handler-transform.ts +5 -31
- package/src/vite/plugins/expose-ids/loader-transform.ts +12 -20
- package/src/vite/plugins/expose-ids/router-transform.ts +98 -26
- package/src/vite/plugins/expose-internal-ids.ts +10 -1
- package/src/vite/plugins/performance-tracks.ts +0 -3
- package/src/vite/plugins/refresh-cmd.ts +1 -1
- package/src/vite/plugins/use-cache-transform.ts +21 -46
- package/src/vite/plugins/vercel-output.ts +384 -0
- package/src/vite/plugins/version-injector.ts +22 -27
- package/src/vite/plugins/version-plugin.ts +6 -66
- package/src/vite/plugins/virtual-entries.ts +137 -26
- package/src/vite/rango.ts +146 -135
- package/src/vite/router-discovery.ts +189 -48
- package/src/vite/utils/ast-handler-extract.ts +11 -20
- package/src/vite/utils/bundle-analysis.ts +6 -13
- package/src/vite/utils/client-chunks.ts +0 -6
- package/src/vite/utils/directive-prologue.ts +40 -0
- package/src/vite/utils/forward-user-plugins.ts +0 -22
- package/src/vite/utils/manifest-utils.ts +4 -75
- package/src/vite/utils/package-resolution.ts +1 -73
- package/src/vite/utils/prerender-utils.ts +71 -44
- package/src/vite/utils/shared-utils.ts +55 -37
- package/src/browser/react/use-client-cache.ts +0 -58
- package/src/browser/shallow.ts +0 -40
- package/src/handles/index.ts +0 -7
- package/src/network-error-thrower.tsx +0 -23
- package/src/router/middleware-cookies.ts +0 -55
package/src/router/find-match.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { tryTrieMatch } from "./trie-matching.js";
|
|
2
|
-
import {
|
|
2
|
+
import {
|
|
3
|
+
getRouterTrie,
|
|
4
|
+
isRouterTrieAuthoritative,
|
|
5
|
+
} from "../route-map-builder.js";
|
|
3
6
|
import {
|
|
4
7
|
findMatch as findRouteMatch,
|
|
5
8
|
isLazyEvaluationNeeded,
|
|
@@ -8,39 +11,55 @@ import {
|
|
|
8
11
|
import type { MetricsStore } from "../server/context";
|
|
9
12
|
import type { RouteEntry } from "../types";
|
|
10
13
|
|
|
14
|
+
// The single-entry cache is module-lifetime, keyed only on pathname, so the same
|
|
15
|
+
// result object is handed to every same-pathname request. ctx.params aliases
|
|
16
|
+
// this object, so handlers mutating it would corrupt the cache for later requests.
|
|
17
|
+
// Clone params; entry/flags are read-only and shared safely.
|
|
18
|
+
function cloneMatchResult<TEnv>(
|
|
19
|
+
r: RouteMatchResult<TEnv> | null,
|
|
20
|
+
): RouteMatchResult<TEnv> | null {
|
|
21
|
+
return r ? { ...r, params: { ...r.params } } : null;
|
|
22
|
+
}
|
|
23
|
+
|
|
11
24
|
export interface FindMatchDeps<TEnv = any> {
|
|
12
25
|
routesEntries: RouteEntry<TEnv>[];
|
|
13
|
-
|
|
26
|
+
// Returns a Promise only when it had to resolve an async include provider
|
|
27
|
+
// (`() => import()`); void for eager/precomputed includes, so the per-entry
|
|
28
|
+
// match loop pays no microtask in the common case.
|
|
29
|
+
evaluateLazyEntry: (entry: RouteEntry<TEnv>) => void | Promise<void>;
|
|
14
30
|
routerId: string;
|
|
15
31
|
}
|
|
16
32
|
|
|
17
33
|
/**
|
|
18
34
|
* Create a findMatch function bound to router state.
|
|
19
35
|
* Includes single-entry cache to avoid redundant matching within the same request.
|
|
36
|
+
*
|
|
37
|
+
* Async because a lazy include may be backed by an async provider
|
|
38
|
+
* (`() => import("./routes")`) that must be resolved before its routes can be
|
|
39
|
+
* matched. The hot path is unaffected: `await` only suspends on the first
|
|
40
|
+
* request to a not-yet-loaded dynamic include; eager routes resolve in the same
|
|
41
|
+
* microtask. Every caller already runs inside an async match pipeline.
|
|
20
42
|
*/
|
|
21
43
|
export function createFindMatch<TEnv = any>(
|
|
22
44
|
deps: FindMatchDeps<TEnv>,
|
|
23
|
-
): (
|
|
45
|
+
): (
|
|
46
|
+
pathname: string,
|
|
47
|
+
ms?: MetricsStore,
|
|
48
|
+
) => Promise<RouteMatchResult<TEnv> | null> {
|
|
24
49
|
// Single-entry cache for findMatch to avoid redundant matching within the same request.
|
|
25
50
|
// previewMatch and match both call findMatch with the same pathname — this ensures
|
|
26
51
|
// the route matching work (which may check thousands of routes) only happens once.
|
|
27
52
|
let lastFindMatchPathname: string | null = null;
|
|
28
53
|
let lastFindMatchResult: RouteMatchResult<TEnv> | null = null;
|
|
29
54
|
|
|
30
|
-
|
|
31
|
-
// Handles lazy evaluation by evaluating lazy entries on first match.
|
|
32
|
-
// Phase 1: try O(path_length) trie match.
|
|
33
|
-
// Phase 2: fall back to regex iteration.
|
|
34
|
-
return function findMatch(
|
|
55
|
+
return async function findMatch(
|
|
35
56
|
pathname: string,
|
|
36
57
|
ms?: MetricsStore,
|
|
37
|
-
): RouteMatchResult<TEnv> | null {
|
|
38
|
-
// Return cached result if same pathname (avoids double-match per request)
|
|
58
|
+
): Promise<RouteMatchResult<TEnv> | null> {
|
|
39
59
|
if (lastFindMatchPathname === pathname) {
|
|
40
|
-
return lastFindMatchResult;
|
|
60
|
+
return cloneMatchResult(lastFindMatchResult);
|
|
41
61
|
}
|
|
42
62
|
|
|
43
|
-
// Helper to push sub-metrics
|
|
44
63
|
const pushMetric = ms
|
|
45
64
|
? (label: string, start: number) => {
|
|
46
65
|
ms.metrics.push({
|
|
@@ -51,17 +70,15 @@ export function createFindMatch<TEnv = any>(
|
|
|
51
70
|
}
|
|
52
71
|
: undefined;
|
|
53
72
|
|
|
54
|
-
// Phase 1: Try trie match (O(path_length))
|
|
55
|
-
// Only use the per-router trie. The global trie merges routes from ALL
|
|
56
|
-
// routers and must not be used — in multi-router setups (host routing)
|
|
57
|
-
// overlapping paths like "/" would match the wrong app's route.
|
|
58
73
|
const routeTrie = getRouterTrie(deps.routerId);
|
|
74
|
+
let trieMatched = false;
|
|
59
75
|
if (routeTrie) {
|
|
60
76
|
const trieStart = performance.now();
|
|
61
77
|
const trieResult = tryTrieMatch(routeTrie, pathname);
|
|
62
78
|
pushMetric?.("match:trie", trieStart);
|
|
63
79
|
|
|
64
80
|
if (trieResult) {
|
|
81
|
+
trieMatched = true;
|
|
65
82
|
// Find the RouteEntry that contains this route.
|
|
66
83
|
// Multiple entries can share the same staticPrefix (e.g., several
|
|
67
84
|
// include("/", patterns) calls all produce staticPrefix=""). Evaluate
|
|
@@ -69,11 +86,33 @@ export function createFindMatch<TEnv = any>(
|
|
|
69
86
|
const entryStart = performance.now();
|
|
70
87
|
let entry: RouteEntry<TEnv> | undefined;
|
|
71
88
|
let fallbackEntry: RouteEntry<TEnv> | undefined;
|
|
89
|
+
let candidateError: unknown;
|
|
90
|
+
let candidateFailed = false;
|
|
72
91
|
|
|
73
92
|
for (const e of deps.routesEntries) {
|
|
74
93
|
if (e.staticPrefix !== trieResult.sp) continue;
|
|
75
94
|
if (!fallbackEntry) fallbackEntry = e;
|
|
76
|
-
|
|
95
|
+
try {
|
|
96
|
+
const ev = deps.evaluateLazyEntry(e);
|
|
97
|
+
if (ev) await ev;
|
|
98
|
+
} catch (err) {
|
|
99
|
+
// Multiple async includes can share one collapsed static prefix, so
|
|
100
|
+
// this loop may evaluate a candidate that is NOT the route's owner.
|
|
101
|
+
// Remember the failure and keep scanning: if another candidate owns
|
|
102
|
+
// the route, this sibling's failure is correctly isolated (its
|
|
103
|
+
// _lazyInflight was cleared, so a later request retries). But if NO
|
|
104
|
+
// candidate ends up owning it, the failing one WAS the owner — a
|
|
105
|
+
// real, trie-matched route whose module failed to import — and we
|
|
106
|
+
// rethrow below as a 5xx rather than silently 404ing (see finding 3:
|
|
107
|
+
// owner failure must stay loud).
|
|
108
|
+
candidateError = err;
|
|
109
|
+
candidateFailed = true;
|
|
110
|
+
console.error(
|
|
111
|
+
`[@rangojs/router] include at "${e.staticPrefix}" failed to load: ` +
|
|
112
|
+
`${(err as Error)?.message ?? String(err)}`,
|
|
113
|
+
);
|
|
114
|
+
continue;
|
|
115
|
+
}
|
|
77
116
|
if (
|
|
78
117
|
e.routes &&
|
|
79
118
|
trieResult.routeKey in (e.routes as Record<string, unknown>)
|
|
@@ -83,12 +122,16 @@ export function createFindMatch<TEnv = any>(
|
|
|
83
122
|
}
|
|
84
123
|
}
|
|
85
124
|
|
|
86
|
-
//
|
|
87
|
-
//
|
|
88
|
-
//
|
|
125
|
+
// The trie matched this route, so it EXISTS. If no same-prefix candidate
|
|
126
|
+
// could own it AND one failed to load, the owning module is the one that
|
|
127
|
+
// threw — surface the module failure as a 5xx, not the misleading 404 a
|
|
128
|
+
// fallthrough would give.
|
|
129
|
+
if (!entry && candidateFailed) {
|
|
130
|
+
throw candidateError;
|
|
131
|
+
}
|
|
132
|
+
|
|
89
133
|
if (!entry) entry = fallbackEntry;
|
|
90
134
|
|
|
91
|
-
// If entry not found (nested include not yet discovered), evaluate parent
|
|
92
135
|
if (!entry) {
|
|
93
136
|
const parent = deps.routesEntries.find(
|
|
94
137
|
(e) =>
|
|
@@ -97,7 +140,8 @@ export function createFindMatch<TEnv = any>(
|
|
|
97
140
|
);
|
|
98
141
|
if (parent) {
|
|
99
142
|
const lazyStart = performance.now();
|
|
100
|
-
deps.evaluateLazyEntry(parent);
|
|
143
|
+
const ev = deps.evaluateLazyEntry(parent);
|
|
144
|
+
if (ev) await ev;
|
|
101
145
|
pushMetric?.("match:lazy-eval", lazyStart);
|
|
102
146
|
}
|
|
103
147
|
entry = deps.routesEntries.find(
|
|
@@ -112,9 +156,7 @@ export function createFindMatch<TEnv = any>(
|
|
|
112
156
|
entry,
|
|
113
157
|
routeKey: trieResult.routeKey,
|
|
114
158
|
params: trieResult.params,
|
|
115
|
-
optionalParams: new Set(trieResult.optionalParams || []),
|
|
116
159
|
redirectTo: trieResult.redirectTo,
|
|
117
|
-
ancestry: trieResult.ancestry,
|
|
118
160
|
...(trieResult.pr ? { pr: true } : {}),
|
|
119
161
|
...(trieResult.pt ? { pt: true } : {}),
|
|
120
162
|
...(trieResult.responseType
|
|
@@ -125,17 +167,25 @@ export function createFindMatch<TEnv = any>(
|
|
|
125
167
|
: {}),
|
|
126
168
|
...(trieResult.rscFirst ? { rscFirst: true } : {}),
|
|
127
169
|
};
|
|
128
|
-
return lastFindMatchResult;
|
|
170
|
+
return cloneMatchResult(lastFindMatchResult);
|
|
129
171
|
}
|
|
172
|
+
} else if (isRouterTrieAuthoritative(deps.routerId)) {
|
|
173
|
+
// Authoritative miss (#664): this trie was deserialized from the
|
|
174
|
+
// COMPLETE build manifest, so trailing-slash redirects are already
|
|
175
|
+
// trie-native hits and a miss means no route exists. Skip the regex
|
|
176
|
+
// fallback — the only route-count-proportional match path — and do
|
|
177
|
+
// not evaluate lazy includes for unmatched (bot-probe) traffic.
|
|
178
|
+
// Trie hits that need lazy splicing keep the fallback loop below
|
|
179
|
+
// (trieMatched === true never reaches this branch).
|
|
180
|
+
lastFindMatchPathname = pathname;
|
|
181
|
+
lastFindMatchResult = null;
|
|
182
|
+
return null;
|
|
130
183
|
}
|
|
131
184
|
}
|
|
132
185
|
|
|
133
|
-
// Phase 2: Fall back to existing matching (regex iteration)
|
|
134
186
|
const regexStart = performance.now();
|
|
135
187
|
let result = findRouteMatch(pathname, deps.routesEntries);
|
|
136
188
|
|
|
137
|
-
// If we hit a lazy entry that needs evaluation, evaluate and retry.
|
|
138
|
-
// Cap iterations to prevent infinite loops from pathological nesting.
|
|
139
189
|
const MAX_LAZY_ITERATIONS = 100;
|
|
140
190
|
let iterations = 0;
|
|
141
191
|
while (isLazyEvaluationNeeded(result)) {
|
|
@@ -148,13 +198,62 @@ export function createFindMatch<TEnv = any>(
|
|
|
148
198
|
lastFindMatchResult = null;
|
|
149
199
|
return null;
|
|
150
200
|
}
|
|
151
|
-
|
|
201
|
+
try {
|
|
202
|
+
const ev = deps.evaluateLazyEntry(result.lazyEntry);
|
|
203
|
+
if (ev) await ev;
|
|
204
|
+
} catch (err) {
|
|
205
|
+
// If the trie matched this pathname, the route is REAL and this lazy
|
|
206
|
+
// entry owns (part of) it — a module-load failure is a genuine error, so
|
|
207
|
+
// propagate it as a 5xx. If the trie did NOT match, this is a
|
|
208
|
+
// genuinely-unmatched pathname (a typo, a bot probe): its 404 must not be
|
|
209
|
+
// upgraded to a 500 just because some lazy include — e.g. a failing root
|
|
210
|
+
// `include("/")` — happened to need evaluating while we probed. Isolate
|
|
211
|
+
// and fall through to the 404 (finding 4: the two match phases agree —
|
|
212
|
+
// owner failure is loud, unmatched stays 404).
|
|
213
|
+
if (trieMatched) throw err;
|
|
214
|
+
console.error(
|
|
215
|
+
`[@rangojs/router] include at "${result.lazyEntry.staticPrefix}" ` +
|
|
216
|
+
`failed to load while resolving unmatched path "${pathname}": ` +
|
|
217
|
+
`${(err as Error)?.message ?? String(err)}`,
|
|
218
|
+
);
|
|
219
|
+
lastFindMatchPathname = pathname;
|
|
220
|
+
lastFindMatchResult = null;
|
|
221
|
+
return null;
|
|
222
|
+
}
|
|
152
223
|
result = findRouteMatch(pathname, deps.routesEntries);
|
|
153
224
|
}
|
|
154
225
|
pushMetric?.("match:regex-fallback", regexStart);
|
|
155
226
|
|
|
227
|
+
// The trie is the single source of truth and is built before findMatch in
|
|
228
|
+
// both dev (handler rebuild) and production (ensureRouterManifest). If the
|
|
229
|
+
// trie was present yet the regex fallback resolved a real match, the trie
|
|
230
|
+
// has a gap (e.g. a route shape it cannot represent) and dev/prod could
|
|
231
|
+
// diverge if the trie were ever absent. Surface it in dev; folded out in
|
|
232
|
+
// production builds.
|
|
233
|
+
//
|
|
234
|
+
// Suppress when the trie DID match (`trieMatched`): that path falls through
|
|
235
|
+
// to the regex fallback only on the first request to a not-yet-spliced lazy
|
|
236
|
+
// entry (e.g. a 2+-level nested include whose deeper parent has not been
|
|
237
|
+
// evaluated). The trie knew the route; runtime lazy discovery simply lagged.
|
|
238
|
+
// That is the supported lazy-include flow, not a trie gap, so warning on it
|
|
239
|
+
// is a false positive (it manufactures bug reports and erodes the signal).
|
|
240
|
+
if (
|
|
241
|
+
process.env.NODE_ENV !== "production" &&
|
|
242
|
+
routeTrie &&
|
|
243
|
+
!trieMatched &&
|
|
244
|
+
result &&
|
|
245
|
+
!isLazyEvaluationNeeded(result)
|
|
246
|
+
) {
|
|
247
|
+
console.warn(
|
|
248
|
+
`[@rangojs/router] Route "${pathname}" resolved via the regex fallback ` +
|
|
249
|
+
`even though the route trie was present. The trie should be the single ` +
|
|
250
|
+
`matching source of truth; this indicates a trie gap. Please report this ` +
|
|
251
|
+
`with your route configuration.`,
|
|
252
|
+
);
|
|
253
|
+
}
|
|
254
|
+
|
|
156
255
|
lastFindMatchPathname = pathname;
|
|
157
256
|
lastFindMatchResult = result;
|
|
158
|
-
return result;
|
|
257
|
+
return cloneMatchResult(result);
|
|
159
258
|
};
|
|
160
259
|
}
|
|
@@ -21,6 +21,11 @@ import { PRERENDER_PASSTHROUGH } from "../prerender.js";
|
|
|
21
21
|
import { substitutePatternParams } from "./substitute-pattern-params.js";
|
|
22
22
|
import { fireAndForgetWaitUntil } from "../types/request-scope.js";
|
|
23
23
|
|
|
24
|
+
// Mutating Headers methods guarded so they throw inside "use cache" / cache()
|
|
25
|
+
// scope. Module-level constant (read-only, .has() lookups) so it is allocated
|
|
26
|
+
// once at module load instead of per createHandlerContext (per-request) call.
|
|
27
|
+
const MUTATING_HEADERS_METHODS = new Set(["set", "append", "delete"]);
|
|
28
|
+
|
|
24
29
|
/**
|
|
25
30
|
* Strip internal _rsc* query params from a URL.
|
|
26
31
|
* Returns a new URL with only user-facing params.
|
|
@@ -212,7 +217,7 @@ export function createHandlerContext<TEnv>(
|
|
|
212
217
|
// Guard mutating Headers methods so they throw inside "use cache" or cache() scope.
|
|
213
218
|
// Uses lazy `ctx` reference (assigned below) — only the specific handler ctx
|
|
214
219
|
// is stamped by cache-runtime, not the shared request context.
|
|
215
|
-
|
|
220
|
+
// MUTATING_HEADERS_METHODS is hoisted to module scope (constant, read-only).
|
|
216
221
|
let ctx: InternalHandlerContext<any, TEnv>;
|
|
217
222
|
const guardedHeaders = new Proxy(stubResponse.headers, {
|
|
218
223
|
get(target, prop, receiver) {
|
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Phase + event instrumentation — the single internal API for observing router
|
|
3
|
+
* work.
|
|
4
|
+
*
|
|
5
|
+
* The router exposes the same work on three surfaces, and the rule is: each
|
|
6
|
+
* surface has exactly one owner here, so they cannot drift.
|
|
7
|
+
*
|
|
8
|
+
* - observePhase(): a span of work. Co-emits the `debugPerformance` perf
|
|
9
|
+
* metric (metrics store -> [RSC Perf] timeline + Server-Timing) AND the
|
|
10
|
+
* platform span (tracing runner -> Cloudflare custom spans / OTel). From one
|
|
11
|
+
* wrap site, so the span set is always a subset of the perf phases and the
|
|
12
|
+
* two can't disagree. Phases that meter their own perf metric with a finer
|
|
13
|
+
* decomposition (request, middleware) pass `metric: false` and get the span
|
|
14
|
+
* only — still co-located, still one owner per surface.
|
|
15
|
+
* - observeEvent(): a discrete fact (TelemetrySink): cache decisions,
|
|
16
|
+
* revalidation decisions, handler errors, timeouts, origin rejections.
|
|
17
|
+
* Event-shaped, not phase-shaped — derived from the same call sites but a
|
|
18
|
+
* separate surface from spans.
|
|
19
|
+
*
|
|
20
|
+
* Why phases, not events, are the parent abstraction: Cloudflare's span API is
|
|
21
|
+
* callback-bound (enterSpan wraps the actual work), so the callback boundary is
|
|
22
|
+
* the source of truth — async-context nesting (a loader's KV/D1/fetch spans
|
|
23
|
+
* landing under rango.loader) cannot be faithfully reconstructed from
|
|
24
|
+
* after-the-fact start/end events. Spans drive; events are emitted alongside.
|
|
25
|
+
*
|
|
26
|
+
* Phase identity lives in the PHASES registry below, so the raw `rango.*` span
|
|
27
|
+
* names, perf-metric labels, and span attributes have a single definition each.
|
|
28
|
+
*
|
|
29
|
+
* When neither perf surface nor tracing is active on the request, observePhase
|
|
30
|
+
* is a direct call — no wrapper, no timestamp, no allocation.
|
|
31
|
+
*/
|
|
32
|
+
|
|
33
|
+
import { _getRequestContext } from "../server/request-context.js";
|
|
34
|
+
import { isAutoGeneratedRouteName } from "../route-name.js";
|
|
35
|
+
import { getRouterContext } from "./router-context.js";
|
|
36
|
+
import { resolveSink, safeEmit, type TelemetryEvent } from "./telemetry.js";
|
|
37
|
+
import { appendMetric } from "./metrics.js";
|
|
38
|
+
import { type MetricsStore } from "../server/context.js";
|
|
39
|
+
import {
|
|
40
|
+
NOOP_TRACE_SPAN,
|
|
41
|
+
traceSpan,
|
|
42
|
+
runThenSettle,
|
|
43
|
+
type TracePhase,
|
|
44
|
+
type TraceSpan,
|
|
45
|
+
} from "./tracing.js";
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Perf-metric boundary for a phase, or `false` for span-only. `false` means the
|
|
49
|
+
* caller records its own perf metric with a finer decomposition than a single
|
|
50
|
+
* wrap (request: a grand total incl. pre-context bootstrap; middleware: pre/post
|
|
51
|
+
* own-time), so observePhase opens the span but records no metric of its own.
|
|
52
|
+
*/
|
|
53
|
+
export type PhaseMetric =
|
|
54
|
+
| { label: string | (() => string); depth?: number }
|
|
55
|
+
| false;
|
|
56
|
+
|
|
57
|
+
/** Describes one observable phase across the perf and span surfaces. */
|
|
58
|
+
export interface PhaseSpec {
|
|
59
|
+
/** Perf timeline label + Server-Timing name, or false for span-only. */
|
|
60
|
+
metric: PhaseMetric;
|
|
61
|
+
/** Span phase gate (per-phase toggle in the tracing config). */
|
|
62
|
+
tracePhase: TracePhase;
|
|
63
|
+
/** Span name (rango.*). */
|
|
64
|
+
spanName: string;
|
|
65
|
+
/** Span attributes set automatically when the span opens. */
|
|
66
|
+
attributes?: Record<string, string | number | boolean>;
|
|
67
|
+
/**
|
|
68
|
+
* Span attributes resolved AFTER the wrapped work runs (so they can read state
|
|
69
|
+
* that only exists once the work is underway, e.g. the matched route name).
|
|
70
|
+
* Applied for streaming phases once fn has constructed its value. Return
|
|
71
|
+
* undefined to add nothing.
|
|
72
|
+
*/
|
|
73
|
+
lazyAttributes?: () => Record<string, string | number | boolean> | undefined;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* The matched route name for the current request, or undefined when there is no
|
|
78
|
+
* named route (unmatched / auto-generated). Shared by the render phase's metric
|
|
79
|
+
* label and its rango.route span attribute so the two can't disagree.
|
|
80
|
+
*/
|
|
81
|
+
function currentRouteName(): string | undefined {
|
|
82
|
+
const routeName = _getRequestContext()?._routeName;
|
|
83
|
+
return routeName && !isAutoGeneratedRouteName(routeName)
|
|
84
|
+
? routeName
|
|
85
|
+
: undefined;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* The router's observable phases. One definition per phase keeps the `rango.*`
|
|
90
|
+
* span names, perf-metric labels, and identifying attributes from spreading
|
|
91
|
+
* across call sites.
|
|
92
|
+
*/
|
|
93
|
+
export const PHASES = {
|
|
94
|
+
/** Whole request pipeline. Span only — handler:total is metered directly. */
|
|
95
|
+
request: {
|
|
96
|
+
metric: false,
|
|
97
|
+
tracePhase: "request",
|
|
98
|
+
spanName: "rango.request",
|
|
99
|
+
} as PhaseSpec,
|
|
100
|
+
|
|
101
|
+
/** One middleware (incl. its downstream onion). Span only — the perf metric
|
|
102
|
+
* is the middleware's exclusive pre/post own-time, recorded directly.
|
|
103
|
+
* `metricLabel` is that metric's label (e.g. "middleware:auth@*"); it doubles
|
|
104
|
+
* as the rango.middleware_name span attribute. */
|
|
105
|
+
middleware: (metricLabel: string): PhaseSpec => ({
|
|
106
|
+
metric: false,
|
|
107
|
+
tracePhase: "middleware",
|
|
108
|
+
spanName: "rango.middleware",
|
|
109
|
+
attributes: { "rango.middleware_name": metricLabel },
|
|
110
|
+
}),
|
|
111
|
+
|
|
112
|
+
/** The server-action execution (decode args + run the action body), before
|
|
113
|
+
* the revalidation render. The metric label carries the action id (the
|
|
114
|
+
* _rsc_action / action $$id) so the perf timeline shows WHICH action ran, not
|
|
115
|
+
* just "an action"; the span also gets it as rango.action_id. */
|
|
116
|
+
action: (id: string): PhaseSpec => ({
|
|
117
|
+
metric: { label: `action:${id}` },
|
|
118
|
+
tracePhase: "action",
|
|
119
|
+
spanName: "rango.action",
|
|
120
|
+
attributes: { "rango.action_id": id },
|
|
121
|
+
}),
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* One loader execution. `depth` is the perf-timeline indentation: 2 (default)
|
|
125
|
+
* for render-time loaders that nest under the render phase; 1 for a standalone
|
|
126
|
+
* fetchable `_rsc_loader` request, which has no render parent.
|
|
127
|
+
*/
|
|
128
|
+
loader: (id: string, depth: number = 2): PhaseSpec => ({
|
|
129
|
+
metric: { label: `loader:${id}`, depth },
|
|
130
|
+
tracePhase: "loader",
|
|
131
|
+
spanName: "rango.loader",
|
|
132
|
+
attributes: { "rango.loader_id": id },
|
|
133
|
+
}),
|
|
134
|
+
|
|
135
|
+
/** One segment route/layout handler execution (the component/handler that
|
|
136
|
+
* produces a segment). Span only — the perf metric (handler:<id>) is owned by
|
|
137
|
+
* the legacy track() at the same call site, so observePhase here adds the
|
|
138
|
+
* rango.handler span without double-recording. `id` is the HANDLER id (the
|
|
139
|
+
* entry.id used in the handler:<id> perf row), carried as rango.handler_id —
|
|
140
|
+
* NOT the emitted segment's id (shortCode), which differs; the *_id naming
|
|
141
|
+
* mirrors rango.loader_id / rango.action_id. */
|
|
142
|
+
handler: (id: string): PhaseSpec => ({
|
|
143
|
+
metric: false,
|
|
144
|
+
tracePhase: "handler",
|
|
145
|
+
spanName: "rango.handler",
|
|
146
|
+
attributes: { "rango.handler_id": id },
|
|
147
|
+
}),
|
|
148
|
+
|
|
149
|
+
/** Whole render phase: match + serialize + SSR. The metric label is resolved
|
|
150
|
+
* lazily at record time (after match has set the route name) so the perf
|
|
151
|
+
* timeline shows WHICH route rendered: `render:total:<routeName>`, falling back
|
|
152
|
+
* to `render:total` when there is no named route (unmatched / auto-generated). */
|
|
153
|
+
render: {
|
|
154
|
+
metric: {
|
|
155
|
+
label: () => {
|
|
156
|
+
const routeName = currentRouteName();
|
|
157
|
+
return routeName ? `render:total:${routeName}` : "render:total";
|
|
158
|
+
},
|
|
159
|
+
},
|
|
160
|
+
tracePhase: "render",
|
|
161
|
+
spanName: "rango.render",
|
|
162
|
+
// Tag the render span with the matched route so the Cloudflare/OTel waterfall
|
|
163
|
+
// shows WHICH route rendered (rango.render + rango.route=index), resolved
|
|
164
|
+
// after match has run. Kept an attribute (not baked into the span name) so the
|
|
165
|
+
// span name stays low-cardinality and aggregatable across routes.
|
|
166
|
+
lazyAttributes: () => {
|
|
167
|
+
const routeName = currentRouteName();
|
|
168
|
+
return routeName ? { "rango.route": routeName } : undefined;
|
|
169
|
+
},
|
|
170
|
+
} as PhaseSpec,
|
|
171
|
+
|
|
172
|
+
/** SSR HTML render from the RSC stream. Colon-delimited like the other ssr:*
|
|
173
|
+
* setup metrics (ssr:module-load / ssr:stream-mode). */
|
|
174
|
+
ssr: {
|
|
175
|
+
metric: { label: "ssr:render-html" },
|
|
176
|
+
tracePhase: "ssr",
|
|
177
|
+
spanName: "rango.ssr",
|
|
178
|
+
} as PhaseSpec,
|
|
179
|
+
} as const;
|
|
180
|
+
|
|
181
|
+
/** Apply a phase spec's static attributes to a span (the no-op span ignores them). */
|
|
182
|
+
function applyAttributes(
|
|
183
|
+
span: TraceSpan,
|
|
184
|
+
attributes: Record<string, string | number | boolean>,
|
|
185
|
+
): void {
|
|
186
|
+
for (const key in attributes) span.setAttribute(key, attributes[key]);
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Record a phase's perf metric for the interval [start, now]. The label may be
|
|
191
|
+
* lazy (resolved here, e.g. render:total needs the route name that match sets
|
|
192
|
+
* partway through the wrapped work).
|
|
193
|
+
*/
|
|
194
|
+
function recordPhaseMetric(
|
|
195
|
+
store: MetricsStore,
|
|
196
|
+
metric: Exclude<PhaseMetric, false>,
|
|
197
|
+
start: number,
|
|
198
|
+
): void {
|
|
199
|
+
const label =
|
|
200
|
+
typeof metric.label === "function" ? metric.label() : metric.label;
|
|
201
|
+
appendMetric(store, label, start, performance.now() - start, metric.depth);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Instrument one unit of work: open its span AND (unless `metric: false`) record
|
|
206
|
+
* its perf metric, from a single wrap site. fn is invoked exactly once with the
|
|
207
|
+
* span (a no-op span when tracing is off); its return value is returned
|
|
208
|
+
* unchanged and thrown errors / rejected promises propagate unchanged. When fn
|
|
209
|
+
* returns a promise both the metric duration and the span end when it settles.
|
|
210
|
+
*
|
|
211
|
+
* This is the ONLY phase primitive: every phase (request/middleware/action/
|
|
212
|
+
* loader/handler/render/ssr) is construction-bound — the span and metric settle
|
|
213
|
+
* when fn's own work completes (for the streaming phases, when the RSC/HTML
|
|
214
|
+
* stream is constructed, NOT when the body drains). Instrumentation is strictly
|
|
215
|
+
* best-effort: it never wraps or buffers the response and adds no work on the
|
|
216
|
+
* streaming path, so it cannot regress response latency or streaming. A loader
|
|
217
|
+
* that resolves while the body streams therefore keeps a rango.loader span that
|
|
218
|
+
* may extend past its render parent — overlapping spans are valid; the loader
|
|
219
|
+
* really did take that long.
|
|
220
|
+
*
|
|
221
|
+
* Reads the metrics store + tracing off the RequestContext ALS, which is active
|
|
222
|
+
* for the WHOLE request — contrast observeEvent, which reads the RouterContext
|
|
223
|
+
* ALS (entered later, during match).
|
|
224
|
+
*/
|
|
225
|
+
export function observePhase<T>(
|
|
226
|
+
spec: PhaseSpec,
|
|
227
|
+
fn: (span: TraceSpan) => T,
|
|
228
|
+
): T {
|
|
229
|
+
const reqCtx = _getRequestContext();
|
|
230
|
+
const store = reqCtx?._metricsStore;
|
|
231
|
+
const tracing = reqCtx?._tracing;
|
|
232
|
+
|
|
233
|
+
// Neither surface active: direct call, zero overhead.
|
|
234
|
+
if (!store && !tracing) return fn(NOOP_TRACE_SPAN);
|
|
235
|
+
|
|
236
|
+
// Attributes only land on a real span. Build the attribute/lazy wrapper only
|
|
237
|
+
// when this phase's span is actually enabled (not toggled off via `spans`), and
|
|
238
|
+
// short-circuit inside when the runner hands back the no-op span (tracing
|
|
239
|
+
// configured but off at runtime — e.g. no executionContext.tracing). That keeps
|
|
240
|
+
// the "configured but effectively off" path free of per-call attribute loops
|
|
241
|
+
// and lazy `.then()` allocations. `lazyAttributes` resolve AFTER fn runs (e.g.
|
|
242
|
+
// rango.route, known post-match) and apply on BOTH success and failure so an
|
|
243
|
+
// errored phase span is still tagged.
|
|
244
|
+
const attributes = spec.attributes;
|
|
245
|
+
const lazy = spec.lazyAttributes;
|
|
246
|
+
const spanEnabled =
|
|
247
|
+
tracing !== undefined && tracing.phases[spec.tracePhase] !== false;
|
|
248
|
+
const wrapped: (span: TraceSpan) => T =
|
|
249
|
+
(attributes || lazy) && spanEnabled
|
|
250
|
+
? (span) => {
|
|
251
|
+
if (span === NOOP_TRACE_SPAN) return fn(span);
|
|
252
|
+
if (attributes) applyAttributes(span, attributes);
|
|
253
|
+
// A SYNCHRONOUS throw from fn skips applyLate — fine by design: the only
|
|
254
|
+
// lazyAttributes phase (render) is always async, so any internal throw
|
|
255
|
+
// surfaces as a rejection that the onReject branch below DOES tag. If a
|
|
256
|
+
// sync lazyAttributes phase is ever added, wrap this in try/catch.
|
|
257
|
+
const out = fn(span);
|
|
258
|
+
if (!lazy) return out;
|
|
259
|
+
const applyLate = () => {
|
|
260
|
+
const late = lazy();
|
|
261
|
+
if (late) applyAttributes(span, late);
|
|
262
|
+
};
|
|
263
|
+
if (out instanceof Promise) {
|
|
264
|
+
return out.then(
|
|
265
|
+
(value) => {
|
|
266
|
+
applyLate();
|
|
267
|
+
return value;
|
|
268
|
+
},
|
|
269
|
+
(error) => {
|
|
270
|
+
applyLate();
|
|
271
|
+
throw error;
|
|
272
|
+
},
|
|
273
|
+
) as T;
|
|
274
|
+
}
|
|
275
|
+
applyLate();
|
|
276
|
+
return out;
|
|
277
|
+
}
|
|
278
|
+
: fn;
|
|
279
|
+
|
|
280
|
+
const runSpan = (): T =>
|
|
281
|
+
traceSpan(tracing, spec.tracePhase, spec.spanName, wrapped);
|
|
282
|
+
|
|
283
|
+
// Span-only — no perf metric to record (metric:false, or perf surface off).
|
|
284
|
+
const metric = spec.metric;
|
|
285
|
+
if (!store || metric === false) return runSpan();
|
|
286
|
+
|
|
287
|
+
// Record the phase duration on EVERY termination — success or failure — so a
|
|
288
|
+
// failed loader/render still shows its timing in the perf report (parity with
|
|
289
|
+
// the old track().finally() path it replaced).
|
|
290
|
+
const start = performance.now();
|
|
291
|
+
return runThenSettle(runSpan, () => recordPhaseMetric(store, metric, start));
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Open a rango.handler span around one segment route/layout handler call. The
|
|
296
|
+
* segment-resolution hot path runs this PER SEGMENT, so it gates on the SPAN
|
|
297
|
+
* surface alone and calls the handler directly otherwise — building neither the
|
|
298
|
+
* PhaseSpec (PHASES.handler allocates) nor the wrapper closure on the off path.
|
|
299
|
+
* The handler:<id> perf metric is owned by the track() at the call site, so the
|
|
300
|
+
* span is the only surface this adds (metric:false); a debugPerformance-only
|
|
301
|
+
* request (no tracing) or a disabled handler phase (spans:{handler:false}) has
|
|
302
|
+
* nothing to record here and short-circuits.
|
|
303
|
+
*/
|
|
304
|
+
export function observeHandler<C, R>(
|
|
305
|
+
id: string,
|
|
306
|
+
handler: (ctx: C) => R,
|
|
307
|
+
ctx: C,
|
|
308
|
+
): R {
|
|
309
|
+
const tracing = _getRequestContext()?._tracing;
|
|
310
|
+
if (!tracing || tracing.phases.handler === false) return handler(ctx);
|
|
311
|
+
return observePhase(PHASES.handler(id), () => handler(ctx));
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Emit one discrete telemetry event (the event-shaped counterpart to
|
|
316
|
+
* observePhase). Resolves the sink from the active router context and stamps the
|
|
317
|
+
* request id when the event omits it. No-op (and total — never throws) when no
|
|
318
|
+
* sink is configured.
|
|
319
|
+
*
|
|
320
|
+
* This is the canonical emitter for SYNCHRONOUS facts that fire inside the
|
|
321
|
+
* request's ALS scope (revalidation decisions, cache-lookup decisions). A few
|
|
322
|
+
* emitters deliberately stay on the lower-level resolveSink + safeEmit because
|
|
323
|
+
* observeEvent's lazy, per-call getRouterContext() read does not fit them — keep
|
|
324
|
+
* this the complete list:
|
|
325
|
+
* - router.ts wrapLoaderPromise (loader.start/end/error) and
|
|
326
|
+
* segment-resolution/streamed-handler-telemetry.ts (streamed handler.error)
|
|
327
|
+
* capture the sink + request id EAGERLY and emit from a fire-and-forget
|
|
328
|
+
* continuation that runs after the ALS scope may have unwound.
|
|
329
|
+
* - router/match-handlers.ts resolves the sink ONCE for the hot match-pipeline
|
|
330
|
+
* loop (request.start/end/error, cache.decision, ...).
|
|
331
|
+
* - segment-resolution/helpers.ts emits via a caller-provided report.telemetry
|
|
332
|
+
* sink rather than the ALS router context.
|
|
333
|
+
* - rsc/handler.ts handleTimeoutResponse (request.timeout), the origin guard
|
|
334
|
+
* (request.origin-rejected), and handleStore.onError (late-handle
|
|
335
|
+
* handler.error) emit via router.telemetry directly — they run outside the
|
|
336
|
+
* RouterContext ALS (only match()/matchPartial() enter it), so a
|
|
337
|
+
* getRouterContext() read there throws and the event would vanish.
|
|
338
|
+
*/
|
|
339
|
+
export function observeEvent(event: TelemetryEvent): void {
|
|
340
|
+
// getRouterContext() either throws (real impl, outside a router context — e.g.
|
|
341
|
+
// the build-time prerender path) or returns null/undefined (e.g. mocked).
|
|
342
|
+
// Either way there is no sink to emit to, so swallow and return.
|
|
343
|
+
let routerCtx: ReturnType<typeof getRouterContext> | null | undefined;
|
|
344
|
+
try {
|
|
345
|
+
routerCtx = getRouterContext();
|
|
346
|
+
} catch {
|
|
347
|
+
return;
|
|
348
|
+
}
|
|
349
|
+
if (!routerCtx?.telemetry) return;
|
|
350
|
+
const stamped =
|
|
351
|
+
event.requestId === undefined && routerCtx.requestId !== undefined
|
|
352
|
+
? ({ ...event, requestId: routerCtx.requestId } as TelemetryEvent)
|
|
353
|
+
: event;
|
|
354
|
+
safeEmit(resolveSink(routerCtx.telemetry), stamped);
|
|
355
|
+
}
|