<!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>[41063] trunk: Multisite: Improve caching in `WP_Network_Query` by ignoring the `$fields` argument.</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/41063">41063</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/41063","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-07-17 20:15:27 +0000 (Mon, 17 Jul 2017)</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'>Multisite: Improve caching in `WP_Network_Query` by ignoring the `$fields` argument.
Prior to this change there were two different cache keys used for the same query. That is because regardless of the `$fields` argument, the query response will be the same. This was already fixed for `WP_Site_Query` in <a href="https://core.trac.wordpress.org/changeset/41059">[41059]</a>.
Props spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/41347">#41347</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpnetworkqueryphp">trunk/src/wp-includes/class-wp-network-query.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitenetworkQueryphp">trunk/tests/phpunit/tests/multisite/networkQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpnetworkqueryphp"></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-network-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-network-query.php 2017-07-16 01:14:36 UTC (rev 41062)
+++ trunk/src/wp-includes/class-wp-network-query.php 2017-07-17 20:15:27 UTC (rev 41063)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,7 +208,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'pre_get_networks', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
+
+ // Ignore the $fields argument as the queried result will be the same regardless.
+ unset( $_args['fields'] );
+
+ $key = md5( serialize( $_args ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $last_changed = wp_cache_get_last_changed( 'networks' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = "get_network_ids:$key:$last_changed";
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitenetworkQueryphp"></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/multisite/networkQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/networkQuery.php 2017-07-16 01:14:36 UTC (rev 41062)
+++ trunk/tests/phpunit/tests/multisite/networkQuery.php 2017-07-17 20:15:27 UTC (rev 41063)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -379,6 +379,79 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $found );
</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 41347
+ */
+ public function test_wp_network_query_cache_with_different_fields_no_count() {
+ global $wpdb;
+
+ $q = new WP_Network_Query();
+ $query_1 = $q->query( array(
+ 'fields' => 'all',
+ 'number' => 3,
+ 'order' => 'ASC',
+ ) );
+ $number_of_queries = $wpdb->num_queries;
+
+ $query_2 = $q->query( array(
+ 'fields' => 'ids',
+ 'number' => 3,
+ 'order' => 'ASC',
+ ) );
+
+ $this->assertEquals( $number_of_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket 41347
+ */
+ public function test_wp_network_query_cache_with_different_fields_active_count() {
+ global $wpdb;
+
+ $q = new WP_Network_Query();
+
+ $query_1 = $q->query( array(
+ 'fields' => 'all',
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'count' => true,
+ ) );
+ $number_of_queries = $wpdb->num_queries;
+
+ $query_2 = $q->query( array(
+ 'fields' => 'ids',
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'count' => true,
+ ) );
+ $this->assertEquals( $number_of_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket 41347
+ */
+ public function test_wp_network_query_cache_with_same_fields_different_count() {
+ global $wpdb;
+
+ $q = new WP_Network_Query();
+
+ $query_1 = $q->query( array(
+ 'fields' => 'ids',
+ 'number' => 3,
+ 'order' => 'ASC',
+ ) );
+
+ $number_of_queries = $wpdb->num_queries;
+
+ $query_2 = $q->query( array(
+ 'fields' => 'ids',
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'count' => true,
+ ) );
+ $this->assertEquals( $number_of_queries + 1, $wpdb->num_queries );
+ }
</ins><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"> endif;
</span></span></pre>
</div>
</div>
</body>
</html>