-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Block Bindings: Accept client ID as parameter for useBlockBindingsUtils
#65818
Merged
cbravobernal
merged 3 commits into
trunk
from
fix/pass-client-id-to-use-block-bindings-utils
Oct 9, 2024
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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
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
174 changes: 174 additions & 0 deletions
174
packages/block-editor/src/utils/test/use-block-bindings-utils.js
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import { renderHook } from '@testing-library/react'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { store as blockEditorStore } from '@wordpress/block-editor'; | ||
| import { dispatch, select } from '@wordpress/data'; | ||
| import { | ||
| createBlock, | ||
| getBlockTypes, | ||
| unregisterBlockType, | ||
| } from '@wordpress/blocks'; | ||
| import { registerCoreBlocks } from '@wordpress/block-library'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { useBlockBindingsUtils } from '../'; | ||
|
|
||
| describe( 'useBlockBindingsUtils', () => { | ||
| beforeAll( () => { | ||
| // Register all core blocks | ||
| registerCoreBlocks(); | ||
| } ); | ||
|
|
||
| let clientId; | ||
| beforeEach( async () => { | ||
| const block = createBlock( 'core/paragraph', { | ||
| metadata: { | ||
| name: 'Block name', | ||
| bindings: { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'initial_key', | ||
| }, | ||
| }, | ||
| prop2: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'initial_key', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } ); | ||
| await dispatch( blockEditorStore ).resetBlocks( [ block ] ); | ||
| clientId = block.clientId; | ||
| } ); | ||
|
|
||
| afterAll( () => { | ||
| // Remove blocks after all tests. | ||
| dispatch( blockEditorStore ).resetBlocks( [] ); | ||
|
|
||
| // Clean up registered blocks | ||
| getBlockTypes().forEach( ( block ) => { | ||
| unregisterBlockType( block.name ); | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'should be possible to update just one connection', async () => { | ||
| renderHook( () => { | ||
| const { updateBlockBindings } = useBlockBindingsUtils( clientId ); | ||
| updateBlockBindings( { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| } ); | ||
| } ); | ||
| const { metadata } = | ||
| await select( blockEditorStore ).getBlockAttributes( clientId ); | ||
| expect( metadata ).toMatchObject( { | ||
| // Other metadata properties shouldn't change. | ||
| name: 'Block name', | ||
| bindings: { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| prop2: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'initial_key', | ||
| }, | ||
| }, | ||
| }, | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'should be possible to update multiple connections at once', async () => { | ||
| renderHook( () => { | ||
| const { updateBlockBindings } = useBlockBindingsUtils( clientId ); | ||
| updateBlockBindings( { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| prop2: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| } ); | ||
| } ); | ||
| const { metadata } = | ||
| await select( blockEditorStore ).getBlockAttributes( clientId ); | ||
| expect( metadata ).toMatchObject( { | ||
| // Other metadata properties shouldn't change. | ||
| name: 'Block name', | ||
| bindings: { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| prop2: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'new_key', | ||
| }, | ||
| }, | ||
| }, | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'should be possible to remove connections', async () => { | ||
| renderHook( () => { | ||
| const { updateBlockBindings } = useBlockBindingsUtils( clientId ); | ||
| updateBlockBindings( { | ||
| prop2: undefined, | ||
| } ); | ||
| } ); | ||
| const { metadata } = | ||
| await select( blockEditorStore ).getBlockAttributes( clientId ); | ||
| expect( metadata ).toMatchObject( { | ||
| // Other metadata properties shouldn't change. | ||
| name: 'Block name', | ||
| bindings: { | ||
| prop1: { | ||
| source: 'core/post-meta', | ||
| args: { | ||
| key: 'initial_key', | ||
| }, | ||
| }, | ||
| }, | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'should be possible to remove all connections', async () => { | ||
| renderHook( () => { | ||
| const { removeAllBlockBindings } = | ||
| useBlockBindingsUtils( clientId ); | ||
| removeAllBlockBindings(); | ||
| } ); | ||
| const { metadata } = | ||
| await select( blockEditorStore ).getBlockAttributes( clientId ); | ||
| expect( metadata ).toMatchObject( { | ||
| // Other metadata properties shouldn't change. | ||
| name: 'Block name', | ||
| } ); | ||
| } ); | ||
| } ); | ||
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.
Super nuanced nit. I believe that you can use here
dispatch( blockEditorStore ).resetBlocks( [ block ] );instead ofinsertBlocks.This way
dispatch( blockEditorStore ).resetBlocks( [] );could be run only once inafterAllinstead ofafterEach.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.
That's a good one 🙂 If I understood you correctly, it has been addressed in this commit: e52bab2
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.
Yes, exactly that 👍🏻