fix: remove router context caching#6734
Merged
schiller-manuel merged 1 commit intomainfrom Feb 22, 2026
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR refactors how router context is accessed across react-router, solid-router, and vue-router packages. The getRouterContext() function is removed and replaced with direct exports of routerContext (a context object or Symbol), simplifying context provisioning and eliminating previous SSR caching logic. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
|
View your CI Pipeline Execution ↗ for commit 96e07c5
☁️ Nx Cloud last updated this comment at |
Contributor
Bundle Size Benchmarks
Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
packages/vue-router/src/useRouter.tsx (1)
9-9: Type cast is necessary for generic support but reduces type safety.The
as anycast is required becauserouterContextis typed asInjectionKey<AnyRouter>while the function returns a genericTRouter. This is a common Vue pattern limitation when combining generics with injection keys.Consider if a more type-safe approach is feasible in the future, such as having the consumer provide the expected type via a factory function. However, this is acceptable for now given the existing pattern.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/vue-router/src/useRouter.tsx` at line 9, The current use of "as any" in the Vue.inject call reduces type safety when retrieving the injected router (see useRouter and routerContext); leave the cast to preserve generic support but replace the bare cast with an explicit explanatory TODO comment above the injection line explaining why the cast is required and suggesting a future, more type-safe approach (e.g., accepting an InjectionKey<TRouter> or a factory that returns TRouter), so the code keeps current behavior while documenting the tradeoff for future refactors.packages/solid-router/src/routerContext.tsx (1)
4-5: Prefer a nullable context type instead ofnull as unknown as AnyRouter.Line 4–5 uses a double assertion that sidesteps strict typing. Consider
AnyRouter | undefined(ornull) and let consumers handle missing providers; this also enables removing theas anyinpackages/solid-router/src/useRouter.tsxLine 9.♻️ Proposed adjustment
-export const routerContext = Solid.createContext<AnyRouter>( - null as unknown as AnyRouter, -) +export const routerContext = Solid.createContext<AnyRouter | undefined>( + undefined, +)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/solid-router/src/routerContext.tsx` around lines 4 - 5, Change routerContext to use a nullable type (e.g., Solid.createContext<AnyRouter | undefined> or AnyRouter | null) instead of the double-assertion null as unknown as AnyRouter; update the context creation in routerContext (symbol: routerContext) to that nullable type and adjust consumers (notably the useRouter hook in useRouter.tsx) to handle the undefined/null provider so you can remove the `as any`/assertion in useRouter.tsx.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@packages/solid-router/src/routerContext.tsx`:
- Around line 4-5: Change routerContext to use a nullable type (e.g.,
Solid.createContext<AnyRouter | undefined> or AnyRouter | null) instead of the
double-assertion null as unknown as AnyRouter; update the context creation in
routerContext (symbol: routerContext) to that nullable type and adjust consumers
(notably the useRouter hook in useRouter.tsx) to handle the undefined/null
provider so you can remove the `as any`/assertion in useRouter.tsx.
In `@packages/vue-router/src/useRouter.tsx`:
- Line 9: The current use of "as any" in the Vue.inject call reduces type safety
when retrieving the injected router (see useRouter and routerContext); leave the
cast to preserve generic support but replace the bare cast with an explicit
explanatory TODO comment above the injection line explaining why the cast is
required and suggesting a future, more type-safe approach (e.g., accepting an
InjectionKey<TRouter> or a factory that returns TRouter), so the code keeps
current behavior while documenting the tradeoff for future refactors.
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
1 participant
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 by CodeRabbit
Breaking Changes
Improvements