Add setting to turn off notifications (#938)

* feature #827

* feature #827

* feature #827

* fixing minor code formatting issues

* feature #827

refactoring: taking out setting check from model to respective listeners

* feature #827

added success message after saving settings

* wip

* wip

* wip

* wip

---------

Co-authored-by: sodu <sparsiev@firmidea.com>
Co-authored-by: Dries Vints <dries@vints.be>

Author: 3 people

app/Enums/NotificationType.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Enums;
+
+use App\Notifications\MentionNotification;
+use App\Notifications\NewReplyNotification;
+
+enum NotificationType: string
+{
+    case MENTION = 'mention';
+    case REPLY = 'reply';
+
+    public function getClass(): string
+    {
+        return match ($this) {
+            self::MENTION => MentionNotification::class,
+            self::REPLY => NewReplyNotification::class,
+        };
+    }
+
+    public function label(): string
+    {
+        return match ($this) {
+            self::MENTION => 'Mentions',
+            self::REPLY => 'Replies',
+        };
+    }
+
+    public static function getTypes(): array
+    {
+        return [
+            self::MENTION->value => self::MENTION,
+            self::REPLY->value => self::REPLY,
+        ];
+    }
+}

app/Http/Controllers/Settings/NotificationSettingsController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Http\Controllers\Settings;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\NotificationSettingsRequest;
+use App\Jobs\SaveNotificationSettings;
+use Illuminate\Auth\Middleware\Authenticate;
+
+class NotificationSettingsController extends Controller
+{
+    public function __construct()
+    {
+        $this->middleware(Authenticate::class);
+    }
+
+    public function store(NotificationSettingsRequest $request)
+    {
+        $this->dispatchSync(new SaveNotificationSettings(
+            $request->user(),
+            (array) $request->validated('allowed_notifications')
+        ));
+
+        $this->success('settings.notifications.updated');
+
+        return redirect()->route('settings.profile');
+    }
+}

app/Http/Requests/NotificationSettingsRequest.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\Requests;
+
+use App\Enums\NotificationType;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+class NotificationSettingsRequest extends FormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'allowed_notifications.*' => Rule::enum(NotificationType::class),
+        ];
+    }
+}

app/Jobs/RegisterUser.php

@@ -2,6 +2,7 @@
 
 namespace App\Jobs;
 
+use App\Enums\NotificationType;
 use App\Exceptions\CannotCreateUser;
 use App\Http\Requests\RegisterRequest;
 use App\Models\User;
@@ -44,6 +45,10 @@ public function handle(): void
             'type' => User::DEFAULT,
             'bio' => '',
             'remember_token' => '',
+            'allowed_notifications' => [
+                NotificationType::MENTION,
+                NotificationType::REPLY,
+            ],
         ]);
         $user->save();
     }

app/Jobs/SaveNotificationSettings.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Models\User;
+
+final class SaveNotificationSettings
+{
+    public function __construct(private User $user, private readonly array $allowedNotifications)
+    {
+    }
+
+    public function handle(): void
+    {
+        $this->user->allowed_notifications = $this->allowedNotifications;
+        $this->user->save();
+    }
+}

app/Listeners/NotifyUsersMentionedInReply.php

@@ -12,9 +12,19 @@ final class NotifyUsersMentionedInReply
     public function handle(ReplyWasCreated $event): void
     {
         $event->reply->mentionedUsers()->each(function ($user) use ($event) {
-            if (! $user->hasBlocked($event->reply->author()) && ! $event->reply->replyAble()->participants()->contains($user)) {
-                $user->notify(new MentionNotification($event->reply));
+            if (! $user->isNotificationAllowed(MentionNotification::class)) {
+                return;
             }
+
+            if ($user->hasBlocked($event->reply->author())) {
+                return;
+            }
+
+            if ($event->reply->replyAble()->participants()->contains($user)) {
+                return;
+            }
+
+            $user->notify(new MentionNotification($event->reply));
         });
     }
 }

app/Listeners/NotifyUsersMentionedInThread.php

@@ -12,9 +12,15 @@ final class NotifyUsersMentionedInThread
     public function handle(ThreadWasCreated $event): void
     {
         $event->thread->mentionedUsers()->each(function ($user) use ($event) {
-            if (! $user->hasBlocked($event->thread->author())) {
-                $user->notify(new MentionNotification($event->thread));
+            if (! $user->isNotificationAllowed(MentionNotification::class)) {
+                return;
             }
+
+            if ($user->hasBlocked($event->thread->author())) {
+                return;
+            }
+
+            $user->notify(new MentionNotification($event->thread));
         });
     }
 }

app/Listeners/SendNewReplyNotification.php

@@ -16,9 +16,15 @@ public function handle(ReplyWasCreated $event): void
         $thread = $event->reply->replyAble();
 
         foreach ($thread->subscriptions() as $subscription) {
-            if ($this->replyAuthorDoesNotMatchSubscriber($event->reply->author(), $subscription)) {
-                $subscription->user()->notify(new NewReplyNotification($event->reply, $subscription));
+            if (! $subscription->user()->isNotificationAllowed(NewReplyNotification::class)) {
+                continue;
             }
+
+            if (! $this->replyAuthorDoesNotMatchSubscriber($event->reply->author(), $subscription)) {
+                continue;
+            }
+
+            $subscription->user()->notify(new NewReplyNotification($event->reply, $subscription));
         }
     }
 

app/Models/User.php

@@ -3,13 +3,16 @@
 namespace App\Models;
 
 use App\Concerns\HasTimestamps;
+use App\Enums\NotificationType;
 use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Contracts\Notifications\Dispatcher;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Auth;
 use Laravel\Sanctum\HasApiTokens;
 
@@ -52,6 +55,13 @@ final class User extends Authenticatable implements MustVerifyEmail
         'banned_reason',
     ];
 
+    /**
+     * {@inheritdoc}
+     */
+    protected $casts = [
+        'allowed_notifications' => 'array',
+    ];
+
     /**
      * {@inheritdoc}
      */
@@ -351,4 +361,12 @@ public function scopeWithUsersWhoArentBlockedBy(Builder $query, User $user)
             $query->where('user_id', $user->getKey());
         });
     }
+
+    public function isNotificationAllowed(string $notification): bool
+    {
+        return collect($this->allowed_notifications ?? [])
+            ->contains(function ($notificationType) use ($notification) {
+                return NotificationType::from($notificationType)->getClass() === $notification;
+            });
+    }
 }

app/Notifications/MentionNotification.php

@@ -3,6 +3,7 @@
 namespace App\Notifications;
 
 use App\Contracts\MentionAble;
+use App\Enums\NotificationType;
 use App\Mail\MentionEmail;
 use App\Models\User;
 use Illuminate\Bus\Queueable;
@@ -34,7 +35,7 @@ public function toDatabase(User $user)
         $replyAble = $this->mentionAble->mentionedIn();
 
         return [
-            'type' => 'mention',
+            'type' => NotificationType::MENTION,
             'replyable_id' => $replyAble->id,
             'replyable_type' => array_search(get_class($replyAble), Relation::morphMap()),
             'replyable_subject' => $this->mentionAble->mentionedIn()->subject(),