@rangojs/router 0.0.0-experimental.d20dd405 → 0.0.0-experimental.d98a8e9d
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/README.md +8 -8
- package/dist/bin/rango.js +147 -57
- package/dist/testing/vitest.js +82 -0
- package/dist/vite/index.js +917 -500
- package/package.json +55 -11
- package/skills/api-client/SKILL.md +211 -0
- package/skills/bundle-analysis/SKILL.md +159 -0
- package/skills/cache-guide/SKILL.md +220 -30
- package/skills/caching/SKILL.md +116 -8
- package/skills/composability/SKILL.md +27 -2
- package/skills/document-cache/SKILL.md +78 -55
- package/skills/handler-use/SKILL.md +1 -1
- package/skills/hooks/SKILL.md +196 -21
- package/skills/host-router/SKILL.md +45 -20
- package/skills/intercept/SKILL.md +1 -4
- package/skills/layout/SKILL.md +4 -7
- package/skills/links/SKILL.md +22 -10
- package/skills/loader/SKILL.md +166 -23
- package/skills/middleware/SKILL.md +13 -9
- package/skills/migrate-nextjs/SKILL.md +1 -1
- package/skills/mime-routes/SKILL.md +27 -0
- package/skills/observability/SKILL.md +137 -0
- package/skills/parallel/SKILL.md +3 -6
- package/skills/prerender/SKILL.md +14 -33
- package/skills/rango/SKILL.md +243 -26
- package/skills/react-compiler/SKILL.md +168 -0
- package/skills/response-routes/SKILL.md +114 -47
- package/skills/route/SKILL.md +9 -4
- package/skills/router-setup/SKILL.md +3 -3
- package/skills/server-actions/SKILL.md +53 -41
- package/skills/testing/SKILL.md +128 -0
- package/skills/testing/bindings.md +89 -0
- package/skills/testing/cache-prerender.md +98 -0
- package/skills/testing/client-components.md +121 -0
- package/skills/testing/e2e-parity.md +124 -0
- package/skills/testing/flight.md +89 -0
- package/skills/testing/handles.md +127 -0
- package/skills/testing/loader.md +108 -0
- package/skills/testing/middleware.md +97 -0
- package/skills/testing/render-handler.md +102 -0
- package/skills/testing/response-routes.md +94 -0
- package/skills/testing/reverse-and-types.md +83 -0
- package/skills/testing/server-actions.md +89 -0
- package/skills/testing/server-tree.md +128 -0
- package/skills/testing/setup.md +120 -0
- package/skills/typesafety/SKILL.md +310 -26
- package/skills/use-cache/SKILL.md +34 -5
- package/skills/view-transitions/SKILL.md +85 -3
- package/src/__augment-tests__/augment.ts +81 -0
- package/src/__augment-tests__/augmented.check.ts +116 -0
- package/src/browser/action-coordinator.ts +53 -36
- package/src/browser/event-controller.ts +42 -66
- package/src/browser/history-state.ts +21 -0
- package/src/browser/index.ts +3 -3
- package/src/browser/navigation-bridge.ts +9 -67
- package/src/browser/navigation-client.ts +68 -83
- package/src/browser/navigation-store.ts +7 -8
- package/src/browser/navigation-transaction.ts +10 -28
- package/src/browser/partial-update.ts +8 -16
- package/src/browser/prefetch/cache.ts +58 -27
- package/src/browser/prefetch/fetch.ts +92 -33
- package/src/browser/react/NavigationProvider.tsx +55 -65
- package/src/browser/react/location-state-shared.ts +175 -4
- package/src/browser/react/location-state.ts +39 -13
- package/src/browser/react/use-handle.ts +17 -9
- package/src/browser/react/use-params.ts +3 -4
- package/src/browser/react/use-reverse.ts +19 -12
- package/src/browser/react/use-router.ts +14 -1
- package/src/browser/response-adapter.ts +32 -1
- package/src/browser/rsc-router.tsx +35 -16
- package/src/browser/scroll-restoration.ts +30 -25
- package/src/browser/segment-structure-assert.ts +2 -2
- package/src/browser/server-action-bridge.ts +23 -30
- package/src/browser/types.ts +2 -0
- package/src/build/collect-fallback-refs.ts +107 -0
- package/src/build/generate-manifest.ts +60 -35
- package/src/build/generate-route-types.ts +2 -0
- package/src/build/index.ts +8 -1
- package/src/build/prefix-tree-utils.ts +123 -0
- package/src/build/route-trie.ts +43 -0
- package/src/build/route-types/codegen.ts +4 -4
- package/src/build/route-types/include-resolution.ts +1 -1
- package/src/build/route-types/per-module-writer.ts +7 -4
- package/src/build/route-types/router-processing.ts +55 -14
- package/src/build/route-types/scan-filter.ts +1 -1
- package/src/build/route-types/source-scan.ts +118 -0
- package/src/build/runtime-discovery.ts +9 -20
- package/src/cache/cache-scope.ts +28 -42
- package/src/cache/cf/cf-cache-store.ts +49 -6
- package/src/client.tsx +9 -30
- package/src/context-var.ts +5 -5
- package/src/decode-loader-results.ts +36 -0
- package/src/errors.ts +30 -4
- package/src/handle.ts +32 -14
- package/src/host/index.ts +2 -2
- package/src/host/router.ts +129 -57
- package/src/host/types.ts +31 -2
- package/src/host/utils.ts +1 -1
- package/src/href-client.ts +136 -20
- package/src/index.rsc.ts +7 -6
- package/src/index.ts +14 -8
- package/src/loader-store.ts +500 -0
- package/src/loader.rsc.ts +25 -7
- package/src/loader.ts +16 -9
- package/src/missing-id-error.ts +68 -0
- package/src/prerender.ts +27 -6
- package/src/response-utils.ts +9 -0
- package/src/reverse.ts +16 -13
- package/src/route-content-wrapper.tsx +6 -28
- package/src/route-definition/dsl-helpers.ts +238 -263
- package/src/route-definition/helper-factories.ts +29 -139
- package/src/route-definition/helpers-types.ts +37 -14
- package/src/route-definition/use-item-types.ts +32 -0
- package/src/route-types.ts +19 -41
- package/src/router/basename.ts +14 -0
- package/src/router/content-negotiation.ts +15 -2
- package/src/router/error-handling.ts +1 -1
- package/src/router/find-match.ts +54 -6
- package/src/router/intercept-resolution.ts +4 -18
- package/src/router/lazy-includes.ts +35 -16
- package/src/router/loader-resolution.ts +79 -36
- package/src/router/manifest.ts +19 -6
- package/src/router/match-handlers.ts +62 -20
- package/src/router/match-middleware/cache-lookup.ts +44 -91
- package/src/router/match-middleware/cache-store.ts +3 -2
- package/src/router/match-result.ts +32 -30
- package/src/router/metrics.ts +1 -1
- package/src/router/middleware-types.ts +1 -1
- package/src/router/middleware.ts +46 -78
- package/src/router/pattern-matching.ts +15 -2
- package/src/router/prerender-match.ts +1 -1
- package/src/router/preview-match.ts +3 -1
- package/src/router/request-classification.ts +4 -28
- package/src/router/revalidation.ts +43 -1
- package/src/router/router-interfaces.ts +45 -28
- package/src/router/router-options.ts +40 -1
- package/src/router/router-registry.ts +2 -5
- package/src/router/segment-resolution/fresh.ts +19 -6
- package/src/router/segment-resolution/revalidation.ts +19 -6
- package/src/router/segment-resolution/view-transition-default.ts +36 -0
- package/src/router/telemetry.ts +99 -0
- package/src/router/trie-matching.ts +22 -3
- package/src/router/types.ts +8 -0
- package/src/router.ts +51 -28
- package/src/rsc/handler-context.ts +2 -2
- package/src/rsc/handler.ts +20 -65
- package/src/rsc/helpers.ts +22 -2
- package/src/rsc/index.ts +1 -1
- package/src/rsc/manifest-init.ts +28 -41
- package/src/rsc/origin-guard.ts +28 -10
- package/src/rsc/response-error.ts +79 -12
- package/src/rsc/response-route-handler.ts +43 -60
- package/src/rsc/rsc-rendering.ts +27 -53
- package/src/rsc/runtime-warnings.ts +9 -10
- package/src/rsc/server-action.ts +13 -37
- package/src/rsc/ssr-setup.ts +16 -0
- package/src/rsc/types.ts +2 -2
- package/src/runtime-env.ts +18 -0
- package/src/search-params.ts +4 -4
- package/src/segment-system.tsx +64 -49
- package/src/serialize.ts +243 -0
- package/src/server/context.ts +150 -51
- package/src/server/cookie-store.ts +28 -4
- package/src/server/request-context.ts +57 -9
- package/src/static-handler.ts +25 -3
- package/src/testing/cache-status.ts +166 -0
- package/src/testing/collect-handle.ts +63 -0
- package/src/testing/dispatch.ts +581 -0
- package/src/testing/dom.entry.ts +22 -0
- package/src/testing/e2e/fixture.ts +188 -0
- package/src/testing/e2e/index.ts +149 -0
- package/src/testing/e2e/matchers.ts +51 -0
- package/src/testing/e2e/page-helpers.ts +272 -0
- package/src/testing/e2e/parity.ts +326 -0
- package/src/testing/e2e/server.ts +195 -0
- package/src/testing/flight-matchers.ts +110 -0
- package/src/testing/flight-normalize.ts +38 -0
- package/src/testing/flight-runtime.d.ts +57 -0
- package/src/testing/flight-tree.ts +682 -0
- package/src/testing/flight.entry.ts +51 -0
- package/src/testing/flight.ts +234 -0
- package/src/testing/generated-routes.ts +223 -0
- package/src/testing/index.ts +106 -0
- package/src/testing/internal/context.ts +304 -0
- package/src/testing/internal/flight-client-globals.ts +30 -0
- package/src/testing/internal/seed-vars.ts +42 -0
- package/src/testing/render-handler.ts +323 -0
- package/src/testing/render-route.tsx +590 -0
- package/src/testing/run-loader.ts +363 -0
- package/src/testing/run-middleware.ts +205 -0
- package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
- package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
- package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
- package/src/testing/vitest-stubs/version.ts +5 -0
- package/src/testing/vitest.ts +285 -0
- package/src/types/global-namespace.ts +39 -26
- package/src/types/handler-context.ts +56 -11
- package/src/types/index.ts +1 -0
- package/src/types/loader-types.ts +6 -3
- package/src/types/segments.ts +18 -1
- package/src/urls/include-helper.ts +10 -53
- package/src/urls/index.ts +1 -5
- package/src/urls/path-helper-types.ts +11 -3
- package/src/urls/path-helper.ts +17 -52
- package/src/urls/pattern-types.ts +36 -19
- package/src/urls/response-types.ts +20 -19
- package/src/urls/type-extraction.ts +58 -139
- package/src/urls/urls-function.ts +1 -5
- package/src/use-loader.tsx +413 -42
- package/src/vite/debug.ts +1 -0
- package/src/vite/discovery/bundle-postprocess.ts +6 -6
- package/src/vite/discovery/discover-routers.ts +75 -72
- package/src/vite/discovery/discovery-errors.ts +194 -0
- package/src/vite/discovery/prerender-collection.ts +19 -25
- package/src/vite/discovery/route-types-writer.ts +40 -84
- package/src/vite/discovery/state.ts +33 -0
- package/src/vite/discovery/virtual-module-codegen.ts +13 -23
- package/src/vite/index.ts +2 -0
- package/src/vite/plugin-types.ts +67 -0
- package/src/vite/plugins/cjs-to-esm.ts +3 -7
- package/src/vite/plugins/client-ref-hashing.ts +12 -1
- package/src/vite/plugins/cloudflare-protocol-stub.ts +1 -1
- package/src/vite/plugins/expose-action-id.ts +2 -2
- package/src/vite/plugins/expose-id-utils.ts +12 -8
- package/src/vite/plugins/expose-ids/export-analysis.ts +100 -20
- package/src/vite/plugins/expose-ids/handler-transform.ts +8 -61
- package/src/vite/plugins/expose-ids/loader-transform.ts +3 -5
- package/src/vite/plugins/expose-internal-ids.ts +47 -67
- package/src/vite/plugins/performance-tracks.ts +12 -16
- package/src/vite/plugins/use-cache-transform.ts +13 -11
- package/src/vite/plugins/version-injector.ts +2 -12
- package/src/vite/plugins/version-plugin.ts +59 -2
- package/src/vite/plugins/virtual-entries.ts +2 -2
- package/src/vite/rango.ts +67 -15
- package/src/vite/router-discovery.ts +208 -63
- package/src/vite/utils/ast-handler-extract.ts +15 -15
- package/src/vite/utils/bundle-analysis.ts +4 -2
- package/src/vite/utils/client-chunks.ts +190 -0
- package/src/vite/utils/forward-user-plugins.ts +193 -0
- package/src/vite/utils/manifest-utils.ts +8 -59
- package/src/vite/utils/shared-utils.ts +107 -26
- package/src/browser/action-response-classifier.ts +0 -99
package/skills/layout/SKILL.md
CHANGED
|
@@ -8,9 +8,6 @@ argument-hint: [component]
|
|
|
8
8
|
|
|
9
9
|
Layouts wrap child routes and persist during navigation within their scope.
|
|
10
10
|
|
|
11
|
-
Canonical semantics reference:
|
|
12
|
-
[docs/execution-model.md](../../docs/internal/execution-model.md)
|
|
13
|
-
|
|
14
11
|
## Basic Layout
|
|
15
12
|
|
|
16
13
|
```typescript
|
|
@@ -206,7 +203,7 @@ layout(<ShopLayout />, () => [
|
|
|
206
203
|
|
|
207
204
|
// Or revalidate based on conditions
|
|
208
205
|
layout(<CartLayout />, () => [
|
|
209
|
-
revalidate(({ actionId }) => actionId?.includes("Cart")
|
|
206
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") || undefined),
|
|
210
207
|
|
|
211
208
|
path("/cart", CartPage, { name: "cart" }),
|
|
212
209
|
])
|
|
@@ -225,7 +222,7 @@ them on both producer and consumer segments:
|
|
|
225
222
|
```typescript
|
|
226
223
|
// revalidation-contracts.ts
|
|
227
224
|
export const revalidateCartData = ({ actionId }) =>
|
|
228
|
-
actionId?.includes("src/actions/cart.ts#addToCart")
|
|
225
|
+
actionId?.includes("src/actions/cart.ts#addToCart") || undefined;
|
|
229
226
|
```
|
|
230
227
|
|
|
231
228
|
```typescript
|
|
@@ -247,7 +244,7 @@ You can also package them as importable handoff helpers:
|
|
|
247
244
|
import { revalidate } from "@rangojs/router";
|
|
248
245
|
|
|
249
246
|
export const revalidateAuthData = ({ actionId }) =>
|
|
250
|
-
actionId?.includes("src/actions/auth.ts#")
|
|
247
|
+
actionId?.includes("src/actions/auth.ts#") || undefined;
|
|
251
248
|
export const revalidateAuth = () => [revalidate(revalidateAuthData)];
|
|
252
249
|
```
|
|
253
250
|
|
|
@@ -294,7 +291,7 @@ export const shopPatterns = urls(({ path, layout, parallel, loader, revalidate }
|
|
|
294
291
|
}, () => [
|
|
295
292
|
// Layout loaders
|
|
296
293
|
loader(CartLoader, () => [
|
|
297
|
-
revalidate(({ actionId }) => actionId?.includes("Cart")
|
|
294
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") || undefined),
|
|
298
295
|
]),
|
|
299
296
|
|
|
300
297
|
// Parallel routes
|
package/skills/links/SKILL.md
CHANGED
|
@@ -13,7 +13,7 @@ argument-hint: [ctx.reverse|href|useHref|useMount|useReverse|scopedReverse]
|
|
|
13
13
|
**On the client, two patterns:**
|
|
14
14
|
|
|
15
15
|
1. **Receive URLs as props / loader data / action return.** The default. The server has the full route manifest and handler context — generate URLs there and hand strings to client components.
|
|
16
|
-
2. **`useReverse(routes)`.** Import a generated `routes` map from a `urls()` module's `.gen.ts` and call `reverse("
|
|
16
|
+
2. **`useReverse(routes)`.** Import a generated `routes` map from a `urls()` module's `.gen.ts` and call `reverse("name", params?)` (the leading dot is optional). Mount-aware via `useMount()`, auto-fills params from `useParams()`, fully typed from the imported map. Use this when a client component needs to generate URLs into a known module without round-tripping through the server.
|
|
17
17
|
|
|
18
18
|
`ctx.reverse()` itself is **server-only** — it depends on the full route manifest and handler context. Client components never import or call it.
|
|
19
19
|
|
|
@@ -213,7 +213,17 @@ function GlobalNav() {
|
|
|
213
213
|
}
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
`href()` provides compile-time validation via `
|
|
216
|
+
`href()` provides compile-time validation via the `Rango.Path` type. Paths are validated against registered route patterns using `PatternToPath`.
|
|
217
|
+
|
|
218
|
+
When wrapping `href()`, type the wrapper's path parameter as `Rango.Path` so it
|
|
219
|
+
keeps the same generated-route validation. `Rango.Path` is ambient — no import,
|
|
220
|
+
just like `Rango.Env` / `Rango.Vars`:
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
import { href } from "@rangojs/router/client";
|
|
224
|
+
|
|
225
|
+
export const appHref = (path: Rango.Path): string => href(path);
|
|
226
|
+
```
|
|
217
227
|
|
|
218
228
|
`href()` is a raw path helper — it is **not** basename-aware. It returns the path as-is (or with the include mount prefix via `useHref()`). For basename-aware navigation, use `Link`, `useRouter().push()`, or `reverse()`, which auto-prefix root-relative paths with the router's basename.
|
|
219
229
|
|
|
@@ -263,6 +273,8 @@ function MountInfo() {
|
|
|
263
273
|
|
|
264
274
|
Hook that returns a typed local reverse function for a `routes` map imported from a generated `.gen.ts` next to a `urls()` module. The route map is the **exposure boundary** — `useReverse` only knows about names in that map, never the full app manifest.
|
|
265
275
|
|
|
276
|
+
> **Which map?** `useReverse` accepts any routes map. Prefer the per-module `routes` (e.g. `urls/blog.gen.ts`): it gives **mount-aware** local `.name` reverse (auto-prefixes the `include()` mount) and only that module's names enter the client bundle. You _can_ instead pass `router.named-routes.gen.ts` (`NamedRoutes`) for **global** names (`blog.post`; the leading dot is optional) — it is a plain importable map and works on the client (it is **not** server-only) — but its paths are **absolute** while `useReverse` mount-prefixes, so it is correct only at the root mount (under a non-root mount it double-prefixes), and importing it pulls every route name and pattern in the app into the client bundle (a small names-to-paths map — not components or loaders), versus the per-module map which exposes only one module's names. So the per-module map is preferred for in-module links; the named-routes map is the escape hatch for global names.
|
|
277
|
+
|
|
266
278
|
```tsx
|
|
267
279
|
"use client";
|
|
268
280
|
import { Link, useReverse } from "@rangojs/router/client";
|
|
@@ -273,8 +285,8 @@ export function BlogNav() {
|
|
|
273
285
|
|
|
274
286
|
return (
|
|
275
287
|
<nav>
|
|
276
|
-
<Link to={reverse("
|
|
277
|
-
<Link to={reverse("
|
|
288
|
+
<Link to={reverse("index")}>Blog</Link>
|
|
289
|
+
<Link to={reverse("post", { postId: "hello" })}>Post</Link>
|
|
278
290
|
</nav>
|
|
279
291
|
);
|
|
280
292
|
}
|
|
@@ -282,7 +294,7 @@ export function BlogNav() {
|
|
|
282
294
|
|
|
283
295
|
### How it resolves
|
|
284
296
|
|
|
285
|
-
1. Strips
|
|
297
|
+
1. Strips an optional leading `.` and looks up the name in the imported `routes` map.
|
|
286
298
|
2. Joins the local pattern with the surrounding `useMount()` value — the include's URL pattern.
|
|
287
299
|
3. Substitutes params: explicit params from the call, then auto-filled from `useParams()` for anything still unresolved (mount params like `:tenantId` flow in this way).
|
|
288
300
|
4. Appends a query string if a search object is passed and the route has a `search` schema.
|
|
@@ -350,14 +362,14 @@ reverse(".search", {}, { q: "hello world", page: 2 });
|
|
|
350
362
|
|
|
351
363
|
### Errors
|
|
352
364
|
|
|
353
|
-
- Unknown name: throws `Unknown
|
|
365
|
+
- Unknown name: throws `Unknown route: ".not-a-route"`.
|
|
354
366
|
- Missing required param: throws `Missing param "postId" for route ".detail"`.
|
|
355
367
|
|
|
356
368
|
Both happen synchronously during `reverse()` — wrap calls in try/catch (or an ErrorBoundary if the throw happens during render) when you need to surface them as UI.
|
|
357
369
|
|
|
358
|
-
###
|
|
370
|
+
### The leading dot is optional
|
|
359
371
|
|
|
360
|
-
`
|
|
372
|
+
`reverse("post")` and `reverse(".post")` resolve **identically** — the leading dot is cosmetic. The map you import IS the scope, so there is no separate global namespace to disambiguate and the dot carries no meaning; it exists only as a readability convention and for parity with `ctx.reverse(".name")` on the server. To link into a different module, import that module's `routes`:
|
|
361
373
|
|
|
362
374
|
```tsx
|
|
363
375
|
import { routes as blogRoutes } from "../urls/blog.gen.js";
|
|
@@ -368,8 +380,8 @@ function CrossNav() {
|
|
|
368
380
|
const shop = useReverse(shopRoutes);
|
|
369
381
|
return (
|
|
370
382
|
<nav>
|
|
371
|
-
<Link to={blog("
|
|
372
|
-
<Link to={shop("
|
|
383
|
+
<Link to={blog("index")}>Blog</Link>
|
|
384
|
+
<Link to={shop("cart")}>Cart</Link>
|
|
373
385
|
</nav>
|
|
374
386
|
);
|
|
375
387
|
}
|
package/skills/loader/SKILL.md
CHANGED
|
@@ -91,6 +91,20 @@ path("/product/:slug", ProductPage, { name: "product" }, () => [
|
|
|
91
91
|
]);
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
+
> **Client refresh `key` vs. server `cache({ key })` vs. `revalidate()`.** Three
|
|
95
|
+
> different "what refreshes" knobs that are easy to confuse:
|
|
96
|
+
>
|
|
97
|
+
> - `useLoader(Loader, { key })` / `useFetchLoader(Loader, { key })` — a
|
|
98
|
+
> **client** refresh identity. It groups which mounted reads of one loader
|
|
99
|
+
> refresh together when one calls `load()`. It never touches the server
|
|
100
|
+
> request. For refreshing **different** loaders together, tag them with
|
|
101
|
+
> `{ refreshGroup }` (one name or several) and call `useRefreshLoaders()(name)`
|
|
102
|
+
> (plain GET only). See the hooks skill ("Scoping refetch with a `key`" and
|
|
103
|
+
> "Refreshing multiple loaders together").
|
|
104
|
+
> - `cache({ key })` — a **server** cache identity (storage hit/miss/ttl/swr).
|
|
105
|
+
> - `revalidate()` — which **server** segments/loaders recompute during
|
|
106
|
+
> navigation and action refreshes.
|
|
107
|
+
|
|
94
108
|
DSL loaders are the **live data layer** — they resolve fresh on every
|
|
95
109
|
request, even when the route is inside a `cache()` boundary. The router
|
|
96
110
|
excludes them from the segment cache at storage time and re-resolves them
|
|
@@ -146,23 +160,23 @@ Loaders receive the same context shape as route handlers.
|
|
|
146
160
|
|
|
147
161
|
### Full field surface
|
|
148
162
|
|
|
149
|
-
| Field | Type | Notes
|
|
150
|
-
| -------------- | ------------------------------ |
|
|
151
|
-
| `params` | `TParams` | Merged route + explicit loader params; overridable by fetchable `load({ params })`.
|
|
152
|
-
| `routeParams` | `Record<string, string>` | Server-trusted route params from URL pattern matching; cannot be overridden.
|
|
153
|
-
| `request` | `Request` | The incoming `Request` (headers, method, body, `signal` for abort).
|
|
154
|
-
| `url` | `URL` | Parsed request URL.
|
|
155
|
-
| `pathname` | `string` | URL pathname (shortcut for `ctx.url.pathname`).
|
|
156
|
-
| `searchParams` | `URLSearchParams` | Shortcut for `ctx.url.searchParams`.
|
|
157
|
-
| `search` | `ResolveSearchSchema<TSearch>` | Typed query params when a search schema is declared on the route; `{}` otherwise.
|
|
158
|
-
| `env` | `TEnv` | Plain bindings from `createRouter<TEnv>()` (DB, KV, secrets, etc.).
|
|
159
|
-
| `get` | `(key \| ContextVar) => value` | Reads variables/context-vars set by middleware.
|
|
160
|
-
| `use` | `(loader \| handle) => T` | Access another loader's data (Promise) or a handle's collected data (after `await ctx.rendered()`).
|
|
161
|
-
| `rendered` | `() => Promise<void>` | **Experimental.** DSL loaders only — waits for non-loader segments before reading handle data.
|
|
162
|
-
| `method` | `string` | HTTP method. `"GET"` for SSR loader runs; reflects real method for fetchable loaders.
|
|
163
|
-
| `body` | `TBody \| undefined` | Parsed request body for fetchable POST/PUT/PATCH/DELETE calls.
|
|
164
|
-
| `formData` | `FormData \| undefined` | Present when a fetchable loader is invoked via form submission.
|
|
165
|
-
| `reverse` | `ScopedReverseFunction` | Generate type-checked URLs from route names (same scoped semantics as route handlers).
|
|
163
|
+
| Field | Type | Notes |
|
|
164
|
+
| -------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
165
|
+
| `params` | `TParams` | Merged route + explicit loader params; overridable by fetchable `load({ params })`. |
|
|
166
|
+
| `routeParams` | `Record<string, string>` | Server-trusted route params from URL pattern matching; cannot be overridden. |
|
|
167
|
+
| `request` | `Request` | The incoming `Request` (headers, method, body, `signal` for abort). |
|
|
168
|
+
| `url` | `URL` | Parsed request URL. |
|
|
169
|
+
| `pathname` | `string` | URL pathname (shortcut for `ctx.url.pathname`). |
|
|
170
|
+
| `searchParams` | `URLSearchParams` | Shortcut for `ctx.url.searchParams`. |
|
|
171
|
+
| `search` | `ResolveSearchSchema<TSearch>` | Typed query params when a search schema is declared on the route; `{}` otherwise. |
|
|
172
|
+
| `env` | `TEnv` | Plain bindings from `createRouter<TEnv>()` (DB, KV, secrets, etc.). |
|
|
173
|
+
| `get` | `(key \| ContextVar) => value` | Reads variables/context-vars set by middleware. |
|
|
174
|
+
| `use` | `(loader \| handle) => T` | Access another loader's data (Promise) or a handle's collected data (after `await ctx.rendered()`). |
|
|
175
|
+
| `rendered` | `() => Promise<void>` | **Experimental.** DSL loaders only — waits for all non-loader segments (including `loading()` streaming handlers) to settle before reading handle data. |
|
|
176
|
+
| `method` | `string` | HTTP method. `"GET"` for SSR loader runs; reflects real method for fetchable loaders. |
|
|
177
|
+
| `body` | `TBody \| undefined` | Parsed request body for fetchable POST/PUT/PATCH/DELETE calls. |
|
|
178
|
+
| `formData` | `FormData \| undefined` | Present when a fetchable loader is invoked via form submission. |
|
|
179
|
+
| `reverse` | `ScopedReverseFunction` | Generate type-checked URLs from route names (same scoped semantics as route handlers). |
|
|
166
180
|
|
|
167
181
|
### Example
|
|
168
182
|
|
|
@@ -185,7 +199,7 @@ export const ProductLoader = createLoader(async (ctx) => {
|
|
|
185
199
|
// Request headers
|
|
186
200
|
const auth = ctx.request.headers.get("Authorization");
|
|
187
201
|
|
|
188
|
-
// Variables set by middleware (from
|
|
202
|
+
// Variables set by middleware (from Rango.Vars augmentation)
|
|
189
203
|
const user = ctx.get("user");
|
|
190
204
|
|
|
191
205
|
// Type-checked URLs for payloads. `.name` resolves within the current
|
|
@@ -244,15 +258,23 @@ path("/product/:slug", ProductPage, { name: "product" }, () => [
|
|
|
244
258
|
revalidate(() => false), // Never revalidate
|
|
245
259
|
]),
|
|
246
260
|
|
|
247
|
-
// Loader that revalidates after cart actions
|
|
261
|
+
// Loader that revalidates after cart actions (defer otherwise — keeps the
|
|
262
|
+
// permissive loader defaults for navigation and other actions intact)
|
|
248
263
|
loader(CartLoader, () => [
|
|
249
|
-
revalidate(({ actionId }) => actionId?.includes("Cart")
|
|
264
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") || undefined),
|
|
250
265
|
]),
|
|
251
266
|
]);
|
|
252
267
|
```
|
|
253
268
|
|
|
254
269
|
### `revalidate()` return shapes
|
|
255
270
|
|
|
271
|
+
> **Scope: `revalidate()` is a partial-render concern, not a cache concern.**
|
|
272
|
+
> It decides whether a segment (here, a loader) re-runs and streams to the
|
|
273
|
+
> client on a navigation or action — never whether a cached value is stale. The
|
|
274
|
+
> cache decides hit/miss/ttl/swr independently and never reads `revalidate()`.
|
|
275
|
+
> Caching a loader is a separate, opt-in step (`loader(Fn, () => [cache({...})])`).
|
|
276
|
+
> See `/cache-guide` → "Two axes" and `/rango` → "The shape of rango".
|
|
277
|
+
|
|
256
278
|
A `revalidate(fn)` callback can return one of four shapes. The chain
|
|
257
279
|
processes revalidators in order; each call's return controls how the
|
|
258
280
|
chain continues:
|
|
@@ -282,6 +304,58 @@ revalidate(() => null); // explicit defer
|
|
|
282
304
|
If every revalidator on a segment defers, the segment-type default
|
|
283
305
|
(e.g. params-changed for routes, `false` for parallels) is used.
|
|
284
306
|
|
|
307
|
+
#### `|| undefined` (defer) vs `?? false` (hard) — pick deliberately
|
|
308
|
+
|
|
309
|
+
A boolean return — including `false` — is a **hard** decision: it short-circuits
|
|
310
|
+
the chain and overrides the segment default. `undefined` **defers** to the
|
|
311
|
+
running suggestion / segment default. They are not interchangeable:
|
|
312
|
+
|
|
313
|
+
```typescript
|
|
314
|
+
// Defer: "revalidate on match, otherwise let the default/downstream decide."
|
|
315
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") || undefined);
|
|
316
|
+
|
|
317
|
+
// Hard: "revalidate ONLY on match, suppress everything else."
|
|
318
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") ?? false);
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
This matters most for loaders, whose defaults are permissive: a loader defaults
|
|
322
|
+
to revalidating on **any** action (`POST`) and on **param/search changes**
|
|
323
|
+
during navigation. So `?? false` on a loader silently suppresses both — the
|
|
324
|
+
loader will not refetch when you navigate to a different `:id`. Use
|
|
325
|
+
`|| undefined` when you want to _add_ a revalidation signal on top of the
|
|
326
|
+
sensible defaults, and reserve `?? false` for the rare case where you genuinely
|
|
327
|
+
want the loader to refetch on nothing but your matched action.
|
|
328
|
+
|
|
329
|
+
When **composing multiple revalidators** on one segment (see below), defer is
|
|
330
|
+
mandatory: the first hard `?? false` ends the chain and the later contracts
|
|
331
|
+
never run.
|
|
332
|
+
|
|
333
|
+
#### Matching actions: `ctx.isAction()`
|
|
334
|
+
|
|
335
|
+
To revalidate after specific server actions, match them by **reference** with
|
|
336
|
+
`ctx.isAction()` rather than hand-written `actionId` substrings. A rename or
|
|
337
|
+
moved file then becomes a type error instead of silently failing to match:
|
|
338
|
+
|
|
339
|
+
```typescript
|
|
340
|
+
import { addToCart, removeFromCart } from "../actions/cart";
|
|
341
|
+
import * as CartActions from "../actions/cart";
|
|
342
|
+
|
|
343
|
+
loader(CartLoader, () => [
|
|
344
|
+
revalidate((ctx) => ctx.isAction(addToCart) || undefined), // one action
|
|
345
|
+
]);
|
|
346
|
+
revalidate((ctx) => ctx.isAction(addToCart, removeFromCart) || undefined); // several
|
|
347
|
+
revalidate((ctx) => ctx.isAction(CartActions) || undefined); // any action in the module
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
`isAction()` is a method on the revalidate predicate's **context argument** —
|
|
351
|
+
there is no standalone `isAction` import; you always reach it through the callback
|
|
352
|
+
parameter (`revalidate((ctx) => ctx.isAction(...))`). It returns a raw boolean, so
|
|
353
|
+
pair it with `|| undefined` for the usual "revalidate on match, else defer"
|
|
354
|
+
intent. It returns `false` on plain navigation and on non-matches, and resolves
|
|
355
|
+
the reference the same way the router derives `actionId` (`$id` in production,
|
|
356
|
+
`$$id` in dev), so it matches in both modes. The raw `actionId` string stays
|
|
357
|
+
available on the same context as an escape hatch.
|
|
358
|
+
|
|
285
359
|
### Revalidation Contracts for Loader Dependencies
|
|
286
360
|
|
|
287
361
|
If a loader reads `ctx.get()` data produced by an outer handler/layout, share
|
|
@@ -289,8 +363,12 @@ the same named revalidation contract across producer and consumer segments.
|
|
|
289
363
|
|
|
290
364
|
```typescript
|
|
291
365
|
// revalidation-contracts.ts
|
|
292
|
-
|
|
293
|
-
|
|
366
|
+
import * as AccountActions from "./actions/account";
|
|
367
|
+
|
|
368
|
+
// Match by reference with ctx.isAction() (rename-safe), and defer (|| undefined)
|
|
369
|
+
// so these contracts compose — a hard `false` would short-circuit the rest.
|
|
370
|
+
export const revalidateAccountScope = (ctx) =>
|
|
371
|
+
ctx.isAction(AccountActions) || undefined;
|
|
294
372
|
|
|
295
373
|
layout(AccountLayout, () => [
|
|
296
374
|
revalidate(revalidateAccountScope), // producer reruns
|
|
@@ -333,6 +411,64 @@ follows the same rule: at build time, loaders are skipped entirely (there is no
|
|
|
333
411
|
real request context), and at runtime the worker resolves them fresh against
|
|
334
412
|
the live database.
|
|
335
413
|
|
|
414
|
+
### Parallel and streaming — latency overlaps first paint
|
|
415
|
+
|
|
416
|
+
Loaders do not block the page. As the render pass begins — the pass that route
|
|
417
|
+
middleware wraps, so loaders run right after middleware, not in a later
|
|
418
|
+
phase — every matched loader is kicked off **concurrently** (their promises start in the
|
|
419
|
+
same tick), and each result is **streamed** to the client as its own RSC Flight
|
|
420
|
+
chunk rather than awaited up front. Pair a loader with `loading()` (or a
|
|
421
|
+
client `<Suspense>`) and the shell paints immediately while the data streams in.
|
|
422
|
+
|
|
423
|
+
This is why **"cached UI still pays full data latency" is the wrong intuition**:
|
|
424
|
+
on a `cache()` hit the UI segments stream instantly from cache while the live
|
|
425
|
+
loaders resolve fresh **in parallel** — data latency _overlaps_ first paint
|
|
426
|
+
instead of being added on top of it. (Without a `loading()` / `<Suspense>`
|
|
427
|
+
boundary a parallel loader blocks its parent, so add one to keep the overlap.)
|
|
428
|
+
|
|
429
|
+
If you come from a framework where the loader is a blocking step that runs
|
|
430
|
+
before the response is built, this is the shift to internalize: here the
|
|
431
|
+
response starts streaming first and loader data fills in.
|
|
432
|
+
|
|
433
|
+
### See it: `debugPerformance`
|
|
434
|
+
|
|
435
|
+
Turn on the per-request performance timeline early — it is the fastest way to
|
|
436
|
+
confirm loaders overlap rather than serialize, and to find the real bottleneck
|
|
437
|
+
locally instead of guessing:
|
|
438
|
+
|
|
439
|
+
```typescript
|
|
440
|
+
const router = createRouter({ document: Document, debugPerformance: true });
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
Or enable it per-request from middleware (e.g. only when `?debug` is present) by
|
|
444
|
+
calling `ctx.debugPerformance()` **before** `await next()`. Each HTML request
|
|
445
|
+
then prints a shared-axis waterfall (and emits a `Server-Timing` header):
|
|
446
|
+
|
|
447
|
+
```
|
|
448
|
+
[RSC Perf] GET /product/widget (24.53ms)
|
|
449
|
+
start dur span timeline
|
|
450
|
+
0.08ms 3.20ms route-matching |#####...................................|
|
|
451
|
+
3.40ms 8.70ms ssr-render-html |.....##############.....................|
|
|
452
|
+
3.42ms 11.90ms loader:…#ProductLoader |.....###################................|
|
|
453
|
+
3.45ms 11.40ms loader:…#ReviewsLoader |.....##################.................|
|
|
454
|
+
0.00ms 24.53ms handler:total |########################################|
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
How to read it:
|
|
458
|
+
|
|
459
|
+
- **Humans:** scan the `#` bars on the shared axis. Bars that start at the same
|
|
460
|
+
offset and run side by side are executing **in parallel** — loaders should
|
|
461
|
+
overlap `ssr-render-html` / `render:total`, not sit alone to the right of
|
|
462
|
+
everything. A lone `loader:*` bar past the render bar is serialized latency to
|
|
463
|
+
chase. `handler:total` is the whole request; `render:total` is the render pass.
|
|
464
|
+
- **LLMs / programmatic:** read each row as `{ start, dur, label }`. A loader
|
|
465
|
+
overlaps paint when its `[start, start+dur]` interval intersects
|
|
466
|
+
`render:total` / `ssr-render-html`. Flag a regression when a `loader:*`
|
|
467
|
+
interval is **disjoint from and starts after** `render:total`, or when its
|
|
468
|
+
`dur` approaches `handler:total` — that loader is on the critical path instead
|
|
469
|
+
of overlapping it. Two `loader:*` rows with near-equal `start` confirm
|
|
470
|
+
parallel execution.
|
|
471
|
+
|
|
336
472
|
### Opting a Loader into Caching
|
|
337
473
|
|
|
338
474
|
To cache a specific loader's data, attach a `cache()` child:
|
|
@@ -606,6 +742,13 @@ export const FileUploadLoader = createLoader(async (ctx) => {
|
|
|
606
742
|
|
|
607
743
|
Client usage — see `/hooks useFetchLoader` for the full client-side pattern.
|
|
608
744
|
|
|
745
|
+
> **Refetch sharing**: when the loader is registered on the route via
|
|
746
|
+
> `loader()`, a plain `load()` call (no `params`, no `body`) broadcasts
|
|
747
|
+
> the new value to every component reading the same loader id —
|
|
748
|
+
> `useLoader` reads in layouts, pages, and parallel slots all converge.
|
|
749
|
+
> Calls with `params` or a non-GET method stay local to the call site.
|
|
750
|
+
> See `/hooks` → "Shared refetch behavior" for the full contract.
|
|
751
|
+
|
|
609
752
|
## Complete Example
|
|
610
753
|
|
|
611
754
|
```typescript
|
|
@@ -641,7 +784,7 @@ export const CartLoader = createLoader(async (ctx) => {
|
|
|
641
784
|
export const urlpatterns = urls(({ path, layout, loader, loading, cache, revalidate }) => [
|
|
642
785
|
layout(<ShopLayout />, () => [
|
|
643
786
|
loader(CartLoader, () => [
|
|
644
|
-
revalidate(({ actionId }) => actionId?.includes("Cart")
|
|
787
|
+
revalidate(({ actionId }) => actionId?.includes("Cart") || undefined),
|
|
645
788
|
]),
|
|
646
789
|
|
|
647
790
|
path("/shop/product/:slug", ProductPage, { name: "product" }, () => [
|
|
@@ -10,9 +10,6 @@ Middleware runs before/after route handlers using the onion model.
|
|
|
10
10
|
|
|
11
11
|
## Execution Model
|
|
12
12
|
|
|
13
|
-
Canonical semantics reference:
|
|
14
|
-
[docs/execution-model.md](../../docs/internal/execution-model.md)
|
|
15
|
-
|
|
16
13
|
There are two levels of middleware with different execution scopes:
|
|
17
14
|
|
|
18
15
|
### Global middleware (`router.use()`)
|
|
@@ -36,15 +33,22 @@ Registered inside `urls()` callback. Wraps **rendering only** -- it does NOT wra
|
|
|
36
33
|
|
|
37
34
|
```
|
|
38
35
|
Request flow (with action):
|
|
39
|
-
global mw -> action executes -> route mw ->
|
|
36
|
+
global mw -> action executes -> route mw -> render pass
|
|
40
37
|
|
|
41
38
|
Request flow (no action):
|
|
42
|
-
global mw -> route mw ->
|
|
39
|
+
global mw -> route mw -> render pass
|
|
43
40
|
|
|
44
41
|
Progressive enhancement (no-JS form POST):
|
|
45
42
|
global mw -> action executes -> route mw -> full page re-render
|
|
46
43
|
```
|
|
47
44
|
|
|
45
|
+
The **render pass** resolves handler, layouts, parallels, and loaders together —
|
|
46
|
+
it is not a handler-then-loaders sequence. Handler-first ordering is guaranteed
|
|
47
|
+
only between a route handler and its child/orphan layouts and parallels (so
|
|
48
|
+
`ctx.set` is visible); loaders run **concurrently** and stream their results, so
|
|
49
|
+
their latency overlaps rendering rather than blocking it. See `/loader` →
|
|
50
|
+
"Parallel and streaming".
|
|
51
|
+
|
|
48
52
|
The contract is: **route middleware wraps rendering regardless of transport** (JS-enabled RSC stream or no-JS HTML). During PE re-render, route middleware observes action-set state (cookies, context variables) the same way it does during JS-enabled post-action revalidation.
|
|
49
53
|
|
|
50
54
|
Revalidation is still partial. Route middleware wraps the render pass that
|
|
@@ -64,7 +68,7 @@ and consumer segments, even when middleware is present in the chain.
|
|
|
64
68
|
|
|
65
69
|
```typescript
|
|
66
70
|
export const revalidateCartData = ({ actionId }) =>
|
|
67
|
-
actionId?.includes("src/actions/cart.ts#")
|
|
71
|
+
actionId?.includes("src/actions/cart.ts#") || undefined;
|
|
68
72
|
|
|
69
73
|
layout(CartLayout, () => [
|
|
70
74
|
middleware(cartRenderMiddleware),
|
|
@@ -192,7 +196,7 @@ export const myMiddleware: Middleware = async (ctx, next) => {
|
|
|
192
196
|
ctx.env.DB; // D1Database
|
|
193
197
|
ctx.env.KV; // KVNamespace
|
|
194
198
|
|
|
195
|
-
// Set variables for downstream handlers (typed via
|
|
199
|
+
// Set variables for downstream handlers (typed via Rango.Vars)
|
|
196
200
|
ctx.set("user", { id: "123", name: "John" });
|
|
197
201
|
|
|
198
202
|
// Continue to next middleware/handler
|
|
@@ -233,8 +237,8 @@ const Dashboard: Handler<"dashboard"> = (ctx) => {
|
|
|
233
237
|
```
|
|
234
238
|
|
|
235
239
|
This works alongside `ctx.get("key")` / `ctx.set("key", value)` (global typing
|
|
236
|
-
via
|
|
237
|
-
data; use
|
|
240
|
+
via Rango.Vars augmentation). Use `createVar` for route-local or feature-scoped
|
|
241
|
+
data; use Rango.Vars for app-wide middleware state.
|
|
238
242
|
|
|
239
243
|
## Redirect with State in Middleware
|
|
240
244
|
|
|
@@ -302,7 +302,7 @@ re-rendering. This is about the segment tree, not cache invalidation:
|
|
|
302
302
|
```typescript
|
|
303
303
|
// Re-run this layout when a blog action fires
|
|
304
304
|
layout(BlogLayout, () => [
|
|
305
|
-
revalidate(({ actionId }) => actionId?.includes("updateBlog")
|
|
305
|
+
revalidate(({ actionId }) => actionId?.includes("updateBlog") || undefined),
|
|
306
306
|
path("/blog/:slug", BlogPost, { name: "blogPost" }),
|
|
307
307
|
]);
|
|
308
308
|
|
|
@@ -108,6 +108,33 @@ path.text("/api/data", () => "plain text version", { name: "dataText" }),
|
|
|
108
108
|
Without an RSC primary, there is no `text/html` candidate — the Accept header
|
|
109
109
|
picks among the response-type candidates directly.
|
|
110
110
|
|
|
111
|
+
## Type Safety For Negotiated Paths
|
|
112
|
+
|
|
113
|
+
`router.named-routes.gen.ts` validates route names, params, search, `href()`, and
|
|
114
|
+
the `Rango.Path` type, but it does not carry response payload metadata. For MIME or
|
|
115
|
+
response payload types, use one of these surfaces:
|
|
116
|
+
|
|
117
|
+
- `RouteResponse<typeof patterns, "routeName">` for a specific response variant
|
|
118
|
+
by route name. This is the clearest option when several MIME variants share
|
|
119
|
+
one URL pattern.
|
|
120
|
+
- `Rango.PathResponse<"/products/:id">` (ambient, no import) for global lookup by URL pattern or concrete path after the app
|
|
121
|
+
registers `typeof router.routeMap`:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
// router.tsx
|
|
125
|
+
export const router = createRouter({ document: Document }).routes(urlpatterns);
|
|
126
|
+
|
|
127
|
+
declare global {
|
|
128
|
+
namespace Rango {
|
|
129
|
+
interface RegisteredRoutes extends typeof router.routeMap {}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
`RegisteredRoutes` is what exposes the richer routeMap entries containing
|
|
135
|
+
response payload metadata. Without it, URL-pattern response lookup has paths but
|
|
136
|
+
no payloads, so response types resolve to `never`.
|
|
137
|
+
|
|
111
138
|
## How It Works
|
|
112
139
|
|
|
113
140
|
1. **Build time**: `buildRouteTrie()` calls `mergeLeaves()` when multiple routes share a pattern.
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: observability
|
|
3
|
+
description: Debug Rango request performance with debugPerformance, Server-Timing, structured telemetry, and tracing
|
|
4
|
+
argument-hint:
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Observability
|
|
8
|
+
|
|
9
|
+
Use this when you need to understand request latency, cache decisions,
|
|
10
|
+
revalidation behavior, loader overlap, or production traces.
|
|
11
|
+
|
|
12
|
+
Rango exposes two complementary observability surfaces:
|
|
13
|
+
|
|
14
|
+
1. **Performance timeline** (`debugPerformance`) — per-request waterfall for
|
|
15
|
+
local or targeted debugging. It prints to the console and emits
|
|
16
|
+
`Server-Timing`.
|
|
17
|
+
2. **Structured telemetry** (`telemetry`) — lifecycle events sent to a pluggable
|
|
18
|
+
sink for production monitoring, OpenTelemetry, or custom metrics.
|
|
19
|
+
|
|
20
|
+
The essentials are below. The exported `TelemetryEvent` union type
|
|
21
|
+
(`import type { TelemetryEvent } from "@rangojs/router"`) is the full event
|
|
22
|
+
contract — every event kind and its fields are typed there.
|
|
23
|
+
|
|
24
|
+
## Performance timeline
|
|
25
|
+
|
|
26
|
+
Enable globally while debugging:
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { createRouter } from "@rangojs/router";
|
|
30
|
+
|
|
31
|
+
const router = createRouter({
|
|
32
|
+
document: Document,
|
|
33
|
+
urls: urlpatterns,
|
|
34
|
+
debugPerformance: true,
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Or enable for selected requests from middleware:
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
middleware(async (ctx, next) => {
|
|
42
|
+
if (ctx.url.searchParams.has("debug")) {
|
|
43
|
+
ctx.debugPerformance();
|
|
44
|
+
}
|
|
45
|
+
await next();
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Call `ctx.debugPerformance()` before `await next()`. The request then prints a
|
|
50
|
+
shared-axis waterfall and adds a `Server-Timing` header.
|
|
51
|
+
|
|
52
|
+
Read the timeline as intervals:
|
|
53
|
+
|
|
54
|
+
- `handler:total` is the whole router request.
|
|
55
|
+
- `render:total` / `ssr-render-html` show the render pass.
|
|
56
|
+
- `loader:*` rows should overlap render work. If a loader starts only after the
|
|
57
|
+
render bar, it is serialized latency.
|
|
58
|
+
- Cache, route matching, middleware pre/post, RSC serialization, and SSR phases
|
|
59
|
+
appear as separate spans, so the slow phase is visible without guessing.
|
|
60
|
+
|
|
61
|
+
## Structured telemetry
|
|
62
|
+
|
|
63
|
+
Use telemetry when you want durable production events rather than a one-request
|
|
64
|
+
debug waterfall.
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
import { createRouter, createConsoleSink } from "@rangojs/router";
|
|
68
|
+
|
|
69
|
+
const router = createRouter({
|
|
70
|
+
document: Document,
|
|
71
|
+
urls: urlpatterns,
|
|
72
|
+
telemetry: createConsoleSink(),
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
For OpenTelemetry:
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import { createRouter, createOTelSink } from "@rangojs/router";
|
|
80
|
+
import { trace } from "@opentelemetry/api";
|
|
81
|
+
|
|
82
|
+
const router = createRouter({
|
|
83
|
+
document: Document,
|
|
84
|
+
urls: urlpatterns,
|
|
85
|
+
telemetry: createOTelSink(trace.getTracer("my-app")),
|
|
86
|
+
});
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Custom sinks implement `emit(event)`:
|
|
90
|
+
|
|
91
|
+
```typescript
|
|
92
|
+
import { createRouter } from "@rangojs/router";
|
|
93
|
+
|
|
94
|
+
const router = createRouter({
|
|
95
|
+
document: Document,
|
|
96
|
+
urls: urlpatterns,
|
|
97
|
+
telemetry: {
|
|
98
|
+
emit(event) {
|
|
99
|
+
myMetrics.record(event);
|
|
100
|
+
},
|
|
101
|
+
},
|
|
102
|
+
});
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Events include `request.start/end/error`, `loader.start/end/error`,
|
|
106
|
+
`handler.error`, `cache.decision`, and `revalidation.decision`.
|
|
107
|
+
|
|
108
|
+
## Debugging revalidation and stale data
|
|
109
|
+
|
|
110
|
+
When stale UI or unexpected partial renders are the question, use all three
|
|
111
|
+
layers together:
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
import { createConsoleSink, createRouter } from "@rangojs/router";
|
|
115
|
+
|
|
116
|
+
const router = createRouter({
|
|
117
|
+
document: Document,
|
|
118
|
+
urls: urlpatterns,
|
|
119
|
+
debugPerformance: true,
|
|
120
|
+
telemetry: createConsoleSink(),
|
|
121
|
+
});
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Then inspect:
|
|
125
|
+
|
|
126
|
+
- `revalidation.decision` telemetry to see which segment re-ran or skipped.
|
|
127
|
+
- cache spans / `cache.decision` events to see hit, miss, stale, and background
|
|
128
|
+
revalidation behavior.
|
|
129
|
+
- loader spans to confirm live loaders overlap the render rather than blocking
|
|
130
|
+
first paint.
|
|
131
|
+
- the `Server-Timing` header to compare local logs with browser-network timing.
|
|
132
|
+
|
|
133
|
+
## Zero-overhead defaults
|
|
134
|
+
|
|
135
|
+
`debugPerformance` is off by default, and `telemetry` emits nothing unless a sink
|
|
136
|
+
is configured. Per-request `ctx.debugPerformance()` lets you turn on the
|
|
137
|
+
waterfall only for the route, user, or query param you are investigating.
|