Changeset 9231

Timestamp:

12/15/2014 08:38:11 PM (10 years ago)

Author:

r-a-y

Message:

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 #6012.

Location:

trunk

Files:

• src/bp-blogs/bp-blogs-functions.php (modified) (1 diff)
• src/bp-groups/bp-groups-functions.php (modified) (2 diffs)
• src/bp-members/bp-members-functions.php (modified) (1 diff)
• tests/phpunit/testcases/blogs/cache.php (modified) (1 diff)
• tests/phpunit/testcases/groups/cache.php (modified) (1 diff)
• tests/phpunit/testcases/members/cache.php (added)

trunk/src/bp-blogs/bp-blogs-functions.php

@@ -1145 +1145 @@
  */
 function bp_blogs_total_blogs() {
-    if ( !$count = wp_cache_get( 'bp_total_blogs', 'bp' ) ) {
+    $count = wp_cache_get( 'bp_total_blogs', 'bp' );
+
+    if ( false === $count ) {
         $blogs = BP_Blogs_Blog::get_all();
         $count = $blogs['total'];

trunk/src/bp-groups/bp-groups-functions.php

@@ -645 +645 @@
  */
 function groups_get_total_group_count() {
-    if ( !$count = wp_cache_get( 'bp_total_group_count', 'bp' ) ) {
+    $count = wp_cache_get( 'bp_total_group_count', 'bp' );
+
+    if ( false === $count ) {
         $count = BP_Groups_Group::get_total_group_count();
         wp_cache_set( 'bp_total_group_count', $count, 'bp' );
@@ -685 +687 @@
         $user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();
 
-    if ( !$count = wp_cache_get( 'bp_total_groups_for_user_' . $user_id, 'bp' ) ) {
+    $count = wp_cache_get( 'bp_total_groups_for_user_' . $user_id, 'bp' );
+
+    if ( false === $count ) {
         $count = BP_Groups_Member::total_group_count( $user_id );
         wp_cache_set( 'bp_total_groups_for_user_' . $user_id, $count, 'bp' );

trunk/src/bp-members/bp-members-functions.php

@@ -598 +598 @@
     global $wpdb;
 
-    if ( !$count = wp_cache_get( 'bp_total_member_count', 'bp' ) ) {
+    $count = wp_cache_get( 'bp_total_member_count', 'bp' );
+
+    if ( false === $count ) {
         $status_sql = bp_core_get_status_sql();
         $count = $wpdb->get_var( "SELECT COUNT(ID) FROM {$wpdb->users} WHERE {$status_sql}" );

trunk/tests/phpunit/testcases/blogs/cache.php

@@ -232 +232 @@
         $this->set_current_user( $old_user );
     }
+
+    /**
+     * @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 );
+    }
 }

trunk/tests/phpunit/testcases/groups/cache.php

@@ -201 +201 @@
         $this->assertEquals( 2, count( groups_get_group_admins( $g ) ) );
     }
+
+    /**
+     * @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 );
+    }
 }