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

useAsyncList: flush state updates when processing queue #48238

Merged
merged 3 commits into from
Feb 20, 2023
Merged

useAsyncList: flush state updates when processing queue #48238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca40c81
Element: start exporting ReactDOM.flushSync
jsnajdr Feb 20, 2023
7648347
useAsyncList: flush state updates when processing queue
jsnajdr Feb 20, 2023
47e7b5b
useAsyncList: queue all the work upfront
jsnajdr Feb 20, 2023
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
23 changes: 11 additions & 12 deletions packages/compose/src/hooks/use-async-list/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { useEffect, useState } from '@wordpress/element';
import { flushSync, useEffect, useState } from '@wordpress/element';
import { createQueue } from '@wordpress/priority-queue';

type AsyncListConfig = {
Expand Down Expand Up @@ -57,17 +57,16 @@ function useAsyncList< T >(
setCurrent( firstItems );

const asyncQueue = createQueue();
const append = ( nextIndex: number ) => () => {
if ( list.length <= nextIndex ) {
return;
}
setCurrent( ( state ) => [
...state,
...list.slice( nextIndex, nextIndex + step ),
] );
asyncQueue.add( {}, append( nextIndex + step ) );
};
asyncQueue.add( {}, append( firstItems.length ) );
for ( let i = firstItems.length; i < list.length; i += step ) {
asyncQueue.add( {}, () => {
flushSync( () => {
setCurrent( ( state ) => [
...state,
...list.slice( i, i + step ),
] );
} );
} );
Copy link
Contributor

Choose a reason for hiding this comment

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

While this PR restores the previous behavior (prior to the upgrade). I think it's still not perfect. Personally, I think we should be calling asyncQueue.add( {}, append( nextIndex + step ) ); outside the callback. kind of like I did here

#48085 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

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

Personally, I think we should be calling asyncQueue.add outside the callback.

Pushed a commit that implements that 👍 Behavior-wise it's exactly the same, it just add all the work to the queue upfront, instead of adding each new task just in time right before the next iteration of the for of waitingList loop inside priority-queue.

}

return () => asyncQueue.reset();
}, [ list ] );
Expand Down
4 changes: 4 additions & 0 deletions packages/element/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### New Features

- Started exporting the `flushSync` function from `react-dom`

## 5.4.0 (2023-02-15)

## 5.3.0 (2023-02-01)
Expand Down
8 changes: 8 additions & 0 deletions packages/element/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,14 @@ _Parameters_

- _component_ `import('./react').WPComponent`: Component's instance.

### flushSync

Forces React to flush any updates inside the provided callback synchronously.

_Parameters_

- _callback_ `Function`: Callback to run synchronously.

### forwardRef

Component enhancer used to enable passing a ref to its wrapped component.
Expand Down
8 changes: 8 additions & 0 deletions packages/element/src/react-platform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import {
createPortal,
findDOMNode,
flushSync,
render,
hydrate,
unmountComponentAtNode,
Expand All @@ -28,6 +29,13 @@ export { createPortal };
*/
export { findDOMNode };

/**
* Forces React to flush any updates inside the provided callback synchronously.
*
* @param {Function} callback Callback to run synchronously.
*/
export { flushSync };

/**
* Renders a given element into the target DOM node.
*
Expand Down