0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
router/docs/router
Manuel Schiller 634da9176e
perf(router-core): streamline route initialization (#8327)
* perf(router-core): reuse parsed route segments for interpolation

Capture original template segments during the existing route-tree parse.
Interpolation only substitutes current values and produces fresh metadata;
it never reparses known routes, including first use and trailing-slash
variants. Rebuild the captured data with the tree for HMR. Parse unknown
templates once per bounded entry and reuse their segments across decoder
changes. Update Devtools and internal test consumers.

Remove internal undefined-path/server-flag compatibility and the divergent
SSR scanner. Both runtimes follow the canonical splat grammar. Keep the
128-result route cache after measuring its removal rather than adding an
unproven configuration option.

Measured against 41e42009be with frozen production bundles:
- 26 client/SSR Link cases, 4 paired replicas each: client unique params
  -3.94% CPU [95% CI -6.30,-1.52], optionals -2.58% [-4.34,-0.78].
  Other cases inconclusive; no supported end-to-end slowdown.
- 1000-route client high-cardinality interpolation -18.55..-24.83%;
  matching with fresh metadata -14.69..-19.12% (5 process samples).
- 1000-route client setup costs an extra 0.084..0.192 ms; sparse first use
  costs about 0.23..0.28 us/call. Retained segment data adds about 200..298 B
  per dynamic route in the measured fixtures.
- All 18 bundle cases add 303..392 gzip B; React minimal/full +311/+326 B.
- Cache-off saves 0.8..0.9 MiB per 1000 used routes and 1.2..1.5 MiB after
  growth, but client encoding/splat Links regress 25.31%/12.71% and SSR
  encoding/splats regress 21.76%/25.37%; retain result caching.
- Shared-value sampled allocations rise 2.18% client/5.23% SSR without that
  cache. Native Vue peaks remain effectively unchanged (macOS captures,
  not a new Linux CodSpeed CI run). Benchmark counts/JIT/GC flags unchanged.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* perf(router-core): avoid temporary route initialization joins

Build route IDs and full paths with direct string assembly and the existing
cleanPath normalizer. Avoid temporary filter/join arrays and the second ID
normalization. Pathless layouts keep the parent's fullPath unchanged.

Add a focused construction benchmark with fresh route objects and separate
processing-only / allocation-plus-processing cases at 100/1000/10000 routes.
Document why client-nav route-tree-scale is not a construction benchmark.

Standalone attribution against 41e42009be, otherwise unchanged Uint16Array
parser, 7 fresh process replicas and 1000 routes per tree:
- Client processRouteTree+route.init CPU improves 11.48-19.57% across
  static, dynamic, nested and mixed trees (all 95% intervals below zero).
- Server CPU improves 9.39-22.29% (all 95% intervals below zero).
- React Router minimal gzip +6 bytes; the composed parse-once implementation
  is measured separately against the required original bundle budget.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* perf(router-core): reuse stable path parameter decoders

Compare allowed-character values rather than recompiling the decoder on
every provider-style options update. Equivalent arrays retain warm route
paths; in-place edits and option removal update encoding correctly.
Publish the configuration key only after successful compilation, and
declare optional state without forcing an unused instance field.

Isolated against 3e0b23f46c with the same path-decoder.bench.ts, seven
alternating independent process pairs (200 locations per batch):
- Stable provider updates: 143.3707 -> 122.5572 us, -14.52%
  (95% process interval -15.51% to -13.52%).
- No-update control: 119.1170 -> 118.8155 us, -0.25%
  (interval -1.05% to +0.55%).
- Deliberately changing configuration every batch: 143.8213 -> 147.7340 us,
  +2.72% (interval +1.38% to +4.08%). Reconfiguration remains the cold path.

These are decoder/update mechanism measurements, not a claim about every
React Link render. Standalone React minimal gzip: 86121 -> 86142 bytes
(+21); raw +48 bytes, Brotli +10 bytes.

Add coverage for equivalent options, mutation, removal, direct overrides
and retrying failed compilation.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* perf(router-core): simplify route-owned path interpolation

Share one canonical scanner between tree processing and unknown templates.
Retain compact dynamic records and derive original parameter names lazily,
instead of reconstructing them during matching. Keep initialization/indexing
and traversal in processRouteTree, including existing nested-mask behavior.

Make pathParamsAllowedCharacters initialization-only, as requested. Compile
the readonly decoder once, remove decoder keys/stamps/update invalidation,
and keep path results on each route. Preserve the shared bounded unmatched
template cache across SSR requests; lightweight matching stays router-local.
Do not add an encoding-specific cache, router-level route map or bulk clear.

Move Devtools-only navigation availability outside the hot formatter.
Preserve legacy standalone fallback match identity and cache behavior,
including inherited params and route-tree replacement. Retain useful encoding
comments and explicit tuple-slot labels.

Final measurements (Node 24.8.0, built production JS, unchanged workloads):
- Original React client-nav Link loop versus 41e42009be, four balanced
  fresh-process pairs: CPU 2.5015016 -> 2.4370936 ms per 8-navigation batch,
  -2.57% (95% process interval -3.72% to -1.42%). Wall -2.58%.
- Fresh 1000-route client processing/init: static -12.39%, dynamic -5.34%,
  nested -6.54%, mixed -2.59%. Server static -9.12%; remaining intervals
  are reported separately and the mixed-server result is inconclusive.
- All 18 gzip fixtures are below 41e by 47-88 bytes. React minimal:
  85801 -> 85731; full: 89392 -> 89318. Raw JS -533..-697 bytes;
  Brotli varies by fixture rather than uniformly shrinking.
- Full 26-case paired client/SSR Link suite: no supported regressions;
  most small changes are inconclusive, not claimed as universal speedups.
- Warm retained path-cache heap saves about 7.8 KiB per 1000 routes in
  default/custom configurations. Native Vue peaks remain near baseline;
  peak, allocation totals and end outstanding are measured separately.

Existing literal grammar/URL/matching expectations are preserved. The
independent oracle covers 49638 segment cases and 338 matching/mask traces
within the old offset range. Initialization-only encoding deliberately
supersedes the previous live-update contract.

Detailed measurements and rejected experiments remain in uncommitted
session reports and LOG.md.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* perf(router-core): initialize routes directly during tree processing

Remove the optional initRoute callback and unconditionally call
route.init({ originalIndex: index }) at the start of the parent-first visit,
before indexing or parsing the route. Require init on this function's input
without imposing it on masks or the shared template-scanning RouteLike type.

Remove the Router and construction-benchmark forwarding wrappers. Adapt
preinitialized matcher fixtures through one test-only helper with a
non-enumerable no-op init; do not normalize their paths/IDs or change their
expected grammar/matching results. Add real-route initialization order,
index and exactly-once coverage.

Performance versus bc71b06207, seven independent process pairs per
shape/mode using the same built-JS entry and fresh route objects:
- Server static 1000-route processing/init: 0.7781686 -> 0.7623686 ms/tree,
  CPU -2.06% (95% interval -3.26% to -0.84%); wall -2.10%.
- Other construction cells are inconclusive, with no supported slowdown.
- All 18 gzip fixtures improve by 10-26 bytes. React minimal:
  85731 -> 85712 bytes (-19). Raw -20 bytes (-59 for Rsbuild);
  Brotli remains fixture-dependent.

Object creation and forced GC are outside processing timers. The common
measurement entry's obsolete third argument is ignored by the new code,
so once-per-tree callback allocation savings are not overstated.

Full measurements and logs remain in the session's
direct-route-init-20260909 artifacts and uncommitted LOG.md.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* perf(router-core): pass route initialization indexes directly

Change the internal initializer to route.init(originalIndex). Update the
Route interface, BaseRoute implementation, processRouteTree contract and
both production call sites, including the standalone legacy fallback.
Remove object-literal arguments without adding compatibility wrappers.

Keep route ordering and stored indexes unchanged. Cover primitive arguments,
index zero and the large legacy fallback index explicitly.

Performance versus f2c2d55f99:
- Seven independent fresh-process construction comparisons per shape/mode
  (100, 1000 and 10000 routes; static/dynamic/nested/mixed) show no
  statistically supported timing difference. Do not claim an unproven
  CPU or heap-byte improvement from the removed object literals.
- All 18 gzip fixtures improve by 7-13 bytes. React minimal:
  85712 -> 85702 (-10); full: 89303 -> 89291 (-12).
- Raw JS decreases by 46 bytes in every fixture. Brotli varies.

The same production-JS phase entry and workloads are used on both sides.
Object creation and forced GC are outside processing timers. Detailed
samples, intervals and logs remain in numeric-route-init-20260909 session
artifacts and uncommitted LOG.md.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* update route trees

* ci: apply automated fixes

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
History 2026-09-13 13:55:04 +02:00
..
api perf(router-core): streamline route initialization (#8327) 2026-09-13 13:55:04 +02:00
assets docs(start): update the "reading-writing-file" tutorial (#6031) 2025-12-07 01:44:03 +13:00
eslint docs: fix syntax error in create-route-property-order.md (#6711) 2026-02-21 03:47:05 +01:00
guide perf(router-core): streamline route initialization (#8327) 2026-09-13 13:55:04 +02:00
how-to docs: remove duplicate Router and Start page headings (#8339) 2026-09-10 12:32:59 +02:00
installation docs: small improvements to wording (#7840) 2026-07-17 21:40:35 +02:00
integrations fix(docs): Ensure we use normal install for query integration package (#8228) 2026-09-03 20:01:54 +02:00
routing docs: minor docs improvements (#7842) 2026-07-22 22:12:34 +02:00
comparison.md docs: add 🟡 (Experimental) for TanStack Start RSC support (#7573) 2026-06-07 15:02:31 +02:00
config.json docs: Update Guides section and add back in missing pages (#7864) 2026-07-22 22:13:55 +02:00
decisions-on-dx.md docs: small improvements to wording (#7840) 2026-07-17 21:40:35 +02:00
devtools.md docs(router): restructure docs to use the unified markdown syntax (#6665) 2026-02-15 21:00:22 +13:00
faq.md docs(router): restructure docs to use the unified markdown syntax (#6665) 2026-02-15 21:00:22 +13:00
overview.md docs(router): restructure docs to use the unified markdown syntax (#6665) 2026-02-15 21:00:22 +13:00
quick-start.md docs: use @tanstack/cli to create tanstack/router app (#7008) 2026-03-23 18:54:46 +01:00