feat: Add message reactions support (#352)

Author: musonza

README.md

@@ -31,6 +31,7 @@ Create a Chat application for your multiple Models
   - [Mark whole conversation as read](#mark-whole-conversation-as-read)
   - [Unread messages count](#unread-messages-count)
   - [Delete a message](#delete-a-message)
+  - [Message Reactions](#message-reactions)
   - [Cleanup Deleted Messages](#cleanup-deleted-messages)
   - [Clear a conversation](#clear-a-conversation)
   - [Get participant conversations](#Get-participant-conversations)
@@ -256,6 +257,66 @@ Chat::conversation($conversation)->setParticipant($participantModel)->unreadCoun
 Chat::message($message)->setParticipant($participantModel)->delete();
 ```
 
+#### Message Reactions
+
+Add emoji or text-based reactions to messages:
+
+```php
+// Add a reaction
+Chat::message($message)->setParticipant($participantModel)->react('👍');
+
+// Add multiple different reactions
+Chat::message($message)->setParticipant($participantModel)->react('❤️');
+```
+
+Remove a reaction:
+
+```php
+Chat::message($message)->setParticipant($participantModel)->unreact('👍');
+```
+
+Toggle a reaction (add if not present, remove if present):
+
+```php
+$result = Chat::message($message)->setParticipant($participantModel)->toggleReaction('👍');
+// $result = ['added' => true/false, 'reaction' => Reaction|null]
+```
+
+Get reactions summary with counts:
+
+```php
+$summary = Chat::message($message)->reactionsSummary();
+// ['👍' => 5, '❤️' => 3, '😂' => 1]
+```
+
+Check if participant has reacted:
+
+```php
+// Check for specific reaction
+Chat::message($message)->setParticipant($participantModel)->hasReacted('👍');
+
+// Check for any reaction
+Chat::message($message)->setParticipant($participantModel)->hasReacted();
+```
+
+Get all reactions on a message:
+
+```php
+$reactions = Chat::message($message)->reactions();
+```
+
+You can also access reactions directly on the Message model:
+
+```php
+$message->reactions; // All reactions
+$message->getReactionsSummary(); // Grouped counts
+$message->react($participant, '👍'); // Add
+$message->unreact($participant, '👍'); // Remove
+$message->hasReacted($participant, '👍'); // Check
+```
+
+**Broadcasting**: When broadcasting is enabled, `MessageReactionAdded` and `MessageReactionRemoved` events are broadcast to the conversation channel.
+
 #### Cleanup Deleted Messages
 
 What to cleanup when all participants have deleted a `$message` or `$conversation`?

database/migrations/add_reactions_to_messages.php

@@ -0,0 +1,57 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Musonza\Chat\ConfigurationManager;
+
+class AddReactionsToMessages extends Migration
+{
+    protected function schema()
+    {
+        $connection = config('musonza_chat.database_connection');
+
+        return $connection ? Schema::connection($connection) : Schema::getFacadeRoot();
+    }
+
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $this->schema()->create(ConfigurationManager::REACTIONS_TABLE, function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->bigInteger('message_id')->unsigned();
+            $table->bigInteger('messageable_id')->unsigned();
+            $table->string('messageable_type');
+            $table->string('reaction', 50); // emoji or reaction type (e.g., '👍', 'like', 'heart')
+            $table->timestamps();
+
+            // Each participant can only have one reaction of each type per message
+            $table->unique(
+                ['message_id', 'messageable_id', 'messageable_type', 'reaction'],
+                'unique_reaction_per_user'
+            );
+
+            $table->index(['message_id'], 'reactions_message_index');
+            $table->index(['messageable_id', 'messageable_type'], 'reactions_messageable_index');
+
+            $table->foreign('message_id')
+                ->references('id')
+                ->on(ConfigurationManager::MESSAGES_TABLE)
+                ->onDelete('cascade');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        $this->schema()->dropIfExists(ConfigurationManager::REACTIONS_TABLE);
+    }
+}

src/ChatServiceProvider.php

@@ -65,9 +65,13 @@ public function publishMigrations()
         $encryptionStub   = __DIR__ . '/../database/migrations/add_is_encrypted_to_messages_table.php';
         $encryptionTarget = $this->app->databasePath() . '/migrations/' . $timestamp . '_add_is_encrypted_to_messages_table.php';
 
+        $reactionsStub   = __DIR__ . '/../database/migrations/add_reactions_to_messages.php';
+        $reactionsTarget = $this->app->databasePath() . '/migrations/' . $timestamp . '_add_reactions_to_messages.php';
+
         $this->publishes([
             $stub           => $target,
             $encryptionStub => $encryptionTarget,
+            $reactionsStub  => $reactionsTarget,
         ], 'chat.migrations');
     }
 

src/ConfigurationManager.php

@@ -12,6 +12,8 @@ class ConfigurationManager
 
     const PARTICIPATION_TABLE = 'chat_participation';
 
+    const REACTIONS_TABLE = 'chat_message_reactions';
+
     public static function paginationDefaultParameters()
     {
         $pagination = config('musonza_chat.pagination', []);

src/Eventing/MessageReactionAdded.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Musonza\Chat\Eventing;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Musonza\Chat\Models\Reaction;
+
+class MessageReactionAdded implements ShouldBroadcast
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var Reaction
+     */
+    public $reaction;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(Reaction $reaction)
+    {
+        $this->reaction = $reaction;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PrivateChannel('mc-chat-conversation.' . $this->reaction->message->conversation_id);
+    }
+
+    /**
+     * Get the data to broadcast.
+     *
+     * @return array
+     */
+    public function broadcastWith()
+    {
+        return [
+            'reaction' => [
+                'id'         => $this->reaction->id,
+                'message_id' => $this->reaction->message_id,
+                'reaction'   => $this->reaction->reaction,
+                'user'       => [
+                    'id'   => $this->reaction->messageable_id,
+                    'type' => $this->reaction->messageable_type,
+                ],
+            ],
+        ];
+    }
+}

src/Eventing/MessageReactionRemoved.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Musonza\Chat\Eventing;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class MessageReactionRemoved implements ShouldBroadcast
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var int
+     */
+    public $messageId;
+
+    /**
+     * @var int
+     */
+    public $conversationId;
+
+    /**
+     * @var string
+     */
+    public $reaction;
+
+    /**
+     * @var int
+     */
+    public $messageableId;
+
+    /**
+     * @var string
+     */
+    public $messageableType;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(int $messageId, int $conversationId, string $reaction, int $messageableId, string $messageableType)
+    {
+        $this->messageId       = $messageId;
+        $this->conversationId  = $conversationId;
+        $this->reaction        = $reaction;
+        $this->messageableId   = $messageableId;
+        $this->messageableType = $messageableType;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PrivateChannel('mc-chat-conversation.' . $this->conversationId);
+    }
+
+    /**
+     * Get the data to broadcast.
+     *
+     * @return array
+     */
+    public function broadcastWith()
+    {
+        return [
+            'message_id' => $this->messageId,
+            'reaction'   => $this->reaction,
+            'user'       => [
+                'id'   => $this->messageableId,
+                'type' => $this->messageableType,
+            ],
+        ];
+    }
+}