<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13149] trunk: Improve the `bp_activity_comments` cache management</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13149">13149</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13149","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-14 15:16:38 +0000 (Sun, 14 Nov 2021)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Improve the `bp_activity_comments` cache management

This cache should also be cleared when:
- an activity comment has been marked as spam/ham.
- an activity comment has been updated.

Props oztaser

Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8296">#8296</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitycachephp">trunk/src/bp-activity/bp-activity-cache.php</a></li>
<li><a href="#trunksrcbpactivitybpactivityfunctionsphp">trunk/src/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesactivitycachephp">trunk/tests/phpunit/testcases/activity/cache.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivitycachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-cache.php       2021-11-13 18:54:07 UTC (rev 13148)
+++ trunk/src/bp-activity/bp-activity-cache.php 2021-11-14 15:16:38 UTC (rev 13149)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,6 +47,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_activity_clear_cache_for_activity( $activity ) {
</span><span class="cx" style="display: block; padding: 0 10px">        wp_cache_delete( $activity->id, 'bp_activity' );
</span><span class="cx" style="display: block; padding: 0 10px">        wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       // Clear the comments cache for the parent activity ID.
+       if ( 'activity_comment' === $activity->type ) {
+               wp_cache_delete( $activity->item_id, 'bp_activity_comments' );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_activity_after_save', 'bp_activity_clear_cache_for_activity' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span></span></pre></div>
<a id="trunksrcbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-functions.php   2021-11-13 18:54:07 UTC (rev 13148)
+++ trunk/src/bp-activity/bp-activity-functions.php     2021-11-14 15:16:38 UTC (rev 13149)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3595,8 +3595,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">        // Clear the activity stream first page cache.
</span><span class="cx" style="display: block; padding: 0 10px">        wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( 'activity_comment' === $activity->type ) {
+               $activity_id = $activity->item_id;
+       } else {
+               $activity_id = $activity->id;
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         // Clear the activity comment cache for this activity item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        wp_cache_delete( $activity->id, 'bp_activity_comments' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_delete( $activity_id, 'bp_activity_comments' );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity.
</span><span class="cx" style="display: block; padding: 0 10px">        if ( 'by_a_person' == $source && !empty( $bp->activity->akismet ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3642,8 +3648,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">        // Clear the activity stream first page cache.
</span><span class="cx" style="display: block; padding: 0 10px">        wp_cache_delete( 'bp_activity_sitewide_front', 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( 'activity_comment' === $activity->type ) {
+               $activity_id = $activity->item_id;
+       } else {
+               $activity_id = $activity->id;
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         // Clear the activity comment cache for this activity item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        wp_cache_delete( $activity->id, 'bp_activity_comments' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_delete( $activity_id, 'bp_activity_comments' );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        // If Akismet is active, and this was a manual spam/ham request, stop Akismet checking the activity.
</span><span class="cx" style="display: block; padding: 0 10px">        if ( 'by_a_person' == $source && !empty( $bp->activity->akismet ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivitycachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/activity/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/cache.php  2021-11-13 18:54:07 UTC (rev 13148)
+++ trunk/tests/phpunit/testcases/activity/cache.php    2021-11-14 15:16:38 UTC (rev 13149)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -358,4 +358,291 @@
</span><span class="cx" style="display: block; padding: 0 10px">                $q2 = bp_activity_get( $activity_args );
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertEqualSets( array( $activities[0] ), wp_list_pluck( $q2['activities'], 'id' ) );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_parent_activity_marked_as_spam() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'bar',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'foo',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $cached_ids = wp_list_pluck( wp_cache_get( $activity, 'bp_activity_comments' ), 'content', 'id' );
+               $this->assertTrue( 'foo' === $cached_ids[ $comment ] );
+
+               $activity_obj = new BP_Activity_Activity( $activity );
+
+               // An activity is always saved after being marked as spam.
+               bp_activity_mark_as_spam( $activity_obj );
+               $activity_obj->save();
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The activity comments cache should be cleared when an activity has been marked as spam' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_activity_comment_marked_as_spam() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'foo',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'bar',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $cached_ids = wp_list_pluck( wp_cache_get( $activity, 'bp_activity_comments' ), 'content', 'id' );
+               $this->assertTrue( 'bar' === $cached_ids[ $comment ] );
+
+               $comment_obj = new BP_Activity_Activity( $comment );
+
+               // An activity is always saved after being marked as spam.
+               bp_activity_mark_as_spam( $comment_obj );
+               $comment_obj->save();
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The parent activity comments cache should be cleared when an activity comment has been marked as spam' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_parent_activity_marked_as_ham() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'bar',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'foo',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $activity_obj          = new BP_Activity_Activity( $activity );
+               $activity_obj->is_spam = 1;
+               $activity_obj->save();
+
+               // An activity is always saved after being marked as spam.
+               bp_activity_mark_as_ham( $activity_obj );
+               $activity_obj->save();
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The activity comments cache should be cleared when an activity has been marked as ham' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_activity_comment_marked_as_ham() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'foo',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'bar',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $comment_obj          = new BP_Activity_Activity( $comment );
+               $comment_obj->is_spam = 1;
+               $comment_obj->save();
+
+               // An activity is always saved after being marked as spam.
+               bp_activity_mark_as_ham( $comment_obj );
+               $comment_obj->save();
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The parent activity comments cache should be cleared when an activity comment has been marked as ham' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_activity_comment_has_been_updated() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'foo',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'bar',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $comment_obj          = new BP_Activity_Activity( $comment );
+               $comment_obj->content = 'foo';
+               $comment_obj->save();
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The parent activity comments cache should be cleared when an activity comment has been updated' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_activity_comment_has_been_deleted() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'foo',
+                       )
+               );
+
+               $comment = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'bar',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               bp_activity_delete_comment( $activity, $comment );
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The parent activity comments cache should be cleared when an activity comment has been deleted' );
+       }
+
+       /**
+        * @ticket BP8296
+        */
+       public function test_activity_comments_cache_should_be_cleared_when_activity_comment_has_been_added() {
+               $u1 = self::factory()->user->create();
+               $u2 = self::factory()->user->create();
+
+               $activity = self::factory()->activity->create(
+                       array(
+                               'component' => buddypress()->activity->id,
+                               'type'      => 'activity_update',
+                               'user_id'   => $u1,
+                               'content'   => 'foo',
+                       )
+               );
+
+               $c1 = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u2,
+                               'content'           => 'bar',
+                       )
+               );
+
+               $activities = bp_activity_get(
+                       array(
+                               'display_comments' => true,
+                       )
+               );
+
+               $c2 = bp_activity_new_comment(
+                       array(
+                               'activity_id'       => $activity,
+                               'skip_notification' => true,
+                               'user_id'           => $u1,
+                               'content'           => 'taz',
+                       )
+               );
+
+               $this->assertFalse( wp_cache_get( $activity, 'bp_activity_comments' ), 'The parent activity comments cache should be cleared when a new activity comment has been added' );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>