shimAttributeSource: don't run outside the registerBlockType filter #53015
Conversation
This file contains hidden or 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
|
Size Change: -19 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
Mamaduka
added
[Type] Bug
tyxla
reviewed
Jul 27, 2023
| addFilter( | ||
| 'blocks.registerBlockType', | ||
| 'core/editor/custom-sources-backwards-compatibility/shim-attribute-source', | ||
| shimAttributeSource |
Member
There was a problem hiding this comment.
Just to confirm, there's no way registerBlockType() will be called before this filter has been added?
Member
Author
There was a problem hiding this comment.
registerBlockType still can and will be called before adding this filter. But now there is a point, very late in the editor initialization, where the filters are re-applied. Basically re-registering the blocks once again. That's the __experimentalReapplyBlockTypeFilters action. If some block got initially registered before all filters were added, the registration will be performed once again, with the new set of filters.
The core/blocks store has two state slices for this: state.unprocessedBlockTypes contains the raw block data with the filters unapplied, and state.blockTypes contains the filtered block types. You can regenerated the blockTypes from unprocessedBlockTypes at any time, multiple times.
Member
There was a problem hiding this comment.
Sounds good, thanks for confirming 👍
tyxla
approved these changes
Jul 28, 2023
Member
tyxla
left a comment
tyxla
left a comment
There was a problem hiding this comment.
Nice find, thanks for the cleanup 🚀
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.
When adding back-compat support for
source: 'meta', theshimAttributeSourcefunction is called in ablocks.registerBlockTypefilter, which is fine, but then it's also called statically, looping through all the blocks that were already registered. All this code was added in Feb 2020, in #20544, and it all made sense.Then, year and a half later, in Oct 2021, in #34299, @gziolo added new
__experimentalReapplyBlockTypeFiltersaction, dispatched during editor initialization, which removes the need for the static loop. It re-runs theblocks.registerBlockTypefilter, automatically catching all the early block registrations. This PR removes that static loop.Found this when working on async block loading in #51778 -- the static loop goes through all registered blocks, which doesn't work well with async loading.
How to test:
There is a e2e suite that tests for this specifically. There is a
meta-attribute-blockplugin that registers two blocks, one early and one late, and tests that they both get the `source: 'meta`` behavior right.