Skip to content
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.

Sign up for GitHub

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

Leverage scheduler.yield in splitTask when available #66001

Merged
merged 9 commits into from
Oct 16, 2024
Merged

Leverage scheduler.yield in splitTask when available #66001

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8538799
Leverage scheduler.yield in splitTask when available
westonruter Oct 9, 2024
70077b8
Eliminate extra Promise when using scheduler.yield()
westonruter Oct 10, 2024
d5c51a6
Avoid needlessly re-checking whether scheduler.yield() is defined
westonruter Oct 10, 2024
2516cd4
Remove needless function wrapper
westonruter Oct 10, 2024
a0933f4
Ensure that scheduler is context object to yield function
westonruter Oct 10, 2024
ee36a34
Remove needless async
westonruter Oct 10, 2024
0abf7be
Reduce verbosity of scheduler.yield() existence check
westonruter Oct 10, 2024
be4ceff
Fix return type for scheduler.yield()
westonruter Oct 10, 2024
3d40b9f
Define scheduler and scheduler.yield as optional
westonruter Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions packages/interactivity/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ interface Flusher {
readonly dispose: () => void;
}

declare global {
interface Window {
scheduler: {
readonly yield: () => void;
westonruter marked this conversation as resolved.
Show resolved Hide resolved
};
}
}

/**
* Executes a callback function after the next frame is rendered.
*
Expand All @@ -48,12 +56,18 @@ const afterNextFrame = ( callback: () => void ) => {
*
* @return Promise
*/
export const splitTask = () => {
return new Promise( ( resolve ) => {
// TODO: Use scheduler.yield() when available.
setTimeout( resolve, 0 );
} );
};
export const splitTask =
'scheduler' in window &&
westonruter marked this conversation as resolved.
Show resolved Hide resolved
typeof window.scheduler === 'object' &&
null !== window.scheduler &&
'yield' in window.scheduler &&
typeof window.scheduler.yield === 'function'
? window.scheduler.yield.bind( window.scheduler )
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other places in Gutenberg, I believe we use requestIdleCallback to optimize for UI responsiveness and delay some tasks with lower priority. I wonder if you can speak about the difference and when to favor one over the other.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With requestIdleCallback the idleness may occur several seconds after requested which would not be desirable for hydration. For splitTask it's purely to break up long tasks which remain high priority. So both have their use cases.

: () => {
return new Promise( ( resolve ) => {
setTimeout( resolve, 0 );
} );
};

/**
* Creates a Flusher object that can be used to flush computed values and notify listeners.
Expand Down
Loading