search

WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.4k stars 4.16k forks source link

Interactivity API: Iteration for WP 6.6 #60219

Closed DAreRodz closed 2 months ago

DAreRodz commented 6 months ago

We completed everything for the first public release of the Interactivity API in WordPress 6.5. Now, during the next iteration―which is going to be shorter―, we aim to focus on improving the current API without releasing new features. This includes enhancing the developer experience (especially during debugging), better test coverage and code quality, as well as fixing any reported bugs.

Note that the list is expected to be modified. I've also added optional tasks we can work on if we find the time.

28-05 Update: All tasks have been redistributed for 6.6 release summary.

Punted to future releases

Won't do

Ready for 6.6

Enhancements

Bug fixes

Code Quality

felixarntz commented 6 months ago

@DAreRodz @gziolo What's the best path to consider additional workstreams for the Interactivity API for 6.6?

Context is that @westonruter and myself have been exploring ideas to facilitate better INP performance centrally via the Interactivity API. For instance, we could automatically yield certain actions and callbacks to the main thread to reduce contention between multiple event listeners. We're close to formalizing our proposal in an issue, and it would be great to eventually include this effort here, if the team is on board.

One of the changes we're proposing may require a BC break in the API which we could handle with a deprecation strategy, but it would also benefit from being implemented sooner than later, now that the API is still very new and not yet as widely adopted outside of core.

DAreRodz commented 6 months ago

Hey @felixarntz, thanks for raising this up! 😊

I'm unsure what would be the "best path" (maybe @gziolo could help), but as this tracking issue is meant to be flexible, I would be happy to include your work. Let's wait for the proposal to see if we can have it ready for WP 6.6 and how the mentioned breaking changes could impact the current API.

gziolo commented 6 months ago

That sounds excellent, @felixarntz. I'm looking forward to seeing the proposal.

@DAreRodz, the Iteration issues mostly bring focus and increase the visibility of what to expect in WordPress 6.6, but it doesn't mean we can't change it. In practice, we should always be open to changing the plans based on the feedback and discoveries from the community experts 😍

sirreal commented 6 months ago

The ability to use existing WordPress Scripts from Script Modules is one of the most impactful things we can work on for the Interactivity API. Anything built with the Interactivity API must be a script module, so although it's not strictly Interactivity API, resolving this ticket for script and module interoperability seems very important: https://core.trac.wordpress.org/ticket/60647

sethrubenstein commented 6 months ago

Second @sirreal calls for WordPress scripts. We use wp-api-fetch and wp-url with interactive blocks, a lot. Making that easier from a dev tooling perspective to automatically enqueue those scripts would be greatly appreciated.

ermincelikovic commented 6 months ago

Is there any chance to get interactivity api outside of blocks? For example in custom php templates?

felixarntz commented 6 months ago

@ermincelikovic While I believe it's not documented, it should already be possible. The main caveat is that by default custom PHP templates wouldn't be processed server-side, so you have to make sure the attributes that are dynamic via the Interactivity API are initialized with their correct value.

As a proof of concept, I have been working on https://github.com/WordPress/wordpress-develop/pull/5795 where I am using the Interactivity API for all dynamic functionality of the Twenty Twenty-One theme. Maybe that's helpful.

luisherranz commented 6 months ago

default custom PHP templates wouldn't be processed server-side, so you have to make sure the attributes that are dynamic via the Interactivity API are initialized with their correct value

You can process them using wp_interactivity_process_directives 🙂

ermincelikovic commented 5 months ago

default custom PHP templates wouldn't be processed server-side, so you have to make sure the attributes that are dynamic via the Interactivity API are initialized with their correct value

You can process them using wp_interactivity_process_directives 🙂

This looks great! How would I import { store, getContext } from "@wordpress/interactivity"; within a context of php template or a traditional script.js file in the theme though?

EDIT: Just found out that script modules are also introduced in 6.5: https://make.wordpress.org/core/2024/03/04/script-modules-in-6-5/

cbravobernal commented 5 months ago

I've added the suggestions in Typescripting utils PR. Ready to be reviewed again. https://github.com/WordPress/gutenberg/pull/60149/

sirreal commented 5 months ago

How would I import { store, getContext } from "@wordpress/interactivity"; within a context of php template or a traditional script.js file in the theme though?

@ermincelikovic The @wordpress/interactivity script module is only available to other script modules at this time. Using it from WordPress scripts is not supported at this time. See this ticket for details.

DAreRodz commented 5 months ago

I've added two PRs to the description above.

The first one could be considered a bug fix (I've added it under that category), and so be released in a minor WP release.

DAreRodz commented 5 months ago

The fix for data-wp-on is merged.

I've also opened an issue to fix the same problem in data-wp-on-window and data-wp-on-document.

fabiankaegy commented 5 months ago

In addition to https://github.com/WordPress/gutenberg/issues/60035 I'd love to see some more useful debugging for the following areas:

Besides debugging here are some other things that I would love to see in the 6.6 cycle.

sirreal commented 5 months ago

I've added https://github.com/WordPress/wordpress-develop/pull/6394 for server-side derived state. It's ready for review.

sirreal commented 5 months ago

I've just added 3 items related to data-wp-ignore directive.

I think there's a bug with the server processing of ignore directives I'm attempting to fix in https://github.com/WordPress/wordpress-develop/pull/6405. I think that nodes with that attribute and their descendants should be ignored completely, no processing should happen on or under a node with data-wp-ignore. @cbravobernal or @DAreRodz can you confirm?

Right now ignore directives are not handled on the server, so those nodes and their descendants are processed. I discovered that while working on tests for #60744.

sirreal commented 5 months ago

I've created this ticket to handle property access on PHP objects in interactivity state, only arrays are well handled at the moment: https://core.trac.wordpress.org/ticket/61039

cbravobernal commented 5 months ago

I've created a PR to add a couple of warnings if Server Directives processing fails.

cbravobernal commented 5 months ago

Created a PR to handle multiple document and window events in the same element.

cbravobernal commented 5 months ago

Created a PR to avoid a wrong directive from killing the runtime.

cbravobernal commented 5 months ago

Added another PR, avoiding an emtpy or a wrong namespace from killing the runtime too.

cbravobernal commented 4 months ago

Added a follow-up issue to improve the readability of the directive processing function inside vdom.ts as @sirreal requested in https://github.com/WordPress/gutenberg/pull/61249#discussion_r1592540765

westonruter commented 4 months ago

Added another performance issue which came out of the discussion in https://github.com/WordPress/gutenberg/discussions/60574#discussioncomment-9060900:

cbravobernal commented 4 months ago

Added a minimum PR with two types:

michalczaplinski commented 4 months ago

Based on discussion in https://github.com/WordPress/gutenberg/discussions/60979#top I've opened a PR to add build configuration for a standalone package:

michalczaplinski commented 4 months ago

I've started a PR to migrate @wordpress/interactivity-router to TS:

fabiankaegy commented 4 months ago

Hi all 👋

Reminder: The release candidate for Gutenberg Version 18.5 is scheduled for next Friday (May 31st). So anything that is supposed to make it into WordPress 6.6 must be merged by then.

Please raise any important issues that need additional attention :)

cbravobernal commented 4 months ago

Hi 👋

I updated the description of the main tracking issue with the list of PRs that won't be included in this release, the PRs that still needs review or commit and the PRs ready for 6.6.

sirreal commented 4 months ago

I've added https://github.com/WordPress/wordpress-develop/pull/6453 as an enhancement for 6.6 (let Interactivity API be used in WP Admin).

cbravobernal commented 4 months ago

I've added a unit test to the bug fix for the fatal error if a state or context uses a stdClass. Ready to review: 👀 https://github.com/WordPress/wordpress-develop/pull/6672

cbravobernal commented 3 months ago

Added a merged a bug fix for data-wp-each-child priority.

luisherranz commented 2 months ago

Closing as finished.

The work for WordPress 6.7 will be tracked in the following tracking issue:

otakupahp commented 2 months ago

The new version introduced a BIG error... Now instead of returning an object, get_context() returns a string

sirreal commented 2 months ago

The new version introduced a BIG error... Now instead of returning an object, get_context() returns a string

@otakupahp Will you please open a new issue with details about the problem?

otakupahp commented 2 months ago

Will you please open a new issue with details about the problem?

I would love, but I spend that time tracking the error, and I'm terrible creating those issues. But I found the reason for it.

Before 6.6 I had an array with other arrays:

array(
    array( 'id' => 1, 'item' => 'item 1 name' ),
    array( 'id' => 1, 'item' => 'item 2 name' ),
    array( 'id' => 1, 'item' => 'item 3 name' ),
);

That create this JSON: 

[
    {"id":1, "item":"item 1 name"},
    {"id":2, "item":"item 2 name"},
    {"id":3, "item":"item 3 name"},
]

The Interactive API created a context object that contains the array without problems.

Now, it just renders a string instead of an array object

To fix the error, I have to modify my array into this:

array(
    'data' => array(
        array( 'id' => 1, 'item' => 'item 1 name' ),
        array( 'id' => 1, 'item' => 'item 2 name' ),
        array( 'id' => 1, 'item' => 'item 3 name' ),
    )
);

Which created this JSON:

{
    "data": [
        {"id":1, "item":"item 1 name"},
        {"id":2, "item":"item 2 name"},
        {"id":3, "item":"item 3 name"},
    ]
}

This is indeed parsed as an object.

SO, I must patch my code to make it work...

Maybe this was introduced on #6672

luisherranz commented 2 months ago

I have created an issue to investigate this bug:

@otakupahp, could you please comment on that issue to provide a detailed list of the steps we need to take to reproduce the problem? Thank you.