fix(react): Prevent lazy route handlers from updating wrong navigation span#18898
Merged
fix(react): Prevent lazy route handlers from updating wrong navigation span#18898
Conversation
onurtemizkan
force-pushed
the
onur/fix-wrapPatchRoutesOnNavigation
branch
from
0c40c63 to
63dcf55
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a race condition in React Router lazy route handling where navigation spans could be incorrectly updated when users navigate away during lazy route loading.
Changes:
- Use captured navigation span consistently instead of calling
getActiveRootSpan()at resolution time inwrapPatchRoutesOnNavigation - Add
!spanJson.timestampguard to prevent updates on already-ended spans - Remove
WINDOW.locationfallback when navigation context exists buttargetPathis undefined to avoid using stale location data
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react/src/reactrouter-compat-utils/lazy-routes.tsx | Updated captureCurrentLocation to return null instead of falling back to WINDOW.location when inside navigation context with undefined targetPath |
| packages/react/src/reactrouter-compat-utils/instrumentation.tsx | Modified wrapPatchRoutesOnNavigation to use captured activeRootSpan consistently in both args.patch callback and completion handler, added !spanJson.timestamp checks, removed WINDOW.location fallback |
| packages/react/test/reactrouter-compat-utils/lazy-routes.test.ts | Added edge case tests for captureCurrentLocation behavior with and without navigation context |
| packages/react/test/reactrouter-compat-utils/instrumentation.test.tsx | Added unit tests for race condition fix verifying ended spans are not updated |
| dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/tests/transactions.test.ts | Added E2E tests simulating rapid navigation scenarios to validate the race condition fix |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
onurtemizkan
force-pushed
the
onur/fix-wrapPatchRoutesOnNavigation
branch
from
63dcf55 to
97659e9
Compare
s1gr1d
approved these changes
Jan 26, 2026
Member
s1gr1d
left a comment
s1gr1d
left a comment
There was a problem hiding this comment.
Looks good, but I have to say the code gets harder and harder to understand 😅
onurtemizkan
force-pushed
the
onur/fix-wrapPatchRoutesOnNavigation
branch
from
97659e9 to
42a863b
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Lms24
approved these changes
Jan 28, 2026
onurtemizkan
added a commit
that referenced
this pull request
Feb 10, 2026
…es (#19086) This PR will resolve the core reason for the series of fixes / handling for automatic lazy-route resolution for a while. Related: #18898, #18881, #18346, #18155, #18098, #17962, #17867, #17438, #17277 The core issue we have been trying to tackle is not having access to the complete route hierarchy when asynchronously loaded lazy routes are used. React Router provides a route manifest that we can use while matching parameterized transaction names with routes in all cases except this lazy-routes pattern. This problem has been discussed on React Router: - remix-run/react-router#11113 While this has been [addressed](remix-run/react-router#11626) for Remix / React Router (Framework Mode), it's still not available in Library Mode. The manifest contains the lazily-loaded route, only when it's navigated to. While waiting for navigation, our transactions can be dropped for several reasons, such as user behaviour like switching tabs (`document.hidden` guard), hitting timeouts like `idleTimeout`, and potentially other reasons. This results in incomplete transaction naming with leftover wildcards, which caused broken aggregation on the Sentry dashboard. The series of attempts to fix this while keeping automatic route discovery has been prone to race conditions and required special-case handling of each edge case scenario, also requiring a considerable amount of internal logic, affecting our readability and performance. At the end, all failed in giving completely robust and deterministic results on the customers' side. This PR proposes a new option: `lazyRouteManifest` specifically for lazy routes. This will let us have initial information about the route hierarchy. So we can assign correct parameterized transaction names without needing to wait for navigated state. It's a static array of routes in parameterized format (needs to be maintained by the users on route hierarchy updates) like: ```ts Sentry.reactRouterV7BrowserTracingIntegration({ // ... enableAsyncRouteHandlers: true lazyRouteManifest: [ '/', '/pricing', '/features', '/login', '/signup', '/forgot-password', '/reset-password/:token', '/org/:orgSlug', '/org/:orgSlug/dashboard', '/org/:orgSlug/projects', '/org/:orgSlug/projects/:projectId', '/org/:orgSlug/projects/:projectId/settings', '/org/:orgSlug/projects/:projectId/issues', '/org/:orgSlug/projects/:projectId/issues/:issueId', '/org/:orgSlug/team', '/org/:orgSlug/team/:memberId', '/org/:orgSlug/settings', '/org/:orgSlug/billing', '/admin', '/admin/users', '/admin/users/:userId', '/admin/orgs', '/admin/orgs/:orgId', ], }) ``` - This will only be active when `enableAsyncRouteHandlers` is set to `true` - To match URLs with given routes, we mimic React Router's own implementation. - When this is not provided or fails, it falls back to the current behaviour - This manifest is primarily for lazy routes, but the users can also add their non-lazy routes here for convenience or consistency. - Also added E2E tests that will fail when (if at some point) React Router manifests include the lazy routes before navigation, so we'll be aware and plan depending on that manifest instead. - We can do a cleanup for the race-condition / edge-case handling part of the code in a follow-up PR. Closes #19090 (added automatically)
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
3 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.
Following up on #18346
Fixes a remaining race condition where the
args.patchcallback and completion handler inwrapPatchRoutesOnNavigationwere still callinggetActiveRootSpan()at resolution time instead of using the captured span. This caused wrong span updates when users navigated away during lazy route loading.The fix uses the captured
activeRootSpanconsistently, adds a!spanJson.timestampcheck to skip updates on ended spans, and removes theWINDOW.locationfallback. IncaptureCurrentLocation, returnsnullwhen navigation context exists buttargetPathisundefined, instead of falling back to staleWINDOW.location.Also added E2E tests that simulate rapid navigation scenarios where a slow lazy route handler completes after the user navigated elsewhere.