<!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][11122] trunk: Add bp_friends_friendships cache group.</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/11122">11122</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/11122","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-20 14:42:04 +0000 (Tue, 20 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'>Add bp_friends_friendships cache group.
Add friendship caching by the ID of the friendship.
Check the cache before querying for friendship
details in `BP_Friends_Friendship::populate`.
Update `get_user_ids_for_friendship()` to create
a new friendship object so it could possibly use
the cached object.
Props dcavins, boonebgorges.
See <a href="http://buddypress.trac.wordpress.org/ticket/6978">#6978</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendscachephp">trunk/src/bp-friends/bp-friends-cache.php</a></li>
<li><a href="#trunksrcbpfriendsclassesclassbpfriendscomponentphp">trunk/src/bp-friends/classes/class-bp-friends-component.php</a></li>
<li><a href="#trunksrcbpfriendsclassesclassbpfriendsfriendshipphp">trunk/src/bp-friends/classes/class-bp-friends-friendship.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsclassbpfriendsfriendshipphp">trunk/tests/phpunit/testcases/friends/class-bp-friends-friendship.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-cache.php 2016-09-20 12:27:29 UTC (rev 11121)
+++ trunk/src/bp-friends/bp-friends-cache.php 2016-09-20 14:42:04 UTC (rev 11122)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +35,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_deleted', 'friends_clear_friend_object_cache' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Clear friendship caches on friendship changes.
+ *
+ * @since 2.7.0
+ *
+ * @param int $friendship_id ID of the friendship that has changed.
+ * @param int $initiator_user_id ID of the first user.
+ * @param int $friend_user_id ID of the second user.
+ * @return bool
+ */
+function bp_friends_clear_bp_friends_friendships_cache( $friendship_id, $initiator_user_id, $friend_user_id ) {
+ // Clear the friendship object cache.
+ wp_cache_delete( $friendship_id, 'bp_friends_friendships' );
+}
+add_action( 'friends_friendship_requested', 'bp_friends_clear_bp_friends_friendships_cache', 10, 3 );
+add_action( 'friends_friendship_accepted', 'bp_friends_clear_bp_friends_friendships_cache', 10, 3 );
+add_action( 'friends_friendship_deleted', 'bp_friends_clear_bp_friends_friendships_cache', 10, 3 );
+
+/**
+ * Clear friendship caches on friendship changes.
+ *
+ * @since 2.7.0
+ *
+ * @param int $friendship_id The friendship ID.
+ * @param BP_Friends_Friendship $friendship Friendship object.
+ */
+function bp_friends_clear_bp_friends_friendships_cache_remove( $friendship_id, BP_Friends_Friendship $friendship ) {
+ // Clear the friendship object cache.
+ wp_cache_delete( $friendship_id, 'bp_friends_friendships' );
+}
+add_action( 'friends_friendship_withdrawn', 'bp_friends_clear_bp_friends_friendships_cache_remove', 10, 2 );
+add_action( 'friends_friendship_rejected', 'bp_friends_clear_bp_friends_friendships_cache_remove', 10, 2 );
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Clear the friend request cache for the user not initiating the friendship.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span></span></pre></div>
<a id="trunksrcbpfriendsclassesclassbpfriendscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/classes/class-bp-friends-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/classes/class-bp-friends-component.php 2016-09-20 12:27:29 UTC (rev 11121)
+++ trunk/src/bp-friends/classes/class-bp-friends-component.php 2016-09-20 14:42:04 UTC (rev 11122)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,7 +288,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Global groups.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add_global_groups( array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'bp_friends_requests'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'bp_friends_requests',
+ 'bp_friends_friendships', // Individual friendship objects are cached here by ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setup_cache_groups();
</span></span></pre></div>
<a id="trunksrcbpfriendsclassesclassbpfriendsfriendshipphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/classes/class-bp-friends-friendship.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/classes/class-bp-friends-friendship.php 2016-09-20 12:27:29 UTC (rev 11121)
+++ trunk/src/bp-friends/classes/class-bp-friends-friendship.php 2016-09-20 14:42:04 UTC (rev 11122)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,15 +122,29 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $friendship = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->friends->table_name} WHERE id = %d", $this->id ) ) ) {
- $this->initiator_user_id = (int) $friendship->initiator_user_id;
- $this->friend_user_id = (int) $friendship->friend_user_id;
- $this->is_confirmed = (int) $friendship->is_confirmed;
- $this->is_limited = (int) $friendship->is_limited;
- $this->date_created = $friendship->date_created;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check cache for friendship data.
+ $friendship = wp_cache_get( $this->id, 'bp_friends_friendships' );
+
+ // Cache missed, so query the DB.
+ if ( false === $friendship ) {
+ $friendship = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->friends->table_name} WHERE id = %d", $this->id ) );
+
+ wp_cache_set( $this->id, $friendship, 'bp_friends_friendships' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty( $this->populate_friend_details ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No friendship found so set the ID and bail.
+ if ( empty( $friendship ) || is_wp_error( $friendship ) ) {
+ $this->id = 0;
+ return;
+ }
+
+ $this->initiator_user_id = (int) $friendship->initiator_user_id;
+ $this->friend_user_id = (int) $friendship->friend_user_id;
+ $this->is_confirmed = (int) $friendship->is_confirmed;
+ $this->is_limited = (int) $friendship->is_limited;
+ $this->date_created = $friendship->date_created;
+
+ if ( ! empty( $this->populate_friend_details ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->friend_user_id == bp_displayed_user_id() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->friend = new BP_Core_User( $this->initiator_user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -707,11 +721,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return object friend_user_id and initiator_user_id.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_user_ids_for_friendship( $friendship_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp = buddypress();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $friendship = new BP_Friends_Friendship( $friendship_id, false, false );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wpdb->get_row( $wpdb->prepare( "SELECT friend_user_id, initiator_user_id FROM {$bp->friends->table_name} WHERE id = %d", $friendship_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $friendship->id ) ) {
+ return null;
+ }
+
+ $retval = new StdClass;
+ $retval->friend_user_id = $friendship->friend_user_id;
+ $retval->initiator_user_id = $friendship->initiator_user_id;
+
+ return $retval;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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="trunktestsphpunittestcasesfriendsclassbpfriendsfriendshipphp"></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/friends/class-bp-friends-friendship.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/friends/class-bp-friends-friendship.php 2016-09-20 12:27:29 UTC (rev 11121)
+++ trunk/tests/phpunit/testcases/friends/class-bp-friends-friendship.php 2016-09-20 14:42:04 UTC (rev 11122)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,4 +147,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $f2 = new BP_Friends_Friendship( $fid );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $f2->is_confirmed );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group friendship_caching
+ */
+ public function test_new_bp_friends_friendship_object_should_hit_friendship_object_cache() {
+ global $wpdb;
+ $now = time();
+ $u1 = $this->factory->user->create( array(
+ 'last_activity' => date( 'Y-m-d H:i:s', $now ),
+ ) );
+ $u2 = $this->factory->user->create( array(
+ 'last_activity' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+
+ friends_add_friend( $u1, $u2, true );
+ $fid = friends_get_friendship_id( $u1, $u2 );
+
+ $friendship_obj = new BP_Friends_Friendship( $fid, false, false );
+ $first_query_count = $wpdb->num_queries;
+ // Create it again.
+ $friendship_obj = new BP_Friends_Friendship( $fid, false, false );
+
+ $this->assertEquals( $first_query_count, $wpdb->num_queries );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>