Merged data should consider origin to return early #45969

oandregal · 2022-11-22T12:55:22Z

What?

This makes the WP_Theme_JSON_Resolver::get_merged_data consider the origin the consumers wants to retrieve, preventing it from calculating data consumers don't need.

Why?

This PR is a preparation for #45372 and other public high-level methods. The consumer should be responsible to know which origin needs to be queried, and the resolver should return data based on that.

How?

This makes the get_merged_data method use the $origin parameter and bail early.
Adds some test to clarify behavior.
Brings back a couple of filters that were missing.

Testing Instructions

Verify that automated test pass.
Test scaling presets work as expected.

codesandbox · 2022-11-22T12:55:24Z

Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

oandregal · 2022-11-22T13:24:01Z

@glendaviesnz I wanted to gather your thoughts on whether this change is ok in terms of the spacing presets. What would be a good testing instructions for this change?

spacedmonkey · 2022-11-22T15:00:02Z

lib/compat/wordpress-6.2/class-wp-theme-json-resolver-6-2.php

+	 *
+	 * @return WP_Theme_JSON
+	 */
+	public static function get_merged_data( $origin = 'custom' ) {


So depending on origin, this function is you more and less information. This is very confusing and even the comment doesnt help explain why this is done at all.

default origin, gives you core data,

blocks, gives you core data + block data,

theme, gives you core data + block data + theme data

custom give you core data + block data + theme data + user data.

First of all, this is confusing, as the naming seems a little off. Origin means what in this context? Why would you only want to load parts of this data? Why not load the lot?

Instead of param, why not function names, like

get_theme_data_for_blocks,
get_theme_data_for_user,
get_theme_data_for_theme.

First of all, this is confusing, as the naming seems a little off. Origin means what in this context? Why would you only want to load parts of this data? Why not load the lot?

That's how the domain works: depending on some context, we need one piece of data or another. Existing use cases are editor vs front-end, or themes with or without theme.json.

Instead of param, why not function names, like

Note that the way this is set up is prior to this PR. This PR only fixes the existing behavior. Whether this could have been done differently is out of scope for this PR.

I agree with @spacedmonkey that it would be better to have separate functions (or even classes) for each type of origin:

$block_origin = new Gutenberg_Block_Origin(); $theme_data = $block_origin->get_theme_data();

or

$user_origin = new Gutenberg_User_Origin(); $theme_data = $user_origin->get_theme_data();

At the same time, I understand @oandregal 's point that the goal of this PR is mainly refactoring/optimization.

That's a conversation separate from this PR. I also want to share my perspective on that: as a collective, we have limited number of hours to produce work, so I tend to favor work that has an impact on users or developer experience. Given this class is private and consumers should use the public methods (see), I'd personally refrain from refactoring for refactor's sake. If anything, we should aim to remove/deprecate these class (and its methods) entirely.

Also, note that there already are separate methods to get the individual origins:

WP_Theme_JSON_Resolver::get_core_data(); WP_Theme_JSON_Resolver::get_theme_data(); WP_Theme_JSON_Resolver::get_blocks_data(); WP_Theme_JSON_Resolver::get_user_data();

The get_merged_data method implements the algorithm that merges the sources together.

glendaviesnz · 2022-11-22T22:03:05Z

@glendaviesnz I wanted to gather your thoughts on whether this change is ok in terms of the spacing presets. What would be a good testing instructions for this change?

At this point there is no way for a user to add a custom spacing scale, so we only need to test if the spacing scale from the core theme.json is generated as expected, and if spacing scale settings from a themes theme.json override the core ones. I tested the following with this PR and seems to be working as expected:

✅ With no theme settings the default 7 step spacing sizes show in block dimensions tools panel
✅ Theme settings of any of the spacingScale params merge with and override the core theme.json settings
✅ Theme setting of a hard coded spacingSizes array overrides the auto generated spacingScale

I don't particularly like the location of set_spacing_sizes in this method, it seems slightly out of place, but when originally looking at this I couldn't find a better location for this as the spacing sizes data can't be generated until the theme data has been merged ... I guess it sort of fits as the generation of the spacing scale is part of the merge process, but I am open to ideas/suggestions on a better place to locate this.

oandregal · 2022-11-22T22:44:22Z

At this point there is no way for a user to add a custom spacing scale

Ok, thanks. I need to look at this tomorrow (I'm from mobile now), though it sounds we need to recalculate the spacing at least for core, blocks (they can have any settings as part of their attributes, so I guess it also affect this?) and theme, but could get rid of the user.

I don't particularly like the location of set_spacing_sizes in this method, it seems slightly out of place

We can look at this separately.

A potential idea. If 1) all but the user origin need this computation and 2) we only compute this if the incoming data has new spacing settings, could we perhaps look at absorbing this in the merge method by doing something along these lines (pseudo-code):

function merge( $incoming ) {
  // an some point at the end
  if ( $incoming_has_spacing_settings ) {
    // Do the scale calculation.
  }
}

glendaviesnz · 2022-11-23T04:12:33Z

at least for core, blocks (they can have any settings as part of their attributes, so I guess it also affect this?) and theme, but could get rid of the user.

At the moment it is only possible to have spacingScale, or spacingSizes settings at the core and theme level. Unique spacing presets can't be set at the block level, and I don't think there are any plans to support this, so currently everything seems to work as expected if $result->set_spacing_sizes() is only run for the default and theme origins - hopefully I am not overlooking something.

anton-vlasenko

It would be nice to have some PHP unit tests for this new static method.

anton-vlasenko · 2022-11-23T22:07:08Z

lib/compat/wordpress-6.2/class-wp-theme-json-resolver-6-2.php

+	 *
+	 * @return WP_Theme_JSON
+	 */
+	public static function get_merged_data( $origin = 'custom' ) {


I agree with @spacedmonkey that it would be better to have separate functions (or even classes) for each type of origin:

$block_origin = new Gutenberg_Block_Origin(); $theme_data = $block_origin->get_theme_data();

or

$user_origin = new Gutenberg_User_Origin(); $theme_data = $user_origin->get_theme_data();

At the same time, I understand @oandregal 's point that the goal of this PR is mainly refactoring/optimization.

oandregal · 2022-11-24T12:18:19Z

It would be nice to have some PHP unit tests for this new static method.

This is not a new method, it is part of WordPress since 5.9 and before that in the plugin. I've added a bunch of tests to cover this behavior.

lib/compat/wordpress-6.2/default-filters.php

glendaviesnz · 2022-11-24T22:37:03Z

so currently everything seems to work as expected if $result->set_spacing_sizes() is only run for the default and theme origins - hopefully I am not overlooking something.

@oandregal, I must have been overlooking something as when I retested today the spacing sizes were not being generated in themes that did not have their own settings in theme.json unless set_spacing_sizes is run before the final return. I am sure I tested this scenario the other day 🤷‍♂️. I pushed the change that fixes this.

anton-vlasenko

Thanks for adding the tests, @oandregal.
I've added my notes.
Also, it should be possible to merge these 4 test methods into a single test method and use the data provider.
The only parameter that get changed across these tests is the argument of the WP_Theme_JSON_Resolver_Gutenberg::get_merged_data() method.

phpunit/class-wp-theme-json-resolver-test.php

oandregal · 2022-11-25T07:36:12Z

Also, it should be possible to merge these 4 test methods into a single test method and use the data provider.

@anton-vlasenko How do you run a single test using the data provider? Happy to use it if there's an easy way to run individual tests, otherwise, that setup requires a lot of manual intervention to do something that simple.

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

oandregal · 2022-11-25T08:32:00Z

@oandregal, I must have been overlooking something as when I retested today the spacing sizes were not being generated in themes that did not have their own settings in theme.json unless set_spacing_sizes is run before the final return. I am sure I tested this scenario the other day man_shrugging. I pushed the change that fixes this.

Thanks, Glen!

oandregal · 2022-11-25T09:02:14Z

@anton-vlasenko taugh me how to run a single dataset: you append @name_of_dataset to the test. For example:

npm run test:unit:php -- --filter test_get_merged_data_returns_origin@origin_default

Runs the test_get_merged_data_returns_origin with the dataset provided by origin_default.

In the past, I had tried with # and other combinations as per some docs, but they didn't work. Happy there is a way! I've adapted the test to use this mechanism.

anton-vlasenko

LGTM! 🎉

lib/compat/wordpress-6.2/class-wp-theme-json-resolver-6-2.php

#45969

… inheriting per WordPress version (#46750) * Backport WP_Theme_JSON_Resolver from core as it is * Substitute WP_Theme_JSON by WP_Theme_JSON_Gutenberg * Substitute WP_Theme_JSON_Data by WP_Theme_JSON_Data_Gutenberg * Rename WP_Theme_JSON_Resolver to WP_Theme_JSON_Resolver_Base The goal is to use it as base to inherit from, until we are able to remove all the children. * Make WP_Theme_JSON_Resolver_6_1 inherit from WP_Theme_JSON_Resolver_Base * 6.1: remove field already defined in base class * 6.1: remove translate, it is equal to base method * 6.1: remove get_core_data, it does not have base changes * 6.1: remove get_user_data Missed core changes and does not do anything differently from core. * 6.1: remove get_user_data_from_wp_global_styles It misses core changes and does not do anything differently. * 6.2: inherit from WP_Theme_JSON_Resolver_Base instead of 6.1 This makes the WP_Theme_JSON_Resover_6_1 class unused. * 6.1: remove class no longer in use * 6.2: deprecate theme_has_support #45380 * 6.2: substitute WP_Theme_JSON_Resolver::theme_has_support by wp_theme_has_theme_json() #45168 * 6.2: port changes to get_user_data_from_wp_global_styles #46043 * 6.2: update get_merged_data #45969 * 6.2: remove get_user_data Same code as core. There's a check for detecting whether the class is an instance of WP_Theme_JSON_Gutenberg that was not ported. This check was introduced to make sure the cache of the core class didn't interfere with the cache of the Gutenberg class, so it's no longer necessary. See #42756 * experimental: make it inherit from WP_Theme_JSON_Resolver_Base * 6.2: remove class no longer in use * experimental: delete remove_json_comments It's already part of the base class. * experimental: remove get_block_data It's already part of the base class and it didn't have the changes from core. * experimental: appearanceTools Port changes to the base class that were meant to be part of 6.1. See #43337 * experimental: port webfonts (experimental API) see #37140 * experimental: use gutenberg_get_legacy_theme_supports_for_theme_json #46112 * experimental: get_theme_data, all code is in the base class * experimental: remove empty class * Rename WP_Theme_JSON_Resolver_Base to WP_Theme_JSON_Resolver_Gutenberg * Fix lint issue: rename class-wp-theme-json-resolver.php to class-wp-theme-json-resolver-gutenberg.php * Move theme.json to unversioned lib/ * Move theme-i18n.json to unversioned lib/

oandregal requested a review from spacedmonkey as a code owner November 22, 2022 12:55

oandregal self-assigned this Nov 22, 2022

oandregal added the [Type] Bug An existing feature does not function as intended label Nov 22, 2022

oandregal mentioned this pull request Nov 22, 2022

Allow for passing stylesheet to wp_theme_has_theme_json. #45955

Open

oandregal requested review from hellofromtonya, felixarntz, anton-vlasenko and glendaviesnz November 22, 2022 13:18

oandregal requested review from mmtr and jorgefilipecosta November 22, 2022 13:35

This was referenced Nov 22, 2022

Update which origins are queried for gutenberg_get_global_settings #45971

Merged

Add WP_Object_Cache to the gutenberg_get_global_settings method #45372

Merged

oandregal added the Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json label Nov 22, 2022

oandregal mentioned this pull request Nov 22, 2022

Code quality check for theme.json related APIs #45171

Open

oandregal requested a review from aristath November 22, 2022 14:02

spacedmonkey reviewed Nov 22, 2022

View reviewed changes

anton-vlasenko requested a review from azaozz November 22, 2022 15:23

oandregal force-pushed the update/get-merged-data-bail-early branch 2 times, most recently from e5ac0a6 to 8f46778 Compare November 22, 2022 16:37

oandregal added a commit that referenced this pull request Nov 22, 2022

Base PR: #45969

f99d2b1

anton-vlasenko reviewed Nov 23, 2022

View reviewed changes

oandregal force-pushed the update/get-merged-data-bail-early branch from 8f46778 to baeebd2 Compare November 24, 2022 12:11

oandregal force-pushed the update/get-merged-data-bail-early branch from 00c27c9 to 795319a Compare November 24, 2022 16:36

oandregal commented Nov 24, 2022

View reviewed changes

lib/compat/wordpress-6.2/default-filters.php Show resolved Hide resolved

Fix lint issues

6865e70

Add the spacing sizes generation back in before final return

1de4692

anton-vlasenko requested changes Nov 24, 2022

View reviewed changes

oandregal and others added 2 commits November 25, 2022 08:47

Update phpunit/class-wp-theme-json-resolver-test.php

3b0e7bf

Co-authored-by: Anton Vlasenko <43744263+anton-vlasenko@users.noreply.github.com>

Fix suggestions

75c1202

oandregal force-pushed the update/get-merged-data-bail-early branch from 782563f to 75c1202 Compare November 25, 2022 07:57

oandregal added 3 commits November 25, 2022 09:57

Use data provider in test

7228291

Inline utility functions

6d06e33

Fix lint issues

07903d3

anton-vlasenko approved these changes Nov 25, 2022

View reviewed changes

oandregal merged commit cf3cbd8 into trunk Nov 25, 2022

oandregal deleted the update/get-merged-data-bail-early branch November 25, 2022 10:17

github-actions bot added this to the Gutenberg 14.7 milestone Nov 25, 2022

mmtr reviewed Nov 25, 2022

View reviewed changes

lib/compat/wordpress-6.2/class-wp-theme-json-resolver-6-2.php Show resolved Hide resolved

oandregal added a commit that referenced this pull request Dec 22, 2022

6.2: update get_merged_data

a5bdc76

#45969

Mamaduka mentioned this pull request Jan 17, 2023

Plugin: Backport PHP changes for WordPress 6.2 release #47187

Closed

85 tasks

Mamaduka mentioned this pull request Jan 24, 2023

Backport: WP_Theme_JSON_Resolver changes WordPress/wordpress-develop#3901

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merged data should consider origin to return early #45969

Merged data should consider origin to return early #45969

oandregal commented Nov 22, 2022 •

edited

Loading

codesandbox bot commented Nov 22, 2022

oandregal commented Nov 22, 2022

spacedmonkey Nov 22, 2022

oandregal Nov 22, 2022

anton-vlasenko Nov 23, 2022

oandregal Nov 24, 2022

oandregal Nov 24, 2022

glendaviesnz commented Nov 22, 2022

oandregal commented Nov 22, 2022

glendaviesnz commented Nov 23, 2022 •

edited

Loading

anton-vlasenko left a comment •

edited

Loading

anton-vlasenko Nov 23, 2022

oandregal commented Nov 24, 2022

glendaviesnz commented Nov 24, 2022

anton-vlasenko left a comment •

edited

Loading

oandregal commented Nov 25, 2022

oandregal commented Nov 25, 2022

oandregal commented Nov 25, 2022

anton-vlasenko left a comment

Merged data should consider origin to return early #45969

Merged data should consider origin to return early #45969

Conversation

oandregal commented Nov 22, 2022 • edited Loading

What?

Why?

How?

Testing Instructions

codesandbox bot commented Nov 22, 2022

oandregal commented Nov 22, 2022

spacedmonkey Nov 22, 2022

Choose a reason for hiding this comment

oandregal Nov 22, 2022

Choose a reason for hiding this comment

anton-vlasenko Nov 23, 2022

Choose a reason for hiding this comment

oandregal Nov 24, 2022

Choose a reason for hiding this comment

oandregal Nov 24, 2022

Choose a reason for hiding this comment

glendaviesnz commented Nov 22, 2022

oandregal commented Nov 22, 2022

glendaviesnz commented Nov 23, 2022 • edited Loading

anton-vlasenko left a comment • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Nov 23, 2022

Choose a reason for hiding this comment

oandregal commented Nov 24, 2022

glendaviesnz commented Nov 24, 2022

anton-vlasenko left a comment • edited Loading

Choose a reason for hiding this comment

oandregal commented Nov 25, 2022

oandregal commented Nov 25, 2022

oandregal commented Nov 25, 2022

anton-vlasenko left a comment

Choose a reason for hiding this comment

oandregal commented Nov 22, 2022 •

edited

Loading

glendaviesnz commented Nov 23, 2022 •

edited

Loading

anton-vlasenko left a comment •

edited

Loading

anton-vlasenko left a comment •

edited

Loading