Block Bindings: Bootstrap server sources earlier #66058
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
SantosGuillamot
added
[Type] Bug
SantosGuillamot
requested review from
gziolo,
ryanwelcher,
artemiomorales and
cbravobernal
SantosGuillamot
requested review from
spacedmonkey,
draganescu,
adamziel and
kevin940726
as code owners
|
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. |
|
Size Change: -224 B (-0.01%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
|
Tests are failing, it seems that now requires to not set a label here: gutenberg/packages/e2e-tests/plugins/block-bindings/index.js Lines 20 to 26 in fe88860 |
SantosGuillamot
requested review from
ntwb,
nerrad and
ajitbohra
as code owners
|
That makes sense. I just pushed a commit to change that. |
SantosGuillamot
commented
Oct 14, 2024
| @@ -1705,42 +1697,6 @@ describe( 'blocks', () => { | |||
| 'Block bindings source "core/test-source" is already registered.' | |||
| ); | |||
| } ); | |||
|
|
|||
| it( 'should correctly merge properties when bootstrap happens after registration', () => { | |||
There was a problem hiding this comment.
I wonder if this should be allowed or not now that server sources get bootstrapped sooner in the process.
There was a problem hiding this comment.
Now that we force the server to register the source sooner than the client, only the client could override the server, not the other way around.
|
Flaky tests detected in 447d4ce. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11323836523
|
gziolo
reviewed
Oct 14, 2024
There was a problem hiding this comment.
This sounds like a very reasonable direction as we should land these changes during beta phase for WP 6.7. Can we add additional validation for the registration to detect that the server registration is limited to the name, label, and context. When there is something else it means it the registration on the client and can happen only once?
For the context, the values from the server and the client get merged together. What's the expected behavior for the label? Which one takes precedence?
IMO, the client one should take precedence, as it will be registered after the server.
That's a good one. If getValues, setValues, canUserEdit or getFieldsList is already available, it means it was previously registered on the client, and we can avoid that re-registrastion. |
Previously, we were only checking Regarding the
To be honest, any option is fine for me, so I can implement whatever you think it's better 🙂 |
gziolo
approved these changes
Oct 14, 2024
|
The label is something that needs to be properly documented. The approach taken is less important to me. It has to be predictable and covered with a unit test that prevents regression. |
I agree. For me it is a matter of defining what is "predictable" for users. The unit test already exists, it just need to be adapted if the current behavior changes. By the way, I run the tests locally with this core branch which includes the necessary code in core, and everything seems to pass as well. |
|
I made the necessary changes in the WordPress core. We should be able to land these changes, too. |
|
Okay, I'm merging this one as well. We can create a follow-up if we decide to change how the label is managed. |
|
There was a conflict while trying to cherry-pick the commit to the wp/6.7 branch. Please resolve the conflict manually and create a PR to the wp/6.7 branch. PRs to wp/6.7 are similar to PRs to trunk, but you should base your PR on the wp/6.7 branch instead of trunk. |
This was referenced Oct 15, 2024
|
@SantosGuillamot Looks like this didn't cherry pick cleanly. Would you be able to take point on getting to merged to the |
|
Sure! I'll take care of that. Thanks for pointing it out. |
SantosGuillamot
added a commit
that referenced
this pull request
Oct 16, 2024
* Remove bindings bootstrap functions * Remove bootstrap calls * Remove old filter * Adapt unit tests * Add compat filter in Gutenberg * Only run script if not already registered * Remove extra label in test * Remove unit test * Add backport changelog * Return warning if any client-only prop is defined Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
|
I've started working on it here. |
SantosGuillamot
added a commit
that referenced
this pull request
Oct 17, 2024
* Remove bindings bootstrap functions * Remove bootstrap calls * Remove old filter * Adapt unit tests * Add compat filter in Gutenberg * Only run script if not already registered * Remove extra label in test * Remove unit test * Add backport changelog * Return warning if any client-only prop is defined Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
SantosGuillamot
added a commit
that referenced
this pull request
Oct 17, 2024
* Remove bindings bootstrap functions * Remove bootstrap calls * Remove old filter * Adapt unit tests * Add compat filter in Gutenberg * Only run script if not already registered * Remove extra label in test * Remove unit test * Add backport changelog * Return warning if any client-only prop is defined Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
cbravobernal
added a commit
that referenced
this pull request
Oct 17, 2024
* Remove bindings bootstrap functions * Remove bootstrap calls * Remove old filter * Adapt unit tests * Add compat filter in Gutenberg * Only run script if not already registered * Remove extra label in test * Remove unit test * Add backport changelog * Return warning if any client-only prop is defined Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: ryanwelcher <welcher@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org>
SantosGuillamot
added
Backported to WP Core
|
The manual cherry-pick has been merged: #66167. I've changed the label to "Backported". Please let me know if anything else is needed. |
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?
Fixes #66031
In this pull request, I'm proposing removing the existing way of bootstrapping the sources defined in the server and do it directly in core with an inline script.
Why?
In the current implementation, bootstrapping happens in
initializeEditor, which happens after dom ready. This means that when a external source is registered in the server and in the client, the bootstrap happens too late, causing unexpected behaviors.How?
I removed the existing logic and added a filter to add an inline script registering the server sources. This will be replicated in core.
Testing Instructions
e2e should pass.
The issue reported here should be fixed.