Block Bindings: Fix passing bindings context to canUserEditValue
#65599
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
SantosGuillamot
added
[Type] Bug
SantosGuillamot
requested review from
gziolo,
artemiomorales and
cbravobernal
gziolo
reviewed
Sep 24, 2024
| blockBindings, | ||
| name, | ||
| clientId, | ||
| updatedContext, |
There was a problem hiding this comment.
I think this should be passing context, and the selector should return the updated context together with attributes:
const { boundAttributes, updatedContext } = useSelect( () => {There was a problem hiding this comment.
It seems moving updatedContext inside the useSelect triggers the same issue reported here where it throws the warning:
The 'useSelect' hook returns different values when called with the same state and parameters. This can lead to unnecessary rerenders.
I can take a look at the solutions suggested there, but I was wondering first: Would it be safe to directly modify the context prop? Instead of doing updatedContext[ key ] = blockContext[ key ]; do directly context[ key ] = blockContext[ key ];.
There was a problem hiding this comment.
It's probably bad idea to mutate anything that React controls - props, context, etc.
There was a problem hiding this comment.
I've started exploring moving the updatedContext to a useMemo call in this pull request.
gziolo
reviewed
Sep 24, 2024
| @@ -139,6 +140,11 @@ export const withBlockBindingSupport = createHigherOrderComponent( | |||
| continue; | |||
| } | |||
|
|
|||
| // Populate context. | |||
| for ( const key of source.usesContext || [] ) { | |||
There was a problem hiding this comment.
With https://github.com/WordPress/gutenberg/pull/65599/files#r1772886078 applied, this can be refactored to:
let updatedContext = context;
if ( source.usesContext?.length ) {
let updatedContext = { ...context };
for ( const key of source.usesContext ) {
updatedContext[ key ] = blockContext[ key ];
}
}
|
Size Change: -28 B (0%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
gziolo
approved these changes
Sep 24, 2024
gziolo
added
Backport to WP 6.7 Beta/RC
|
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. |
SantosGuillamot
deleted the
fix/pass-bindings-uses-context-in-all-scenarios
branch
gutenbergplugin
pushed a commit
that referenced
this pull request
Sep 24, 2024
…65599) * Pass updated context as `context` prop * Use `updatedContext` in pattern overrides Co-authored-by: SantosGuillamot <[email protected]> Co-authored-by: gziolo <[email protected]>
github-actions
bot
added
Backported to WP Core
|
I just cherry-picked this PR to the wp/6.7 branch to get it included in the next release: 44e4896 |
|
One remark is that from this point, the context passed to the source API methods is what the block defines with |
|
Thanks for fixing! |
|
I just cherry-picked this PR to the release/19.3 branch to get it included in the next release: 9b8b551 |
kevin940726
pushed a commit
that referenced
this pull request
Sep 25, 2024
…65599) * Pass updated context as `context` prop * Use `updatedContext` in pattern overrides Co-authored-by: SantosGuillamot <[email protected]> Co-authored-by: gziolo <[email protected]>
kevin940726
removed
the
Backport to Gutenberg RC
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?
This PR ensure the
usesContextproperty from registered sources is taken into account in all the scenarios, includingcanUserEditValuewhich isn't working as expected right now.Why?
After this core commit, the context is populated dynamically both in the server and in the editor depending on the block bindings existing. However, the updated context is only pass to
getValuesandsetValues.This is causing e2e tests to fail.
How?
I'm passing the updated context as
props.contextto ensure it is always available. This context is only updated once the block is connected to the relevant sources.Testing Instructions
Failing e2e tests should pass. Manual testing: