<!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>[BuddyPress][9231] trunk: Check cache for count functions that return zero.</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="http://buddypress.trac.wordpress.org/changeset/9231">9231</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9231","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-15 20:38:11 +0000 (Mon, 15 Dec 2014)</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'>Check cache for count functions that return zero.
Some of our count functions were previously setting counts of zero
correctly, but the functions themselves were not referencing the cache
properly when the count returned zero. This led to unnecessary database
queries and we hate extra queries!
This commit addresses the problem and adds unit tests.
Props r-a-y, boonebgorges.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6012">#6012</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpblogsbpblogsfunctionsphp">trunk/src/bp-blogs/bp-blogs-functions.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesblogscachephp">trunk/tests/phpunit/testcases/blogs/cache.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupscachephp">trunk/tests/phpunit/testcases/groups/cache.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestcasesmemberscachephp">trunk/tests/phpunit/testcases/members/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpblogsbpblogsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/bp-blogs-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/bp-blogs-functions.php 2014-12-13 12:43:12 UTC (rev 9230)
+++ trunk/src/bp-blogs/bp-blogs-functions.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1144,7 +1144,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int $count Total blog count.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_blogs_total_blogs() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$count = wp_cache_get( 'bp_total_blogs', 'bp' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = wp_cache_get( 'bp_total_blogs', 'bp' );
+
+ if ( false === $count ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $blogs = BP_Blogs_Blog::get_all();
</span><span class="cx" style="display: block; padding: 0 10px"> $count = $blogs['total'];
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'bp_total_blogs', $count, 'bp' );
</span></span></pre></div>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2014-12-13 12:43:12 UTC (rev 9230)
+++ trunk/src/bp-groups/bp-groups-functions.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -644,7 +644,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function groups_get_total_group_count() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$count = wp_cache_get( 'bp_total_group_count', 'bp' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = wp_cache_get( 'bp_total_group_count', 'bp' );
+
+ if ( false === $count ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $count = BP_Groups_Group::get_total_group_count();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'bp_total_group_count', $count, 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -684,7 +686,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $user_id ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
</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 ( !$count = wp_cache_get( 'bp_total_groups_for_user_' . $user_id, 'bp' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = wp_cache_get( 'bp_total_groups_for_user_' . $user_id, 'bp' );
+
+ if ( false === $count ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $count = BP_Groups_Member::total_group_count( $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'bp_total_groups_for_user_' . $user_id, $count, 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-functions.php 2014-12-13 12:43:12 UTC (rev 9230)
+++ trunk/src/bp-members/bp-members-functions.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -597,7 +597,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_get_total_member_count() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</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 ( !$count = wp_cache_get( 'bp_total_member_count', 'bp' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = wp_cache_get( 'bp_total_member_count', 'bp' );
+
+ if ( false === $count ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $status_sql = bp_core_get_status_sql();
</span><span class="cx" style="display: block; padding: 0 10px"> $count = $wpdb->get_var( "SELECT COUNT(ID) FROM {$wpdb->users} WHERE {$status_sql}" );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'bp_total_member_count', $count, 'bp' );
</span></span></pre></div>
<a id="trunktestsphpunittestcasesblogscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/blogs/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/blogs/cache.php 2014-12-13 12:43:12 UTC (rev 9230)
+++ trunk/tests/phpunit/testcases/blogs/cache.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,4 +231,27 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $old_user );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group bp_blogs_total_blogs
+ * @group counts
+ */
+ public function test_bp_blogs_total_count_should_respect_cached_value_of_0() {
+ if ( ! is_multisite() ) {
+ return;
+ }
+
+ global $wpdb;
+
+ // prime cache
+ // no blogs are created by default, so count is zero
+ bp_blogs_total_blogs();
+ $first_query_count = $wpdb->num_queries;
+
+ // run function again
+ bp_blogs_total_blogs();
+
+ // check if function references cache or hits the DB by comparing query count
+ $this->assertEquals( $first_query_count, $wpdb->num_queries );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/cache.php 2014-12-13 12:43:12 UTC (rev 9230)
+++ trunk/tests/phpunit/testcases/groups/cache.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,4 +200,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // assert new cached value
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, count( groups_get_group_admins( $g ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group groups_get_total_group_count
+ * @group counts
+ */
+ public function test_groups_get_total_group_count_should_respect_cached_value_of_0() {
+ global $wpdb;
+
+ // prime cache
+ // no groups are created by default, so count is zero
+ groups_get_total_group_count();
+ $first_query_count = $wpdb->num_queries;
+
+ // run function again
+ groups_get_total_group_count();
+
+ // check if function references cache or hits the DB by comparing query count
+ $this->assertEquals( $first_query_count, $wpdb->num_queries );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmemberscachephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/members/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/cache.php (rev 0)
+++ trunk/tests/phpunit/testcases/members/cache.php 2014-12-15 20:38:11 UTC (rev 9231)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,26 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group cache
+ * @group members
+ */
+class BP_Tests_Members_Cache extends BP_UnitTestCase {
+ /**
+ * @group bp_core_get_total_member_count
+ * @group cache
+ */
+ public function test_bp_core_get_total_member_count_should_respect_cached_value_of_0() {
+ global $wpdb;
+
+ // set cached value to zero
+ wp_cache_set( 'bp_total_member_count', 0, 'bp' );
+ $num_queries = $wpdb->num_queries;
+
+ // run function
+ bp_core_get_total_member_count();
+
+ // check if function references cache or hits the DB by comparing query count
+ $this->assertEquals( $num_queries, $wpdb->num_queries );
+ }
+}
+
</ins></span></pre>
</div>
</div>
</body>
</html>