Merge pull request #618 from AaronJackson/notification-sensitivity

Notification sensitivity

Author: dpslwk

app/HMS/Entities/Role.php

@@ -2,6 +2,8 @@
 
 namespace HMS\Entities;
 
+use App\Notifications\NotificationSensitivityInterface;
+use App\Notifications\NotificationSensitivityType;
 use Doctrine\Common\Collections\ArrayCollection;
 use HMS\Helpers\Discord;
 use HMS\Traits\Entities\SoftDeletable;
@@ -447,9 +449,11 @@ public function routeNotificationForSlack(): false|string
     /**
      * Route notifications to the Discord channel.
      *
+     * @param mixed $notification
+     *
      * @return null|string
      */
-    public function routeNotificationForDiscord(): ?string
+    public function routeNotificationForDiscord($notification): ?string
     {
         if (! config('services.discord.token')) {
             return null;
@@ -468,15 +472,25 @@ public function routeNotificationForDiscord(): ?string
 
         $discord = app(Discord::class);
 
-        if ($this->getDiscordPrivateChannel()) {
-            return $discord->findChannelByName($this->getDiscordPrivateChannel())['id'];
-        }
+        $privateChannel = $discord->findChannelByName($this->getDiscordPrivateChannel())['id'];
+        $publicChannel = $discord->findChannelByName($this->getDiscordChannel())['id'];
+
+        // If they are null it'll cancel the notification, so it's ok
+        // to just return the whatever is returned from the ORM.
+        if ($notification instanceof NotificationSensitivityInterface) {
+            switch ($notification->getDiscordSensitivity()) {
+                case NotificationSensitivityType::PRIVATE:
+                    return $privateChannel;
+
+                case NotificationSensitivityType::PUBLIC:
+                    return $publicChannel;
 
-        if ($this->getDiscordChannel()) {
-            return $discord->findChannelByName($this->getDiscordChannel())['id'];
+                case NotificationSensitivityType::ANY:
+                    break;
+            }
         }
 
-        return null;
+        return $privateChannel ? $privateChannel : $publicChannel;
     }
 
     /**

app/HMS/Helpers/Discord.php

@@ -2,6 +2,7 @@
 
 namespace HMS\Helpers;
 
+use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Log;
 use RestCord\DiscordClient;
 
@@ -186,6 +187,25 @@ public function listGuildMembers()
         return $this->members;
     }
 
+    /**
+     * Obtains an array of Discord channels.
+     *
+     * @return array
+     */
+    private function getChannels()
+    {
+        // Avoid hitting redis if already in used for this instance of Discord
+        if ($this->channels) {
+            return $this->channels;
+        }
+
+        $this->channels = Cache::remember('discord.channels', 3600, fn () => $this->client->guild->getGuildChannels([
+            'guild.id' => $this->guildId,
+        ]));
+
+        return $this->channels;
+    }
+
     /**
      * Find a discord channel by name.
      *
@@ -195,13 +215,7 @@ public function listGuildMembers()
      */
     public function findChannelByName(string $channelName)
     {
-        if (! $this->channels) {
-            $this->channels = $this->client->guild->getGuildChannels([
-                'guild.id' => $this->guildId,
-            ]);
-        }
-
-        foreach ($this->channels as $channel) {
+        foreach ($this->getChannels() as $channel) {
             if ($channel['name'] == $channelName) {
                 return $channel;
             }

app/Notifications/Banking/AuditResult.php

@@ -2,6 +2,8 @@
 
 namespace App\Notifications\Banking;
 
+use App\Notifications\NotificationSensitivityInterface;
+use App\Notifications\NotificationSensitivityType;
 use Carbon\Carbon;
 use HMS\Entities\Role;
 use HMS\Entities\User;
@@ -15,7 +17,7 @@
 use NotificationChannels\Discord\DiscordChannel;
 use NotificationChannels\Discord\DiscordMessage;
 
-class AuditResult extends Notification implements ShouldQueue
+class AuditResult extends Notification implements ShouldQueue, NotificationSensitivityInterface
 {
     use Queueable;
 
@@ -211,4 +213,16 @@ public function toDiscord($notifiable)
 
         return (new DiscordMessage())->embed($embed);
     }
+
+    /**
+     * Returns the sensitivity for notification routing to
+     * Discord. e.g. whether it should go to the private or public
+     * team channel.
+     *
+     * @return string
+     */
+    public function getDiscordSensitivity()
+    {
+        return NotificationSensitivityType::PUBLIC;
+    }
 }

app/Notifications/NewMemberApprovalNeeded.php

@@ -12,7 +12,7 @@
 use NotificationChannels\Discord\DiscordChannel;
 use NotificationChannels\Discord\DiscordMessage;
 
-class NewMemberApprovalNeeded extends Notification implements ShouldQueue
+class NewMemberApprovalNeeded extends Notification implements ShouldQueue, NotificationSensitivityInterface
 {
     use Queueable;
 
@@ -154,4 +154,16 @@ public function toDiscord($notifiable)
 
         return DiscordMessage::create($message);
     }
+
+    /**
+     * Returns the sensitivity for notification routing to
+     * Discord. e.g. whether it should go to the private or public
+     * team channel.
+     *
+     * @return string
+     */
+    public function getDiscordSensitivity()
+    {
+        return NotificationSensitivityType::PRIVATE;
+    }
 }

app/Notifications/NotificationSensitivityInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Notifications;
+
+interface NotificationSensitivityInterface
+{
+    /**
+     * Returns the sensitivity for notification routing to
+     * Discord. e.g. whether it should go to the private or public
+     * team channel.
+     *
+     * @return string
+     */
+    public function getDiscordSensitivity();
+}

app/Notifications/NotificationSensitivityType.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Notifications;
+
+abstract class NotificationSensitivityType
+{
+    public const ANY = 'ANY';
+    public const PUBLIC = 'PUBLIC';
+    public const PRIVATE = 'PRIVATE';
+}

app/Notifications/NotifyIncommingRoleEmail.php

@@ -9,7 +9,7 @@
 use NotificationChannels\Discord\DiscordChannel;
 use NotificationChannels\Discord\DiscordMessage;
 
-class NotifyIncommingRoleEmail extends Notification implements ShouldQueue
+class NotifyIncommingRoleEmail extends Notification implements ShouldQueue, NotificationSensitivityInterface
 {
     use Queueable;
 
@@ -83,4 +83,16 @@ public function toDiscord($notifiable)
 
         return (new DiscordMessage())->embed($embed);
     }
+
+    /**
+     * Returns the sensitivity for notification routing to
+     * Discord. e.g. whether it should go to the private or public
+     * team channel.
+     *
+     * @return string
+     */
+    public function getDiscordSensitivity()
+    {
+        return NotificationSensitivityType::PRIVATE;
+    }
 }