Merge pull request #44 from kirschbaum-development/issue-28-event-notification

ISSUE-28: Implement opt-in notifications for user mentions in comments

Author: navneetrai

README.md

@@ -450,7 +450,7 @@ class SendSubscribedUserNotification implements ShouldQueue
 
 ### Sending notifications when a user is mentioned
 
-Every time a user is mentioned, the `Kirschbaum\Commentions\Events\UserWasMentionedEvent` is dispatched. You can listen to this event and send notifications to the mentioned user.
+Every time a user is mentioned, the `Kirschbaum\Commentions\Events\UserWasMentionedEvent` is dispatched. Commentions ships an optional, opt-in notification you can enable via configuration, or you can listen to the event and handle it yourself.
 
 Example usage:
 
@@ -477,6 +477,30 @@ class SendUserMentionedNotification implements ShouldQueue
 
 If you have [event auto-discovery](https://laravel.com/docs/11.x/events#registering-events-and-listeners), this should be enough. Otherwise, make sure to register your listener on the `EventServiceProvider`.
 
+#### Built-in opt-in notifications
+
+Enable notifications for mentions in your `config/commentions.php`:
+
+```php
+    'notifications' => [
+        'mentions' => [
+            'enabled' => true,
+            'channels' => ['mail', 'database'],
+        ],
+    ],
+```
+
+Optionally, provide a URL resolver so emails/links point users to the right place:
+
+```php
+use Kirschbaum\Commentions\Config;
+
+Config::resolveCommentUrlUsing(function (\Kirschbaum\Commentions\Comment $comment) {
+    // Return a URL to view the record and scroll to the comment
+    return route('projects.show', $comment->commentable) . '#comment-' . $comment->getId();
+});
+```
+
 ### Resolving the authenticated user
 
 By default, when a new comment is made, the `Commenter` is automatically set to the current user logged in user (`auth()->user()`). If you want to change this behavior, you can implement your own resolver:

config/commentions.php

@@ -49,12 +49,36 @@
         // When true, subscribed users will also receive the same event as mentions
         // (UserWasMentionedEvent). When false, a distinct
         // UserIsSubscribedToCommentableEvent will be dispatched instead.
-        'dispatch_as_mention' => false,
+        'dispatch_as_mention' => env('COMMENTIONS_SUBSCRIPTIONS_DISPATCH_AS_MENTION', false),
         // Controls whether the subscribers list is shown in the sidebar UI
-        'show_subscribers' => true,
+        'show_subscribers' => env('COMMENTIONS_SUBSCRIPTIONS_SHOW_SUBSCRIBERS', true),
         // Automatically subscribe the author when they add a comment
-        'auto_subscribe_on_comment' => true,
+        'auto_subscribe_on_comment' => env('COMMENTIONS_SUBSCRIPTIONS_AUTO_SUBSCRIBE_ON_COMMENT', true),
         // Automatically subscribe a user when they are mentioned in a comment
-        'auto_subscribe_on_mention' => true,
+        'auto_subscribe_on_mention' => env('COMMENTIONS_SUBSCRIPTIONS_AUTO_SUBSCRIBE_ON_MENTION', true),
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Notifications (opt-in)
+    |--------------------------------------------------------------------------
+    |
+    | Configure notification delivery when a user is mentioned in a comment.
+    | Disabled by default; enable and choose the channels you want to use.
+    |
+    */
+    'notifications' => [
+        'mentions' => [
+            'enabled' => env('COMMENTIONS_NOTIFICATIONS_MENTIONS_ENABLED', false),
+
+            'channels' => explode(',', env('COMMENTIONS_NOTIFICATIONS_MENTIONS_CHANNELS', 'mail')),
+
+            'listener' => \Kirschbaum\Commentions\Listeners\SendUserMentionedNotification::class,
+            'notification' => \Kirschbaum\Commentions\Notifications\UserMentionedInComment::class,
+
+            'mail' => [
+                'subject' => env('COMMENTIONS_NOTIFICATIONS_MENTIONS_MAIL_SUBJECT', 'You were mentioned in a comment'),
+            ],
+        ],
     ],
 ];

src/CommentionsServiceProvider.php

@@ -5,8 +5,11 @@
 use Filament\Support\Assets\Css;
 use Filament\Support\Assets\Js;
 use Filament\Support\Facades\FilamentAsset;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Gate;
 use Kirschbaum\Commentions\Comment as CommentModel;
+use Kirschbaum\Commentions\Events\UserWasMentionedEvent;
+use Kirschbaum\Commentions\Listeners\SendUserMentionedNotification;
 use Kirschbaum\Commentions\Livewire\Comment;
 use Kirschbaum\Commentions\Livewire\CommentList;
 use Kirschbaum\Commentions\Livewire\Comments;
@@ -67,5 +70,10 @@ public function packageBooted(): void
         $this->publishes([
             __DIR__ . '/../resources/lang' => resource_path('lang/vendor/commentions'),
         ], 'commentions-lang');
+
+        if (config('commentions.notifications.mentions.enabled', false)) {
+            $listenerClass = (string) config('commentions.notifications.mentions.listener', SendUserMentionedNotification::class);
+            Event::listen(UserWasMentionedEvent::class, $listenerClass);
+        }
     }
 }

src/Config.php

@@ -12,6 +12,8 @@ class Config
 
     protected static ?Closure $resolveAuthenticatedUser = null;
 
+    protected static ?Closure $resolveCommentUrl = null;
+
     public static function resolveAuthenticatedUserUsing(Closure $callback): void
     {
         static::$resolveAuthenticatedUser = $callback;
@@ -39,6 +41,24 @@ public static function getCommentReactionTable(): string
         return config('commentions.tables.comment_reactions', 'comment_reactions');
     }
 
+    public static function resolveCommentUrlUsing(Closure $callback): void
+    {
+        static::$resolveCommentUrl = $callback;
+    }
+
+    public static function resolveCommentUrl(?Comment $comment): ?string
+    {
+        if ($comment === null) {
+            return null;
+        }
+
+        if (static::$resolveCommentUrl instanceof Closure) {
+            return call_user_func(static::$resolveCommentUrl, $comment);
+        }
+
+        return null;
+    }
+
     public static function getCommentModel(): string
     {
         return config('commentions.comment.model', Comment::class);

src/Listeners/SendUserMentionedNotification.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Kirschbaum\Commentions\Listeners;
+
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Support\Facades\Notification;
+use Kirschbaum\Commentions\Events\UserWasMentionedEvent;
+use Kirschbaum\Commentions\Notifications\UserMentionedInComment;
+
+class SendUserMentionedNotification implements ShouldQueue
+{
+    use InteractsWithQueue;
+
+    public function handle(UserWasMentionedEvent $event): void
+    {
+        $user = $event->user;
+
+        if (! config('commentions.notifications.mentions.enabled', false)) {
+            return;
+        }
+
+        $channels = (array) config('commentions.notifications.mentions.channels', []);
+        if (empty($channels)) {
+            return;
+        }
+
+        $notificationClass = (string) config('commentions.notifications.mentions.notification', UserMentionedInComment::class);
+        $notification = app($notificationClass, ['comment' => $event->comment, 'channels' => $channels]);
+
+        Notification::send($user, $notification);
+    }
+}

src/Notifications/UserMentionedInComment.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Kirschbaum\Commentions\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\BroadcastMessage;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use Kirschbaum\Commentions\Comment;
+use Kirschbaum\Commentions\Config;
+use Kirschbaum\Commentions\Manager;
+
+class UserMentionedInComment extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    public function __construct(
+        protected Comment $comment,
+        protected array $channels
+    ) {}
+
+    public function via(object $notifiable): array
+    {
+        return $this->channels;
+    }
+
+    public function toMail(object $notifiable): MailMessage
+    {
+        $url = Config::resolveCommentUrl($this->comment) ?? url('/');
+
+        return (new MailMessage())
+            ->subject((string) config('commentions.notifications.mentions.mail.subject', 'You were mentioned in a comment'))
+            ->greeting('Hi ' . Manager::getName($notifiable))
+            ->line('You were mentioned in a comment by ' . $this->comment->getAuthorName() . '.')
+            ->line(strip_tags($this->comment->getBodyMarkdown()))
+            ->action('View comment', $url);
+    }
+
+    public function toArray(object $notifiable): array
+    {
+        return [
+            'comment_id' => $this->comment->getId(),
+            'comment_body' => $this->comment->getBody(),
+            'author_name' => $this->comment->getAuthorName(),
+            'url' => Config::resolveCommentUrl($this->comment),
+        ];
+    }
+
+    public function toBroadcast(object $notifiable): BroadcastMessage
+    {
+        return new BroadcastMessage($this->toArray($notifiable));
+    }
+}