Changeset 59083

Timestamp:

09/24/2024 07:33:55 AM (4 months ago)

Author:

gziolo

Message:

Build: Prepare for more Script Modules

This is a companion to ​https://github.com/WordPress/gutenberg/pull/65460 that requires syncing in WordPress Core. Namely, the block-library changes require registration with their updated script module IDs so that the blocks continue to work correctly.

They key improvement is script modules registration is handled in one central place, and a combined asset file is used to improve the performance by avoiding multiple disk operations for every individual file.

Props jonsurrell, gziolo, wildworks, noisysocks.
See #60647, #59462.

Location:

trunk

Files:

• .gitignore (modified) (1 diff)
• Gruntfile.js (modified) (1 diff)
• src/wp-includes/assets (modified) (1 prop)
• src/wp-includes/assets/script-modules-packages.min.php (added)
• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/interactivity-api/class-wp-interactivity-api.php (modified) (2 diffs)
• src/wp-includes/script-modules.php (modified) (1 diff)
• tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php (modified) (2 diffs)
• tools/webpack/modules.js (deleted)
• tools/webpack/script-modules.js (added)
• tools/webpack/shared.js (modified) (2 diffs)
• webpack.config.js (modified) (2 diffs)

trunk/.gitignore

@@ -32 +32 @@
 /src/wp-includes/assets/*
 !/src/wp-includes/assets/script-loader-packages.min.php
+!/src/wp-includes/assets/script-modules-packages.min.php
 /src/wp-includes/js
 /src/wp-includes/css/dist

trunk/Gruntfile.js

@@ -57 +57 @@
             'wp-includes/blocks/**/*.css',
             '!wp-includes/assets/script-loader-packages.min.php',
+            '!wp-includes/assets/script-modules-packages.min.php',
         ],
 

trunk/src/wp-includes/assets

@@ -1 +1 @@
 script-loader-packages.php
 script-loader-react-*.php
+script-modules-packages.php

@@ -1 +1 @@
 script-loader-packages.php
 script-loader-react-*.php
+script-modules-packages.php

trunk/src/wp-includes/default-filters.php

@@ -571 +571 @@
 add_action( 'wp_default_scripts', 'wp_default_scripts' );
 add_action( 'wp_default_scripts', 'wp_default_packages' );
+add_action( 'wp_default_scripts', 'wp_default_script_modules' );
 
 add_action( 'wp_enqueue_scripts', 'wp_localize_jquery_ui_datepicker', 1000 );

trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

@@ -282 +282 @@
      * Registers the `@wordpress/interactivity` script modules.
      *
+     * @deprecated 6.7.0 Script Modules registration is handled by {@see wp_default_script_modules()}.
+     *
      * @since 6.5.0
      */
     public function register_script_modules() {
-        $suffix = wp_scripts_get_suffix();
-
-        wp_register_script_module(
-            '@wordpress/interactivity',
-            includes_url( "js/dist/interactivity$suffix.js" )
-        );
-
-        wp_register_script_module(
-            '@wordpress/interactivity-router',
-            includes_url( "js/dist/interactivity-router$suffix.js" ),
-            array( '@wordpress/interactivity' )
-        );
+        _deprecated_function( __METHOD__, '6.7.0', 'wp_default_script_modules' );
     }
 
@@ -303 +294 @@
      *
      * @since 6.5.0
-     * @since 6.7.0 Use the {@see "script_module_data_{$module_id}"} filter to pass client-side data.
      */
     public function add_hooks() {
-        add_action( 'wp_enqueue_scripts', array( $this, 'register_script_modules' ) );
-        add_action( 'admin_enqueue_scripts', array( $this, 'register_script_modules' ) );
-
         add_filter( 'script_module_data_@wordpress/interactivity', array( $this, 'filter_script_module_interactivity_data' ) );
     }

trunk/src/wp-includes/script-modules.php

@@ -124 +124 @@
     wp_script_modules()->deregister( $id );
 }
+
+/**
+ * Registers all the default WordPress Script Modules.
+ *
+ * @since 6.7.0
+ */
+function wp_default_script_modules() {
+    $suffix = defined( 'WP_RUN_CORE_TESTS' ) ? '.min' : wp_scripts_get_suffix();
+
+    /*
+     * Expects multidimensional array like:
+     *
+     *     'interactivity/index.min.js' => array('dependencies' => array(…), 'version' => '…'),
+     *     'interactivity/debug.min.js' => array('dependencies' => array(…), 'version' => '…'),
+     *     'interactivity-router/index.min.js' => …
+     */
+    $assets = include ABSPATH . WPINC . "/assets/script-modules-packages{$suffix}.php";
+
+    foreach ( $assets as $file_name => $script_module_data ) {
+        /*
+         * Build the WordPress Script Module ID from the file name.
+         * Prepend `@wordpress/` and remove extensions and `/index` if present:
+         *   - interactivity/index.min.js  => @wordpress/interactivity
+         *   - interactivity/debug.min.js  => @wordpress/interactivity/debug
+         *   - block-library/query/view.js => @wordpress/block-library/query/view
+         */
+        $script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:\.min)?\.js$~D', '', $file_name, 1 );
+
+        switch ( $script_module_id ) {
+            /*
+             * Interactivity exposes two entrypoints, "/index" and "/debug".
+             * "/debug" should replalce "/index" in devlopment.
+             */
+            case '@wordpress/interactivity/debug':
+                if ( ! SCRIPT_DEBUG ) {
+                    continue 2;
+                }
+                $script_module_id = '@wordpress/interactivity';
+                break;
+            case '@wordpress/interactivity':
+                if ( SCRIPT_DEBUG ) {
+                    continue 2;
+                }
+                break;
+        }
+
+        $path = "/wp-includes/js/dist/script-modules/{$file_name}";
+        wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'] );
+    }
+}

trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php

@@ -213 +213 @@
 
     /**
+     * Test that the deprecated register_script_modules method is deprecated but does not throw.
+     *
+     * @ticket 60647
+     *
+     * @expectedDeprecated WP_Interactivity_API::register_script_modules
+     */
+    public function test_register_script_modules_deprecated() {
+        $this->interactivity->register_script_modules();
+    }
+
+    /**
      * Sets up an activity, runs an optional callback, and returns a MockAction for inspection.
      *
@@ -222 +233 @@
     private function get_script_data_filter_result( ?Closure $callback = null ): MockAction {
         $this->interactivity->add_hooks();
-        $this->interactivity->register_script_modules();
         wp_enqueue_script_module( '@wordpress/interactivity' );
         $filter = new MockAction();

trunk/tools/webpack/shared.js

@@ -103 +103 @@
     '@wordpress/interactivity-router',
 ];
+const SCRIPT_AND_MODULE_DUAL_PACKAGES = [
+    '@wordpress/block-library',
+];
 const WORDPRESS_NAMESPACE = '@wordpress/';
 
@@ -112 +115 @@
     BUNDLED_PACKAGES,
     MODULES,
+    SCRIPT_AND_MODULE_DUAL_PACKAGES,
     WORDPRESS_NAMESPACE,
 };

trunk/webpack.config.js

@@ -3 +3 @@
 const mediaConfig = require( './tools/webpack/media' );
 const packagesConfig = require( './tools/webpack/packages' );
-const modulesConfig = require( './tools/webpack/modules' );
+const scriptModulesConfig = require( './tools/webpack/script-modules' );
 const vendorsConfig = require( './tools/webpack/vendors' );
 
@@ -20 +20 @@
         mediaConfig( env ),
         packagesConfig( env ),
-        modulesConfig( env ),
+        scriptModulesConfig( env ),
         ...vendorsConfig( env ),
     ];

@@ -1 +1 @@
 script-loader-packages.php
 script-loader-react-*.php
+script-modules-packages.php