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

Theme JSON: cached resolved URIs #66155

Open
wants to merge 8 commits into
base: trunk
Choose a base branch
from
Open

Theme JSON: cached resolved URIs #66155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c8660e3
A pretty basic caching test for resolved theme URIs in WP_Theme_JSON_…
ramonjd Oct 16, 2024
6dea724
Add a test
ramonjd Oct 18, 2024
436486f
Merge tests with the same data
ramonjd Oct 21, 2024
5cdb27e
Add annotation for version
ramonjd Oct 21, 2024
2f172a9
Backport entry
ramonjd Oct 21, 2024
739d40c
Use hashed key built using stringified theme.json
ramonjd Oct 21, 2024
b9762eb
Fix your tests, man!
ramonjd Oct 21, 2024
6140eb0
remove dupe call
ramonjd Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions backport-changelog/6.8/7596.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
https://github.com/WordPress/wordpress-develop/pull/7596

* https://github.com/WordPress/gutenberg/pull/66155
34 changes: 25 additions & 9 deletions lib/class-wp-theme-json-resolver-gutenberg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ class WP_Theme_JSON_Resolver_Gutenberg {
*/
protected static $theme_json_file_cache = array();

/**
* Cache for resolved files per theme.
*
* @since 6.8.0
* @var array
*/
protected static $resolved_theme_uris_cache = array();

/**
* Processes a file that adheres to the theme.json schema
* and returns an array with its contents, or a void array if none found.
Expand Down Expand Up @@ -696,20 +704,22 @@ protected static function get_file_path_from_theme( $file_name, $template = fals
* and `$i18n_schema` variables to reset.
* @since 6.1.0 Added the `$blocks` and `$blocks_cache` variables
* to reset.
* @since 6.8.0 Added the `$resolved_theme_uris_cache` variable to reset.
*/
public static function clean_cached_data() {
static::$core = null;
static::$blocks = null;
static::$blocks_cache = array(
static::$core = null;
static::$blocks = null;
static::$blocks_cache = array(
'core' => array(),
'blocks' => array(),
'theme' => array(),
'user' => array(),
);
static::$theme = null;
static::$user = null;
static::$user_custom_post_type_id = null;
static::$i18n_schema = null;
static::$theme = null;
static::$user = null;
static::$user_custom_post_type_id = null;
static::$i18n_schema = null;
static::$resolved_theme_uris_cache = array();
}

/**
Expand Down Expand Up @@ -839,6 +849,7 @@ public static function get_style_variations_from_directory( $directory, $scope =
*
* @since 6.6.0
* @since 6.7.0 Added support for resolving block styles.
* @since 6.8.0 Added caching for resolved theme URIs.
*
* @param WP_Theme_JSON_Gutenberg $theme_json A theme json instance.
* @return array An array of resolved paths.
Expand All @@ -850,7 +861,12 @@ public static function get_resolved_theme_uris( $theme_json ) {
return $resolved_theme_uris;
}

$theme_json_data = $theme_json->get_raw_data();
$theme_json_data = $theme_json->get_raw_data();
$resolved_theme_uris_cache_key = md5( wp_json_encode( $theme_json_data ) );
Copy link
Member Author

Choose a reason for hiding this comment

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

Not yet sure if this will make things better or worse 😄

Copy link
Member Author

Choose a reason for hiding this comment

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

It'd be great if WordPress had minimum PHP 8 support for faster hashing: https://php.watch/articles/php-hash-benchmark

Copy link
Member Author

Choose a reason for hiding this comment

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

md4 outperforms md5 for file integrity on many benchmarks I've seen but hash( 'md4', wp_json_encode( $theme_json_data ) ) doesn't move the needle at all for me in performance tests.

Copy link
Contributor

@aaronrobertshaw aaronrobertshaw Oct 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

If we had a minimum PHP version of 8, we could avoid the hashing and use a WeakMap where the theme_json data/object was the key.

Copy link
Member

Choose a reason for hiding this comment

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

Before the caching we should check theme development mode. WDYT?

$can_use_cached = ! wp_is_development_mode( 'theme' );
if ( $can_use_cached ) {
	// Add caching here.
}

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, but I'm not sure whether it's required here just yet.

The method is called several times in a single session and the main performance enhancement here is to avoid subsequent (and expensive) processing in the same session. This applies to the frontend and editor.

Nothing is saved to the database so I don't expect theme developers to run into any gotchas when testing sites given that the cache is wiped every time the page refreshes.

Also it's being used in gutenberg_get_global_stylesheet and gutenberg_get_global_stylesheet which are both using caches as well.

I could be missing some subtleties so please let me know!


if ( ! empty( static::$resolved_theme_uris_cache[ $resolved_theme_uris_cache_key ] ) ) {
return static::$resolved_theme_uris_cache[ $resolved_theme_uris_cache_key ];
}

// Using the same file convention when registering web fonts. See: WP_Font_Face_Resolver:: to_theme_file_uri.
$placeholder = 'file:./';
Expand Down Expand Up @@ -901,7 +917,7 @@ public static function get_resolved_theme_uris( $theme_json ) {
}
}
}

static::$resolved_theme_uris_cache[ $resolved_theme_uris_cache_key ] = $resolved_theme_uris;
return $resolved_theme_uris;
}

Expand Down
26 changes: 25 additions & 1 deletion phpunit/class-wp-theme-json-resolver-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ class WP_Theme_JSON_Resolver_Gutenberg_Test extends WP_UnitTestCase {
*/
private static $property_blocks_cache_orig_value;

/**
* WP_Theme_JSON_Resolver_Gutenberg::$resolved_theme_uris_cache property.
*
* @var ReflectionProperty
*/
private static $property_resolved_theme_uris_cache;

/**
* Original value of the WP_Theme_JSON_Resolver_Gutenberg::$resolved_theme_uris_cache property.
*
* @var array
*/
private static $property_resolved_theme_uris_cache_orig_value;

/**
* WP_Theme_JSON_Resolver_Gutenberg::$core property.
*
Expand Down Expand Up @@ -81,11 +95,16 @@ public static function set_up_before_class() {
static::$property_core = new ReflectionProperty( WP_Theme_JSON_Resolver_Gutenberg::class, 'core' );
static::$property_core->setAccessible( true );
static::$property_core_orig_value = static::$property_core->getValue();

static::$property_resolved_theme_uris_cache = new ReflectionProperty( WP_Theme_JSON_Resolver_Gutenberg::class, 'resolved_theme_uris_cache' );
static::$property_resolved_theme_uris_cache->setAccessible( true );
static::$property_resolved_theme_uris_cache_orig_value = static::$property_resolved_theme_uris_cache->getValue();
}

public static function tear_down_after_class() {
static::$property_blocks_cache->setValue( null, static::$property_blocks_cache_orig_value );
static::$property_core->setValue( null, static::$property_core_orig_value );
static::$property_resolved_theme_uris_cache->setValue( null, static::$property_resolved_theme_uris_cache_orig_value );
parent::tear_down_after_class();
}

Expand Down Expand Up @@ -1347,7 +1366,12 @@ public function test_get_resolved_theme_uris() {
$actual = WP_Theme_JSON_Resolver_Gutenberg::get_resolved_theme_uris( $theme_json );
remove_filter( 'theme_file_uri', $filter_theme_file_uri_callback );

$this->assertSame( $expected_data, $actual );
$this->assertSame( $expected_data, $actual, 'Resolved theme uris do not match.' );

// Test that resolved theme uris are cached.
$cache_key = md5( wp_json_encode( $theme_json->get_raw_data() ) );
$expected_cache_data = array( "$cache_key" => $actual );
$this->assertSame( $expected_cache_data, static::$property_resolved_theme_uris_cache->getValue(), 'Resolved theme uris cache data does not match.' );
}

/**
Expand Down
Loading