Changeset 8537

Timestamp:

06/16/2014 08:19:57 PM (11 years ago)

Author:

r-a-y

Message:

Groups: Cache calls to BP_Groups_Member::get_group_administrator_ids()

When a logged-in user is viewing the group directory and is a member of
each group in the loop, when rendering the "Leave Group" button, a call
is done to fetch the group admins of each group to determine whether the
user is the sole admin.

Since this query is uncached, this could lead to twenty additional DB
queries being run on the page. Thus, this commit caches this query and
invalidates the cache whenever a group member is promoted / demoted or
saved into the database.

Fixes #5711.

Location:

trunk

Files:

• src/bp-groups/bp-groups-cache.php (modified) (1 diff)
• src/bp-groups/bp-groups-classes.php (modified) (1 diff)
• tests/phpunit/testcases/groups/cache.php (modified) (1 diff)

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

@@ -173 +173 @@
 add_action( 'groups_uninvite_user', 'groups_clear_group_user_object_cache', 10, 2 );
 add_action( 'groups_remove_member', 'groups_clear_group_user_object_cache', 10, 2 );
+
+/**
+ * Clear group administrator cache.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param int $group_id The group ID.
+ */
+function groups_clear_group_administrator_cache( $group_id ) {
+    wp_cache_delete( $group_id, 'bp_group_admins' );
+}
+add_action( 'groups_promote_member', 'groups_clear_group_administrator_cache' );
+add_action( 'groups_demote_member',  'groups_clear_group_administrator_cache' );
+add_action( 'groups_delete_group',   'groups_clear_group_administrator_cache' );
+
+/**
+ * Clear group administrator cache when a group member is saved.
+ *
+ * This accounts for situations where group administrators are added manually
+ * using {@link BP_Groups_Member::save()}.  Usually via a plugin.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param BP_Groups_Member $member
+ */
+function groups_clear_group_administrator_cache_on_member_save( BP_Groups_Member $member ) {
+    groups_clear_group_administrator_cache( $member->group_id );
+}
+add_action( 'groups_member_after_save', 'groups_clear_group_administrator_cache_on_member_save' );
 
 /* List actions to clear super cached pages on, if super cache is installed */

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

@@ -2627 +2627 @@
         global $bp, $wpdb;
 
-        return $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_admin = 1 AND is_banned = 0", $group_id ) );
+        $group_admins = wp_cache_get( $group_id, 'bp_group_admins' );
+
+        if ( false === $group_admins ) {
+            $group_admins = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_admin = 1 AND is_banned = 0", $group_id ) );
+
+            wp_cache_set( $group_id, $group_admins, 'bp_group_admins' );
+        }
+
+        return $group_admins;
     }
 

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

@@ -155 +155 @@
         $this->assertNotEmpty( wp_cache_get( $g2, 'bp_groups' ) );
     }
+
+    /**
+     * @group groups_get_group_admins
+     */
+    public function test_groups_get_group_admins_cache() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+        // prime cache
+        groups_get_group_admins( $g );
+
+        // promote user 2 to an admin
+        bp_update_is_item_admin( true );
+        groups_promote_member( $u2, $g, 'admin' );
+
+        // assert that cache is invalidated
+        $this->assertEmpty( wp_cache_get( $g, 'bp_group_admins' ) );
+
+        // assert new cached value
+        $this->assertEquals( 2, count( groups_get_group_admins( $g ) ) );
+    }
+
+    /**
+     * @group groups_get_group_admins
+     */
+    public function test_groups_get_group_admins_cache_on_member_save() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $g = $this->factory->group->create( array( 'creator_id' => $u1 ) );
+
+        // prime cache
+        groups_get_group_admins( $g );
+
+        // promote user 2 to an admin via BP_Groups_Member::save()
+        self::add_user_to_group( $u2, $g, array( 'is_admin' => 1 ) );
+
+        // assert that cache is invalidated
+        $this->assertEmpty( wp_cache_get( $g, 'bp_group_admins' ) );
+
+        // assert new cached value
+        $this->assertEquals( 2, count( groups_get_group_admins( $g ) ) );
+    }
 }