Changeset 11072

Timestamp:

09/09/2016 03:30:07 PM (8 years ago)

Author:

boonebgorges

Message:

Cache the results of group ID and count queries.

Query results are cached using an incrementor, and are invalidated in
bulk whenever a group is created, updated, or deleted, or when
groupmeta is modified.

See #5451.

Location:

trunk

Files:

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

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

@@ -253 +253 @@
 add_action( 'bp_groups_member_before_delete_invite', 'bp_groups_clear_user_group_cache_on_other_events', 10, 2 );
 add_action( 'groups_accept_invite', 'bp_groups_clear_user_group_cache_on_other_events', 10, 2 );
+
+/**
+ * Reset cache incrementor for the Groups component.
+ *
+ * This function invalidates all cached results of group queries,
+ * whenever one of the following events takes place:
+ *   - A group is created or updated.
+ *   - A group is deleted.
+ *   - A group's metadata is modified.
+ *
+ * @since 2.7.0
+ *
+ * @return bool True on success, false on failure.
+ */
+function bp_groups_reset_cache_incrementor() {
+    return bp_core_reset_incrementor( 'bp_groups' );
+}
+add_action( 'groups_group_after_save', 'bp_groups_reset_cache_incrementor' );
+add_action( 'bp_groups_delete_group',  'bp_groups_reset_cache_incrementor' );
+add_action( 'updated_group_meta',      'bp_groups_reset_cache_incrementor' );
+add_action( 'deleted_group_meta',      'bp_groups_reset_cache_incrementor' );
+add_action( 'added_group_meta',        'bp_groups_reset_cache_incrementor' );
 
 /* List actions to clear super cached pages on, if super cache is installed */

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

@@ -824 +824 @@
         );
 
-
         if ( ! empty( $r['user_id'] ) ) {
             $sql['from'] .= " JOIN {$bp->groups->table_name_members} m ON ( g.id = m.group_id )";
@@ -966 +965 @@
          */
         $paged_groups_sql = apply_filters( 'bp_groups_get_paged_groups_sql', $paged_groups_sql, $sql, $r );
-        $paged_group_ids  = $wpdb->get_col( $paged_groups_sql );
+
+        $cached = bp_core_get_incremented_cache( $paged_groups_sql, 'bp_groups' );
+        if ( false === $cached ) {
+            $paged_group_ids = $wpdb->get_col( $paged_groups_sql );
+            bp_core_set_incremented_cache( $paged_groups_sql, 'bp_groups', $paged_group_ids );
+        } else {
+            $paged_group_ids = $cached;
+        }
 
         $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
@@ -994 +1000 @@
          */
         $total_groups_sql = apply_filters( 'bp_groups_get_total_groups_sql', $total_groups_sql, $sql, $r );
-        $total_groups     = (int) $wpdb->get_var( $total_groups_sql );
+
+        $cached = bp_core_get_incremented_cache( $total_groups_sql, 'bp_groups' );
+        if ( false === $cached ) {
+            $total_groups = (int) $wpdb->get_var( $total_groups_sql );
+            bp_core_set_incremented_cache( $total_groups_sql, 'bp_groups', $total_groups );
+        } else {
+            $total_groups = (int) $cached;
+        }
 
         $group_ids = array();

trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -508 +508 @@
     }
 
+    /**
+     * @group cache
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_queries_should_be_cached() {
+        global $wpdb;
+
+        $g = $this->factory->group->create();
+
+        $found1 = BP_Groups_Group::get();
+
+        $num_queries = $wpdb->num_queries;
+
+        $found2 = BP_Groups_Group::get();
+
+        $this->assertEqualSets( $found1, $found2 );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @group cache
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_query_caches_should_be_busted_by_groupmeta_update() {
+        global $wpdb;
+
+        $groups = $this->factory->group->create_many( 2 );
+        groups_update_groupmeta( $groups[0], 'foo', 'bar' );
+        groups_update_groupmeta( $groups[1], 'foo', 'bar' );
+
+        $found1 = BP_Groups_Group::get( array(
+            'meta_query' => array(
+                array(
+                    'key' => 'foo',
+                    'value' => 'bar',
+                ),
+            ),
+        ) );
+
+        $this->assertEqualSets( array( $groups[0], $groups[1] ), wp_list_pluck( $found1['groups'], 'id' ) );
+
+        groups_update_groupmeta( $groups[1], 'foo', 'baz' );
+
+        $found2 = BP_Groups_Group::get( array(
+            'meta_query' => array(
+                array(
+                    'key' => 'foo',
+                    'value' => 'bar',
+                ),
+            ),
+        ) );
+
+        $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found2['groups'], 'id' ) );
+    }
+
+    /**
+     * @group cache
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_query_caches_should_be_busted_by_group_save() {
+        global $wpdb;
+
+        $groups = $this->factory->group->create_many( 2 );
+        groups_update_groupmeta( $groups[0], 'foo', 'bar' );
+        groups_update_groupmeta( $groups[1], 'foo', 'bar' );
+
+        $found1 = BP_Groups_Group::get( array(
+            'search_terms' => 'Foo',
+        ) );
+
+        $this->assertEmpty( $found1['groups'] );
+
+        $group0 = groups_get_group( array( 'group_id' => $groups[0] ) );
+        $group0->name = 'Foo';
+        $group0->save();
+
+        $found2 = BP_Groups_Group::get( array(
+            'search_terms' => 'Foo',
+        ) );
+
+        $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found2['groups'], 'id' ) );
+    }
+
+    /**
+     * @group cache
+     * @ticket BP5451
+     * @ticket BP6643
+     */
+    public function test_get_query_caches_should_be_busted_by_group_delete() {
+        global $wpdb;
+
+        $groups = $this->factory->group->create_many( 2 );
+
+        $found1 = BP_Groups_Group::get();
+
+        $this->assertEqualSets( $groups, wp_list_pluck( $found1['groups'], 'id' ) );
+
+        $group0 = groups_get_group( array( 'group_id' => $groups[0] ) );
+        $group0->delete();
+
+        $found2 = BP_Groups_Group::get();
+
+        $this->assertEqualSets( array( $groups[1] ), wp_list_pluck( $found2['groups'], 'id' ) );
+    }
+
     /** convert_type_to_order_orderby() **********************************/