<!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][8332] trunk: Overhaul caching for user last_activity values</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/8332">8332</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-04-30 17:22:22 +0000 (Wed, 30 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Overhaul caching for user last_activity values
The last_activity methods in the BP_Core_User class were originally designed
without persistent caching in mind. In <a href="http://buddypress.trac.wordpress.org/changeset/8047">r8047</a>, some minimal caching support was
introduced, but it was tacked on and incomplete. In particular, it depended
on an inconsistent structure of return values from the last_activity methods.
See <a href="http://buddypress.trac.wordpress.org/ticket/5128">#5128</a> for more background.
This changeset introduces a number of changes that make last_activity methods
perform more consistently, as well as full support for object caching.
- BP_Core_User::get_last_activity() always returns a multidimensional array
of last_activity arrays, keyed by user_id. This remains true even when
last_activity data is being fetched only for a single user.
- last_activity data is stored in the bp_last_activity cache bucket without
the user-id-keyed wrapper.
- BP_Core_User::get_last_activity() now uses the same caching technique as
other BuddyPress and WordPress queries: detect which requested items are not
yet in the cache, prime the cache for those items, and then fetch all
requested values directly from the cache to build a return value.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5590">#5590</a>
Props imath, johnjamesjacoby for initial patches</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreclassesphp">trunk/bp-core/bp-core-classes.php</a></li>
<li><a href="#trunkteststestcasescoreclassbpcoreuserphp">trunk/tests/testcases/core/class-bp-core-user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-classes.php (8331 => 8332)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-classes.php 2014-04-29 12:36:19 UTC (rev 8331)
+++ trunk/bp-core/bp-core-classes.php 2014-04-30 17:22:22 UTC (rev 8332)
</span><span class="lines">@@ -1321,48 +1321,37 @@
</span><span class="cx"> public static function get_last_activity( $user_id ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><del>- if ( is_array( $user_id ) ) {
- $user_ids = wp_parse_id_list( $user_id );
- } else {
- $user_ids = array( absint( $user_id ) );
- }
</del><ins>+ // Sanitize and remove empty values
+ $user_ids = array_filter( wp_parse_id_list( $user_id ) );
</ins><span class="cx">
</span><span class="cx"> if ( empty( $user_ids ) ) {
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // get cache for single user only
- // @todo Why only single user?
- if ( ! is_array( $user_id ) ) {
- $cache = wp_cache_get( $user_id, 'bp_last_activity' );
</del><ins>+ $uncached_user_ids = bp_get_non_cached_ids( $user_ids, 'bp_last_activity' );
+ if ( ! empty( $uncached_user_ids ) ) {
+ $bp = buddypress();
</ins><span class="cx">
</span><del>- if ( false !== $cache ) {
- return $cache;
</del><ins>+ $user_ids_sql = implode( ',', $uncached_user_ids );
+ $user_count = count( $uncached_user_ids );
+
+ $last_activities = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, date_recorded FROM {$bp->members->table_name_last_activity} WHERE component = %s AND type = 'last_activity' AND user_id IN ({$user_ids_sql}) LIMIT {$user_count}", $bp->members->id ) );
+
+ foreach ( $last_activities as $last_activity ) {
+ wp_cache_set( $last_activity->user_id, array(
+ 'user_id' => $last_activity->user_id,
+ 'date_recorded' => $last_activity->date_recorded,
+ 'activity_id' => $last_activity->id,
+ ), 'bp_last_activity' );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $bp = buddypress();
-
- $user_ids_sql = implode( ',', $user_ids );
- $user_count = count( $user_ids );
-
- $last_activities = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, date_recorded FROM {$bp->members->table_name_last_activity} WHERE component = %s AND type = 'last_activity' AND user_id IN ({$user_ids_sql}) LIMIT {$user_count}", $bp->members->id ) );
-
- // Re-key
</del><ins>+ // Fetch all user data from the cache
</ins><span class="cx"> $retval = array();
</span><del>- foreach ( $last_activities as $last_activity ) {
- $retval[ $last_activity->user_id ] = array(
- 'user_id' => $last_activity->user_id,
- 'date_recorded' => $last_activity->date_recorded,
- 'activity_id' => $last_activity->id,
- );
</del><ins>+ foreach ( $user_ids as $user_id ) {
+ $retval[ $user_id ] = wp_cache_get( $user_id, 'bp_last_activity' );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // If this was a single user query, update the cache
- if ( ! is_array( $user_id ) && isset( $retval[ $user_id ] ) ) {
- wp_cache_set( $user_id, $retval[ $user_id ], 'bp_last_activity' );
- }
-
</del><span class="cx"> return $retval;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1385,7 +1374,7 @@
</span><span class="cx">
</span><span class="cx"> $activity = self::get_last_activity( $user_id );
</span><span class="cx">
</span><del>- if ( ! empty( $activity ) ) {
</del><ins>+ if ( ! empty( $activity[ $user_id ] ) ) {
</ins><span class="cx"> $updated = $wpdb->update(
</span><span class="cx"> $table_name,
</span><span class="cx">
</span><span class="lines">@@ -1442,7 +1431,7 @@
</span><span class="cx"> )
</span><span class="cx"> );
</span><span class="cx">
</span><del>- // setup activity array for caching
</del><ins>+ // set up activity array for caching
</ins><span class="cx"> // view the foreach loop in the get_last_activity() method for format
</span><span class="cx"> $activity = array();
</span><span class="cx"> $activity[ $user_id ] = array(
</span><span class="lines">@@ -1453,7 +1442,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // set cache
</span><del>- wp_cache_set( $user_id, $activity, 'bp_last_activity' );
</del><ins>+ wp_cache_set( $user_id, $activity[ $user_id ], 'bp_last_activity' );
</ins><span class="cx">
</span><span class="cx"> return $updated;
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasescoreclassbpcoreuserphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/core/class-bp-core-user.php (8331 => 8332)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/core/class-bp-core-user.php 2014-04-29 12:36:19 UTC (rev 8331)
+++ trunk/tests/testcases/core/class-bp-core-user.php 2014-04-30 17:22:22 UTC (rev 8332)
</span><span class="lines">@@ -158,6 +158,7 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * @group last_activity
</span><ins>+ * @group cache
</ins><span class="cx"> */
</span><span class="cx"> public function test_get_last_activity_store_in_cache() {
</span><span class="cx"> $u = $this->create_user();
</span><span class="lines">@@ -175,26 +176,77 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * @group last_activity
</span><ins>+ * @group cache
</ins><span class="cx"> */
</span><del>- public function test_get_last_activity_in_cache_single_user() {
</del><ins>+ public function test_get_last_activity_store_in_cache_multiple_users() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $time = bp_core_current_time();
+
+ // Cache is set during user creation. Clear to reflect actual
+ // pageload
+ wp_cache_delete( $u1, 'bp_last_activity' );
+ wp_cache_delete( $u2, 'bp_last_activity' );
+
+ // prime cache
+ $a = BP_Core_User::get_last_activity( array( $u1, $u2 ) );
+
+ $this->assertSame( $a[ $u1 ], wp_cache_get( $u1, 'bp_last_activity' ) );
+ $this->assertSame( $a[ $u2 ], wp_cache_get( $u2, 'bp_last_activity' ) );
+ }
+
+ /**
+ * @group last_activity
+ * @group cache
+ */
+ public function test_get_last_activity_from_cache_single_user() {
</ins><span class="cx"> $u = $this->create_user();
</span><span class="cx"> $time = bp_core_current_time();
</span><span class="cx">
</span><span class="cx"> BP_Core_User::update_last_activity( $u, $time );
</span><span class="cx">
</span><del>- // Cache is set during user creation. Clear to reflect actual pageload
</del><ins>+ // Cache is set during user creation. Clear to reflect actual
+ // pageload
</ins><span class="cx"> wp_cache_delete( $u, 'bp_last_activity' );
</span><span class="cx">
</span><del>- // prime cache
- $a = BP_Core_User::get_last_activity( $u );
- $b = BP_Core_User::get_last_activity( $u );
</del><ins>+ // Prime cache
+ $uncached = BP_Core_User::get_last_activity( $u );
</ins><span class="cx">
</span><del>- $this->assertSame( $a, $b );
</del><ins>+ // Fetch again to get from the cache
+ $cached = BP_Core_User::get_last_activity( $u );
+
+ $this->assertSame( $uncached, $cached );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * @group last_activity
</span><ins>+ * @group cache
</ins><span class="cx"> */
</span><ins>+ public function test_get_last_activity_in_cache_multiple_users() {
+ $u1 = $this->create_user();
+ $u2 = $this->create_user();
+ $time = bp_core_current_time();
+
+ BP_Core_User::update_last_activity( $u1, $time );
+ BP_Core_User::update_last_activity( $u2, $time );
+
+ // Cache is set during user creation. Clear to reflect actual pageload
+ wp_cache_delete( $u1, 'bp_last_activity' );
+ wp_cache_delete( $u2, 'bp_last_activity' );
+
+ // Prime cache
+ $uncached = BP_Core_User::get_last_activity( array( $u1, $u2 ) );
+
+ // Second grab will be from the cache
+ $cached = BP_Core_User::get_last_activity( array( $u1, $u2 ) );
+ $cached_u1 = wp_cache_get( $u1, 'bp_last_activity' );
+
+ $this->assertSame( $cached, $uncached );
+ }
+
+ /**
+ * @group last_activity
+ */
</ins><span class="cx"> public function test_update_last_activity() {
</span><span class="cx"> $u = $this->create_user();
</span><span class="cx"> $time = bp_core_current_time();
</span></span></pre>
</div>
</div>
</body>
</html>