Block API: Fix the block 'edit' property validation #57193
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
Mamaduka
added
[Type] Bug
|
Size Change: +260 B (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
Mamaduka
commented
Dec 19, 2023
| @@ -168,7 +168,7 @@ describe( 'blocks', () => { | |||
| it( 'should reject blocks with an invalid edit function', () => { | |||
| const blockType = { | |||
| save: noop, | |||
| edit: 'not-a-function', | |||
There was a problem hiding this comment.
We can explicitly disallow strings, which is a valid element type for React. WDYT?
Mamaduka
requested review from
a team and
aaronrobertshaw
and removed request for
a team
gziolo
reviewed
Dec 20, 2023
gziolo
approved these changes
Dec 20, 2023
|
Nice, all goo to land it 🚀 |
Mamaduka
force-pushed
the
fix/blocks-api-edit-component-check
branch
from
077fd13 to
a8b5bf5
Compare
bph
added
[Feature] Block API
3 tasks
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?
PR fixes the block's
editproperty validation when bootstrapping the block types, failing for memoized components.Why?
The main requirement for the
editproperty is to be a valid React component for the block editor to render, which usually means having the type of afunction, but can be a specialobjectwhen wrapped in React APIs.I noticed this while working on #57173. The HoCs like
withSelectwill returnpureor memoized components.How?
Use the
isValidElementTypefrom the officialreact-islibrary to check theeditproperty's validity correctly.P.S. If this check is too extensive, we can create our custom utility using primitives provided by the library.
Testing Instructions
The "edit" property must be a valid function.error on the trunk.Patch
Testing Instructions for Keyboard
Same