Changeset 51212

Timestamp:

06/23/2021 12:04:47 AM (3 years ago)

Author:

desrosj

Message:

Build/Test Tools: Add the regenerator-runtime script as a dependency to wp-polyfill.

In [51146], the core-js package replaced the deprecated @babel//polyfill one. The core-js package builds wp-polyfill from a configuration provided by @wordpress/babel-preset-default instead of copying a one size fits all polyfill.

That change caused an issue where plugins and themes relying on the regenerator-runtime script being included in the wp-polyfill.js file encountering fatal JavaScript errors.

This adds the regenerator-runtime package to Core and registers it as a dependency for wp-polyfill. While Core does not require regenerator-runtime, it will allow for a smoother transition to using core-js.

This dependency will be removed in a future version of WordPress, so developers are encouraged to add regenerator-runtime as a dependency for any custom script that requires it.

Follow up to [51146].

Props gziolo, herregroen, jeherve, hellofromtonya, peterwilsoncc.
Fixes #52941.

Location:

trunk

Files:

• package.json (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (5 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)
• tools/webpack/packages.js (modified) (2 diffs)

trunk/package.json

@@ -148 +148 @@
         "react": "16.13.1",
         "react-dom": "16.13.1",
+        "regenerator-runtime": "0.13.7",
         "twemoji": "13.1.0",
         "underscore": "1.13.1",

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

@@ -81 +81 @@
 
     $vendor_scripts = array(
-        'react'     => array( 'wp-polyfill' ),
-        'react-dom' => array( 'react' ),
+        'react'       => array( 'wp-polyfill' ),
+        'react-dom'   => array( 'react' ),
+        'regenerator-runtime',
         'moment',
         'lodash',
@@ -92 +93 @@
         'wp-polyfill-element-closest',
         'wp-polyfill-object-fit',
-        'wp-polyfill',
+        'wp-polyfill' => array( 'regenerator-runtime' ),
     );
 
@@ -98 +99 @@
         'react'                       => '16.13.1',
         'react-dom'                   => '16.13.1',
+        'regenerator-runtime'         => '0.13.7',
         'moment'                      => '2.29.1',
         'lodash'                      => '4.17.19',
@@ -107 +109 @@
         'wp-polyfill-element-closest' => '2.0.2',
         'wp-polyfill-object-fit'      => '2.3.5',
-        'wp-polyfill'                 => '7.4.4',
+        'wp-polyfill'                 => '3.15.0',
     );
 
@@ -121 +123 @@
         $scripts->add( $handle, $path, $dependencies, $version, 1 );
     }
-
-    $scripts->add( 'wp-polyfill', null, array( 'wp-polyfill' ) );
 
     did_action( 'init' ) && $scripts->add_inline_script( 'lodash', 'window.lodash = _.noConflict();' );

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

@@ -724 +724 @@
         $ver       = get_bloginfo( 'version' );
         $suffix    = wp_scripts_get_suffix();
-        $expected  = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&amp;load%5Bchunk_0%5D=jquery-core,jquery-migrate,wp-polyfill,wp-dom-ready,wp-hooks&amp;ver={$ver}'></script>\n";
+        $expected  = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&amp;load%5Bchunk_0%5D=jquery-core,jquery-migrate,regenerator-runtime,wp-polyfill,wp-dom-ready,wp-hooks&amp;ver={$ver}'></script>\n";
         $expected .= "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n";
         $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n";

trunk/tools/webpack/packages.js

@@ -85 +85 @@
         'react.js': 'react/umd/react.development.js',
         'react-dom.js': 'react-dom/umd/react-dom.development.js',
+        'regenerator-runtime.js': 'regenerator-runtime/runtime.js',
     };
 
@@ -99 +100 @@
 
     const minifyVendors = {
+        'regenerator-runtime.min.js': 'regenerator-runtime/runtime.js',
         'wp-polyfill-fetch.min.js': 'whatwg-fetch/dist/fetch.umd.js',
         'wp-polyfill-element-closest.min.js': 'element-closest/element-closest.js',