Block Editor: Warn when useBlockProps hook used with a wrong Block API version
#33274
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
gziolo
added
[Package] Block editor
gziolo
commented
Jul 8, 2021
|
Size Change: +5.46 kB (+1%) Total Size: 1.07 MB
ℹ️ View Unchanged
|
diegohaz
reviewed
Jul 8, 2021
| * | ||
| * @type {Record<string, true | undefined>} | ||
| */ | ||
| export const logged = Object.create( null ); |
There was a problem hiding this comment.
Is it Object.create( null ) instead of just {} to avoid prototype pollution? Very clever! 👍
There was a problem hiding this comment.
Yes, I copied it over from @wordpress/deprecated.
There was a problem hiding this comment.
Would we be better off with Set?
There was a problem hiding this comment.
Good point, we could use Set 👍🏻
There was a problem hiding this comment.
#33380 should address it.
|
I see the warning even when I'm just hovering over the block on the block inserter (I guess that's because the preview is calling the hook). Is this expected? |
ellatrix
reviewed
Jul 8, 2021
| @@ -128,6 +132,12 @@ export function useBlockProps( props = {}, { __unstableIsHtml } = {} ) { | |||
| } ), | |||
| ] ); | |||
|
|
|||
| if ( blockAPIVersion < 2 ) { | |||
| warning( | |||
There was a problem hiding this comment.
warning is our custom helper that works nearly the same as React warnings that get applied only for development builds.
ellatrix
reviewed
Jul 8, 2021
ellatrix
approved these changes
Jul 9, 2021
gziolo
added
[Type] Code Quality
7 tasks
sarayourfriend
pushed a commit
that referenced
this pull request
Jul 15, 2021
…API version (#33274) * Block Editor: Warn when `useBlockProps` hook used with a wrong Block API version * Revert apiVersion change in the Heading block
12 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.
Description
API version mismatch when using
useBlockPropsseems to be the most common issue reported recently. This PR proposes that we detect when someone is usinguseBlockPropswithapiVersionset to1for a block type that is using alsouseBlockProps. The warning is going to be printed only in the development mode.@wordpress/warningchangesThis PR also ensures that a given unique message is reported only once when calling
warningmethod from@wordpress/warning. It mirrors the implementation used withdeprecatedfrom@wordpress/deprecated. The rationale is to avoid seeing a flood of the same messages reported on the Browser Console. It was very annoying for theuseBlockPropshook that would print the warning for every block and on every re-render.How has this been tested?
Create a new post and insert the Heading block that has the
apiVersiondowngraded to1to throw the warning. Observe the warning on the Browser Console.Screenshots
Types of changes
Checklist:
*.native.jsfiles for terms that need renaming or removal).