support last_read_message_id

Author: QuentinGab

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

@@ -19,10 +19,11 @@
  * @property Collection<int, TConversation> $conversations
  * @property Collection<int, TMessage> $messages
  * @property ?TMessage $latestMessage
+ * @property ?TConversationUser $conversationUser Conversation Pivot
  */
-trait ParticipateToConversations
+trait HasConversationsTrait
 {
-    protected static function bootParticipateToConversations(): void
+    protected static function bootHasConversationsTrait(): void
     {
         static::deleting(function ($model) {
             $model->conversations()->detach();
@@ -63,6 +64,7 @@ public static function getModelMessage(): string
     public function conversations(): BelongsToMany
     {
         return $this->belongsToMany(static::getModelConversation())
+            ->as('conversationUser')
             ->using(static::getModelConversationUser())
             ->withPivot(['id', 'last_read_message_id', 'muted_at', 'archived_at', 'conversation_id', 'user_id', 'metadata'])
             ->withTimestamps();

src/Conversation.php

@@ -32,11 +32,12 @@
  * @property ?Model $conversationable
  * @property Collection<int, TUser> $users
  * @property Collection<int, TMessage> $messages
- * @property ?TMessage $denormalizedLatestMessage
  * @property ?TMessage $latestMessage
  * @property ?TMessage $oldestMessage
+ * @property ?TConversationUser $conversationUser User Pivot
  * @property ?Carbon $messaged_at
  * @property ?int $latest_message_id
+ * @property ?TMessage $denormalizedLatestMessage
  * @property Carbon $updated_at
  * @property Carbon $created_at
  */
@@ -108,6 +109,7 @@ public function conversationable(): MorphTo
     public function users(): BelongsToMany
     {
         return $this->belongsToMany(static::getModelUser())
+            ->as('conversationUser')
             ->using(static::getModelConversationUser())
             ->withPivot(['id', 'last_read_message_id', 'muted_at', 'archived_at', 'conversation_id', 'user_id', 'metadata'])
             ->withTimestamps();
@@ -167,6 +169,27 @@ public function send(Message $message): static
         return $this;
     }
 
+    /**
+     * Update `last_read_message_id` pivot value
+     */
+    public function markAsDenormalizedReadBy(User|int $user): static
+    {
+        /** @var int $userId */
+        $userId = $user instanceof User ? $user->getKey() : $user;
+
+        /** @var ?ConversationUser $pivot */
+        // @phpstan-ignore-next-line
+        $pivot = $this->users->find($userId)?->conversationUser;
+
+        if ($pivot) {
+            $pivot
+                ->markAsDenormalizedRead($this->latest_message_id)
+                ->save();
+        }
+
+        return $this;
+    }
+
     public function scopeUnread(Builder $query, User|int $user): void
     {
         $userId = $user instanceof User ? $user->getKey() : $user;

src/ConversationUser.php

@@ -29,4 +29,15 @@ class ConversationUser extends Pivot
         'archived_at' => 'datetime',
         'metadata' => AsArrayObject::class,
     ];
+
+    public function markAsDenormalizedRead(Message|int $message): static
+    {
+        $messageId = $message instanceof Message ? $message->id : $message;
+
+        if ($messageId > $this->last_read_message_id) {
+            $this->last_read_message_id = $messageId;
+        }
+
+        return $this;
+    }
 }

tests/Models/User.php

@@ -4,12 +4,12 @@
 
 namespace Elegantly\Conversation\Tests\Models;
 
-use Elegantly\Conversation\Concerns\ParticipateToConversations;
+use Elegantly\Conversation\Concerns\HasConversationsTrait;
 use Illuminate\Foundation\Auth\User as Authentificate;
 
 class User extends Authentificate
 {
-    use ParticipateToConversations;
+    use HasConversationsTrait;
 
     protected $table = 'users';
 }