Changeset 11101

Timestamp:

09/14/2016 02:06:10 AM (9 years ago)

Author:

boonebgorges

Message:

Activity: Invalidate query caches when a user's 'last_activity' is updated.

User 'last_activity' is stored in the activity table, but not updated
via the Activity API, so regular invalidation techniques do not work.

In addition, 'last_activity' is quite frequently updated, meaning that
the activity query cache becomes less valuable. To mitigate this, the
current changeset separates the cache for queries containing
'last_activity' from the cache for those that do not.

Fixes #7245.

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)
• src/bp-core/classes/class-bp-core-user.php (modified) (1 diff)
• src/bp-members/bp-members-cache.php (modified) (1 diff)
• tests/phpunit/testcases/members/cache.php (modified) (1 diff)

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

@@ -76 +76 @@
  */
 function bp_activity_reset_cache_incrementor() {
-    return bp_core_reset_incrementor( 'bp_activity' );
+    $without_last_activity = bp_core_reset_incrementor( 'bp_activity' );
+    $with_last_activity    = bp_core_reset_incrementor( 'bp_activity_with_last_activity' );
+    return $without_last_activity && $with_last_activity;
 }
 add_action( 'bp_activity_delete',    '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 );
 
-            $cached = bp_core_get_incremented_cache( $activity_ids_sql, 'bp_activity' );
+            /*
+             * Queries that include 'last_activity' are cached separately,
+             * since they are generally much less long-lived.
+             */
+            if ( preg_match( '/a\.type NOT IN \([^\)]*\'last_activity\'[^\)]*\)/', $activity_ids_sql ) ) {
+                $cache_group = 'bp_activity';
+            } else {
+                $cache_group = 'bp_activity_with_last_activity';
+            }
+
+            $cached = bp_core_get_incremented_cache( $activity_ids_sql, $cache_group );
             if ( false === $cached ) {
                 $activity_ids = $wpdb->get_col( $activity_ids_sql );
-                bp_core_set_incremented_cache( $activity_ids_sql, 'bp_activity', $activity_ids );
+                bp_core_set_incremented_cache( $activity_ids_sql, $cache_group, $activity_ids );
             } else {
                 $activity_ids = $cached;
@@ -709 +719 @@
              */
             $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 );
-            $cached = bp_core_get_incremented_cache( $total_activities_sql, 'bp_activity' );
+            $cached = bp_core_get_incremented_cache( $total_activities_sql, $cache_group );
             if ( false === $cached ) {
                 $total_activities = $wpdb->get_var( $total_activities_sql );
-                bp_core_set_incremented_cache( $total_activities_sql, 'bp_activity', $total_activities );
+                bp_core_set_incremented_cache( $total_activities_sql, $cache_group, $total_activities );
             } else {
                 $total_activities = $cached;

trunk/src/bp-core/classes/class-bp-core-user.php

@@ -913 +913 @@
         wp_cache_set( $user_id, $activity[ $user_id ], 'bp_last_activity' );
 
+        /**
+         * Fires when a user's last_activity value has been updated.
+         *
+         * @since 2.7.0
+         *
+         * @param int    $user_id ID of the user.
+         * @param string $time    Last activity timestamp, in 'Y-m-d H:i:s' format.
+         */
+        do_action( 'bp_core_user_updated_last_activity', $user_id, $time );
+
         return $updated;
     }

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

@@ -62 +62 @@
 add_action( 'wpmu_delete_user', 'bp_members_clear_member_type_cache' );
 add_action( 'delete_user', 'bp_members_clear_member_type_cache' );
+
+/**
+ * Invalidate activity caches when a user's last_activity value is changed.
+ *
+ * @since 2.7.0
+ *
+ * @return bool True on success, false on failure.
+ */
+function bp_members_reset_activity_cache_incrementor() {
+    return bp_core_reset_incrementor( 'bp_activity_with_last_activity' );
+}
+add_action( 'bp_core_user_updated_last_activity', 'bp_members_reset_activity_cache_incrementor' );

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

@@ -23 +23 @@
         $this->assertEquals( $num_queries, $wpdb->num_queries );
     }
+
+    /**
+     * @ticket BP7237
+     * @ticket BP6643
+     * @ticket BP7245
+     */
+    public function test_last_activity_should_bust_activity_with_last_activity_cache() {
+        global $wpdb;
+
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        $time_1 = date( 'Y-m-d H:i:s', time() - HOUR_IN_SECONDS );
+        $time_2 = date( 'Y-m-d H:i:s', time() - ( HOUR_IN_SECONDS * 2 ) );
+        bp_update_user_last_activity( $u1, $time_1 );
+        bp_update_user_last_activity( $u2, $time_2 );
+
+        $activity_args_a = array(
+            'filter' => array(
+                'object' => buddypress()->members->id,
+                'action' => 'last_activity',
+            ),
+            'max' => 1,
+        );
+
+        $activity_args_b = array(
+            'filter' => array(
+                'action' => 'new_member',
+            ),
+            'fields' => 'ids',
+        );
+
+        // Prime bp_activity and bp_activity_with_last_activity caches.
+        $a1 = bp_activity_get( $activity_args_a );
+        $expected = array( $u1, $u2 );
+        $found = array_map( 'intval', wp_list_pluck( $a1['activities'], 'user_id' ) );
+        $this->assertSame( $expected, $found );
+
+        $b1 = bp_activity_get( $activity_args_b );
+
+        // Bump u2 activity so it should appear first.
+        $new_time = date( 'Y-m-d H:i:s', time() - HOUR_IN_SECONDS );
+        bp_update_user_last_activity( $u2, $new_time );
+
+        $a2 = bp_activity_get( $activity_args_a );
+        $expected = array( $u2, $u1 );
+        $found = array_map( 'intval', wp_list_pluck( $a2['activities'], 'user_id' ) );
+        $this->assertSame( $expected, $found );
+
+        $num_queries = $wpdb->num_queries;
+
+        // bp_activity cache should not have been touched.
+        $b2 = bp_activity_get( $activity_args_b );
+        $this->assertEqualSets( $b1, $b2 );
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
 }