<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58334] trunk: Editor: Cache global styles for blocks.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58334">58334</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58334","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-04 14:50:24 +0000 (Tue, 04 Jun 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Editor: Cache global styles for blocks.
This caches the generated CSS from block nodes in merged Theme JSON data to avoid repeated costly operations required to compute style properties for blocks. The generated CSS is saved to a transient that expires every hour.
Props thekt12, spacedmonkey, pereirinha, mukesh27, isabel_brison, oandregal, andrewserong, ramonjd.
Fixes <a href="https://core.trac.wordpress.org/ticket/59595">#59595</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesglobalstylesandsettingsphp">trunk/src/wp-includes/global-styles-and-settings.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpAddGlobalStylesForBlocksphp">trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesglobalstylesandsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/global-styles-and-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/global-styles-and-settings.php 2024-06-04 14:42:29 UTC (rev 58333)
+++ trunk/src/wp-includes/global-styles-and-settings.php 2024-06-04 14:50:24 UTC (rev 58334)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -307,9 +307,45 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tree = WP_Theme_JSON_Resolver::get_merged_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $block_nodes = $tree->get_styles_block_nodes();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $can_use_cached = ! wp_is_development_mode( 'theme' );
+ if ( $can_use_cached ) {
+ // Hash global settings and block nodes together to optimize performance of key generation.
+ $hash = md5(
+ wp_json_encode(
+ array(
+ 'global_setting' => wp_get_global_settings(),
+ 'block_nodes' => $block_nodes,
+ )
+ )
+ );
+
+ $cache_key = "wp_styles_for_blocks:$hash";
+ $cached = get_site_transient( $cache_key );
+ if ( ! is_array( $cached ) ) {
+ $cached = array();
+ }
+ }
+
+ $update_cache = false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $block_nodes as $metadata ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_css = $tree->get_styles_for_block( $metadata );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $can_use_cached ) {
+ // Use the block name as the key for cached CSS data. Otherwise, use a hash of the metadata.
+ $cache_node_key = isset( $metadata['name'] ) ? $metadata['name'] : md5( wp_json_encode( $metadata ) );
+
+ if ( isset( $cached[ $cache_node_key ] ) ) {
+ $block_css = $cached[ $cache_node_key ];
+ } else {
+ $block_css = $tree->get_styles_for_block( $metadata );
+ $cached[ $cache_node_key ] = $block_css;
+ $update_cache = true;
+ }
+ } else {
+ $block_css = $tree->get_styles_for_block( $metadata );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_should_load_separate_core_block_assets() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_style( 'global-styles', $block_css );
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,6 +390,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $update_cache ) {
+ set_site_transient( $cache_key, $cached, HOUR_IN_SECONDS );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpAddGlobalStylesForBlocksphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php 2024-06-04 14:42:29 UTC (rev 58333)
+++ trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php 2024-06-04 14:50:24 UTC (rev 58334)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,6 +76,87 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensure that the block cache is set for global styles.
+ *
+ * @ticket 59595
+ */
+ public function test_styles_for_blocks_cache_is_set() {
+ $this->set_up_third_party_block();
+
+ wp_register_style( 'global-styles', false, array(), true, true );
+
+ $cache_key = $this->get_wp_styles_for_blocks_cache_key();
+ $styles_for_blocks_before = get_site_transient( $cache_key );
+ $this->assertFalse( $styles_for_blocks_before );
+
+ wp_add_global_styles_for_blocks();
+
+ $styles_for_blocks_after = get_site_transient( $cache_key );
+ $this->assertNotEmpty( $styles_for_blocks_after );
+ }
+
+ /**
+ * Confirm that the block cache is skipped when in dev mode for themes.
+ *
+ * @ticket 59595
+ */
+ public function test_styles_for_blocks_skips_cache_in_dev_mode() {
+ global $_wp_tests_development_mode;
+
+ $orig_dev_mode = $_wp_tests_development_mode;
+
+ // Setting development mode to theme should skip the cache.
+ $_wp_tests_development_mode = 'theme';
+
+ wp_register_style( 'global-styles', false, array(), true, true );
+
+ // Initial register of global styles.
+ wp_add_global_styles_for_blocks();
+
+ $cache_key = $this->get_wp_styles_for_blocks_cache_key();
+ $styles_for_blocks_initial = get_site_transient( $cache_key );
+
+ // Cleanup.
+ $_wp_tests_development_mode = $orig_dev_mode;
+
+ $this->assertFalse( $styles_for_blocks_initial );
+ }
+
+ /**
+ * Confirm that the block cache is updated if the block meta has changed.
+ *
+ * @ticket 59595
+ */
+ public function test_styles_for_blocks_cache_is_skipped() {
+ wp_register_style( 'global-styles', false, array(), true, true );
+
+ // Initial register of global styles.
+ wp_add_global_styles_for_blocks();
+
+ $cache_key = $this->get_wp_styles_for_blocks_cache_key();
+ $styles_for_blocks_initial = get_site_transient( $cache_key );
+ $this->assertNotEmpty( $styles_for_blocks_initial, 'Initial cache was not set.' );
+
+ $this->set_up_third_party_block();
+
+ /*
+ * Call register of global styles again to ensure the cache is updated.
+ * In normal conditions, this function is only called once per request.
+ */
+ wp_add_global_styles_for_blocks();
+
+ $cache_key = $this->get_wp_styles_for_blocks_cache_key();
+ $styles_for_blocks_updated = get_site_transient( $cache_key );
+ $this->assertNotEmpty( $styles_for_blocks_updated, 'Updated cache was not set.' );
+
+ $this->assertNotEquals(
+ $styles_for_blocks_initial,
+ $styles_for_blocks_updated,
+ 'Block style cache was not updated.'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 56915
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 61165
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,4 +334,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = wp_styles()->get_data( 'global-styles', 'after' );
</span><span class="cx" style="display: block; padding: 0 10px"> return is_array( $actual ) ? $actual : array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get cache key for `wp_styles_for_blocks`.
+ *
+ * @return string The cache key.
+ */
+ private function get_wp_styles_for_blocks_cache_key() {
+ $tree = WP_Theme_JSON_Resolver::get_merged_data();
+ $block_nodes = $tree->get_styles_block_nodes();
+ // md5 is a costly operation, so we hashing global settings and block_node in a single call.
+ $hash = md5(
+ wp_json_encode(
+ array(
+ 'global_setting' => wp_get_global_settings(),
+ 'block_nodes' => $block_nodes,
+ )
+ )
+ );
+
+ return "wp_styles_for_blocks:$hash";
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>