Changeset 9482

Timestamp:

02/13/2015 05:24:33 PM (11 years ago)

Author:

boonebgorges

Message:

Cache the results of BP_Messages_Thread::get_recipients().

This can save a large number of queries on certain inbox views.

Props wpdennis.
See #6221. Fixes #6220.

Location:

trunk

Files:

• src/bp-messages/bp-messages-cache.php (modified) (1 diff)
• src/bp-messages/bp-messages-classes.php (modified) (1 diff)
• tests/phpunit/testcases/messages/class.bp-messages-thread.php (modified) (1 diff)

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

@@ -85 +85 @@
 add_action( 'messages_notice_after_save',    'bp_notices_clear_cache' );
 add_action( 'messages_notice_before_delete', 'bp_notices_clear_cache' );
+
+/**
+ * Invalidate thread recipient cache on message update.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param BP_Messages_Message $message Message object.
+ */
+function bp_messages_clear_message_thread_recipient_cache_on_message_sent( BP_Messages_Message $message ) {
+    wp_cache_delete( 'thread_recipients_' . $message->thread_id, 'bp_messages' );
+}
+add_action( 'messages_message_sent', 'bp_messages_clear_message_thread_recipient_cache_on_message_sent' );
+
+/**
+ * Invalidate thread recipient cache on thread deletion.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param int|array $thread_ids IDs of deleted threads.
+ */
+function bp_messages_clear_message_thread_recipient_cache_on_thread_delete( $thread_ids ) {
+    foreach ( (array) $thread_ids as $thread_id ) {
+        wp_cache_delete( 'thread_recipients_' . $thread_id, 'bp_messages' );
+    }
+}
+add_action( 'messages_delete_thread', 'bp_messages_clear_message_thread_recipient_cache_on_thread_delete' );

trunk/src/bp-messages/bp-messages-classes.php

@@ -214 +214 @@
         global $wpdb;
 
-        $bp = buddypress();
-
-        $recipients = array();
-        $results    = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $this->thread_id ) );
-
-        foreach ( (array) $results as $recipient ) {
-            $recipients[$recipient->user_id] = $recipient;
+        $recipients = wp_cache_get( 'thread_recipients_' . $this->thread_id, 'bp_messages' );
+        if ( false === $recipients ) {
+            $bp = buddypress();
+
+            $recipients = array();
+            $results    = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $this->thread_id ) );
+
+            foreach ( (array) $results as $recipient ) {
+                $recipients[ $recipient->user_id ] = $recipient;
+            }
+
+            wp_cache_set( 'thread_recipients_' . $this->thread_id, $recipients, 'bp_messages' );
         }
 

trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php

@@ -93 +93 @@
         $this->assertSame( $expected, $found );
     }
+
+    /**
+     * @group get_recipients
+     * @group cache
+     */
+    public function test_get_recipients_should_cache_its_values() {
+        global $wpdb;
+
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        $t1 = $this->factory->message->create( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2 ),
+            'subject' => 'Foo',
+        ) );
+
+        $thread = new BP_Messages_Thread( $t1 );
+        $recipients = $thread->get_recipients();
+
+        $num_queries = $wpdb->num_queries;
+        $recipients_cached = $thread->get_recipients();
+
+        $this->assertEquals( $recipients, $recipients_cached );
+        $this->assertEquals( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @group get_recipients
+     * @group cache
+     */
+    public function test_get_recipients_cache_should_be_busted_when_thread_message_is_sent() {
+        global $wpdb;
+
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        $t1 = $this->factory->message->create( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2 ),
+            'subject' => 'Foo',
+        ) );
+
+        $thread = new BP_Messages_Thread( $t1 );
+        $recipients = $thread->get_recipients();
+
+        // Verify that the cache is populated.
+        $num_queries = $wpdb->num_queries;
+        $recipients_cached = $thread->get_recipients();
+        $this->assertEquals( $num_queries, $wpdb->num_queries );
+
+        messages_new_message( array(
+            'sender_id' => $u2,
+            'thread_id' => $t1,
+            'recipients' => array( $u1 ),
+            'subject' => 'Bar',
+            'content' => 'Baz',
+        ) );
+
+        // Cache should be empty.
+        $num_queries = $wpdb->num_queries;
+        $recipients_uncached = $thread->get_recipients();
+        $this->assertEquals( $num_queries + 1, $wpdb->num_queries );
+    }
+
+    /**
+     * @group get_recipients
+     * @group cache
+     */
+    public function test_get_recipients_cache_should_be_busted_when_single_thread_is_deleted() {
+        global $wpdb;
+
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        $t1 = $this->factory->message->create( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2 ),
+            'subject' => 'Foo',
+        ) );
+
+        $thread = new BP_Messages_Thread( $t1 );
+        $recipients = $thread->get_recipients();
+
+        // Verify that the cache is populated.
+        $num_queries = $wpdb->num_queries;
+        $recipients_cached = $thread->get_recipients();
+        $this->assertEquals( $num_queries, $wpdb->num_queries );
+
+        messages_delete_thread( $t1 );
+
+        // Cache should be empty.
+        $this->assertFalse( wp_cache_get( 'thread_recipients_' . $t1, 'bp_messages' ) );
+    }
+
+    /**
+     * @group get_recipients
+     * @group cache
+     */
+    public function test_get_recipients_cache_should_be_busted_when_array_of_threads_is_deleted() {
+        global $wpdb;
+
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        $t1 = $this->factory->message->create( array(
+            'sender_id' => $u1,
+            'recipients' => array( $u2 ),
+            'subject' => 'Foo',
+        ) );
+
+        $thread = new BP_Messages_Thread( $t1 );
+        $recipients = $thread->get_recipients();
+
+        // Verify that the cache is populated.
+        $num_queries = $wpdb->num_queries;
+        $recipients_cached = $thread->get_recipients();
+        $this->assertEquals( $num_queries, $wpdb->num_queries );
+
+        messages_delete_thread( array( $t1 ) );
+
+        // Cache should be empty.
+        $this->assertFalse( wp_cache_get( 'thread_recipients_' . $t1, 'bp_messages' ) );
+    }
 }