Changeset 11865

Timestamp:

02/27/2018 01:29:33 PM (7 years ago)

Author:

dcavins

Message:

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 #7436.

Location:

trunk

Files:

• src/bp-friends/bp-friends-cache.php (modified) (1 diff)
• src/bp-friends/bp-friends-filters.php (modified) (1 diff)
• src/bp-friends/classes/class-bp-friends-friendship.php (modified) (1 diff)
• tests/phpunit/testcases/friends/functions.php (modified) (2 diffs)

trunk/src/bp-friends/bp-friends-cache.php

@@ -120 +120 @@
 add_action( 'friends_friendship_rejected',  'bp_friends_clear_request_cache_on_remove', 10, 2 );
 
+/**
+ * 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' );
+
 // List actions to clear super cached pages on, if super cache is installed.
 add_action( 'friends_friendship_rejected',  'bp_core_clear_cache' );

trunk/src/bp-friends/bp-friends-filters.php

@@ -35 +35 @@
     $maybe_friend_ids = wp_parse_id_list( $user_ids_sql );
 
+    // Bulk prepare the friendship cache.
+    BP_Friends_Friendship::update_bp_friends_cache( $user_id, $maybe_friend_ids );
+
     foreach ( $maybe_friend_ids as $friend_id ) {
         $status = BP_Friends_Friendship::check_is_friend( $user_id, $friend_id );

trunk/src/bp-friends/classes/class-bp-friends-friendship.php

@@ -604 +604 @@
         }
 
-        /*
-         * 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' );
-
-        if ( $result ) {
-            $friendship = current( $result );
-            if ( ! $friendship->is_confirmed ) {
-                $status = $initiator_userid == $friendship->initiator_user_id ? 'pending' : 'awaiting_response';
+        BP_Friends_Friendship::update_bp_friends_cache( $initiator_userid, $possible_friend_userid );
+
+        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';
             } else {
-                $status = 'is_friend';
-            }
-        } else {
-            $status = 'not_friends';
-        }
-
-        return $status;
+                $status_initiator = 'pending'; 
+                $status_friend    = 'awaiting_response';
+            }
+            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;
+        }
+
+        // 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' );
+        }
     }
 

trunk/tests/phpunit/testcases/friends/functions.php

@@ -283 +283 @@
      * @group friendship_caching
      */
-    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
-     */
     public function test_friends_check_friendship_should_hit_friendship_object_cache() {
         global $wpdb;
@@ -326 +299 @@
 
         /*
-         * We expect this to generate one query to find $u2's friendships,
-         * but the friendship object itself should come from cache.
+         * This should access the previous friendship check's cached items.
          */
         friends_check_friendship_status( $u2, $u1 );
 
-        $this->assertEquals( $first_query_count + 1, $wpdb->num_queries );
+        $this->assertEquals( $first_query_count, $wpdb->num_queries );
     }