<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58935] trunk: Script Loader: Refactor Etag generation for concatenated assets.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58935">58935</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58935","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-25 23:47:01 +0000 (Sun, 25 Aug 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Script Loader: Refactor Etag generation for concatenated assets.
Move Etag HTTP header generation in `load-scripts.php` and `load-styles.php` to `WP_Dependencies`.
Introduces the method `WP_Dependencies::get_etag()` and associated unit tests.
Follow up to <a href="https://core.trac.wordpress.org/changeset/57943">[57943]</a>.
Props vrajadas, martinkrcho, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/61485">#61485</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminloadscriptsphp">trunk/src/wp-admin/load-scripts.php</a></li>
<li><a href="#trunksrcwpadminloadstylesphp">trunk/src/wp-admin/load-styles.php</a></li>
<li><a href="#trunksrcwpincludesclasswpdependenciesphp">trunk/src/wp-includes/class-wp-dependencies.php</a></li>
<li><a href="#trunktestsphpunittestsdependenciesphp">trunk/tests/phpunit/tests/dependencies.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminloadscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/load-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/load-scripts.php 2024-08-25 23:11:02 UTC (rev 58934)
+++ trunk/src/wp-admin/load-scripts.php 2024-08-25 23:47:01 UTC (rev 58935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,25 +52,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_default_packages_vendor( $wp_scripts );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_default_packages_scripts( $wp_scripts );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$etag = "WP:{$wp_version};";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$etag = $wp_scripts->get_etag( $load );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-foreach ( $load as $handle ) {
- if ( ! array_key_exists( $handle, $wp_scripts->registered ) ) {
- continue;
- }
-
- $ver = $wp_scripts->registered[ $handle ]->ver ? $wp_scripts->registered[ $handle ]->ver : $wp_version;
- $etag .= "{$handle}:{$ver};";
-}
-
-/*
- * This is not intended to be cryptographically secure, just a fast way to get
- * a fixed length string based on the script versions. As this file does not
- * load the full WordPress environment, it is not possible to use the salted
- * wp_hash() function.
- */
-$etag = 'W/"' . md5( $etag ) . '"';
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_SERVER['HTTP_IF_NONE_MATCH'] ) && stripslashes( $_SERVER['HTTP_IF_NONE_MATCH'] ) === $etag ) {
</span><span class="cx" style="display: block; padding: 0 10px"> header( "$protocol 304 Not Modified" );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span></span></pre></div>
<a id="trunksrcwpadminloadstylesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/load-styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/load-styles.php 2024-08-25 23:11:02 UTC (rev 58934)
+++ trunk/src/wp-admin/load-styles.php 2024-08-25 23:47:01 UTC (rev 58935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,25 +55,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_styles = new WP_Styles();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_default_styles( $wp_styles );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$etag = "WP:{$wp_version};";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$etag = $wp_styles->get_etag( $wp_version, $load );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-foreach ( $load as $handle ) {
- if ( ! array_key_exists( $handle, $wp_styles->registered ) ) {
- continue;
- }
-
- $ver = $wp_styles->registered[ $handle ]->ver ? $wp_styles->registered[ $handle ]->ver : $wp_version;
- $etag .= "{$handle}:{$ver};";
-}
-
-/*
- * This is not intended to be cryptographically secure, just a fast way to get
- * a fixed length string based on the script versions. As this file does not
- * load the full WordPress environment, it is not possible to use the salted
- * wp_hash() function.
- */
-$etag = 'W/"' . md5( $etag ) . '"';
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_SERVER['HTTP_IF_NONE_MATCH'] ) && stripslashes( $_SERVER['HTTP_IF_NONE_MATCH'] ) === $etag ) {
</span><span class="cx" style="display: block; padding: 0 10px"> header( "$protocol 304 Not Modified" );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpdependenciesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-dependencies.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-dependencies.php 2024-08-25 23:11:02 UTC (rev 58934)
+++ trunk/src/wp-includes/class-wp-dependencies.php 2024-08-25 23:47:01 UTC (rev 58935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -490,4 +490,42 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get etag header for cache validation.
+ *
+ * @since 6.7.0
+ *
+ * @global string $wp_version The WordPress version string.
+ *
+ * @param string[] $load Array of script or style handles to load.
+ * @return string Etag header.
+ */
+ public function get_etag( $load ) {
+ /*
+ * Note: wp_get_wp_version() is not used here, as this file can be included
+ * via wp-admin/load-scripts.php or wp-admin/load-styles.php, in which case
+ * wp-includes/functions.php is not loaded.
+ */
+ global $wp_version;
+
+ $etag = "WP:{$wp_version};";
+
+ foreach ( $load as $handle ) {
+ if ( ! array_key_exists( $handle, $this->registered ) ) {
+ continue;
+ }
+
+ $ver = $this->registered[ $handle ]->ver ?? $wp_version;
+ $etag .= "{$handle}:{$ver};";
+ }
+
+ /*
+ * This is not intended to be cryptographically secure, just a fast way to get
+ * a fixed length string based on the script versions. As this file does not
+ * load the full WordPress environment, it is not possible to use the salted
+ * wp_hash() function.
+ */
+ return 'W/"' . md5( $etag ) . '"';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdependenciesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dependencies.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies.php 2024-08-25 23:11:02 UTC (rev 58934)
+++ trunk/tests/phpunit/tests/dependencies.php 2024-08-25 23:47:01 UTC (rev 58935)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,4 +148,94 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'one', $dep->queue );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Data provider for test_get_etag.
+ *
+ * @return array[]
+ */
+ public function data_provider_get_etag() {
+ return array(
+ 'should accept one dependency' => array(
+ 'load' => array(
+ 'abcd' => '1.0.2',
+ ),
+ 'hash_source_string' => 'WP:6.7;abcd:1.0.2;',
+ 'expected' => 'W/"8145d7e3c41d5a9cc2bccba4afa861fc"',
+ ),
+ 'should accept empty array of dependencies' => array(
+ 'load' => array(),
+ 'hash_source_string' => 'WP:6.7;',
+ 'expected' => 'W/"7ee896c19250a3d174f11469a4ad0b1e"',
+ ),
+ );
+ }
+
+ /**
+ * Tests get_etag method for WP_Scripts.
+ *
+ * @ticket 58433
+ * @ticket 61485
+ *
+ * @covers WP_Dependencies::get_etag
+ *
+ * @dataProvider data_provider_get_etag
+ *
+ * @param array $load List of scripts to load.
+ * @param string $hash_source_string Hash source string.
+ * @param string $expected Expected etag.
+ */
+ public function test_get_etag_scripts( $load, $hash_source_string, $expected ) {
+ global $wp_version;
+ // Modify global to avoid tests needing to change with each new version of WordPress.
+ $original_wp_version = $wp_version;
+ $wp_version = '6.7';
+ $instance = wp_scripts();
+
+ foreach ( $load as $handle => $ver ) {
+ // The src should not be empty.
+ wp_enqueue_script( $handle, 'https://example.org', array(), $ver );
+ }
+
+ $result = $instance->get_etag( array_keys( $load ) );
+
+ // Restore global prior to making assertions.
+ $wp_version = $original_wp_version;
+
+ $this->assertSame( $expected, $result, "Expected MD hash: $expected for $hash_source_string, but got: $result." );
+ }
+
+ /**
+ * Tests get_etag method for WP_Styles.
+ *
+ * @ticket 58433
+ * @ticket 61485
+ *
+ * @covers WP_Dependencies::get_etag
+ *
+ * @dataProvider data_provider_get_etag
+ *
+ * @param array $load List of styles to load.
+ * @param string $hash_source_string Hash source string.
+ * @param string $expected Expected etag.
+ */
+ public function test_get_etag_styles( $load, $hash_source_string, $expected ) {
+ global $wp_version;
+ // Modify global to avoid tests needing to change with each new version of WordPress.
+ $original_wp_version = $wp_version;
+ $wp_version = '6.7';
+ $instance = wp_scripts();
+
+ foreach ( $load as $handle => $ver ) {
+ // The src should not be empty.
+ wp_enqueue_style( $handle, 'https://example.cdn', array(), $ver );
+ }
+
+ $result = $instance->get_etag( array_keys( $load ) );
+
+ // Restore global prior to making assertions.
+ $wp_version = $original_wp_version;
+
+ $this->assertSame( $expected, $result, "Expected MD hash: $expected for $hash_source_string, but got: $result." );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>