Changeset 54276

Timestamp:

09/21/2022 01:55:25 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Editor: Improve block loading PHP performance.

This commit improves PHP performance for core blocks by reading a single PHP file with block metadata, instead of reading a JSON file per-block and then decoding from JSON to PHP.

Includes:

• Adding a new Grunt task to convert block.json files to block-json.php.
• Using the new block-json.php file in the register_block_type_from_metadata() function.

Follow-up to [48141].

Props aristath, gziolo, johnbillion, presstoke, mukesh27, hellofromTonya, petitphp, adamsilverstein, costdev, desrosj, SergeyBiryukov.
Fixes #55005.

Location:

trunk

Files:

• Gruntfile.js (modified) (3 diffs)
• package-lock.json (modified) (2 diffs)
• package.json (modified) (1 diff)
• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/blocks/blocks-json.php (added)

trunk/Gruntfile.js

@@ -4 +4 @@
 var webpackConfig = require( './webpack.config' );
 var installChanged = require( 'install-changed' );
+var json2php = require( 'json2php' );
 
 module.exports = function(grunt) {
@@ -1404 +1405 @@
     } );
 
+    grunt.registerTask( 'copy:block-json', 'Copies block.json file contents to block-json.php.', function() {
+        var blocks = {};
+        grunt.file.recurse( SOURCE_DIR + 'wp-includes/blocks', function( abspath, rootdir, subdir, filename ) {
+            if ( /^block\.json$/.test( filename ) ) {
+                blocks[ subdir ] = grunt.file.readJSON( abspath );
+            }
+        } );
+        grunt.file.write(
+            SOURCE_DIR + 'wp-includes/blocks/blocks-json.php',
+            '<?php return ' + json2php( blocks ) + ';'
+        );
+    } );
+
     grunt.registerTask( 'copy:js', [
         'copy:npm-packages',
@@ -1452 +1466 @@
         'clean:files',
         'copy:files',
+        'copy:block-json',
         'copy:version',
     ] );

trunk/package-lock.json

@@ -4327 +4327 @@
                 "json2php": "^0.0.4",
                 "webpack-sources": "^3.2.2"
+            },
+            "dependencies": {
+                "json2php": {
+                    "version": "0.0.4",
+                    "resolved": "https://registry.npmjs.org/json2php/-/json2php-0.0.4.tgz",
+                    "integrity": "sha512-hFzejhs28f70sGnutcsRS459MnAsjRVI85RgPAL1KQIZEpjiDitc27CZv4IgOtaR86vrqOVlu9vJNew2XyTH4g==",
+                    "dev": true
+                }
             }
         },
@@ -17764 +17772 @@
         },
         "json2php": {
-            "version": "0.0.4",
-            "resolved": "https://registry.npmjs.org/json2php/-/json2php-0.0.4.tgz",
-            "integrity": "sha512-hFzejhs28f70sGnutcsRS459MnAsjRVI85RgPAL1KQIZEpjiDitc27CZv4IgOtaR86vrqOVlu9vJNew2XyTH4g==",
-            "dev": true
+            "version": "0.0.5",
+            "resolved": "https://registry.npmjs.org/json2php/-/json2php-0.0.5.tgz",
+            "integrity": "sha512-jWpsGAYlQDKOjJcyq3rYaxcZ+5YMhZIKHKTjdIKJPI9zLSX+yRWHSSwtV8hvIg7YMhbKkgPO669Ve2ZgFK5C7w=="
         },
         "json5": {

trunk/package.json

@@ -144 +144 @@
         "jquery-form": "4.3.0",
         "jquery-hoverintent": "1.10.2",
+        "json2php": "^0.0.5",
         "lodash": "4.17.21",
         "masonry-layout": "4.2.2",

trunk/src/wp-includes/blocks.php

@@ -284 +284 @@
  */
 function register_block_type_from_metadata( $file_or_folder, $args = array() ) {
-    $filename      = 'block.json';
-    $metadata_file = ( substr( $file_or_folder, -strlen( $filename ) ) !== $filename ) ?
-        trailingslashit( $file_or_folder ) . $filename :
+    /*
+     * Get an array of metadata from a PHP file.
+     * This improves performance for core blocks as it's only necessary to read a single PHP file
+     * instead of reading a JSON file per-block, and then decoding from JSON to PHP.
+     * Using a static variable ensures that the metadata is only read once per request.
+     */
+    static $core_blocks_meta;
+    if ( ! $core_blocks_meta ) {
+        $core_blocks_meta = include_once ABSPATH . WPINC . '/blocks/blocks-json.php';
+    }
+
+    $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ?
+        trailingslashit( $file_or_folder ) . 'block.json' :
         $file_or_folder;
+
     if ( ! file_exists( $metadata_file ) ) {
         return false;
     }
 
-    $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+    // Try to get metadata from the static cache for core blocks.
+    $metadata = false;
+    if ( str_starts_with( $file_or_folder, ABSPATH . WPINC ) ) {
+        $core_block_name = str_replace( ABSPATH . WPINC . '/blocks/', '', $file_or_folder );
+        if ( ! empty( $core_blocks_meta[ $core_block_name ] ) ) {
+            $metadata = $core_blocks_meta[ $core_block_name ];
+        }
+    }
+
+    // If metadata is not found in the static cache, read it from the file.
+    if ( ! $metadata ) {
+        $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+    }
+
     if ( ! is_array( $metadata ) || empty( $metadata['name'] ) ) {
         return false;