<!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>[36871] trunk: Dependencies: Improve group processing of script dependencies.</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 { 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/36871">36871</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/36871","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-03-06 19:49:54 +0000 (Sun, 06 Mar 2016)</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'>Dependencies: Improve group processing of script dependencies.
This is a follow-up to <a href="https://core.trac.wordpress.org/changeset/36604">[36604]</a>.
When processing dependencies `$this->group` will be the minimum of the script's registered group and all preceding siblings. This is wrong because only a scripts ancestors in the dependency chain should affect where it is loaded. Effectively `$this->group` introduced a form of global state which potentially corrupted the group of dependencies. Sorting covers up this problem.
The issue in <a href="https://core.trac.wordpress.org/ticket/35873">#35873</a> was that script were not moving their dependencies to a lower group when necessary.
The fix:
* In `WP_Dependencies::all_deps()` pass the new `$group` value to `WP_Dependencies::all_deps()`. Previously the wrong value was passed because the parent script could have moved with `WP_Scripts::set_group()`.
* In `WP_Scripts::all_deps()` pass the `$group` parameter to `WP_Dependencies::all_deps()` so it doesn't always use `false` for `$group`. Same for `WP_Styles::all_deps()`.
Props stephenharris, gitlost.
Fixes <a href="https://core.trac.wordpress.org/ticket/35956">#35956</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdependenciesphp">trunk/src/wp-includes/class.wp-dependencies.php</a></li>
<li><a href="#trunksrcwpincludesclasswpscriptsphp">trunk/src/wp-includes/class.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesclasswpstylesphp">trunk/src/wp-includes/class.wp-styles.php</a></li>
<li><a href="#trunktestsphpunittestsdependenciesscriptsphp">trunk/tests/phpunit/tests/dependencies/scripts.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2016-03-06 15:54:13 UTC (rev 36870)
+++ trunk/src/wp-includes/class.wp-dependencies.php 2016-03-06 19:49:54 UTC (rev 36871)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,6 +77,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 4.5.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var int
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $group = 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,7 +162,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array($handle, $this->done, true) ) // Already done
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $moved = $this->set_group( $handle, $recursion, $group );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $moved = $this->set_group( $handle, $recursion, $group );
+ $new_group = $this->groups[ $handle ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $queued && !$moved ) // already queued and in the right group
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -171,7 +173,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $keep_going = false; // Item doesn't exist.
</span><span class="cx" style="display: block; padding: 0 10px"> elseif ( $this->registered[$handle]->deps && array_diff($this->registered[$handle]->deps, array_keys($this->registered)) )
</span><span class="cx" style="display: block; padding: 0 10px"> $keep_going = false; // Item requires dependencies that don't exist.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $group ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ elseif ( $this->registered[$handle]->deps && !$this->all_deps( $this->registered[$handle]->deps, true, $new_group ) )
</ins><span class="cx" style="display: block; padding: 0 10px"> $keep_going = false; // Item requires dependencies that don't exist.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $keep_going ) { // Either item or its dependencies don't exist.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -397,16 +399,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_group( $handle, $recursion, $group ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $group = (int) $group;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $recursion ) {
- $group = min( $this->group, $group );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $this->groups[ $handle ] ) && $this->groups[ $handle ] <= $group ) {
+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->group = $group;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->groups[ $handle ] = $group;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset($this->groups[$handle]) && $this->groups[$handle] <= $group )
- return false;
-
- $this->groups[$handle] = $group;
</del><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpscriptsphp"></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-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class.wp-scripts.php 2016-03-06 15:54:13 UTC (rev 36870)
+++ trunk/src/wp-includes/class.wp-scripts.php 2016-03-06 19:49:54 UTC (rev 36871)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -509,7 +509,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function all_deps( $handles, $recursion = false, $group = false ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = parent::all_deps( $handles, $recursion );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = parent::all_deps( $handles, $recursion, $group );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $recursion ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the list of script dependencies left to print.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpstylesphp"></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-styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class.wp-styles.php 2016-03-06 15:54:13 UTC (rev 36870)
+++ trunk/src/wp-includes/class.wp-styles.php 2016-03-06 19:49:54 UTC (rev 36871)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -310,7 +310,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function all_deps( $handles, $recursion = false, $group = false ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = parent::all_deps( $handles, $recursion );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = parent::all_deps( $handles, $recursion, $group );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $recursion ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the array of enqueued styles before processing for output.
</span></span></pre></div>
<a id="trunktestsphpunittestsdependenciesscriptsphp"></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/scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies/scripts.php 2016-03-06 15:54:13 UTC (rev 36870)
+++ trunk/tests/phpunit/tests/dependencies/scripts.php 2016-03-06 19:49:54 UTC (rev 36871)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,24 +272,76 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 35873
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_register_script_with_dependencies_in_head_and_footer() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_register_script( 'parent', '/parent.js', array( 'child' ), '1', true ); // in footer
- wp_register_script( 'child', '/child.js', array( 'grandchild' ), '1', false ); // in head
- wp_register_script( 'grandchild', '/grandchild.js', array(), '1', true ); // in footer
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_register_script( 'parent', '/parent.js', array( 'child-head' ), null, true ); // in footer
+ wp_register_script( 'child-head', '/child-head.js', array( 'child-footer' ), null, false ); // in head
+ wp_register_script( 'child-footer', '/child-footer.js', array(), null, true ); // in footer
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'parent' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $header = get_echo( 'wp_print_head_scripts' );
</span><span class="cx" style="display: block; padding: 0 10px"> $footer = get_echo( 'wp_print_footer_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">- $expected_header = "<script type='text/javascript' src='/grandchild.js?ver=1'></script>\n";
- $expected_header .= "<script type='text/javascript' src='/child.js?ver=1'></script>\n";
- $expected_footer = "<script type='text/javascript' src='/parent.js?ver=1'></script>\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $expected_header = "<script type='text/javascript' src='/child-footer.js'></script>\n";
+ $expected_header .= "<script type='text/javascript' src='/child-head.js'></script>\n";
+ $expected_footer = "<script type='text/javascript' src='/parent.js'></script>\n";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected_header, $header );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected_footer, $footer );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 35956
+ */
+ function test_wp_register_script_with_dependencies_in_head_and_footer_in_reversed_order() {
+ wp_register_script( 'child-head', '/child-head.js', array(), null, false ); // in head
+ wp_register_script( 'child-footer', '/child-footer.js', array(), null, true ); // in footer
+ wp_register_script( 'parent', '/parent.js', array( 'child-head', 'child-footer' ), null, true ); // in footer
+
+ wp_enqueue_script( 'parent' );
+
+ $header = get_echo( 'wp_print_head_scripts' );
+ $footer = get_echo( 'wp_print_footer_scripts' );
+
+ $expected_header = "<script type='text/javascript' src='/child-head.js'></script>\n";
+ $expected_footer = "<script type='text/javascript' src='/child-footer.js'></script>\n";
+ $expected_footer .= "<script type='text/javascript' src='/parent.js'></script>\n";
+
+ $this->assertEquals( $expected_header, $header );
+ $this->assertEquals( $expected_footer, $footer );
+ }
+
+ /**
+ * @ticket 35956
+ */
+ function test_wp_register_script_with_dependencies_in_head_and_footer_in_reversed_order_and_two_parent_scripts() {
+ wp_register_script( 'grandchild-head', '/grandchild-head.js', array(), null, false ); // in head
+ wp_register_script( 'child-head', '/child-head.js', array(), null, false ); // in head
+ wp_register_script( 'child-footer', '/child-footer.js', array( 'grandchild-head' ), null, true ); // in footer
+ wp_register_script( 'child2-head', '/child2-head.js', array(), null, false ); // in head
+ wp_register_script( 'child2-footer', '/child2-footer.js', array(), null, true ); // in footer
+ wp_register_script( 'parent-footer', '/parent-footer.js', array( 'child-head', 'child-footer', 'child2-head', 'child2-footer' ), null, true ); // in footer
+ wp_register_script( 'parent-header', '/parent-header.js', array( 'child-head' ), null, false ); // in head
+
+ wp_enqueue_script( 'parent-footer' );
+ wp_enqueue_script( 'parent-header' );
+
+ $header = get_echo( 'wp_print_head_scripts' );
+ $footer = get_echo( 'wp_print_footer_scripts' );
+
+ $expected_header = "<script type='text/javascript' src='/child-head.js'></script>\n";
+ $expected_header .= "<script type='text/javascript' src='/grandchild-head.js'></script>\n";
+ $expected_header .= "<script type='text/javascript' src='/child2-head.js'></script>\n";
+ $expected_header .= "<script type='text/javascript' src='/parent-header.js'></script>\n";
+
+ $expected_footer = "<script type='text/javascript' src='/child-footer.js'></script>\n";
+ $expected_footer .= "<script type='text/javascript' src='/child2-footer.js'></script>\n";
+ $expected_footer .= "<script type='text/javascript' src='/parent-footer.js'></script>\n";
+
+ $this->assertEquals( $expected_header, $header );
+ $this->assertEquals( $expected_footer, $footer );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 14853
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_add_inline_script_returns_bool() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,7 +434,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 14853-2
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 14853
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_add_inline_script_before_with_concat() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_scripts;
</span></span></pre>
</div>
</div>
</body>
</html>