<!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][13339] trunk: BP Messages: make sure Threads unread count is consistent</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 { white-space: pre-line; 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/13339">13339</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/13339","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-10-11 19:10:58 +0000 (Tue, 11 Oct 2022)</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'>BP Messages: make sure Threads unread count is consistent
<a href="http://buddypress.trac.wordpress.org/changeset/13102">[13102]</a> introduced a regression considering the way we used to set a thread's unread count. This count is set using the list of recipient objects (which include an `unread_count` property for each user object) by checking for the requested user ID into this list to find the corresponding unread count.
Slicing this list into smaller parts to paginate recipients results introduced potential cases where the requested user ID wasn't found into this paginated list of recipients.
Before doing the slice operation, we need to set the requested user ID thread's unread count to be sure it's the right one and not a `null` value.
Props sjregan
Closes https://github.com/buddypress/buddypress/pull/26
See <a href="http://buddypress.trac.wordpress.org/ticket/8750">#8750</a> (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesclassesclassbpmessagesthreadphp">trunk/src/bp-messages/classes/class-bp-messages-thread.php</a></li>
<li><a href="#trunktestsphpunittestcasesmessagestemplatephp">trunk/tests/phpunit/testcases/messages/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesclassesclassbpmessagesthreadphp"></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/classes/class-bp-messages-thread.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/classes/class-bp-messages-thread.php 2022-10-06 23:12:28 UTC (rev 13338)
+++ trunk/src/bp-messages/classes/class-bp-messages-thread.php 2022-10-11 19:10:58 UTC (rev 13339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,14 +200,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sender_ids[ $message->sender_id ] = $message->sender_id;
</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">- // Fetch the recipients.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Fetch the recipients and set the displayed/logged in user's unread count.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->recipients = $this->get_recipients( $thread_id, $r );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get the unread count for the user.
- if ( isset( $this->recipients[ $r['user_id'] ] ) ) {
- $this->unread_count = $this->recipients[ $r['user_id'] ]->unread_count;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Grab all message meta.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true === (bool) $r['update_meta_cache'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_messages_update_meta_cache( wp_list_pluck( $this->messages, 'id' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -311,10 +306,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'thread_recipients_' . $thread_id, (array) $recipients, 'bp_messages' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the unread count for the user.
+ if ( isset( $r['user_id'] ) && $r['user_id'] && isset( $recipients[ $r['user_id'] ]->unread_count ) ) {
+ $this->unread_count = (int) $recipients[ $r['user_id'] ]->unread_count;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Paginate the results.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $recipients ) && $r['recipients_per_page'] && $r['recipients_page'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $start = ( $r['recipients_page'] - 1 ) * ( $r['recipients_per_page'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $recipients = array_slice( $recipients, $start, $r['recipients_per_page'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $recipients = array_slice( $recipients, $start, $r['recipients_per_page'], true );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -756,6 +756,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $thread_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'ASC',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id' => $r['user_id'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'recipients_page' => $r['recipients_page'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'recipients_per_page' => $r['recipients_per_page'],
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmessagestemplatephp"></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/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/messages/template.php 2022-10-06 23:12:28 UTC (rev 13338)
+++ trunk/tests/phpunit/testcases/messages/template.php 2022-10-11 19:10:58 UTC (rev 13339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -424,4 +424,114 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotCount( 2, $messages_template->threads[0]->recipients );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 1, $messages_template->threads[0]->recipients );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group pagination
+ * @group BP_Messages_Box_Template
+ * @group BP8750
+ */
+ public function test_thread_unread_count_setting_per_page_recipients() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+
+ // create initial thread
+ $message_1 = self::factory()->message->create_and_get(
+ array(
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2 ),
+ )
+ );
+
+ // create some replies to thread
+ self::factory()->message->create_and_get(
+ array(
+ 'thread_id' => $message_1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => array( $u1 ),
+ )
+ );
+
+ self::factory()->message->create_and_get(
+ array(
+ 'thread_id' => $message_1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => array( $u1 ),
+ )
+ );
+
+ // set $u1 as current user.
+ $old_current_user = get_current_user_id();
+ $this->set_current_user( $u1 );
+
+ $messages_template = new BP_Messages_Box_Template(
+ array(
+ 'recipients_page' => 1,
+ 'recipients_per_page' => 1,
+ )
+ );
+
+ $this->set_current_user( $old_current_user );
+
+ $thread = reset( $messages_template->threads );
+
+ $this->assertEquals( 2, $thread->unread_count );
+ }
+
+ /**
+ * @group pagination
+ * @group BP_Messages_Box_Template
+ * @group BP8750
+ */
+ public function test_thread_unread_count_setting_per_page_recipients_with_specific_user_id() {
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+
+ // create initial thread
+ $message_1 = self::factory()->message->create_and_get(
+ array(
+ 'sender_id' => $u3,
+ 'recipients' => array( $u1, $u2 ),
+ )
+ );
+
+ // create some replies to thread
+ self::factory()->message->create_and_get(
+ array(
+ 'thread_id' => $message_1->thread_id,
+ 'sender_id' => $u2,
+ 'recipients' => array( $u1, $u3 ),
+ )
+ );
+
+ self::factory()->message->create_and_get(
+ array(
+ 'thread_id' => $message_1->thread_id,
+ 'sender_id' => $u1,
+ 'recipients' => array( $u2, $u3 ),
+ )
+ );
+
+ self::factory()->message->create_and_get(
+ array(
+ 'thread_id' => $message_1->thread_id,
+ 'sender_id' => $u3,
+ 'recipients' => array( $u2, $u1 ),
+ )
+ );
+
+ $messages_template = new BP_Messages_Box_Template(
+ array(
+ 'user_id' => $u3,
+ 'recipients_page' => 1,
+ 'recipients_per_page' => 1,
+ )
+ );
+
+ $thread = reset( $messages_template->threads );
+
+ $this->assertFalse( isset( $thread->recipients[ $u3 ] ) );
+ $this->assertCount( 1, $thread->recipients );
+ $this->assertEquals( 2, $thread->unread_count );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>