-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(react): Add POP
guard for long-running pageload
spans
#17867
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
onurtemizkan
wants to merge
6
commits into
develop
Choose a base branch
from
onur/react-router-long-running-pageload-guard
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+211
−23
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b3027fd
fix(react): Add `POP` guard for long-running `pageload` spans
onurtemizkan 2d3c168
Improve
onurtemizkan 9cceed1
Make memory router consistent
onurtemizkan 9e5b891
Improve the loading state checks
onurtemizkan a8e716a
Add E2E tests
onurtemizkan 69b516d
Stop relying on `idle` state
onurtemizkan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
49 changes: 49 additions & 0 deletions
49
...2e-tests/test-applications/react-router-7-lazy-routes/src/pages/LongRunningLazyRoutes.tsx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import React, { useEffect, useState } from 'react'; | ||
import { Link, useParams } from 'react-router-dom'; | ||
|
||
// Component that simulates a long-running component load | ||
// This is used to test the POP guard during long-running pageloads | ||
const SlowLoadingComponent = () => { | ||
const { id } = useParams<{ id: string }>(); | ||
const [data, setData] = useState<string | null>(null); | ||
const [isLoading, setIsLoading] = useState(true); | ||
|
||
useEffect(() => { | ||
// Simulate a component that takes time to initialize | ||
// This extends the pageload duration to create a window where POP events might occur | ||
setTimeout(() => { | ||
setData(`Data loaded for ID: ${id}`); | ||
setIsLoading(false); | ||
}, 1000); | ||
}, [id]); | ||
|
||
if (isLoading) { | ||
return <div id="loading-indicator">Loading...</div>; | ||
} | ||
|
||
return ( | ||
<div id="slow-loading-content"> | ||
<div>{data}</div> | ||
<Link to="/" id="navigate-home"> | ||
Go Home | ||
</Link> | ||
</div> | ||
); | ||
}; | ||
|
||
export const longRunningNestedRoutes = [ | ||
{ | ||
path: 'slow', | ||
children: [ | ||
{ | ||
path: ':id', | ||
element: <SlowLoadingComponent />, | ||
loader: async () => { | ||
// Simulate slow data fetching in the loader | ||
await new Promise(resolve => setTimeout(resolve, 2000)); | ||
return null; | ||
}, | ||
}, | ||
], | ||
}, | ||
]; |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -241,6 +241,10 @@ export function createV6CompatibleWrapCreateBrowserRouter< | |
|
||
const activeRootSpan = getActiveRootSpan(); | ||
|
||
// Track whether we've completed the initial pageload to properly distinguish | ||
// between POPs that occur during pageload vs. legitimate back/forward navigation. | ||
let isInitialPageloadComplete = false; | ||
|
||
// The initial load ends when `createBrowserRouter` is called. | ||
// This is the earliest convenient time to update the transaction name. | ||
// Callbacks to `router.subscribe` are not called for the initial load. | ||
|
@@ -255,20 +259,25 @@ export function createV6CompatibleWrapCreateBrowserRouter< | |
} | ||
|
||
router.subscribe((state: RouterState) => { | ||
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') { | ||
// Wait for the next render if loading an unsettled route | ||
if (state.navigation.state !== 'idle') { | ||
requestAnimationFrame(() => { | ||
handleNavigation({ | ||
location: state.location, | ||
routes, | ||
navigationType: state.historyAction, | ||
version, | ||
basename, | ||
allRoutes: Array.from(allRoutes), | ||
}); | ||
}); | ||
} else { | ||
// Check if pageload span has ended to mark completion | ||
if (!isInitialPageloadComplete) { | ||
const currentRootSpan = getActiveRootSpan(); | ||
const isStillInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload'; | ||
|
||
if (!isStillInPageload) { | ||
isInitialPageloadComplete = true; | ||
// Don't handle this specific callback if it's a POP that marks completion | ||
if (state.historyAction === 'POP') { | ||
return; | ||
} | ||
} | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bug: Race Condition in Pageload Completion LogicThe pageload completion logic has a race condition. It can prematurely mark pageload as complete if the root span is missing, not necessarily because pageload finished. This causes legitimate |
||
|
||
const shouldHandleNavigation = | ||
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete); | ||
|
||
if (shouldHandleNavigation) { | ||
const navigationHandler = (): void => { | ||
handleNavigation({ | ||
location: state.location, | ||
routes, | ||
|
@@ -277,6 +286,13 @@ export function createV6CompatibleWrapCreateBrowserRouter< | |
basename, | ||
allRoutes: Array.from(allRoutes), | ||
}); | ||
}; | ||
|
||
// Wait for the next render if loading an unsettled route | ||
if (state.navigation.state !== 'idle') { | ||
requestAnimationFrame(navigationHandler); | ||
} else { | ||
navigationHandler(); | ||
} | ||
} | ||
}); | ||
|
@@ -352,17 +368,47 @@ export function createV6CompatibleWrapCreateMemoryRouter< | |
updatePageloadTransaction({ activeRootSpan, location, routes, basename, allRoutes: Array.from(allRoutes) }); | ||
} | ||
|
||
// Track whether we've completed the initial pageload to properly distinguish | ||
// between POPs that occur during pageload vs. legitimate back/forward navigation. | ||
let isInitialPageloadComplete = false; | ||
|
||
router.subscribe((state: RouterState) => { | ||
// Check if pageload span has ended to mark completion | ||
if (!isInitialPageloadComplete) { | ||
const currentRootSpan = getActiveRootSpan(); | ||
const isStillInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload'; | ||
|
||
if (!isStillInPageload) { | ||
isInitialPageloadComplete = true; | ||
// Don't handle this specific callback if it's a POP that marks completion | ||
if (state.historyAction === 'POP') { | ||
return; | ||
} | ||
} | ||
} | ||
|
||
const location = state.location; | ||
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') { | ||
handleNavigation({ | ||
location, | ||
routes, | ||
navigationType: state.historyAction, | ||
version, | ||
basename, | ||
allRoutes: Array.from(allRoutes), | ||
}); | ||
const shouldHandleNavigation = | ||
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete); | ||
|
||
if (shouldHandleNavigation) { | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const navigationHandler = (): void => { | ||
handleNavigation({ | ||
location, | ||
routes, | ||
navigationType: state.historyAction, | ||
version, | ||
basename, | ||
allRoutes: Array.from(allRoutes), | ||
}); | ||
}; | ||
|
||
// Wait for the next render if loading an unsettled route | ||
if (state.navigation.state !== 'idle') { | ||
requestAnimationFrame(navigationHandler); | ||
} else { | ||
navigationHandler(); | ||
} | ||
} | ||
}); | ||
|
||
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.