fix: restore routerLoad argument to createHandler#2228
Merged
Conversation
The optional 3rd argument to createHandler, introduced in #1840 to enable TanStack Router SSR, was accidentally dropped in the v2 rewrite (#1942). The client half (StartClientTanstack) survived, so apps using the with-tanstack-router pattern crashed with a 500 from an uninitialized router store. Restores routerLoad on both createHandler variants and threads it through createBaseHandler, invoked before createPageEvent so it only runs for page renders (not server functions or API routes). Fixes #2221 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for solid-start-landing-page ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: 00d960b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
commit: |
lxsmnsyc
approved these changes
Jul 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restores the optional
routerLoadthird argument tocreateHandler, which was accidentally dropped in the v2 rewrite (#1942).routerLoadwas introduced in #1840 to enable TanStack Router SSR — it primes the router store on the server before rendering. The client half of that integration (StartClientTanstack) survived the rewrite, but the server half didn't, so any v2 app following thewith-tanstack-routertemplate pattern (createHandler(fn, undefined, routerLoad)) returns HTTP 500 withTypeError: Cannot read properties of undefinedfrom the uninitialized router store. The docs (create-handler.mdx) still document the parameter.Fixes #2221
Changes
createHandler(server + SPA variants) acceptsrouterLoad?: (event: FetchEvent) => Promise<void>again and threads it throughcreateBaseHandler.createPageEvent, so it only runs for page renders. This is a slight narrowing from v1, where it ran at the top ofprovideRequestEventfor every request including API routes — the hook exists to prime the router store for SSR, so running it for non-page requests was wasted work.Verification
Tested with a fixture app based on the original
with-tanstack-routerexample (code-based routes, no router-plugin codegen), on a fresh server each time since the module-level router singleton retains state across hot reloads:tsc --noEmitpasses; unit test suite unchanged (the one pre-existingfetchEvent.specfailure reproduces identically onmain).🤖 Generated with Claude Code