<!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>[53097] trunk: Networks and Sites: Improve cache key generation in `WP_Site_Query` class.</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/53097">53097</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/53097","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-07 17:44:34 +0000 (Thu, 07 Apr 2022)</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'>Networks and Sites: Improve cache key generation in `WP_Site_Query` class.
Improve cache key generation in the `WP_Site_Query` class by removing `update_site_cache` and `update_site_meta_cache` elements in the array used to generate
the cache key. These elements do not affect that cache and by removing them, improve the likelihood of reusing an existing cache.
Props Spacedmonkey, furi3r, johnbillion, johnjamesjacoby, flixos90.
Fixes <a href="https://core.trac.wordpress.org/ticket/55462">#55462</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitewpSiteQueryphp">trunk/tests/phpunit/tests/multisite/wpSiteQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpsitequeryphp"></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-site-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-site-query.php 2022-04-07 16:42:11 UTC (rev 53096)
+++ trunk/src/wp-includes/class-wp-site-query.php 2022-04-07 17:44:34 UTC (rev 53097)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,8 +345,8 @@
</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><span class="cx" style="display: block; padding: 0 10px"> $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Ignore the $fields argument as the queried result will be the same regardless.
- unset( $_args['fields'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ignore the $fields, $update_site_cache, $update_site_meta_cache argument as the queried result will be the same regardless.
+ unset( $_args['fields'], $_args['update_site_cache'], $_args['update_site_meta_cache'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $key = md5( serialize( $_args ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $last_changed = wp_cache_get_last_changed( 'sites' );
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitewpSiteQueryphp"></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/wpSiteQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/wpSiteQuery.php 2022-04-07 16:42:11 UTC (rev 53096)
+++ trunk/tests/phpunit/tests/multisite/wpSiteQuery.php 2022-04-07 17:44:34 UTC (rev 53097)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -849,7 +849,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">- $number_of_queries = $wpdb->num_queries;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $number_of_queries = get_num_queries();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_2 = $q->query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -864,6 +864,70 @@
</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 55462
+ */
+ public function test_wp_site_query_cache_with_same_fields_same_cache_fields() {
+ $q = new WP_Site_Query();
+
+ $query_1 = $q->query(
+ array(
+ 'fields' => 'ids',
+ 'network_id' => self::$network_ids['wordpress.org/'],
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'update_site_cache' => true,
+ 'update_site_meta_cache' => true,
+ )
+ );
+
+ $number_of_queries = get_num_queries();
+
+ $query_2 = $q->query(
+ array(
+ 'fields' => 'ids',
+ 'network_id' => self::$network_ids['wordpress.org/'],
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'update_site_cache' => true,
+ 'update_site_meta_cache' => true,
+ )
+ );
+ $this->assertSame( $number_of_queries, get_num_queries() );
+ }
+
+ /**
+ * @ticket 55462
+ */
+ public function test_wp_site_query_cache_with_same_fields_different_cache_fields() {
+ $q = new WP_Site_Query();
+
+ $query_1 = $q->query(
+ array(
+ 'fields' => 'ids',
+ 'network_id' => self::$network_ids['wordpress.org/'],
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'update_site_cache' => true,
+ 'update_site_meta_cache' => true,
+ )
+ );
+
+ $number_of_queries = get_num_queries();
+
+ $query_2 = $q->query(
+ array(
+ 'fields' => 'ids',
+ 'network_id' => self::$network_ids['wordpress.org/'],
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'update_site_cache' => false,
+ 'update_site_meta_cache' => false,
+ )
+ );
+ $this->assertSame( $number_of_queries, get_num_queries() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40229
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_wp_site_query_meta_query
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>