Block editor: optimise hasSelectedInnerBlock selector #60330
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +23 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
youknowriad
reviewed
Apr 1, 2024
| return selectedBlockClientIds.some( ( id ) => | ||
| // Pass true because we don't care about order and it's more | ||
| // performant. | ||
| getBlockParents( state, id, true ).includes( clientId ) |
There was a problem hiding this comment.
I wonder if we can stop this as a single block. (Maybe we can if the current block clientId is not selected)
There was a problem hiding this comment.
Not sure what you mean, do you mean merging with the non deep code block?
There was a problem hiding this comment.
I mean if one single selected block is not within the clientId, probably the others won't be and we could just check selectedBlockClientIds[ 0 ]
That said:
- This only works if the
clientIdis not within the selection itself. - It is based on an assumption that non-consecutive selection is not supported.
There was a problem hiding this comment.
Let's keep it future proof then :)
There was a problem hiding this comment.
Two ideas that could make it even faster:
- Looking at the logic in
getSelectedBlockClientIds, all multi-selected blocks always have a common parent. I can select multiple children of one block, but I can't select the last item of one list and first item of a second list. Trying to do this in the editor will select the entire two lists. Therefore, we need to check just one of the selected block, the parents are always the same and all the.sometests are identical. That's the Riad's idea basically. - Instead of calling
getBlockParents, what if we proceeded one parent at a time, withgetBlockRootClientId? Then we don't have to construct the parents array.
There was a problem hiding this comment.
Yes, but not sure if it's valuable after the lack of a real improvement in the metric. The most important is that we don't run anything if no block is selected, and if there is, it's a pretty small loop. For multi selection yes, I guess we could just check the first ID. Not sure if we'd want to keep it future proof for non consecutive selection.
youknowriad
approved these changes
Apr 1, 2024
|
It doesn't seem to impact the metrics though. |
|
Strange, I am seeing it in the performance recordings though 🤔 |
tyxla
approved these changes
Apr 1, 2024
Comment on lines
+1241
to
+1243
| if ( ! selectedBlockClientIds.length ) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
That's a pretty neat optimization on its own - we only care about selected blocks, so no need to loop through all of them.
| isBlockSelected( state, innerClientId ) || | ||
| isBlockMultiSelected( state, innerClientId ) || | ||
| ( deep && hasSelectedInnerBlock( state, innerClientId, deep ) ) | ||
| const selectedBlockClientIds = getSelectedBlockClientIds( state ); |
There was a problem hiding this comment.
That's a neat way to check for both single- and multi-selection 👍
| ( innerClientId ) => | ||
| isBlockSelected( state, innerClientId ) || | ||
| isBlockMultiSelected( state, innerClientId ) || | ||
| ( deep && hasSelectedInnerBlock( state, innerClientId, deep ) ) |
There was a problem hiding this comment.
Removing a recursion in favor of a loop usually results in a performance improvement 👍
| return selectedBlockClientIds.some( ( id ) => | ||
| // Pass true because we don't care about order and it's more | ||
| // performant. | ||
| getBlockParents( state, id, true ).includes( clientId ) |
There was a problem hiding this comment.
I wonder if we need a test with 3 levels of nested blocks, but from what I understand, if we have blocks X > Y > Z (Z nested in Y, Y nested in X), and Z is selected, hasSelectedInnerBlock should return false by design, right?
There was a problem hiding this comment.
Should return false for what? If Z is selected it will return true for both X and Y unless you remove the deep flag
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
Co-authored-by: ellatrix <[email protected]> Co-authored-by: youknowriad <[email protected]> Co-authored-by: tyxla <[email protected]>
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?
Optimises the selector by looking at the selection and checking if the parent (or any of the parents) match the clientId. Skips checks if no blocks are selected.
Why?
This selector is terribly unperformant. Just by opening 3 templates, it runs 2.5 million times.
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast