Reduce number of List View re-renders while typing #51518
Merged
Conversation
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
noisysocks
added
[Type] Performance
Mamaduka
reviewed
Jun 15, 2023
| "wp.data.select( 'core/block-editor' ).__unstableGetClientIdWithClientIdsTree", | ||
| { | ||
| since: '6.3', | ||
| version: '6.5', |
There was a problem hiding this comment.
I think the current consensus is that we won't remove deprecated APIs. We can omit targeted versions for removal, at least for now.
Mamaduka
reviewed
Jun 15, 2023
| "wp.data.select( 'core/block-editor' ).__unstableGetClientIdsTree", | ||
| { | ||
| since: '6.3', | ||
| version: '6.5', |
|
Size Change: +2.83 kB (0%) Total Size: 1.4 MB
ℹ️ View Unchanged
|
Mamaduka
approved these changes
Jun 15, 2023
There was a problem hiding this comment.
Thanks, @noisysocks! The changes test well for me.
Do you know if there are any "penalties" for recursively calling the memoized selector?
P.S. We had some issues with getClientIdsWithDescendants and getClientIdsOfDescendants. See #40700.
jsnajdr
reviewed
Jun 15, 2023
| @@ -10,37 +10,26 @@ import { useSelect } from '@wordpress/data'; | |||
| import { store as blockEditorStore } from '../../store'; | |||
| import { unlock } from '../../lock-unlock'; | |||
|
|
|||
| const NON_DISABLED_EDITING_MODES = [ 'default', 'contentOnly' ]; | |||
There was a problem hiding this comment.
The downside of this that once a new editing mode is added, you'll need to update this list. Not sure how realistic this risk is. A good solution would be to have two list-like arguments, allow-list and deny-list, and passing a [ 'disabled' ] denylist.
There was a problem hiding this comment.
You're right!
My first instinct was to have it so that you pass a predicate function.
getClientIdsTreeWithBlockEditingMode( ( mode ) => mode !== 'disabled' )Then I wondered why make the selector so specific to block editing mode? It could accept a query-like object that lets you do whatever filtering you want.
getClientIdsTree( { rootBlockId: 'foo', blockEditingMode: ( mode ) => mode !== 'disabled' } )Then I started to think I'm over-engineering this and YAGNI 😅
The selector is private and only used by List View so instead I think let's emphasise that fact by moving the !== 'disabled' logic into the selector and renaming it to mention ListView by name. I've done that in 2ff27b0.
That keeps things simple and doesn't prevent us from doing something generic if needed in the future.
| state.settings.templateLock, | ||
| state.blockListSettings, | ||
| ] | ||
| ); |
There was a problem hiding this comment.
When a block is disabled and its children aren't, this function will merge the children as the disabled block's siblings. I.e., this:
[ { id: 'cover', inner: [ id: 'para1' ], disabled: true }, { id: 'para2' } ]
will become:
[ { id: 'para1' }, { id: 'para2' } ]
This behavior already existed before this PR, but I find it suprising. Do we really want to display the list view tree like this? I would expect such a disabled block to be greyed out.
There was a problem hiding this comment.
Yeah this was the design decision. It mimics the list view that you get in the right hand sidebar when editing a page or using a content locked pattern.
We can always revisit based on user feedback 😀
|
Flaky tests detected in 2ff27b0. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5306754331
|
noisysocks
added
the
[Feature] Page Content Focus
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
* Add getClientIdsTreeWithBlockEditingMode() * Rename getClientIdsTreeWithBlockEditingMode -> getListViewClientIdsTree
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Follows #50643.
Fixes this comment left by @Mamaduka #50643 (comment).
Reduces the number of times List View re-renders while typing into post content.
Why?
Typing performance!
How?
__unstableGetClientIdsTreeas it's not used anymore. I checked wpdirectory.net and the only hits are plugins that bundle@wordpress/block-editor.Testing Instructions
Screenshots or screencast <!-- if applicable -→
Before:
Kapture.2023-06-15.at.15.48.21.mp4
After:
Kapture.2023-06-15.at.15.47.30.mp4