Changeset 59256

Timestamp:

10/18/2024 09:53:45 PM (8 weeks ago)

Author:

joemcgill

Message:

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.

This is a follow-up that reimplements [58334], which was previously reverted in [58710].

Props thekt12, spacedmonkey, pereirinha, mukesh27, isabel_brison, oandregal, andrewserong, ramonjd, joemcgill, costdev, aaronrobertshaw, peterwilsoncc.
Fixes #61679. See #59595.

Location:

trunk

Files:

• src/wp-includes/global-styles-and-settings.php (modified) (2 diffs)
• tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php (modified) (2 diffs)

trunk/src/wp-includes/global-styles-and-settings.php

@@ -258 +258 @@
     $tree        = WP_Theme_JSON_Resolver::resolve_theme_file_uris( $tree );
     $block_nodes = $tree->get_styles_block_nodes();
+
+    $can_use_cached = ! wp_is_development_mode( 'theme' );
+    $update_cache   = false;
+
+    if ( $can_use_cached ) {
+        // Hash the merged WP_Theme_JSON data to bust cache on settings or styles change.
+        $cache_hash = md5( wp_json_encode( $tree->get_raw_data() ) );
+        $cache_key  = 'wp_styles_for_blocks';
+        $cached     = get_transient( $cache_key );
+
+        // Reset the cached data if there is no value or if the hash has changed.
+        if ( ! is_array( $cached ) || $cached['hash'] !== $cache_hash ) {
+            $cached = array(
+                'hash'   => $cache_hash,
+                'blocks' => array(),
+            );
+
+            // Update the cache if the hash has changed.
+            $update_cache = true;
+        }
+    }
+
     foreach ( $block_nodes as $metadata ) {
-        $block_css = $tree->get_styles_for_block( $metadata );
+
+        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['blocks'][ $cache_node_key ] ) ) {
+                $block_css = $cached['blocks'][ $cache_node_key ];
+            } else {
+                $block_css                           = $tree->get_styles_for_block( $metadata );
+                $cached['blocks'][ $cache_node_key ] = $block_css;
+
+                // Update the cache if the cache contents have changed.
+                $update_cache = true;
+            }
+        } else {
+            $block_css = $tree->get_styles_for_block( $metadata );
+        }
 
         if ( ! wp_should_load_separate_core_block_assets() ) {
@@ -305 +343 @@
         }
     }
+
+    if ( $update_cache ) {
+        set_transient( $cache_key, $cached );
+    }
 }
 

trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php

@@ -19 +19 @@
     private $test_blocks = array();
 
+    /**
+     * Administrator ID.
+     *
+     * @var int
+     */
+    private static $administrator_id;
+
+    public static function set_up_before_class() {
+        parent::set_up_before_class();
+        self::$administrator_id = self::factory()->user->create(
+            array(
+                'role'       => 'administrator',
+                'user_email' => 'administrator@example.com',
+            )
+        );
+    }
+
     public function set_up() {
         parent::set_up();
@@ -77 +94 @@
 
     /**
+     * Tests that the block cache is set for global styles.
+     *
+     * @ticket 61679
+     */
+    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                = 'wp_styles_for_blocks';
+        $styles_for_blocks_before = get_transient( $cache_key );
+        $this->assertFalse( $styles_for_blocks_before, 'No block styles should be cached yet.' );
+
+        wp_add_global_styles_for_blocks();
+
+        $styles_for_blocks_after = get_transient( $cache_key );
+        $this->assertNotEmpty( $styles_for_blocks_after, 'No block styles were cached.' );
+    }
+
+    /**
+     * Tests that the block cache is skipped when in dev mode for themes.
+     *
+     * @ticket 61679
+     */
+    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();
+
+        $styles_for_blocks_initial = get_transient( 'wp_styles_for_blocks' );
+
+        // Cleanup.
+        $_wp_tests_development_mode = $orig_dev_mode;
+
+        $this->assertFalse( $styles_for_blocks_initial );
+    }
+
+    /**
+     * Tests that the block cache is updated if the block meta has changed.
+     *
+     * @ticket 61679
+     */
+    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();
+
+        $styles_for_blocks_initial = get_transient( 'wp_styles_for_blocks' );
+        $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();
+
+        $styles_for_blocks_updated = get_transient( 'wp_styles_for_blocks' );
+        $this->assertNotEmpty( $styles_for_blocks_updated, 'Updated cache was not set.' );
+
+        $this->assertNotSame(
+            $styles_for_blocks_initial,
+            $styles_for_blocks_updated,
+            'Block style cache was not updated.'
+        );
+    }
+
+    /**
+     * Confirms that `wp_styles_for_blocks` cache is cleared when a user modifies global styles.
+     * @ticket 61679
+     */
+    public function test_styles_for_blocks_cache_is_reset_when_user_styles_change() {
+        // Only administrators can update the global styles post.
+        wp_set_current_user( self::$administrator_id );
+
+        $this->set_up_third_party_block();
+
+        wp_register_style( 'global-styles', false, array(), true, true );
+        wp_add_global_styles_for_blocks();
+
+        $cache_key                = 'wp_styles_for_blocks';
+        $styles_for_blocks_before = get_transient( $cache_key );
+
+        // Update the global styles post.
+        $post_id     = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
+        $before      = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
+        $old_content = json_decode( $before['post_content'], true );
+
+        // Mock a change in the global styles.
+        $new_content = array_merge(
+            $old_content,
+            array(
+                'styles' => array(
+                    'elements' => array(
+                        'button' => array(
+                            'color' => array(
+                                'background' => 'orange',
+                            ),
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        wp_update_post(
+            array(
+                'ID'           => $post_id,
+                'post_content' => wp_json_encode( $new_content ),
+            )
+        );
+
+        // Reset the static cache, since this would be reset between requests.
+        WP_Theme_JSON_Resolver::clean_cached_data();
+
+        /*
+         * 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               = 'wp_styles_for_blocks';
+        $styles_for_blocks_after = get_transient( $cache_key );
+
+        $this->assertNotSame(
+            $styles_for_blocks_before,
+            $styles_for_blocks_after,
+            'Block style cache was not updated.'
+        );
+    }
+
+    /**
      * @ticket 56915
      * @ticket 61165