implement getReadAt

Author: QuentinGab

src/Concerns/HasConversationsTrait.php renamed to src/Concerns/ParticipateToConversations.php

@@ -10,6 +10,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Support\Facades\DB;
 
 /**
  * @template TConversationUser of ConversationUser
@@ -21,7 +22,7 @@
  * @property ?TMessage $latestMessage
  * @property ?TConversationUser $conversationUser Conversation Pivot
  */
-trait HasConversationsTrait
+trait ParticipateToConversations
 {
     protected static function bootHasConversationsTrait(): void
     {
@@ -71,6 +72,8 @@ public function conversations(): BelongsToMany
     }
 
     /**
+     * Return unread conversations using the `message_reads` table
+     *
      * @return BelongsToMany<TConversation, $this>
      */
     public function conversationsUnread(): BelongsToMany
@@ -79,13 +82,39 @@ public function conversationsUnread(): BelongsToMany
     }
 
     /**
+     * Return read conversations using the `message_reads` table
+     *
      * @return BelongsToMany<TConversation, $this>
      */
     public function conversationsRead(): BelongsToMany
     {
         return $this->conversations()->read($this->id);
     }
 
+    /**
+     * Return unread conversations using the pivot column `conversation_user.last_read_message_id`
+     *
+     * @return BelongsToMany<TConversation, $this>
+     */
+    public function denormalizedConversationsUnread(): BelongsToMany
+    {
+        return $this
+            ->conversations()
+            ->wherePivot('last_read_message_id', '<', DB::raw('conversations.latest_message_id'));
+    }
+
+    /**
+     * Return read conversations using the pivot column `conversation_user.last_read_message_id`
+     *
+     * @return BelongsToMany<TConversation, $this>
+     */
+    public function denormalizedConversationsRead(): BelongsToMany
+    {
+        return $this
+            ->conversations()
+            ->wherePivot('last_read_message_id', '>=', DB::raw('conversations.latest_message_id'));
+    }
+
     /**
      * @return BelongsToMany<TConversation, $this>
      */

src/Message.php

@@ -39,8 +39,8 @@
  * @property ?TUser $user
  * @property Collection<int, MessageRead> $reads
  * @property ?ArrayObject<array-key, mixed> $metadata
- * @property ?Carbon $created_at
- * @property ?Carbon $read_at
+ * @property Carbon $created_at
+ * @property Carbon $read_at
  * @property ?Carbon $deleted_at
  */
 class Message extends Model
@@ -179,21 +179,28 @@ public function markAsUnreadBy(User|int $user): static
         return $this;
     }
 
-    public function isReadBy(User|int $user): bool
+    public function getReadAt(User|int $user): ?Carbon
     {
         $userId = $user instanceof User ? $user->getKey() : $user;
 
         if ($this->user_id === $userId) {
-            return true;
+            return $this->created_at;
         }
 
         if ($this->read_at) {
-            return true;
+            return $this->read_at;
         }
 
-        return (bool) $this->reads->firstWhere(function ($read) use ($userId) {
+        $read = $this->reads->firstWhere(function ($read) use ($userId) {
             return $read->user_id === $userId && $read->read_at !== null;
         });
+
+        return $read?->read_at;
+    }
+
+    public function isReadBy(User|int $user): bool
+    {
+        return (bool) $this->getReadAt($user);
     }
 
     public function isReadByAnyone(): bool