feat: allow users to select notification types (#1512)

* feat: allow users to select notification types * fix(ui): display personal notification types before management types * fix: update allRequestsAutoApproved check to account for new REQUEST_MOVIE & REQUEST_TV perms * fix(ui): do not display Discord notif type selector if user not eligible for any types * refactor(ui): remove unnecessary 'enabled' checkboxes from user notif settings * fix(ui): correct checkbox behavior * fix: add missing return type on hasNotificationType * refactor: remove unused isValid prop in NotificationsWebPush * fix(ui): use SensitiveInput for users' public PGP keys * fix(ui): add missing tip/hint for email encryption setting * refactor(svg): use the new Discord logo * revert(api): undo breaking change removing discordEnabled from UserSettingsNotificationsResponse * fix(lang): update notification type descriptions for clarity * fix(telegram): do not send users notifications of their own auto-approved requests
sct · Jun 4, 2021 · e605989 · e605989
1 parent 6a3649f
commit e605989
Show file tree

Hide file tree

Showing 35 changed files with 1,066 additions and 647 deletions.
diff --git a/overseerr-api.yml b/overseerr-api.yml
@@ -1213,8 +1213,6 @@ components:
               type: string
             userToken:
               type: string
-            priority:
-              type: number
     LunaSeaSettings:
       type: object
       properties:
@@ -1599,6 +1597,9 @@ components:
           nullable: true
         discordEnabled:
           type: boolean
+        discordEnabledTypes:
+          type: number
+          nullable: true
         discordId:
           type: string
           nullable: true

diff --git a/server/entity/UserSettings.ts b/server/entity/UserSettings.ts
@@ -108,7 +108,10 @@ export class UserSettings {
   })
   public notificationTypes: Partial<NotificationAgentTypes>;
 
-  public hasNotificationType(key: NotificationAgentKey, type: Notification) {
+  public hasNotificationType(
+    key: NotificationAgentKey,
+    type: Notification
+  ): boolean {
     return hasNotificationType(type, this.notificationTypes[key] ?? 0);
   }
 }
diff --git a/server/interfaces/api/userSettingsInterfaces.ts b/server/interfaces/api/userSettingsInterfaces.ts
@@ -20,6 +20,7 @@ export interface UserSettingsNotificationsResponse {
   emailEnabled?: boolean;
   pgpKey?: string;
   discordEnabled?: boolean;
+  discordEnabledTypes?: number;
   discordId?: string;
   telegramEnabled?: boolean;
   telegramBotUsername?: string;

diff --git a/server/lib/notifications/agents/agent.ts b/server/lib/notifications/agents/agent.ts
@@ -24,6 +24,6 @@ export abstract class BaseAgent<T extends NotificationAgentConfig> {
 }
 
 export interface NotificationAgent {
-  shouldSend(type: Notification): boolean;
+  shouldSend(): boolean;
   send(type: Notification, payload: NotificationPayload): Promise<boolean>;
 }
diff --git a/server/lib/notifications/agents/discord.ts b/server/lib/notifications/agents/discord.ts
@@ -193,12 +193,10 @@ class DiscordAgent
     };
   }
 
-  public shouldSend(type: Notification): boolean {
-    if (
-      this.getSettings().enabled &&
-      this.getSettings().options.webhookUrl &&
-      hasNotificationType(type, this.getSettings().types)
-    ) {
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
+    if (settings.enabled && settings.options.webhookUrl) {
       return true;
     }
 
@@ -209,6 +207,12 @@ class DiscordAgent
     type: Notification,
     payload: NotificationPayload
   ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
     logger.debug('Sending Discord notification', {
       label: 'Notifications',
       type: Notification[type],
@@ -218,13 +222,6 @@ class DiscordAgent
     let content = undefined;
 
     try {
-      const { botUsername, botAvatarUrl, webhookUrl } =
-        this.getSettings().options;
-
-      if (!webhookUrl) {
-        return false;
-      }
-
       if (payload.notifyUser) {
         // Mention user who submitted the request
         if (
@@ -258,9 +255,9 @@ class DiscordAgent
           .join(' ');
       }
 
-      await axios.post(webhookUrl, {
-        username: botUsername,
-        avatar_url: botAvatarUrl,
+      await axios.post(settings.options.webhookUrl, {
+        username: settings.options.botUsername,
+        avatar_url: settings.options.botAvatarUrl,
         embeds: [this.buildEmbed(type, payload)],
         content,
       } as DiscordWebhookPayload);

diff --git a/server/lib/notifications/agents/email.ts b/server/lib/notifications/agents/email.ts
@@ -1,7 +1,7 @@
 import { EmailOptions } from 'email-templates';
 import path from 'path';
 import { getRepository } from 'typeorm';
-import { hasNotificationType, Notification } from '..';
+import { Notification } from '..';
 import { MediaType } from '../../../constants/media';
 import { User } from '../../../entity/User';
 import logger from '../../../logger';
@@ -28,12 +28,14 @@ class EmailAgent
     return settings.notifications.agents.email;
   }
 
-  public shouldSend(type: Notification): boolean {
+  public shouldSend(): boolean {
     const settings = this.getSettings();
 
     if (
       settings.enabled &&
-      hasNotificationType(type, this.getSettings().types)
+      settings.options.emailFrom &&
+      settings.options.smtpHost &&
+      settings.options.smtpPort
     ) {
       return true;
     }

diff --git a/server/lib/notifications/agents/lunasea.ts b/server/lib/notifications/agents/lunasea.ts
@@ -50,12 +50,10 @@ class LunaSeaAgent
     };
   }
 
-  public shouldSend(type: Notification): boolean {
-    if (
-      this.getSettings().enabled &&
-      this.getSettings().options.webhookUrl &&
-      hasNotificationType(type, this.getSettings().types)
-    ) {
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
+    if (settings.enabled && settings.options.webhookUrl) {
       return true;
     }
 
@@ -66,26 +64,32 @@ class LunaSeaAgent
     type: Notification,
     payload: NotificationPayload
   ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
     logger.debug('Sending LunaSea notification', {
       label: 'Notifications',
       type: Notification[type],
       subject: payload.subject,
     });
 
     try {
-      const { webhookUrl, profileName } = this.getSettings().options;
-
-      if (!webhookUrl) {
-        return false;
-      }
-
-      await axios.post(webhookUrl, this.buildPayload(type, payload), {
-        headers: {
-          Authorization: `Basic ${Buffer.from(`${profileName}:`).toString(
-            'base64'
-          )}`,
-        },
-      });
+      await axios.post(
+        settings.options.webhookUrl,
+        this.buildPayload(type, payload),
+        settings.options.profileName
+          ? {
+              headers: {
+                Authorization: `Basic ${Buffer.from(
+                  `${settings.options.profileName}:`
+                ).toString('base64')}`,
+              },
+            }
+          : undefined
+      );
 
       return true;
     } catch (e) {
@@ -94,7 +98,7 @@ class LunaSeaAgent
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: e.response.data,
+        response: e.response?.data,
       });
 
       return false;

diff --git a/server/lib/notifications/agents/pushbullet.ts b/server/lib/notifications/agents/pushbullet.ts
@@ -24,12 +24,10 @@ class PushbulletAgent
     return settings.notifications.agents.pushbullet;
   }
 
-  public shouldSend(type: Notification): boolean {
-    if (
-      this.getSettings().enabled &&
-      this.getSettings().options.accessToken &&
-      hasNotificationType(type, this.getSettings().types)
-    ) {
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
+    if (settings.enabled && settings.options.accessToken) {
       return true;
     }
 
@@ -137,29 +135,31 @@ class PushbulletAgent
     type: Notification,
     payload: NotificationPayload
   ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
     logger.debug('Sending Pushbullet notification', {
       label: 'Notifications',
       type: Notification[type],
       subject: payload.subject,
     });
 
     try {
-      const endpoint = 'https://api.pushbullet.com/v2/pushes';
-
-      const { accessToken } = this.getSettings().options;
-
       const { title, body } = this.constructMessageDetails(type, payload);
 
       await axios.post(
-        endpoint,
+        'https://api.pushbullet.com/v2/pushes',
         {
           type: 'note',
           title: title,
           body: body,
         } as PushbulletPayload,
         {
           headers: {
-            'Access-Token': accessToken,
+            'Access-Token': settings.options.accessToken,
           },
         }
       );

diff --git a/server/lib/notifications/agents/pushover.ts b/server/lib/notifications/agents/pushover.ts
@@ -30,12 +30,13 @@ class PushoverAgent
     return settings.notifications.agents.pushover;
   }
 
-  public shouldSend(type: Notification): boolean {
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
     if (
-      this.getSettings().enabled &&
-      this.getSettings().options.accessToken &&
-      this.getSettings().options.userToken &&
-      hasNotificationType(type, this.getSettings().types)
+      settings.enabled &&
+      settings.options.accessToken &&
+      settings.options.userToken
     ) {
       return true;
     }
@@ -161,6 +162,12 @@ class PushoverAgent
     type: Notification,
     payload: NotificationPayload
   ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
     logger.debug('Sending Pushover notification', {
       label: 'Notifications',
       type: Notification[type],
@@ -169,14 +176,12 @@ class PushoverAgent
     try {
       const endpoint = 'https://api.pushover.net/1/messages.json';
 
-      const { accessToken, userToken } = this.getSettings().options;
-
       const { title, message, url, url_title, priority } =
         this.constructMessageDetails(type, payload);
 
       await axios.post(endpoint, {
-        token: accessToken,
-        user: userToken,
+        token: settings.options.accessToken,
+        user: settings.options.userToken,
         title: title,
         message: message,
         url: url,

diff --git a/server/lib/notifications/agents/slack.ts b/server/lib/notifications/agents/slack.ts
@@ -218,12 +218,10 @@ class SlackAgent
     };
   }
 
-  public shouldSend(type: Notification): boolean {
-    if (
-      this.getSettings().enabled &&
-      this.getSettings().options.webhookUrl &&
-      hasNotificationType(type, this.getSettings().types)
-    ) {
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
+    if (settings.enabled && settings.options.webhookUrl) {
       return true;
     }
 
@@ -234,19 +232,22 @@ class SlackAgent
     type: Notification,
     payload: NotificationPayload
   ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
     logger.debug('Sending Slack notification', {
       label: 'Notifications',
       type: Notification[type],
       subject: payload.subject,
     });
     try {
-      const webhookUrl = this.getSettings().options.webhookUrl;
-
-      if (!webhookUrl) {
-        return false;
-      }
-
-      await axios.post(webhookUrl, this.buildEmbed(type, payload));
+      await axios.post(
+        settings.options.webhookUrl,
+        this.buildEmbed(type, payload)
+      );
 
       return true;
     } catch (e) {