Merge pull request #12145 from nanaya/channel-notification-combine

 Combine channel notification job classes

Author: notbakaneko

app/Jobs/Notifications/ChannelAnnouncement.php

@@ -3,55 +3,29 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the GNU Affero General Public License v3.0.
 // See the LICENCE file in the repository root for full licence text.
 
+declare(strict_types=1);
+
 namespace App\Jobs\Notifications;
 
-use App\Models\Chat\Message;
 use App\Models\Notification;
-use App\Models\User;
 
-class ChannelAnnouncement extends BroadcastNotificationBase
+class ChannelAnnouncement extends ChannelMessageBase
 {
     const DELIVERY_MODE_DEFAULTS = ['mail' => true, 'push' => true];
 
-    protected $message;
-
     public static function getBaseKey(Notification $notification): string
     {
         return 'channel.announcement.announce';
     }
 
-    public static function getMailLink(Notification $notification): string
-    {
-        return route('chat.index', ['channel_id' => $notification->notifiable_id]);
-    }
-
-    public function __construct(Message $message, User $source)
-    {
-        parent::__construct($source);
-
-        $this->message = $message;
-    }
-
     public function getDetails(): array
     {
         $channel = $this->message->channel;
 
         return [
+            ...parent::getDetails(),
             'channel_id' => $channel->getKey(),
             'name' => $channel->name,
-            'title' => truncate($this->message->content, static::CONTENT_TRUNCATE),
-            'type' => strtolower($channel->type),
-            'cover_url' => $this->source->user_avatar,
         ];
     }
-
-    public function getListeningUserIds(): array
-    {
-        return $this->message->channel->userIds();
-    }
-
-    public function getNotifiable()
-    {
-        return $this->message->channel;
-    }
 }

app/Jobs/Notifications/ChannelMessage.php

@@ -3,52 +3,13 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the GNU Affero General Public License v3.0.
 // See the LICENCE file in the repository root for full licence text.
 
+declare(strict_types=1);
+
 namespace App\Jobs\Notifications;
 
-use App\Models\Chat\Message;
 use App\Models\Notification;
-use App\Models\User;
 
-class ChannelMessage extends BroadcastNotificationBase
+class ChannelMessage extends ChannelMessageBase
 {
     const NOTIFICATION_OPTION_NAME = Notification::CHANNEL_MESSAGE;
-
-    protected $message;
-
-    public static function getBaseKey(Notification $notification): string
-    {
-        return "channel.channel.{$notification->details['type']}";
-    }
-
-    public static function getMailLink(Notification $notification): string
-    {
-        // TODO: probably should enable linking to a channel directly...
-        return route('chat.index', ['sendto' => $notification->source_user_id]);
-    }
-
-    public function __construct(Message $message, User $source)
-    {
-        parent::__construct($source);
-
-        $this->message = $message;
-    }
-
-    public function getDetails(): array
-    {
-        return [
-            'title' => truncate($this->message->content, static::CONTENT_TRUNCATE),
-            'type' => strtolower($this->message->channel->type),
-            'cover_url' => $this->source->user_avatar,
-        ];
-    }
-
-    public function getListeningUserIds(): array
-    {
-        return $this->message->channel->userIds();
-    }
-
-    public function getNotifiable()
-    {
-        return $this->message->channel;
-    }
 }

app/Jobs/Notifications/ChannelMessageBase.php

@@ -0,0 +1,49 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Jobs\Notifications;
+
+use App\Models\Chat\Message;
+use App\Models\Notification;
+use App\Models\User;
+
+abstract class ChannelMessageBase extends BroadcastNotificationBase
+{
+    public static function getBaseKey(Notification $notification): string
+    {
+        return "channel.channel.{$notification->details['type']}";
+    }
+
+    public static function getMailLink(Notification $notification): string
+    {
+        return route('chat.index', ['channel_id' => $notification->notifiable_id]);
+    }
+
+    public function __construct(protected Message $message, User $source)
+    {
+        parent::__construct($source);
+    }
+
+    public function getDetails(): array
+    {
+        return [
+            'title' => truncate($this->message->content, static::CONTENT_TRUNCATE),
+            'type' => strtolower($this->message->channel->type),
+            'cover_url' => $this->source->user_avatar,
+        ];
+    }
+
+    public function getListeningUserIds(): array
+    {
+        return $this->message->channel->userIds();
+    }
+
+    public function getNotifiable()
+    {
+        return $this->message->channel;
+    }
+}