Fix synced pattern editing in write mode and refactor block editing mode to reducer #67026
+1,485
−306
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
- Remove the prev. React effect for managing pattern block editing modes
- Implement higher order reducer in the block editor store ... it:
- Tracks the clientIds of pattern blocks.
- Uses the pattern block clientIds to manage block editing modes
for pattern blocks and their inner blocks.
- Updates both on any actions that change block lists.
This reverts commit e1d6ca4. It doesn't really work, since reducer won't have access to `state.blocks.tree`.
|
Size Change: +710 B (+0.04%) Total Size: 1.82 MB
ℹ️ View Unchanged
|
…educer. Add special handling for only adding pattern block itself as content only when not in zoomed out or nav mode
…en synced pattern overrides or when write mode is active
|
Flaky tests detected in 6f69a32. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11928398849
|
talldan
force-pushed
the
demo/block-editing-mode-branches
branch
from
9363eb2
to
d636bac
Compare
talldan
added
[Type] Bug
talldan
force-pushed
the
demo/block-editing-mode-branches
branch
from
47827e8
to
6f69a32
Compare
This was referenced Nov 20, 2024
talldan
requested review from
draganescu,
youknowriad,
getdave,
ramonjd,
tellthemachines and
aaronrobertshaw
youknowriad
reviewed
Nov 20, 2024
| registry.dispatch( preferencesStore ).set( 'core', 'editorTool', mode ); | ||
|
|
||
| if ( mode === 'navigation' ) { | ||
| speak( __( 'You are currently in Write mode.' ) ); | ||
| } else if ( mode === 'edit' ) { | ||
| speak( __( 'You are currently in Design mode.' ) ); | ||
| } | ||
|
|
||
| dispatch( { type: 'SET_EDITOR_MODE', mode } ); |
There was a problem hiding this comment.
This is the one that I'm not sure about because some people could call registry.dispatch( preferencesStore ).set( 'core', 'editorTool', mode ); directly. Maybe it's fine I don't know
youknowriad
reviewed
Nov 20, 2024
| const isContent = hasContentRoleAttribute( name ); | ||
|
|
||
| return isContent ? 'contentOnly' : 'disabled'; | ||
| if ( state.derivedBlockEditingModes?.has( clientId ) ) { |
There was a problem hiding this comment.
In which case, there's no "derived block editing mode"?
youknowriad
reviewed
Nov 20, 2024
| @@ -112,6 +112,7 @@ function getEnabledClientIdsTreeUnmemoized( state, rootClientId ) { | |||
| export const getEnabledClientIdsTree = createRegistrySelector( ( select ) => | |||
| createSelector( getEnabledClientIdsTreeUnmemoized, ( state ) => [ | |||
There was a problem hiding this comment.
I think some of the dependencies here can probably be removed because they're not used in the selector anymore. But I don't expect that it impacts anything.
youknowriad
reviewed
Nov 20, 2024
| function getDerivedBlockEditingModeForBlock( | ||
| state, | ||
| clientId, | ||
| { |
There was a problem hiding this comment.
What's the difference between this argument and all the content that is already in state?
youknowriad
reviewed
Nov 20, 2024
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?
Supercedes some previous attempts #66919, #66949, and #65408!
Fixes #66424
In Write Mode, parts of synced patterns that are supposed to be non-editable are editable. This PR fixes the problem, plus undertakes some refactoring of how block editing mode works due to some performance caused by so much logic being in the
getBlockEditingModeselector.Why?
This bug happens because Write Mode overrides the blockEditingMode of a synced pattern's inner blocks.
Pattern blocks try calling
setBlockEditingModefor child blocks imperatively (in the pattern block's edit function). This does set the correct block editing modes in the block editor store, but when write mode is active thegetBlockEditingModeselector returns early with a different value.#65408 tried to fix this by updating the
getBlockEditingModeselector, but it cause a performance hit.How?
This PR fixes the issue by moving the pattern block editing modes to the block editor store, so that it can work harmoniously with the way Write Mode and Zoom Out mode determine the block editing mode.
The PR also undertakes a refactor of how block editing mode works for zoomed out and write mode to improve performance. The
getBlockEditingModeselect is called a lot (including recursively), so any code added there can cause performance regressions.The summary of the changes is:
getBlockEditingModeselectorwithDerivedBlockEditingModeshigher order reducer, it calculates a derivedBlockEditingMode state for any actions that might require this is recomputed using a few other functions:getDerivedBlockEditingModesForTreetraverses a block tree calculating the block editing modes for all the blocks in that tree, returning them in aMap. This can be used for the entire block tree or just a part of the block tree.getDerivedBlockEditingModeForBlockcalculates the block editing mode for a single client id. Called bygetDerivedBlockEditingModesForTreeon each block in the tree.getDerivedBlockEditingModesUpdatesused for actions that add/remove a partial subset of blocks. It should only return a value when there are block editing mode changes, meaning the store state doesn't unnecessarily change.traverseBlockTree,getBlockTreeBlock,findParentInClientIdsList,hasBindings.isContentBlockprivate function to the blocks package.It's quite a lot of code, so I'm open to suggestions on how to structure it.
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
Before
Kapture.2024-11-13.at.17.24.45.mp4
After
Kapture.2024-11-13.at.17.28.44.mp4