fix: HMR: only invalidate router if match is existing and not cached #5713
Merged
schiller-manuel(GitHub profile, opens in a new tab)merged 1 commit into
main fromrefs/pull/5713/head·merged by schiller-manuel(GitHub profile, opens in a new tab) Summary by CodeRabbit#
- Bug Fixes
- Improved hot module replacement efficiency by conditionally invalidating routes only when a matching route exists, reducing unnecessary invalidations during development.
- 1
github-actions[bot](GitHub profile, opens in a new tab) added labelspackage: router-plugin
View your CI Pipeline Execution ↗ for commit 2913af1dce86721c026d10e701553e7d5317f719
Command Status Duration Result nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded 9m 6s View ↗ nx run-many --target=build --exclude=examples/*...✅ Succeeded 33s View ↗
☁️ Nx Cloud last updated this comment at
2025-10-31 23:07:50UTCMore templates
- tanstack-router-solid-example-basic
- tanstack-router-solid-example-basic-devtools-panel
- tanstack-router-solid-example-basic-file-based
- tanstack-router-solid-example-basic-non-nested-devtools
- tanstack-router-solid-example-basic-solid-query
- tanstack-router-solid-example-basic-solid-query-file-based
- tanstack-router-solid-example-basic-ssr-streaming-file-based
- tanstack-router-solid-example-kitchen-sink-file-based
- tanstack-router-solid-example-kitchen-sink-solid-query
- tanstack-router-solid-example-kitchen-sink-solid-query-file-based
- tanstack-router-solid-example-quickstart-file-based
- tanstack-solid-start-example-bare
- tanstack-solid-start-example-basic
- tanstack-solid-start-example-basic-auth
- tanstack-solid-start-example-basic-cloudflare
- tanstack-solid-start-example-basic-netlify
- tanstack-solid-start-example-basic-nitro
- tanstack-start-example-basic-solid-query
- tanstack-solid-start-example-basic-static
- tanstack-solid-start-example-basic-supabase
- tanstack-router-react-example-authenticated-routes
- tanstack-router-react-example-authenticated-routes-firebase
- tanstack-router-react-example-basic
- tanstack-router-react-example-basic-default-search-params
- tanstack-router-react-example-basic-devtools-panel
- tanstack-router-react-example-basic-file-based
- tanstack-router-react-example-basic-non-nested-devtools
- tanstack-router-react-example-react-query
- tanstack-router-react-example-basic-react-query-file-based
- tanstack-router-react-example-basic-ssr-file-based
- tanstack-router-react-example-basic-ssr-streaming-file-based
- tanstack-router-react-example-basic-virtual-file-based
- tanstack-router-react-example-basic-virtual-inside-file-based
- tanstack-router-react-example-deferred-data
- tanstack-router-i18n-paraglide
- tanstack-router-react-example-kitchen-sink
- tanstack-router-react-example-kitchen-sink-file-based
- tanstack-router-react-example-kitchen-sink-react-query
- tanstack-router-react-example-kitchen-sink-react-query-file-based
- tanstack-router-react-example-large-file-based
- tanstack-router-react-example-location-masking
- tanstack-router-react-example-navigation-blocking
- tanstack-router-react-example-quickstart
- tanstack-router-react-example-quickstart-esbuild-file-based
- tanstack-router-react-example-quickstart-file-based
- tanstack-router-react-example-quickstart-rspack-file-based
- tanstack-router-react-example-quickstart-webpack-file-based
- router-monorepo-react-query
- router-mono-simple
- router-mono-simple-lazy
- tanstack-router-react-example-scroll-restoration
- tanstack-search-validator-adapters
- tanstack-start-example-bare
- tanstack-start-example-basic
- tanstack-start-example-basic-auth
- tanstack-start-example-basic-cloudflare
- tanstack-start-example-basic-react-query
- tanstack-start-example-basic-static
- tanstack-start-bun-hosting
- tanstack-start-example-clerk-basic
- tanstack-start-example-convex-trellaux
- tanstack-start-example-counter
- tanstack-start-i18n-paraglide
- tanstack-start-example-large
- tanstack-start-example-material-ui
- tanstack-start-streaming-data-from-server-functions
- tanstack-start-example-supabase-basic
- tanstack-start-tailwind-v4
- tanstack-start-example-trellaux
- tanstack-start-example-workos
- tanstack-router-react-example-view-transitions
- tanstack-router-react-example-with-framer-motion
- tanstack-router-react-example-with-trpc
- tanstack-router-react-example-with-trpc-react-query
@tanstack/arktype-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5713@tanstack/directive-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5713@tanstack/eslint-plugin-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5713@tanstack/history
npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5713@tanstack/nitro-v2-vite-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5713@tanstack/react-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5713@tanstack/react-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5713@tanstack/react-router-ssr-query
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5713@tanstack/react-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5713@tanstack/react-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5713@tanstack/react-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5713@tanstack/router-cli
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5713@tanstack/router-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5713@tanstack/router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5713@tanstack/router-devtools-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5713@tanstack/router-generator
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5713@tanstack/router-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5713@tanstack/router-ssr-query-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5713@tanstack/router-utils
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5713@tanstack/router-vite-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5713@tanstack/server-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5713@tanstack/solid-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5713@tanstack/solid-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5713@tanstack/solid-router-ssr-query
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@5713@tanstack/solid-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5713@tanstack/solid-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5713@tanstack/solid-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5713@tanstack/start-client-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5713@tanstack/start-plugin-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5713@tanstack/start-server-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5713@tanstack/start-static-server-functions
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5713@tanstack/start-storage-context
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5713@tanstack/valibot-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5713@tanstack/virtual-file-routes
npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5713@tanstack/zod-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5713commit:
2913af1
Sign in to join this conversation.
Walkthrough#
The router-plugin's hot module replacement logic is updated to conditionally invalidate routes. Instead of unconditionally calling
router.invalidate(), the code now checks if a matching route exists inrouter.state.matchesorrouter.state.pendingMatchesbefore invalidating, using a filter function to identify the old route ID.Changes#
packages/router-plugin/src/core/route-hmr-statement.tsrouter.invalidate()call using a filter function that checks for matching routes before invalidation.packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx,packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx,packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxEstimated code review effort#
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs#
Poem#
Pre-merge checks and finishing touches#
❌ Failed checks (1 warning)
@coderabbitai generate docstringsto improve docstring coverage.✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 3e32efb53821734d756f814c4d07eaa76917155c and 2913af1dce86721c026d10e701553e7d5317f719.
📒 Files selected for processing (4)
packages/router-plugin/src/core/route-hmr-statement.ts(2 hunks)packages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsx(1 hunks)packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx(1 hunks)packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsx(1 hunks)🧰 Additional context used
📓 Path-based instructions (3)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
Files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.tspackages/{router-cli,router-generator,router-plugin,virtual-file-routes}/**
📄 CodeRabbit inference engine (AGENTS.md)
Files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.tspackages/router-plugin/**
📄 CodeRabbit inference engine (AGENTS.md)
Files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.ts🧠 Learnings (7)
📓 Common learnings
📚 Learning: 2025-10-08T08:11:47.088Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.ts📚 Learning: 2025-09-23T17:36:12.598Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.ts📚 Learning: 2025-10-01T18:30:26.591Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/solid/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/arrow-function@true.tsxpackages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.ts📚 Learning: 2025-09-23T17:36:12.598Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx📚 Learning: 2025-09-23T17:36:12.598Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsx📚 Learning: 2025-09-23T17:36:12.598Z
Applied to files:
packages/router-plugin/tests/add-hmr/snapshots/react/function-declaration@true.tsxpackages/router-plugin/src/core/route-hmr-statement.ts⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (5)
Comment `@coderabbitai help` to get the list of available commands and usage tips.