<!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][11865] trunk: Change check in BP_Friends_Friendship::check_is_friend().</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/11865">11865</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/11865","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>2018-02-27 13:29:33 +0000 (Tue, 27 Feb 2018)</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'>Change check in BP_Friends_Friendship::check_is_friend().
In BP2.5, we introduced a new friendship caching mechanism that created a new cache item containing all of a user's friendships. This approach worked well on sites with fewer friendships per user, but caused cache access issues on sites with lots of friendship connections.
This update replaces the cache-intensive change to `BP_Friends_Friendship::check_is_friend()` with a return to a single lookup to determine friendship status between two users. To minimize SQL lookups, individual friendships are now cached, and a new cache-warming function has been added to bulk update these new cache items: `BP_Friends_Friendship::update_bp_friends_cache()`.
Props januzi_pl, boonebgorges, r-a-y, djpaul, dcavins.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7436">#7436</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendscachephp">trunk/src/bp-friends/bp-friends-cache.php</a></li>
<li><a href="#trunksrcbpfriendsbpfriendsfiltersphp">trunk/src/bp-friends/bp-friends-filters.php</a></li>
<li><a href="#trunksrcbpfriendsclassesclassbpfriendsfriendshipphp">trunk/src/bp-friends/classes/class-bp-friends-friendship.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsfunctionsphp">trunk/tests/phpunit/testcases/friends/functions.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 2018-02-27 13:29:26 UTC (rev 11864)
+++ trunk/src/bp-friends/bp-friends-cache.php 2018-02-27 13:29:33 UTC (rev 11865)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,6 +119,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_withdrawn', 'bp_friends_clear_request_cache_on_remove', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_rejected', 'bp_friends_clear_request_cache_on_remove', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Delete individual friendships from the cache when they are changed.
+ *
+ * @since 3.0.0
+ *
+ * @param BP_Friends_Friendship $friendship Friendship object.
+ */
+function bp_friends_delete_cached_friendships_on_friendship_save( $friendship ) {
+ bp_core_delete_incremented_cache( $friendship->friend_user_id . ':' . $friendship->initiator_user_id, 'bp_friends' );
+ bp_core_delete_incremented_cache( $friendship->initiator_user_id . ':' . $friendship->friend_user_id, 'bp_friends' );
+}
+add_action( 'friends_friendship_after_save', 'bp_friends_delete_cached_friendships_on_friendship_save' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // List actions to clear super cached pages on, if super cache is installed.
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_rejected', 'bp_core_clear_cache' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_accepted', 'bp_core_clear_cache' );
</span></span></pre></div>
<a id="trunksrcbpfriendsbpfriendsfiltersphp"></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-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-filters.php 2018-02-27 13:29:26 UTC (rev 11864)
+++ trunk/src/bp-friends/bp-friends-filters.php 2018-02-27 13:29:33 UTC (rev 11865)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,6 +34,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $maybe_friend_ids = wp_parse_id_list( $user_ids_sql );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bulk prepare the friendship cache.
+ BP_Friends_Friendship::update_bp_friends_cache( $user_id, $maybe_friend_ids );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $maybe_friend_ids as $friend_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $status = BP_Friends_Friendship::check_is_friend( $user_id, $friend_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $user_query->results[ $friend_id ]->friendship_status = $status;
</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 2018-02-27 13:29:26 UTC (rev 11864)
+++ trunk/src/bp-friends/classes/class-bp-friends-friendship.php 2018-02-27 13:29:33 UTC (rev 11865)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -603,28 +603,68 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return 'not_friends';
</span><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">- /*
- * Find friendships where the possible_friend_userid is the
- * initiator or friend.
- */
- $args = array(
- 'initiator_user_id' => $possible_friend_userid,
- 'friend_user_id' => $possible_friend_userid
- );
- $result = self::get_friendships( $initiator_userid, $args, 'OR' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ BP_Friends_Friendship::update_bp_friends_cache( $initiator_userid, $possible_friend_userid );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $result ) {
- $friendship = current( $result );
- if ( ! $friendship->is_confirmed ) {
- $status = $initiator_userid == $friendship->initiator_user_id ? 'pending' : 'awaiting_response';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_core_get_incremented_cache( $initiator_userid . ':' . $possible_friend_userid, 'bp_friends' );
+ }
+
+
+ /**
+ * Find uncached friendships between a user and one or more other users and cache them.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id The ID of the primary user for whom we want
+ * to check friendships statuses.
+ * @param int|array|string $possible_friend_ids The IDs of the one or more users
+ * to check friendship status with primary user.
+ * @return null
+ */
+ public static function update_bp_friends_cache( $user_id, $possible_friend_ids ) {
+ global $wpdb;
+ $bp = buddypress();
+ $possible_friend_ids = wp_parse_id_list( $possible_friend_ids );
+
+ $fetch = array();
+ foreach ( $possible_friend_ids as $friend_id ) {
+ // Check for cached items in both friendship directions.
+ if ( false === bp_core_get_incremented_cache( $user_id . ':' . $friend_id, 'bp_friends' )
+ || false === bp_core_get_incremented_cache( $friend_id . ':' . $user_id, 'bp_friends' ) ) {
+ $fetch[] = $friend_id;
+ }
+ }
+ if ( empty( $fetch ) ) {
+ return;
+ }
+
+ $friend_ids_sql = implode( ',', array_unique( $fetch ) );
+ $sql = $wpdb->prepare( "SELECT initiator_user_id, friend_user_id, is_confirmed FROM {$bp->friends->table_name} WHERE (initiator_user_id = %d AND friend_user_id IN ({$friend_ids_sql}) ) OR (initiator_user_id IN ({$friend_ids_sql}) AND friend_user_id = %d )", $user_id, $user_id );
+ $friendships = $wpdb->get_results( $sql );
+
+ // Use $handled to keep track of all of the $possible_friend_ids we've matched.
+ $handled = array();
+ foreach ( $friendships as $friendship ) {
+ $initiator_user_id = (int) $friendship->initiator_user_id;
+ $friend_user_id = (int) $friendship->friend_user_id;
+ if ( 1 === (int) $friendship->is_confirmed ) {
+ $status_initiator = $status_friend = 'is_friend';
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $status = 'is_friend';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $status_initiator = 'pending';
+ $status_friend = 'awaiting_response';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $status = 'not_friends';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_set_incremented_cache( $initiator_user_id . ':' . $friend_user_id, 'bp_friends', $status_initiator );
+ bp_core_set_incremented_cache( $friend_user_id . ':' . $initiator_user_id, 'bp_friends', $status_friend );
+
+ $handled[] = ( $initiator_user_id === $user_id ) ? $friend_user_id : $initiator_user_id;
</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">- return $status;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set all those with no matching entry to "not friends" status.
+ $not_friends = array_diff( $fetch, $handled );
+
+ foreach ( $not_friends as $not_friend_id ) {
+ bp_core_set_incremented_cache( $user_id . ':' . $not_friend_id, 'bp_friends', 'not_friends' );
+ bp_core_set_incremented_cache( $not_friend_id . ':' . $user_id, 'bp_friends', 'not_friends' );
+ }
</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="trunktestsphpunittestcasesfriendsfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/friends/functions.php 2018-02-27 13:29:26 UTC (rev 11864)
+++ trunk/tests/phpunit/testcases/friends/functions.php 2018-02-27 13:29:33 UTC (rev 11865)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,33 +282,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group friendship_caching
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_friends_check_friendship_should_hit_user_cache() {
- global $wpdb;
- $now = time();
- $u1 = self::factory()->user->create( array(
- 'last_activity' => date( 'Y-m-d H:i:s', $now ),
- ) );
- $u2 = self::factory()->user->create( array(
- 'last_activity' => date( 'Y-m-d H:i:s', $now - 100 ),
- ) );
- $u3 = self::factory()->user->create( array(
- 'last_activity' => date( 'Y-m-d H:i:s', $now - 200 ),
- ) );
-
- friends_add_friend( $u1, $u2, true );
- friends_add_friend( $u1, $u3, false );
-
- friends_check_friendship_status( $u1, $u2 );
- $first_query_count = $wpdb->num_queries;
-
- friends_check_friendship_status( $u1, $u3 );
-
- $this->assertEquals( $first_query_count, $wpdb->num_queries );
- }
-
- /**
- * @group friendship_caching
- */
</del><span class="cx" style="display: block; padding: 0 10px"> public function test_friends_check_friendship_should_hit_friendship_object_cache() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px"> $now = time();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,12 +298,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $first_query_count = $wpdb->num_queries;
</span><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">- * We expect this to generate one query to find $u2's friendships,
- * but the friendship object itself should come from cache.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This should access the previous friendship check's cached items.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> friends_check_friendship_status( $u2, $u1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $first_query_count + 1, $wpdb->num_queries );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $first_query_count, $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 class="cx" style="display: block; padding: 0 10px"> public function test_friends_get_recently_active() {
</span></span></pre>
</div>
</div>
</body>
</html>