<!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][8076] trunk: Improved cache invalidation when posting activity comments</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 { 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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8076">8076</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-03-07 01:32:04 +0000 (Fri, 07 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://buddypress.trac.wordpress.org/ticket/5434">#5434</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityfunctionsphp">trunk/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunkteststestcasesactivityfunctionsphp">trunk/tests/testcases/activity/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-functions.php (8075 => 8076)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2014-03-07 01:32:01 UTC (rev 8075)
+++ trunk/bp-activity/bp-activity-functions.php 2014-03-07 01:32:04 UTC (rev 8076)
</span><span class="lines">@@ -1240,10 +1240,18 @@
</span><span class="cx"> 'hide_sitewide' => $is_hidden
</span><span class="cx"> ) );
</span><span class="cx">
</span><del>- // Clear the comment and item cache for this activity
- wp_cache_delete( $parent_id, 'bp_activity_comments' );
- wp_cache_delete( $parent_id, 'bp_activity' );
</del><ins>+ // Comment caches are stored only with the top-level item
+ wp_cache_delete( $activity_id, 'bp_activity_comments' );
</ins><span class="cx">
</span><ins>+ // 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' );
+
</ins><span class="cx"> do_action( 'bp_activity_comment_posted', $comment_id, $params, $activity );
</span><span class="cx">
</span><span class="cx"> return $comment_id;
</span></span></pre></div>
<a id="trunkteststestcasesactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/activity/functions.php (8075 => 8076)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/activity/functions.php 2014-03-07 01:32:01 UTC (rev 8075)
+++ trunk/tests/testcases/activity/functions.php 2014-03-07 01:32:04 UTC (rev 8076)
</span><span class="lines">@@ -540,4 +540,129 @@
</span><span class="cx"> remove_filter( 'bp_is_username_compatibility_mode', '__return_true' );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @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' );
+ }
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>