-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Interactivity API: Defer hydration until node is scrolled near the viewport #58284
Open
westonruter
wants to merge
13
commits into
trunk
Choose a base branch
from
try/interactivity-lazy-hydration
base: trunk
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.
+34
−8
Open
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
645c945
Break long hydration task in interactivity init
westonruter 6ac9d62
Yield to main between toVdom() and hydrate()
westonruter cffdb4d
Update changelog
westonruter 4cc10a7
Delay hydration of nodes until they near the viewport
westonruter 3770575
Yield to main after hydration
westonruter 1f845c9
Check if isInputPending prior to hydration
westonruter d0587db
Merge remote-tracking branch 'origin/trunk' into try/interactivity-la…
westonruter cfe2b04
Merge branch 'trunk' of https://github.com/WordPress/gutenberg into t…
westonruter d580cce
Merge branch 'trunk' into try/interactivity-lazy-hydration
westonruter fb15565
Remove now-discouraged use of isInputPending
westonruter 3ec8de5
Merge branch 'trunk' of https://github.com/WordPress/gutenberg into t…
westonruter 6b95333
Merge branch 'trunk' into try/interactivity-lazy-hydration
westonruter 5532ee4
Merge branch 'trunk' of https://github.com/WordPress/gutenberg into t…
westonruter 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 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 |
---|---|---|
|
@@ -30,17 +30,47 @@ function yieldToMain() { | |
|
||
// Initialize the router with the initial DOM. | ||
export const init = async () => { | ||
const pendingNodes = new Set(); | ||
|
||
const intersectionObserver = new window.IntersectionObserver( | ||
async ( entries ) => { | ||
for ( const entry of entries ) { | ||
if ( ! entry.isIntersecting ) { | ||
continue; | ||
} | ||
|
||
const node = entry.target; | ||
intersectionObserver.unobserve( node ); | ||
pendingNodes.delete( node ); | ||
if ( pendingNodes.size === 0 ) { | ||
intersectionObserver.disconnect(); | ||
} | ||
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. This would be problematic for islands that are added dynamically during client-side navigations. The IntersectionObserver may need to remain persistently, if |
||
|
||
if ( ! hydratedIslands.has( node ) ) { | ||
while ( window.navigator.scheduling?.isInputPending() ) { | ||
await yieldToMain(); | ||
} | ||
const fragment = getRegionRootFragment( node ); | ||
const vdom = toVdom( node ); | ||
await yieldToMain(); | ||
hydrate( vdom, fragment ); | ||
await yieldToMain(); | ||
} | ||
} | ||
}, | ||
{ | ||
root: null, // To watch for intersection relative to the device's viewport. | ||
rootMargin: '100% 0% 100% 0%', // Intersect when within 1 viewport approaching from top or bottom. | ||
threshold: 0.0, // As soon as even one pixel is visible. | ||
} | ||
); | ||
|
||
const nodes = document.querySelectorAll( | ||
`[data-${ directivePrefix }-interactive]` | ||
); | ||
|
||
for ( const node of nodes ) { | ||
if ( ! hydratedIslands.has( node ) ) { | ||
await yieldToMain(); | ||
const fragment = getRegionRootFragment( node ); | ||
const vdom = toVdom( node ); | ||
await yieldToMain(); | ||
hydrate( vdom, fragment ); | ||
} | ||
pendingNodes.add( node ); | ||
intersectionObserver.observe( node ); | ||
} | ||
}; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there are no
nodes
below, then this wouldn't need to be constructed in the first place.