-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Fix broken editor when passing attributes as undefined or null and add warning for block authors #73149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Fix broken editor when passing attributes as undefined or null and add warning for block authors #73149
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
82e6464
Ensure attributes is always an object, never null or undefined
jeryj 43a1493
Revert setting empty attributes object in favor of warning within reg…
jeryj 1c1fee6
Revert "Revert setting empty attributes object in favor of warning wi…
jeryj e67d081
Add warning when passing attributes as undefined and inform that this…
jeryj d7c5041
Update warning message
jeryj 2a06573
Add unit tests for block registration with undefined, null, or no att…
jeryj 99c3dbb
Use it to avoid duplication in unit test
jeryj ac10381
Remove temporary messaging about the fix being removed
jeryj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,19 @@ export const processBlockType = | |
| ), | ||
| }; | ||
|
|
||
| // Temporary fix to allow block authors time to fix blocks that register attributes as null or undefined. | ||
| if ( | ||
| ! blockType.attributes || | ||
| typeof blockType.attributes !== 'object' | ||
| ) { | ||
| warning( | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we also include a test for this? |
||
| 'The block "' + | ||
| name + | ||
| '" must not register attributes as null or undefined. Use an empty object (`attributes: {}`) or exclude the attributes key. In the next Gutenberg release, passing null or undefined for attributes will cause the block editor to crash.' | ||
jeryj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ); | ||
| blockType.attributes = {}; | ||
| } | ||
|
|
||
| const settings = applyFilters( | ||
| 'blocks.registerBlockType', | ||
| blockType, | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't have to be temporary. Folks might encounter this in the future, too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with it not being temporary if others agree. I'd defer to folks with more expertise in block registration first.