Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Interactivity API - Fix SSR if parsed block changes in a filter. #6245

Closed
wants to merge 7 commits into from
Closed

Interactivity API - Fix SSR if parsed block changes in a filter. #6245

wants to merge 7 commits into from

Conversation

cbravobernal
Copy link
Contributor

@cbravobernal cbravobernal commented Mar 11, 2024 •
edited
Loading

Trac ticket:
https://core.trac.wordpress.org/ticket/60743#ticket

As commented in WordPress/gutenberg#59057 (comment)
If someone edits the $parsed_block variable, it will fail within the Interactivity API SSR processing comparison:

wordpress-develop/src/wp-includes/interactivity-api/interactivity-api.php

Line 49 in 9a616a5

if ( $root_block_name === $parsed_block['blockName'] && $parsed_block === $root_parsed_block ) {

It seems that this comparison won't be needed in 6.6, as a md5 bug did not allow to add keys to that variable.

Co-authored with @SantosGuillamot

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 11, 2024 •
edited
Loading

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props cbravobernal, swissspidy, flixos90, joemcgill, gziolo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions GitHub Actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@swissspidy
Copy link
Member

cc @gziolo @luisherranz for reviews

felixarntz
felixarntz reviewed Mar 11, 2024
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one feedback.

src/wp-includes/interactivity-api/interactivity-api.php Outdated Show resolved Hide resolved
@gziolo
Copy link
Member

gziolo commented Mar 12, 2024

I don't have enough insight to tell whether the priority 20, 99, or PHP_INT_MAX would work better here. The final approach should most likely impact the render_block_* filter used in this function as it uses exactly the same reasoning:

wordpress-develop/src/wp-includes/interactivity-api/interactivity-api.php

Lines 60 to 63 in 3c2a87e

* Uses a priority of 20 to ensure that other filters can add additional
* directives before the processing starts.
*/
add_filter( 'render_block_' . $block_name, $process_interactive_blocks, 20, 2 );

One important aspect to keep in mind is that we have been talking about when HTML API is capable of processing all HTML tags, we could explore running all the processing in a single pass based on the HTML output generated for the <body> tag in the document. In that case, we wouldn't need to use these filters. Anyway, we are still not there and we would also have to confirm that the performance is equal or improved before switching to that approach.

@swissspidy swissspidy dismissed joemcgill’s stale review March 13, 2024 09:18

Change has been applied

@swissspidy swissspidy requested a review from gziolo March 13, 2024 09:21
swissspidy
swissspidy approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@swissspidy swissspidy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, but awaiting final review from @gziolo

gziolo
gziolo approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good. My feedback was addressed. Everything is nicely aligned with the changes included 👍🏻

@swissspidy
Copy link
Member

Committed to trunk in https://core.trac.wordpress.org/changeset/57826

Needs double sign-off (dev-reviewed) for backporting to the 6.5 branch.

@gziolo gziolo closed this Mar 14, 2024
@cbravobernal cbravobernal mentioned this pull request Mar 15, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gziolo gziolo gziolo approved these changes

@swissspidy swissspidy swissspidy approved these changes

@felixarntz felixarntz felixarntz approved these changes

@joemcgill joemcgill joemcgill left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
5 participants
@cbravobernal @swissspidy @gziolo @joemcgill @felixarntz