Block Bindings: Refactor utils file. #64740
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
cbravobernal
added
[Type] Code Quality
cbravobernal
changed the title
|
Size Change: -105 B (-0.01%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Comment on lines
18
to
+19
| const { updateBlockAttributes } = useDispatch( blockEditorStore ); | ||
| const { getBlockAttributes } = useSelect( blockEditorStore ); | ||
| const { getBlockAttributes } = useRegistry().select( blockEditorStore ); |
There was a problem hiding this comment.
Is there a benefit to doing it for dispatch as well?
There was a problem hiding this comment.
dispatch doesn't establish event listeners, so it shouldn't make any difference. @jsnajdr, can you chime in?
There was a problem hiding this comment.
useDispatch is implemented as useRegistry().dispatch( store ), so changing the code has no effect. dispatch indeed doesn't establish any event listeners.
Even this change for useSelect is basically a noop, because useSelect( store ) is a special form that returns useRegistry().select( store ). Only the callback form (useSelect( ( select ) => ... )) establishes listeners.
All in all, the useBlockBindingsUtils doesn't establish any local state or listeners and will never trigger rerenders. It merely returns two callbacks that will read from the store when called, and will see the value that is in the store at that moment.
There was a problem hiding this comment.
Ah, cool, so no change is necessary. That wasn't clear enough when reading the post on Make Core.
SantosGuillamot
requested changes
Aug 26, 2024
Comment on lines
51
to
54
| const { | ||
| metadata: { bindings: currentBindings, ...metadata }, | ||
| } = getBlockAttributes( clientId ); | ||
| const newBindings = { ...currentBindings }; |
There was a problem hiding this comment.
If I am not mistaken, this will break when there is no metadata and it is undefined. For example, when adding a binding to a new paragraph block. It tries to destructure metadata expecting to be an object but it is undefined.
Is that right?
There was a problem hiding this comment.
We might need to do something like this maybe:
const { metadata: { bindings: currentBindings, ...metadata } = {} } =
getBlockAttributes( clientId );
There was a problem hiding this comment.
Fixed in 9e98a29
Comment on lines
90
to
92
| const { | ||
| metadata: { bindings, ...metadata }, | ||
| } = getBlockAttributes( clientId ); |
There was a problem hiding this comment.
Not sure if this comment is relevant here as well because I guess removeAllBlockBindings should not be called when there are no bindings. But maybe it is better to add a fallback just in case?
There was a problem hiding this comment.
It doesn't harm to add extra safety.
There was a problem hiding this comment.
Fixed in 9e98a29
|
🚢 |
SantosGuillamot
approved these changes
Aug 27, 2024
cbravobernal
added
the
Backport to Gutenberg RC
artemiomorales
pushed a commit
that referenced
this pull request
Aug 28, 2024
* Refactor block binding utils * Add security checks Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
cbravobernal
added a commit
that referenced
this pull request
Aug 28, 2024
* DataViews: Add missing styles and remove opinionated ones for generic usage (#64711) Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@git.wordpress.org> * Shuffle: Don't call '__experimentalGetAllowedPatterns' for every block (#64736) Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: wpsoul <wpsoul@git.wordpress.org> * DataViews: hide sort direction control if there is no sortable fields (#64817) Co-authored-by: oandregal <oandregal@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org> * Block Bindings: Refactor utils file. (#64740) * Refactor block binding utils * Add security checks Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> * Interactivity API: Fix computeds without scope in Firefox (#64825) * Replace NO_SCOPE symbol with an object * Update changelog Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: Marc-pi <mdxfr@git.wordpress.org> --------- Co-authored-by: Riad Benguella <benguella@gmail.com> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@git.wordpress.org> Co-authored-by: George Mamadashvili <georgemamadashvili@gmail.com> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: wpsoul <wpsoul@git.wordpress.org> Co-authored-by: André <583546+oandregal@users.noreply.github.com> Co-authored-by: oandregal <oandregal@git.wordpress.org> Co-authored-by: Carlos Bravo <37012961+cbravobernal@users.noreply.github.com> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: David Arenas <david.arenas@automattic.com> Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: Marc-pi <mdxfr@git.wordpress.org>
|
I just cherry-picked this PR to the release/19.1 branch to get it included in the next release: #64876 |
artemiomorales
removed
the
Backport to Gutenberg RC
bph
pushed a commit
to bph/gutenberg
that referenced
this pull request
Aug 31, 2024
* Refactor block binding utils * Add security checks Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
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?
Some code refactor following the indications in #64102 (comment)
Testing Instructions
E2E tests should work.