Changeset 11122

Timestamp:

09/20/2016 02:42:04 PM (8 years ago)

Author:

dcavins

Message:

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

Location:

trunk

Files:

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

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

@@ -34 +34 @@
 add_action( 'friends_friendship_accepted', 'friends_clear_friend_object_cache' );
 add_action( 'friends_friendship_deleted',  'friends_clear_friend_object_cache' );
+
+/**
+ * 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 );
 
 /**

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

@@ -289 +289 @@
         // Global groups.
         wp_cache_add_global_groups( array(
-            'bp_friends_requests'
+            'bp_friends_requests',
+            'bp_friends_friendships', // Individual friendship objects are cached here by ID.
         ) );
 

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

@@ -123 +123 @@
         $bp = buddypress();
 
-        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;
-        }
-
-        if ( !empty( $this->populate_friend_details ) ) {
+        // 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' );
+        }
+
+        // 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 ) ) {
             if ( $this->friend_user_id == bp_displayed_user_id() ) {
                 $this->friend = new BP_Core_User( $this->initiator_user_id );
@@ -708 +722 @@
      */
     public static function get_user_ids_for_friendship( $friendship_id ) {
-        global $wpdb;
-
-        $bp = buddypress();
-
-        return $wpdb->get_row( $wpdb->prepare( "SELECT friend_user_id, initiator_user_id FROM {$bp->friends->table_name} WHERE id = %d", $friendship_id ) );
+
+        $friendship = new BP_Friends_Friendship( $friendship_id, false, false );
+
+        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;
     }
 

trunk/tests/phpunit/testcases/friends/class-bp-friends-friendship.php

@@ -148 +148 @@
         $this->assertEquals( 1, $f2->is_confirmed );
     }
+
+    /**
+     * @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 );
+    }
 }