Block Example: Avoid a crash when block is not registered #55686
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
t-hamano
added
[Type] Bug
|
Size Change: +60 B (0%) Total Size: 1.7 MB
ℹ️ View Unchanged
|
t-hamano
commented
Oct 30, 2023
| @@ -2276,4 +2277,33 @@ describe( 'block factory', () => { | |||
| expect( isContainerGroupBlock( 'core/group' ) ).toBe( false ); | |||
| } ); | |||
| } ); | |||
|
|
|||
| describe( 'getBlockFromExample', () => { | |||
There was a problem hiding this comment.
This test is similar to this test:
gutenberg/packages/blocks/src/api/test/templates.js
Lines 209 to 219 in b6b4cf6
Mamaduka
reviewed
Oct 30, 2023
There was a problem hiding this comment.
Thank you, @t-hamano!
We could also catch the error coming from the createBlock. What do you think?
Proposed change
export const getBlockFromExample = ( name, example ) => {
try {
return createBlock(
name,
example.attributes,
( example.innerBlocks ?? [] ).map( ( innerBlock ) =>
getBlockFromExample( innerBlock.name, innerBlock )
)
);
} catch {
return createBlock( 'core/missing', {
originalName: name,
originalContent: '',
originalUndelimitedContent: '',
} );
}
};
Cool! I updated it like that in b5cd693. |
dcalhoun
pushed a commit
that referenced
this pull request
Oct 30, 2023
* Block Example: Avoid a crash when block is not registered * Use a try-catch statement
dcalhoun
pushed a commit
that referenced
this pull request
Oct 31, 2023
* Block Example: Avoid a crash when block is not registered * Use a try-catch statement
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.
Fixe #54786
What?
This PR fixes a critical error that occurs when
getBlockFromExample()is passed an unregistered block.Why?
This is because the
createBlock()function running internally throws an exception if the block does not exist.How?
As far as reading this comment, I think that throwing an exception when the block does not exist is the intended behavior. I think we should check if the block exists before running
createBlock()and replace it with acore/missingblock as a fallback if it doesn't exist, as shown in this code.Another approach might be to implicitly transform the unregistered block passed to the
createBlock()function into acore/missingblock instead of throwing an exception. However, I personally find this approach a bit unnatural.Testing Instructions
This PR should fix critical bugs that occur in the following four cases. In each case, I assume a scenario where the Columns block contains an Image block that is not registered in the example.
Preview in block inserter
wp.blocks.unregisterBlockType('core/image')from the browser console.Preview block style
wp.blocks.unregisterBlockType('core/image')from the browser console.wp.blocks.registerBlockStyle('core/columns',{name:'test',label:'Test'});from the browser console.Style Book
wp.blocks.unregisterBlockType('core/image')from the browser console.Preview in the Global Styles
wp.blocks.unregisterBlockType('core/image')from the browser console.