Changeset 8076

Timestamp:

03/07/2014 01:32:04 AM (11 years ago)

Author:

boonebgorges

Message:

Improved cache invalidation when posting activity comments

• Because activity comment caches are stored only with the top-level parent, we should be invalidating the bp_activity_comments cache for that item, not for the immediate parent
• When a new comment is created, clear the bp_activity cache for each ancestor

See #5434

Location:

trunk

Files:

• bp-activity/bp-activity-functions.php (modified) (1 diff)
• tests/testcases/activity/functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-functions.php

@@ -1241 +1241 @@
     ) );
 
-    // Clear the comment and item cache for this activity
-    wp_cache_delete( $parent_id, 'bp_activity_comments' );
-    wp_cache_delete( $parent_id, 'bp_activity' );
+    // Comment caches are stored only with the top-level item
+    wp_cache_delete( $activity_id, 'bp_activity_comments' );
+
+    // Walk the tree to clear caches for all parent items
+    $clear_id = $parent_id;
+    while ( $clear_id != $activity_id ) {
+        $clear_object = new BP_Activity_Activity( $clear_id );
+        wp_cache_delete( $clear_id, 'bp_activity' );
+        $clear_id = intval( $clear_object->secondary_item_id );
+    }
+    wp_cache_delete( $activity_id, 'bp_activity' );
 
     do_action( 'bp_activity_comment_posted', $comment_id, $params, $activity );

trunk/tests/testcases/activity/functions.php

@@ -541 +541 @@
     }
 
+    /**
+     * @group bp_activity_new_comment
+     * @group cache
+     */
+    public function test_bp_activity_new_comment_clear_comment_caches() {
+        $a1 = $this->factory->activity->create();
+        $a2 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a1,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a3 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a2,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a4 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a3,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a5 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a3,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+
+        // prime caches
+        bp_activity_get( array(
+            'in' => array( $a1 ),
+            'display_comments' => 'threaded',
+        ) );
+
+        // should be populated
+        $this->assertNotEmpty( wp_cache_get( $a1, 'bp_activity_comments' ) );
+
+        bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a4,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+
+        // should be empty
+        $this->assertFalse( wp_cache_get( $a1, 'bp_activity_comments' ) );
+    }
+
+    /**
+     * @group bp_activity_new_comment
+     * @group cache
+     */
+    public function test_bp_activity_new_comment_clear_activity_caches() {
+        $a1 = $this->factory->activity->create();
+        $a2 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a1,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a3 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a2,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a4 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a3,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+        $a5 = bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a3,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+
+        // prime caches
+        bp_activity_get( array(
+            'in' => array( $a1 ),
+            'display_comments' => 'threaded',
+        ) );
+
+        // should be populated
+        $this->assertNotEmpty( wp_cache_get( $a1, 'bp_activity' ) );
+        $this->assertNotEmpty( wp_cache_get( $a2, 'bp_activity' ) );
+        $this->assertNotEmpty( wp_cache_get( $a3, 'bp_activity' ) );
+        $this->assertNotEmpty( wp_cache_get( $a4, 'bp_activity' ) );
+        $this->assertNotEmpty( wp_cache_get( $a5, 'bp_activity' ) );
+
+        // Stuff may run on bp_activity_comment_posted that loads the
+        // cache, so we use this dumb technique to check cache values
+        // before any of that stuff gets a chance to run. WordPress
+        // sure is neat sometimes
+        $this->acaches = array(
+            $a1 => '',
+            $a2 => '',
+            $a3 => '',
+            $a4 => '',
+        );
+        add_action( 'bp_activity_comment_posted', array( $this, 'check_activity_caches' ), 0 );
+
+        bp_activity_new_comment( array(
+            'activity_id' => $a1,
+            'parent_id' => $a4,
+            'content' => 'foo',
+            'user_id' => 1,
+        ) );
+
+        // should be empty
+        foreach ( $this->acaches as $k => $v ) {
+            $this->assertFalse( $v, "Cache should be false for $k" );
+        }
+    }
+
+    public function check_activity_caches() {
+        foreach ( $this->acaches as $k => $v ) {
+            $this->acaches[ $k ] = wp_cache_get( $k, 'bp_activity' );
+        }
+    }
 }