<!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][9482] trunk: Cache the results of `BP_Messages_Thread::get_recipients()`.</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/9482">9482</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/9482","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-13 17:24:33 +0000 (Fri, 13 Feb 2015)</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'>Cache the results of `BP_Messages_Thread::get_recipients()`.
This can save a large number of queries on certain inbox views.
Props wpdennis.
See <a href="http://buddypress.trac.wordpress.org/ticket/6221">#6221</a>. Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6220">#6220</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagescachephp">trunk/src/bp-messages/bp-messages-cache.php</a></li>
<li><a href="#trunksrcbpmessagesbpmessagesclassesphp">trunk/src/bp-messages/bp-messages-classes.php</a></li>
<li><a href="#trunktestsphpunittestcasesmessagesclassbpmessagesthreadphp">trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagescachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-cache.php 2015-02-13 16:20:10 UTC (rev 9481)
+++ trunk/src/bp-messages/bp-messages-cache.php 2015-02-13 17:24:33 UTC (rev 9482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,3 +84,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'messages_notice_after_save', 'bp_notices_clear_cache' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'messages_notice_before_delete', 'bp_notices_clear_cache' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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' );
</ins></span></pre></div>
<a id="trunksrcbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-classes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-classes.php 2015-02-13 16:20:10 UTC (rev 9481)
+++ trunk/src/bp-messages/bp-messages-classes.php 2015-02-13 17:24:33 UTC (rev 9482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,13 +213,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_recipients() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><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">+ $recipients = wp_cache_get( 'thread_recipients_' . $this->thread_id, 'bp_messages' );
+ if ( false === $recipients ) {
+ $bp = buddypress();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $recipients = array();
- $results = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $this->thread_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $recipients = array();
+ $results = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", $this->thread_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) $results as $recipient ) {
- $recipients[$recipient->user_id] = $recipient;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( (array) $results as $recipient ) {
+ $recipients[ $recipient->user_id ] = $recipient;
+ }
+
+ wp_cache_set( 'thread_recipients_' . $this->thread_id, $recipients, 'bp_messages' );
</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="trunktestsphpunittestcasesmessagesclassbpmessagesthreadphp"></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/messages/class.bp-messages-thread.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php 2015-02-13 16:20:10 UTC (rev 9481)
+++ trunk/tests/phpunit/testcases/messages/class.bp-messages-thread.php 2015-02-13 17:24:33 UTC (rev 9482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,4 +92,128 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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' ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>