Changeset 11054

Timestamp:

09/01/2016 03:27:12 AM (9 years ago)

Author:

boonebgorges

Message:

Cache the results of activity ID and count queries.

Query results are cached using an incrementor, and are invalidated in
bulk whenever an activity item is created, updated, or deleted.

Fixes #7237.

Location:

trunk

Files:

• src/bp-activity/bp-activity-cache.php (modified) (1 diff)
• src/bp-activity/classes/class-bp-activity-activity.php (modified) (2 diffs)
• tests/phpunit/testcases/activity/cache.php (modified) (1 diff)

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

@@ -64 +64 @@
 }
 add_action( 'bp_activity_deleted_activities', 'bp_activity_clear_cache_for_deleted_activity' );
+
+/**
+ * Reset cache incrementor for the Activity component.
+ *
+ * Called whenever an activity item is created, updated, or deleted, this
+ * function effectively invalidates all cached results of activity queries.
+ *
+ * @since 2.7.0
+ *
+ * @return bool True on success, false on failure.
+ */
+function bp_activity_reset_cache_incrementor() {
+    return bp_core_reset_incrementor( 'bp_activity' );
+}
+add_action( 'bp_activity_delete', 'bp_activity_reset_cache_incrementor' );
+add_action( 'bp_activity_add', 'bp_activity_reset_cache_incrementor' );

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -646 +646 @@
             $activity_ids_sql = apply_filters( 'bp_activity_paged_activities_sql', $activity_ids_sql, $r );
 
-            $activity_ids = $wpdb->get_col( $activity_ids_sql );
+            $cached = bp_core_get_incremented_cache( $activity_ids_sql, 'bp_activity' );
+            if ( false === $cached ) {
+                $activity_ids = $wpdb->get_col( $activity_ids_sql );
+                bp_core_set_incremented_cache( $activity_ids_sql, 'bp_activity', $activity_ids );
+            } else {
+                $activity_ids = $cached;
+            }
 
             $retval['has_more_items'] = ! empty( $per_page ) && count( $activity_ids ) > $per_page;
@@ -703 +709 @@
              */
             $total_activities_sql = apply_filters( 'bp_activity_total_activities_sql', "SELECT count(DISTINCT a.id) FROM {$bp->activity->table_name} a {$join_sql} {$where_sql}", $where_sql, $sort );
-            $total_activities     = $wpdb->get_var( $total_activities_sql );
+            $cached = bp_core_get_incremented_cache( $total_activities_sql, 'bp_activity' );
+            if ( false === $cached ) {
+                $total_activities = $wpdb->get_var( $total_activities_sql );
+                bp_core_set_incremented_cache( $total_activities_sql, 'bp_activity', $total_activities );
+            } else {
+                $total_activities = $cached;
+            }
 
             if ( !empty( $r['max'] ) ) {

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

@@ -84 +84 @@
         $this->assertSame( 'bar foo', $a_fp['activities'][0]->content );
     }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     */
+    public function test_query_should_be_cached() {
+        global $wpdb;
+
+        $u = $this->factory->user->create();
+        $a = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $activity_args = array(
+            'per_page' => 10,
+            'fields' => 'ids',
+            'count_total' => true,
+        );
+
+        $a1 = bp_activity_get( $activity_args );
+
+        $num_queries = $wpdb->num_queries;
+
+        $a2 = bp_activity_get( $activity_args );
+
+        $this->assertEqualSets( $a1, $a2 );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     */
+    public function test_query_cache_should_be_skipped_for_different_query_params() {
+        global $wpdb;
+
+        $u = $this->factory->user->create();
+        $a = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $activity_args = array(
+            'per_page' => 10,
+            'fields' => 'ids',
+            'count_total' => true,
+            'filter' => array(
+                'component' => buddypress()->activity->id,
+            ),
+        );
+
+        $a1 = bp_activity_get( $activity_args );
+
+        $num_queries = $wpdb->num_queries;
+
+        // This is enough to make the ID and COUNT clause miss the cache.
+        $activity_args['filter']['action'] = 'activity_update';
+        $a2 = bp_activity_get( $activity_args );
+
+        $this->assertEqualSets( $a1, $a2 );
+
+        // Two extra queries: one for the IDs, one for the count.
+        $n = $num_queries + 2;
+        $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     */
+    public function test_query_cache_should_be_invalidated_by_activity_add() {
+        global $wpdb;
+
+        $u = $this->factory->user->create();
+        $a1 = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $activity_args = array(
+            'per_page' => 10,
+            'fields' => 'ids',
+            'count_total' => true,
+        );
+
+        $q1 = bp_activity_get( $activity_args );
+
+        // Bust the cache.
+        $a2 = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+
+        $q2 = bp_activity_get( $activity_args );
+
+        $expected = array( $a1, $a2 );
+
+        $this->assertEqualSets( $expected, $q2['activities'] );
+        $this->assertEquals( 2, $q2['total'] );
+        $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     */
+    public function test_query_cache_should_be_invalidated_by_activity_edit() {
+        global $wpdb;
+
+        $u = $this->factory->user->create();
+        $a = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $activity_args = array(
+            'per_page' => 10,
+            'fields' => 'ids',
+            'count_total' => true,
+        );
+
+        $q1 = bp_activity_get( $activity_args );
+
+        // Bust the cache.
+        $this->factory->activity->create( array(
+            'id'            => $a,
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar baz',
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+
+        $q2 = bp_activity_get( $activity_args );
+
+        $this->assertEqualSets( $q1, $q2 );
+        $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     */
+    public function test_query_cache_should_be_invalidated_by_activity_delete() {
+        global $wpdb;
+
+        $u = $this->factory->user->create();
+        $a = $this->factory->activity->create( array(
+            'component'     => buddypress()->activity->id,
+            'type'          => 'activity_update',
+            'user_id'       => $u,
+            'content'       => 'foo bar',
+        ) );
+
+        $activity_args = array(
+            'per_page' => 10,
+            'fields' => 'ids',
+            'count_total' => true,
+        );
+
+        $q1 = bp_activity_get( $activity_args );
+
+        // Bust the cache.
+        bp_activity_delete( array(
+            'id' => $a,
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+
+        $q2 = bp_activity_get( $activity_args );
+
+        $this->assertEqualSets( array(), $q2['activities'] );
+        $this->assertEquals( 0, $q2['total'] );
+        $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+    }
 }