Changeset 13340

Timestamp:

10/11/2022 07:22:19 PM (2 years ago)

Author:

imath

Message:

BP Messages: make sure Threads unread count is consistent

[13102] 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

Fixes #8750 (branch 10.0)

Location:

branches/10.0

Files:

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

branches/10.0/src/bp-messages/classes/class-bp-messages-thread.php

@@ -201 +201 @@
         }
 
-        // Fetch the recipients.
+        // Fetch the recipients and set the displayed/logged in user's unread count.
         $this->recipients = $this->get_recipients( $thread_id, $r );
-
-        // Get the unread count for the user.
-        if ( isset( $this->recipients[ $r['user_id'] ] ) ) {
-            $this->unread_count = $this->recipients[ $r['user_id'] ]->unread_count;
-        }
 
         // Grab all message meta.
@@ -312 +307 @@
         }
 
+        // 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;
+        }
+
         // Paginate the results.
         if ( ! empty( $recipients ) && $r['recipients_per_page'] && $r['recipients_page'] ) {
             $start      = ( $r['recipients_page'] - 1 ) * ( $r['recipients_per_page'] );
-            $recipients = array_slice( $recipients, $start, $r['recipients_per_page'] );
+            $recipients = array_slice( $recipients, $start, $r['recipients_per_page'], true );
         }
 
@@ -757 +757 @@
                 'ASC',
                 array(
+                    'user_id'             => $r['user_id'],
                     'update_meta_cache'   => false,
                     'recipients_page'     => $r['recipients_page'],

branches/10.0/tests/phpunit/testcases/messages/template.php

@@ -425 +425 @@
         $this->assertCount( 1, $messages_template->threads[0]->recipients );
     }
+
+    /**
+     * @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 );
+    }
 }