Changeset 61587 for trunk/tests/phpunit/tests/dependencies/scripts.php

Timestamp:

02/04/2026 01:41:25 AM (2 months ago)

Author:

westonruter

Message:

Script Loader: Allow classic scripts to depend on script modules.

This allows classic scripts to declare dependencies on script modules by passing module_dependencies in the $args param for wp_register_script() or wp_enqueue_script(). The WP_Script_Modules::get_import_map() method is updated to traverse the dependency tree of all enqueued classic scripts to find any associated script module dependencies and include them in the importmap, enabling dynamic imports of modules within classic scripts.

A _wp_scripts_add_args_data() helper function is introduced to consolidate argument validation and processing for wp_register_script() and wp_enqueue_script(), reducing code duplication. This function validates that the $args array only contains recognized keys (strategy, in_footer, fetchpriority, module_dependencies) and triggers a _doing_it_wrong() notice for any unrecognized keys. Similarly, WP_Scripts::add_data() is updated to do early type checking for the data passed to $args. The script modules in module_dependencies may be referenced by a module ID string or by an array that has an id key, following the same pattern as dependencies in WP_Script_Modules.

When a script module is added to the module_dependencies for a classic script, but it does not exist at the time the importmap is printed, a _doing_it_wrong() notice is emitted.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/8024

Follow-up to [61323].

Props sirreal, westonruter.
See #64229.
Fixes #61500.

File:

• trunk/tests/phpunit/tests/dependencies/scripts.php (modified) (2 diffs)

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -107 +107 @@
 
     /**
+     * Tests that scripts trigger _doing_it_wrong for unrecognized keys in the $args array.
+     *
+     * @ticket 63486
+     *
+     * @covers ::wp_register_script
+     * @covers ::wp_enqueue_script
+     * @covers ::_wp_scripts_add_args_data
+     *
+     * @dataProvider data_unrecognized_keys_in_args
+     *
+     * @param string $function_name Function name to call.
+     * @param array  $args          Arguments to pass to the function.
+     * @param string $expected_msg  Expected error message substring.
+     */
+    public function test_unrecognized_keys_in_args( string $function_name, array $args, string $expected_msg ) {
+        $this->setExpectedIncorrectUsage( $function_name );
+
+        call_user_func_array( $function_name, $args );
+
+        $this->assertStringContainsString(
+            $expected_msg,
+            $this->caught_doing_it_wrong[ $function_name ]
+        );
+    }
+
+    /**
+     * Data provider for test_unrecognized_keys_in_args.
+     *
+     * @return array<string, array{function_name: string, args: array, expected_msg: string}>
+     */
+    public function data_unrecognized_keys_in_args(): array {
+        return array(
+            'register_script' => array(
+                'function_name' => 'wp_register_script',
+                'args'          => array(
+                    'unrecognized-key-register',
+                    '/script.js',
+                    array(),
+                    null,
+                    array(
+                        'unrecognized_key' => 'value',
+                        'another_bad_key'  => 'value',
+                    ),
+                ),
+                'expected_msg'  => 'Unrecognized key(s) in the $args param: unrecognized_key, another_bad_key. Supported keys: strategy, in_footer, fetchpriority, module_dependencies',
+            ),
+            'enqueue_script'  => array(
+                'function_name' => 'wp_enqueue_script',
+                'args'          => array(
+                    'unrecognized-key-enqueue',
+                    '/script.js',
+                    array(),
+                    null,
+                    array(
+                        'strategy'            => 'defer',
+                        'in_footer'           => true,
+                        'fetchpriority'       => 'high',
+                        'module_dependencies' => array( 'foo' ),
+                        'invalid_key'         => 'bar',
+                    ),
+                ),
+                'expected_msg'  => 'Unrecognized key(s) in the $args param: invalid_key. Supported keys: strategy, in_footer, fetchpriority, module_dependencies',
+            ),
+        );
+    }
+
+    /**
      * Test versioning
      *
@@ -1276 +1343 @@
         wp_register_script( 'alias', false, array(), null, array( 'fetchpriority' => 'low' ) );
         $this->assertArrayNotHasKey( 'fetchpriority', wp_scripts()->registered['alias']->extra );
+    }
+
+    /**
+     * Tests validation of module_dependencies in WP_Scripts::add_data().
+     *
+     * @ticket 61500
+     *
+     * @covers WP_Scripts::add_data
+     *
+     * @dataProvider data_add_data_module_dependencies_validation
+     *
+     * @param mixed      $data     Data to add.
+     * @param string     $message  Expected error message.
+     * @param bool       $expected Expected return value.
+     * @param array|null $stored   Expected stored value.
+     */
+    public function test_add_data_module_dependencies_validation( $data, string $message, bool $expected, ?array $stored ) {
+        wp_register_script( 'test-script', '/test.js' );
+
+        $expected_incorrect_usage = 'WP_Scripts::add_data';
+        $this->setExpectedIncorrectUsage( $expected_incorrect_usage );
+
+        $this->assertSame( $expected, wp_scripts()->add_data( 'test-script', 'module_dependencies', $data ) );
+        $this->assertStringContainsString( $message, $this->caught_doing_it_wrong[ $expected_incorrect_usage ] );
+
+        if ( null === $stored ) {
+            $this->assertFalse( wp_scripts()->get_data( 'test-script', 'module_dependencies' ) );
+        } else {
+            $this->assertSame( $stored, wp_scripts()->get_data( 'test-script', 'module_dependencies' ) );
+        }
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array<string, array{data: mixed, message: string, expected: bool, stored: array<string|array<string, string>>|null}>
+     */
+    public function data_add_data_module_dependencies_validation(): array {
+        return array(
+            'non-array' => array(
+                'data'     => 'not-an-array',
+                'message'  => 'The value for "module_dependencies" must be an array',
+                'expected' => false,
+                'stored'   => null,
+            ),
+            'bad-items' => array(
+                'data'     => array( 'valid', 123, true, array(), array( 'id' => 'valid2' ) ),
+                'message'  => 'has one or more of its script module dependencies ("module_dependencies") which are invalid',
+                'expected' => true,
+                'stored'   => array( 'valid', array( 'id' => 'valid2' ) ),
+            ),
+        );
     }