0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
Commit graph

47 commits

Author SHA1 Message Date
Kyle Mathews
988a9d6788
test: add invariant and property tests for code-splitter shared bindings (#6662)
* test: add invariant, property, and exhaustive tests for code-splitter shared bindings

Add 76 new tests across three layers for the shared virtual module
code-splitting logic introduced in #6659:

Layer 1 - Algebraic property tests on helper functions:
- expandTransitively: idempotence, monotonicity, cycle handling
- buildDependencyGraph: subset invariants
- removeBindingsDependingOnRoute: direct/transitive removal
- expandDestructuredDeclarations: idempotence, sibling expansion
- collectLocalBindingsFromStatement: all declaration types

Layer 2 - Invariant tests on computeSharedBindings:
- Route is never in the shared set
- Results are always real local bindings (never imports)
- Destructured siblings cohesion
- Transitive dependency inclusion
- Route-dependent binding exclusion
- Determinism across repeated calls

Layer 3 - Small-scope exhaustive tests:
- Single binding × 3 declaration kinds × 4 property patterns × 2 groupings
- Two bindings × 4 cross-group reference patterns × 2 groupings
- Transitive dependency chains (linear, 3-deep, diamond)
- Meta-invariant conformance across all shared-* fixture files

Testing approach inspired by:
https://gist.github.com/KyleAMathews/64bcea53a57f600cc3b73bc366d9ac4d

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* ci: apply automated fixes

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-14 18:41:23 +01:00
Manuel Schiller
523972e0df
fix: shared virtual module for code-split routes (#6659)
* fix: shared virtual module for code-split routes

When a route file has module-level bindings (variables, functions, classes) referenced by **both** split and non-split route properties, the bindings are duplicated — initialized independently in the reference file and in each virtual split file. This breaks singletons, causes double side effects, and wastes bundle size.

```tsx
const collection = { name: 'todos', preload: async () => {} }
export const Route = createFileRoute('/todos')({
  loader: async () => {
    await collection.preload()
  }, // stays in reference
  component: () => <div>{collection.name}</div>, // split to virtual
})
```
In this example, `collection` is initialized in **both** the reference file (because `loader` references it) and the `?tsr-split=component` virtual file (because the component references it). Two separate instances exist at runtime.

To solve this issue, this PR introduces a third virtual module `route.tsx?tsr-shared=1` that contains shared bindings. Both the reference and virtual files import from it.

When `sharedBindings` is empty (the common case — component-only helpers, loader-only code), no shared module exists and the system works exactly as today.

The reference transform runs first and will emit a static import of `?tsr-shared=1` **only when needed**. Since split chunks are only discovered via the reference file's emitted `import('...?tsr-split=...')`, the bundler will always process/evaluate the reference module first. Result: the shared module is evaluated once and then reused by any later-loaded split chunk.
2026-02-14 13:10:54 +01:00
Manuel Schiller
30dc11e50a
fix: autoCodeSplitting` with destructured export (#6656)
fixes #4787
2026-02-14 02:26:03 +01:00
Birk Skyum
174be108f2
chore: optimize links to github (#6633) 2026-02-10 23:42:52 +01:00
Sean Cassiere
70248f219d
fix(router-plugin): normalize file paths for Windows compatibility with rspack/webpack (#6333)
The route generator stores file paths with forward slashes
but rspack and webpack on Windows pass native paths with
backslashes to transform handlers.

This caused TSR_ROUTES_BY_ID_MAP lookups to fail, preventing
autoCodeSplitting from working on Windows with rspack.The
route generator stores file paths with forward slashes, but
rspack and webpack on Windows pass native paths with backslashes to
transform handlers.

This caused TSR_ROUTES_BY_ID_MAP lookups to fail, preventing
autoCodeSplitting from working on Windows with rspack.
2026-01-09 20:13:07 +13:00
Manuel Schiller
7d598a1e2d
chore: bump babel-dead-code-elimination (#6228) 2025-12-26 02:11:04 +01:00
Flo
7b4dcee399
refactor(router-core): index routes have index nodes in the segment tree (#6171) 2025-12-21 16:32:19 +01:00
Nico Lynzaad
2ae37028a0
fix(router-plugin): do not overwrite resolved generator config with unprocessed inline config (#5963)
* do not overwrite resolved config with unprocessed inline input

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-25 20:08:37 +02:00
Flo
f39eb9b832
refactor(router-core): Process routeTree into segment tree instead of flatRoutes [WIP] (#5722) 2025-11-15 13:45:02 +01:00
Manuel Schiller
913430d701
fix: HMR: only invalidate router if match is existing and not cached (#5713) 2025-11-01 00:15:36 +01:00
Manuel Schiller
93d19ad11f
fix: route HMR handling (#5710) 2025-10-31 20:38:17 +01:00
Manuel Schiller
6f744c2089
fix: enable dead code elimination in split-route to remove unused imports (#5711) 2025-10-31 20:37:51 +01:00
Manuel Schiller
5022a60d2e
fix: only transform files in codesplitter if changes were made (#5460) 2025-10-13 01:32:01 +02:00
Sean Cassiere
96bde26a90
fix(router-plugin): show warning for non-splittable items (#5145) 2025-09-13 12:47:02 +12:00
Manuel Schiller
b8ef497d90
fix: do not rename functions / variables when code splitting (#4960)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-15 17:13:26 +02:00
jihoon
638a902ee6
fix(router-plugin): add support for boolean and null literals in code splitter (#4915)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-08-13 13:01:57 +12:00
Sean Cassiere
b9f88c5426
test(router-plugin): split addHmr snapshot testing (#4612) 2025-07-10 19:49:47 +12:00
Wei Tang Lin
84228d51dd
fix(router-plugin): code-splitting to handle explicit undefined (#4564)
Co-authored-by: weitang.lin <weitang.lin@mujin.co.jp>
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-07-07 15:35:55 +12:00
Manuel Schiller
d728d69900
feat: ssr setting per route (#4565)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-07-05 14:35:14 +02:00
Sean Cassiere
d2fe66637b
fix(router-plugin): codeSplittingOptions.splitBehavior to work with verboseFileRoutes (#4414) 2025-06-13 22:00:03 +12:00
Manuel Schiller
8b5accb27c
feat: Merge alpha to main (#4365)
Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com>
Co-authored-by: Iha Shin (신의하) <me@xiniha.dev>
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
Co-authored-by: MoeedDar <moeed.dar@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Saša Šijak <me@ssijak.com>
Co-authored-by: Christopher Horobin <chrishorobin@hotmail.com>
Co-authored-by: Ryan Gillie <gillie.ryan@hotmail.com>
Co-authored-by: Jaga Santagostino <jagasantagostino@gmail.com>
Co-authored-by: Birk Skyum <birk.skyum@pm.me>
Co-authored-by: Yeoh Joer <yeoh.joer@outlook.com>
Co-authored-by: Dane Grant <danecando@gmail.com>
Co-authored-by: Birk Skyum <74932975+birkskyum@users.noreply.github.com>
Co-authored-by: Luis Merino <mail@luismerino.name>
Co-authored-by: ThaumRystra <9525416+ThaumRystra@users.noreply.github.com>
Co-authored-by: Adam Hunter <arhunter@gmail.com>
Co-authored-by: Leonardo Montini <lion.48m@gmail.com>
Co-authored-by: Joel Tannas <jtannas@gmail.com>
Co-authored-by: scarf <greenscarf005@gmail.com>
Co-authored-by: Lenz Weber-Tronic <lorenz.weber-tronic@apollographql.com>
Co-authored-by: Iñaki Larramendi <30437204+ilarramendi@users.noreply.github.com>
Co-authored-by: Hiển Đào Vinh <neo.go.vn@gmail.com>
Co-authored-by: Lleyton W Morris <42259073+ViewableGravy@users.noreply.github.com>
Co-authored-by: Lleyton Morris <lmorris@nexigen.digital>
Co-authored-by: Matthew Struble <matt@vevox.io>
Co-authored-by: Matt Anderson <matt@mattdev.ca>
Co-authored-by: Chung <chungwong@users.noreply.github.com>
Co-authored-by: Maxx Coffee <josh@joshcoffee.dev>
Co-authored-by: Joshua Coffee <joshcoffee@gannett.com>
Co-authored-by: Jack Herrington <jherr@pobox.com>
Co-authored-by: Neeraj Dalal <admin@nrjdalal.com>
Co-authored-by: Thomas Marnet <thomas.marnet@gmail.com>
Co-authored-by: Vianney Carel <vcarel@users.noreply.github.com>
Co-authored-by: Vianney Carel <vianney.carel@logfuse.fr>
Co-authored-by: Diego Rincón <97266392+diegoarff@users.noreply.github.com>
Co-authored-by: Erfan Hosseini <43422324+Erfanhosseini98@users.noreply.github.com>
Co-authored-by: IderAghbal <3328396+IderAghbal@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Andrew Jefferson <8148776+eastlondoner@users.noreply.github.com>
2025-06-10 23:19:32 +02:00
Manuel Schiller
b84e5c77bc
fix: make route HMR handling robust against route deletion (#4292) 2025-06-01 18:15:26 +02:00
Manuel Schiller
5663aa601b
fix: proper HMR handling for file routes (#4240)
porting from alpha to main

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-23 19:30:01 +02:00
Sean Cassiere
6fcf118785
fix(router-plugin): do not split the pendingComponent (#4047)
This change, makes it so that the `pendingComponent` is no longer
code-split by default when using the `automaticCodeSplitting` feature.

With this change, both the `loader` and `pendingComponent` will not be
code-split by _default_.
2025-04-25 17:00:34 +12:00
Sean Cassiere
e9b253ebfd
fix(router-plugin): code-splitting to handle default exported function declarations (#3901)
Currently, when the code-splitter encounters a known identifier used for
configuration in `createFileRoute` (such as `component`, `loader`,
`errorComponent`, etc.) it retains the export without splitting it out
into a separate file.

This functionality is currently partially working when the export is a
"default export" which references an already declared identifier.

```ts
const loader = () => {}
export default loader
```

However, it does not work when the "default export" is also making a
function declaration for the export.

```ts
export default function loader() {}
```

This PR adds the functionality to detect this use case and perform the
same transformations to align itself with the behaviour for all others
exports.
2025-04-01 10:14:32 +13:00
Manuel Schiller
1cb9443912
fix: bump babel-dead-code-elimination (#3881)
fixes #3824
2025-03-29 17:25:03 +01:00
Ben Durrant
3abf4c19f7
fix(start,router): Change DCE so it only affects *newly* dead code (#3422)
Co-authored-by: Manuel Schiller <manuel.schiller@caligano.de>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-02-18 19:20:52 +01:00
Sean Cassiere
e88b960702
refactor(router-plugin): code-splitting to be agnostic to support 'targets' (#3400) 2025-02-12 15:21:06 +13:00
Sean Cassiere
cf693e7353
feat(router-plugin): configurable key-based code splitting (#3355) 2025-02-09 14:09:18 +13:00
Sean Cassiere
01f2cbe198
fix(router-plugin): handle "ConditionalExpression" when code-splitting (#3359) 2025-02-08 03:29:26 +13:00
Sean Cassiere
323820b6f6
fix(router-plugin): reduce route-tree bundle size (#3354)
Currently, when using `automaticCodeSplitting`, as part of compiling the "reference" route, we add a component (named `TSRDummyComponent`) to aid with the HMR trickery.

In removing this component from the production bundle, it impacts the visitor by reducing the initial js bundle that wires the route-tree.
2025-02-07 23:42:56 +13:00
Manuel Schiller
c636f9b825
fix(router-plugin): fix handling of import attributes (#3331) 2025-02-04 20:02:59 +01:00
Sean Cassiere
a65f7704d4
fix(router-plugin): HMR for autoCodesplitting routes (#3275) 2025-01-30 12:27:05 +13:00
Manuel Schiller
40dd906868
fix: do not minify during code splitting (#3189)
fixes #3183
2025-01-18 08:55:48 +01:00
Tanner Linsley
e9781b777e
feat: Agnostic Server Fn Plugin (#2993)
* checkpoint

* checkpoint

* cleanup

* checkpoint

* client babel now works, runtime and rpc injection

* fix: dont touch anything outside of the function

* server functions now import a tsr-serverfn-split file version

* checkpoint

* checkpoint

* fis tests

* It's working!!!

* move serverFnFetcher to start client

* fix: no extra context, throw errors from middleware

* docs: add custom link example for mantine (#3033)

* ci: apply automated fixes

* fix(react-router): make sure full matches are passed into route functions (#3039)

* release: v1.91.3

* docs: minor typo in code-based-routing.md (#3043)

* feat(start): create-start cli (#2920)

* create start cli

* update lockfile

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* docs: Minor typo in middleware.md (#3042)

* release: v1.92.0

* refactor(react-router): expose `scrollBehavior` on the `ScrollRestoration` component (#3053)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

* release: v1.92.1

* fix(start): returning `null` from server functions (#3048)

Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>

* release: v1.92.2

* fix: allow serverFn errors to also have context (#3037)

* fix: allow serverFn errors to also have context

* fix: allow errors, undefined from server functions

* remove logs

* fix: transformer and tests

* ci: apply automated fixes

* no logs

* fix conficts

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* release: v1.92.3

* move directive plugin to own package

* fixes, tests

* suggested fixes from sean

* fix tests

* fix: import specifier

* fix: dev imports

* fix: simpler config, better logging, more reliable plugin coordination

* fix: update test snapshots

* fix: non-split directives, clean up compilers, logging, and

* fix: production server fn builds

* feat(start): explicitly enable and disable route generation

* fix: $fetch during dev

* ci: apply automated fixes

* Update comparison.md

* docs: remove duplicate word (#3125)

* docs: remove duplicate word

* docs: correct typo in learn-the-basics.md

* chore: add skipLibCheck to examples (#3134)

* docs: Typo issue - getParent Does not Exists in type RouteOptions (#3131)

* docs: Fix notFound import (#3133)

* docs: fix dead link and typo in guide (#3136)

Typo introduced in https://github.com/TanStack/router/pull/2963.

* fix(react-router): separate internal and user provided history state (#3119)

* release: v1.95.2

* fix(router-generator) use explicit routes export by default (#3109)

Co-authored-by: Vladimir Panov <vladimir.panov@motorsport.com>

* fix(start): serialize `FormData` for server function input (#3138)

* release: v1.95.3

* test(react-router): check `FormData` serialization in transformer (#3139)

* docs(router): missing character in code-splitting guide (#3143)

* fix(create-start): readme changes and little fixes (#3142)

* release: v1.95.4

* fix(start): preserve multiple values for same key in `FormData` serialization (#3140)

Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>

* release: v1.95.5

* docs(migrate): correct typo in migration documentation (#3153)

* docs(start): fix `FormData` server functions examples (#3062)

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

* docs(router): require the use of React's `createRoot` function (#3151)

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>

* fix: order of injected scripts (#3158)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* release: v1.95.6

* perf(start): reduce instantiations of server fn and middleware (again) (#3168)

* perf: reduce instantiations of server fns

* perf(start): reduce instantiations of middleware

* release: v1.95.7

* fix imports

* fix: build test

---------

Co-authored-by: Youssef Benlemlih <youssefbenlemlih7@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Manuel Schiller <manuel.schiller@caligano.de>
Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com>
Co-authored-by: AlexisPin <72150908+AlexisPin@users.noreply.github.com>
Co-authored-by: timoconnellaus <tim.oconnell.australia@gmail.com>
Co-authored-by: Arnaud Kleinpeter <arnaud.kleinpeter@gmail.com>
Co-authored-by: Joshua Knauber <49953016+joshuaKnauber@users.noreply.github.com>
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
Co-authored-by: alakhpc <alakhpc@gmail.com>
Co-authored-by: Mark Vu <markvu.work@gmail.com>
Co-authored-by: Christopher Horobin <chrishorobin@hotmail.com>
Co-authored-by: Muthu Kumar <muthu32@users.noreply.github.com>
Co-authored-by: Jeff Hertzler <jeffhertzler@gmail.com>
Co-authored-by: Philippe Serhal <philippe.serhal@gmail.com>
Co-authored-by: Andrei <andreiradoidev@gmail.com>
Co-authored-by: Volodymyr <vpanov.me@gmail.com>
Co-authored-by: Vladimir Panov <vladimir.panov@motorsport.com>
Co-authored-by: pierluigigiancola <pierluigi.giancola@gmail.com>
Co-authored-by: Tom Ballinger <tom@convex.dev>
Co-authored-by: Ben Durrant <ben.durrant@marketdojo.com>
Co-authored-by: Lukas Frey <lukas.frey03@outlook.de>
Co-authored-by: John <12599934+jorroll@users.noreply.github.com>
2025-01-14 20:36:33 -07:00
Manuel Schiller
27a88213c8
fix(router-plugin): correctly handle VariableDeclarator when splitting (#2650) 2024-10-27 01:04:00 +02:00
Manuel Schiller
d6af29ea4e
feat: add default setting for ssr in router (#2477) 2024-10-05 16:06:17 +02:00
Manuel Schiller
da9b824be5
feat: allow to exclude routes from SSR (#2463) 2024-10-04 21:53:45 +02:00
Sean Cassiere
df6701841b
fix(router-plugin): do not split if known ident is exported (#2334) 2024-09-19 00:52:12 +02:00
Sean Cassiere
68b5b528c7
refactor(router plugin): restructure the plugin's internals (#2155)
* chore(router-plugin): rename "code-splitter" to "router-code-splitter"

* refactor(router-plugin): follow unplugin standards and move lib code into "core"

* test(router-plugin): update imports
2024-08-21 00:13:07 +12:00
Sean Cassiere
bfe73c0a41
refactor(router-plugin): use babel-dead-code-elimination to handle the removal of unreferenced code (#1855)
* chore(router-plugin): add `babel-dead-code-elimination`

* feat(router-plugin): initial implementation

* chore(router-plugin): better test scripts

* test(router-plugin): check it with the new functions

* fix(start-vite-plugin): add vite

* feat(router-plugin): bump unplugin

* fix(router-plugin): making sure it works

* chore(router-plugin): cleanup

* chore(router-plugin): delete "eliminateUnreferencedIdentifiers.ts"

* fix(router-plugin): esm problems

* chore(router-plugin): restore minification for production

* chore(start-vite-plugin): undo the vite

* Bump vite

* pnpm dedupe

* test(router-plugin): bit of renaming here

---------

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
2024-06-29 14:16:02 +12:00
Tanner Linsley
fd692cf77d
feat: New Serialization Paradigm (#1824)
* checkpoint

* fix: config

* checkpoint

* testing fixes (#1679)

* examples: init trellaux

* feat: Better serialization/streaming, RSC proof of concept

* fixup server-handler

* fix: update deps and lock

* fix: remove rscFrom

* fix: remove useLoaderDataTransform

* fix: min react version

* chore: lockfile

* style: prettier fail

* chore: swap expect-error for ignore

* chore(react-router): try coercing the types

* chore: put this back in

* fix: some tests

* remove conditions

* fix tests

* update lockfile

* fix: refactor dehydrated data

* Update docs

* fix: remove unused deferred logic

* fix port

* nevermind

* fix: remove rebase garbage

* disable playwright for a hot minute

* oops, actually disable it now

* fix: prettier formatting

* fix: do not ignore app.config files

---------

Co-authored-by: Nikhil Saraf <nsaraf98@gmail.com>
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2024-06-28 09:45:01 -06:00
Sean Cassiere
10eb05902c
fix(router-plugin): experimental.enableCodeSplitting - allow the use of inlined wrappers for the route options when splitting nodes (#1813)
* test(router-plugin): tests for the route-items being wrapped in React.memo

* fix(router-plugin): React.memo breaks the codesplitting

* test(router-plugin): snapshots for the React.memo stuff

* refactor(router-plugin): variable naming is hard 😅

* chore(router-plugin): whoops
2024-06-22 04:22:04 +12:00
Sean Cassiere
940ddb7690
fix(router-plugin): removing trailing import string literals with no references for experimental.enableCodesplitting (#1810)
* refactor(router-plugin): use the helpers

* fix(router-plugin): unnecessarily importing items that should be eliminated

* fix(router-plugin): update snapshots

* fix(router-plugin): same treatment for loaders

* test(router-plugin): update snapshots

* style(router-plugin): eslint

* refactor(router-plugin): use guard clauses

* perf(router-plugin): reduce the double traversals being done here
2024-06-22 02:38:24 +12:00
Sean Cassiere
06fc3f467c
fix(router-plugin): experimental.enableCodeSplitting not handling default imports (#1807)
* test(router-plugin): starting point

* fix(router-plugin): fix default imported components

* test(router-plugin): test case for there being both a default component import and a destructured loader import

* chore(router-plugin): cleanup of my testing test file...
2024-06-22 00:30:09 +12:00
Sean Cassiere
e5d8b815db
fix(router-plugin): inline-config should be optional (#1783)
* fix(router-plugin): package.json fields causing issues during imports

* fix: make the inlineConfig optional

* chore: trigger ci

* chore: try ci again

* chore: add a better readme

* test: just something to trigger CI honestly
2024-06-19 17:53:55 +12:00
Sean Cassiere
40043475cf
refactor: setup the @tanstack/router-plugin package using "unplugin" (#1778)
* feat: scaffold the new `@tanstack/router-plugin` package

* chore: include in the overrides

* feat: more scaffolding

* test: just a random test that'll be removed later

* build: hopefully fixes build

* style: import order

* chore: peer deps for router-plugin

* feat: setup the generator

* refactor: combined needs to be done for the individual plugin

* chore: copy all the babel stuff over from router-vite-plugin

* feat: copy the babel plugin setup from router-plugin

* feat: enfore pre

* refactor: turn the error into its own custom one

* style: eslint

* style: more eslint

* chore: update the readme
2024-06-19 15:43:31 +12:00