<!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][11101] trunk: Activity: Invalidate query caches when a user's 'last_activity' is updated.</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" 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/11101">11101</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/11101","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-14 02:06:10 +0000 (Wed, 14 Sep 2016)</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'>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 <a href="http://buddypress.trac.wordpress.org/ticket/7245">#7245</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitycachephp">trunk/src/bp-activity/bp-activity-cache.php</a></li>
<li><a href="#trunksrcbpactivityclassesclassbpactivityactivityphp">trunk/src/bp-activity/classes/class-bp-activity-activity.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpcoreuserphp">trunk/src/bp-core/classes/class-bp-core-user.php</a></li>
<li><a href="#trunksrcbpmembersbpmemberscachephp">trunk/src/bp-members/bp-members-cache.php</a></li>
<li><a href="#trunktestsphpunittestcasesmemberscachephp">trunk/tests/phpunit/testcases/members/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 2016-09-14 01:34:44 UTC (rev 11100)
+++ trunk/src/bp-activity/bp-activity-cache.php 2016-09-14 02:06:10 UTC (rev 11101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +75,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_activity_reset_cache_incrementor() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return bp_core_reset_incrementor( 'bp_activity' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_activity_delete', 'bp_activity_reset_cache_incrementor' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_activity_add', 'bp_activity_reset_cache_incrementor' );
</span></span></pre></div>
<a id="trunksrcbpactivityclassesclassbpactivityactivityphp"></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/classes/class-bp-activity-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/classes/class-bp-activity-activity.php 2016-09-14 01:34:44 UTC (rev 11100)
+++ trunk/src/bp-activity/classes/class-bp-activity-activity.php 2016-09-14 02:06:10 UTC (rev 11101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -645,10 +645,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_ids_sql = apply_filters( 'bp_activity_paged_activities_sql', $activity_ids_sql, $r );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cached = bp_core_get_incremented_cache( $activity_ids_sql, 'bp_activity' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === $cached ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_ids = $wpdb->get_col( $activity_ids_sql );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_set_incremented_cache( $activity_ids_sql, 'bp_activity', $activity_ids );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_set_incremented_cache( $activity_ids_sql, $cache_group, $activity_ids );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_ids = $cached;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -708,10 +718,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $sort Sort direction for query.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $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 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cached = bp_core_get_incremented_cache( $total_activities_sql, 'bp_activity' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cached = bp_core_get_incremented_cache( $total_activities_sql, $cache_group );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === $cached ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $total_activities = $wpdb->get_var( $total_activities_sql );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_set_incremented_cache( $total_activities_sql, 'bp_activity', $total_activities );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_set_incremented_cache( $total_activities_sql, $cache_group, $total_activities );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $total_activities = $cached;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpcoreuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-core-user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-core-user.php 2016-09-14 01:34:44 UTC (rev 11100)
+++ trunk/src/bp-core/classes/class-bp-core-user.php 2016-09-14 02:06:10 UTC (rev 11101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -912,6 +912,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set cache.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( $user_id, $activity[ $user_id ], 'bp_last_activity' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $updated;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpmembersbpmemberscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-cache.php 2016-09-14 01:34:44 UTC (rev 11100)
+++ trunk/src/bp-members/bp-members-cache.php 2016-09-14 02:06:10 UTC (rev 11101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,3 +61,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wpmu_delete_user', 'bp_members_clear_member_type_cache' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'delete_user', 'bp_members_clear_member_type_cache' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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' );
</ins></span></pre></div>
<a id="trunktestsphpunittestcasesmemberscachephp"></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/members/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/cache.php 2016-09-14 01:34:44 UTC (rev 11100)
+++ trunk/tests/phpunit/testcases/members/cache.php 2016-09-14 02:06:10 UTC (rev 11101)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,5 +22,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // check if function references cache or hits the DB by comparing query count
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $num_queries, $wpdb->num_queries );
</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 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 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>