feat(notif): add Gotify agent (#2196)

* feat(notifications): adds gotify notifications

adds new settings screen for gotify notifications including url, token and types settings

fix #2183

* feat(notif): add Gotify agent
addresses PR comments, runs i18n:extract

fix #2183

* reword validationTokenRequired

change wording to indicate presence, not validity

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>

* feat(notifications): gotify notifications fix

applies changes from #2077 in which Yup validation was failing for types

fix #2183

* feat(notifications): adds gotify notifications

adds new settings screen for gotify notifications including url, token and types settings

fix #2183

* feat(notif): add Gotify agent
addresses PR comments, runs i18n:extract

fix #2183

* reword validationTokenRequired

change wording to indicate presence, not validity

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>

* feat(notifications): gotify notifications fix

applies changes from #2077 in which Yup validation was failing for types

fix #2183

* feat(notifications): incorporate issue feature into gotify notifications

* feat(notifications): adds gotify notifications

adds new settings screen for gotify notifications including url, token and types settings

fix #2183

* feat(notif): add Gotify agent
addresses PR comments, runs i18n:extract

fix #2183

* reword validationTokenRequired

change wording to indicate presence, not validity

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>

* feat: add missing ts field

include notifyAdmin in test notification endpoint

* feat: apply formatting/line break items

add addition line break before conditional, change ordering of notifyAdmin/notifyUser in test
endpoint

* feat: remove duplicated endpoints

during rebase, notification endpoints were duplicated upon rebasing. remove duplicate routes

* feat: correct linting quirks

* feat: formatting improvements

* feat(gotify): refactor axios post to leverage 'getNotificationPayload'

Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com>

server/index.ts

@@ -17,6 +17,7 @@ import { startJobs } from './job/schedule';
 import notificationManager from './lib/notifications';
 import DiscordAgent from './lib/notifications/agents/discord';
 import EmailAgent from './lib/notifications/agents/email';
+import GotifyAgent from './lib/notifications/agents/gotify';
 import LunaSeaAgent from './lib/notifications/agents/lunasea';
 import PushbulletAgent from './lib/notifications/agents/pushbullet';
 import PushoverAgent from './lib/notifications/agents/pushover';
@@ -76,6 +77,7 @@ app
     notificationManager.registerAgents([
       new DiscordAgent(),
       new EmailAgent(),
+      new GotifyAgent(),
       new LunaSeaAgent(),
       new PushbulletAgent(),
       new PushoverAgent(),

server/lib/notifications/agents/gotify.ts

@@ -0,0 +1,148 @@
+import axios from 'axios';
+import { hasNotificationType, Notification } from '..';
+import { IssueStatus, IssueTypeName } from '../../../constants/issue';
+import logger from '../../../logger';
+import { getSettings, NotificationAgentGotify } from '../../settings';
+import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+
+interface GotifyPayload {
+  title: string;
+  message: string;
+  priority: number;
+  extras: any;
+}
+
+class GotifyAgent
+  extends BaseAgent<NotificationAgentGotify>
+  implements NotificationAgent
+{
+  protected getSettings(): NotificationAgentGotify {
+    if (this.settings) {
+      return this.settings;
+    }
+
+    const settings = getSettings();
+
+    return settings.notifications.agents.gotify;
+  }
+
+  public shouldSend(): boolean {
+    const settings = this.getSettings();
+
+    if (settings.enabled && settings.options.url && settings.options.token) {
+      return true;
+    }
+
+    return false;
+  }
+
+  private getNotificationPayload(
+    type: Notification,
+    payload: NotificationPayload
+  ): GotifyPayload {
+    const { applicationUrl, applicationTitle } = getSettings().main;
+    let priority = 0;
+
+    const title = payload.event
+      ? `${payload.event} - ${payload.subject}`
+      : payload.subject;
+    let message = payload.message ?? '';
+
+    if (payload.request) {
+      message += `\n\nRequested By: ${payload.request.requestedBy.displayName}`;
+
+      let status = '';
+      switch (type) {
+        case Notification.MEDIA_PENDING:
+          status = 'Pending Approval';
+          break;
+        case Notification.MEDIA_APPROVED:
+        case Notification.MEDIA_AUTO_APPROVED:
+          status = 'Processing';
+          break;
+        case Notification.MEDIA_AVAILABLE:
+          status = 'Available';
+          break;
+        case Notification.MEDIA_DECLINED:
+          status = 'Declined';
+          break;
+        case Notification.MEDIA_FAILED:
+          status = 'Failed';
+          break;
+      }
+
+      if (status) {
+        message += `\nRequest Status: ${status}`;
+      }
+    } else if (payload.comment) {
+      message += `\nComment from ${payload.comment.user.displayName}:\n${payload.comment.message}`;
+    } else if (payload.issue) {
+      message += `\n\nReported By: ${payload.issue.createdBy.displayName}`;
+      message += `\nIssue Type: ${IssueTypeName[payload.issue.issueType]}`;
+      message += `\nIssue Status: ${
+        payload.issue.status === IssueStatus.OPEN ? 'Open' : 'Resolved'
+      }`;
+
+      if (type == Notification.ISSUE_CREATED) {
+        priority = 1;
+      }
+    }
+
+    for (const extra of payload.extra ?? []) {
+      message += `\n\n**${extra.name}**\n${extra.value}`;
+    }
+
+    if (applicationUrl && payload.media) {
+      const actionUrl = `${applicationUrl}/${payload.media.mediaType}/${payload.media.tmdbId}`;
+      message += `\n\nOpen in ${applicationTitle}(${actionUrl})`;
+    }
+
+    return {
+      extras: {
+        'client::display': {
+          contentType: 'text/markdown',
+        },
+      },
+      title,
+      message,
+      priority,
+    };
+  }
+
+  public async send(
+    type: Notification,
+    payload: NotificationPayload
+  ): Promise<boolean> {
+    const settings = this.getSettings();
+
+    if (!hasNotificationType(type, settings.types ?? 0)) {
+      return true;
+    }
+
+    logger.debug('Sending Gotify notification', {
+      label: 'Notifications',
+      type: Notification[type],
+      subject: payload.subject,
+    });
+    try {
+      const endpoint = `${settings.options.url}/message?token=${settings.options.token}`;
+      const notificationPayload = this.getNotificationPayload(type, payload);
+
+      await axios.post(endpoint, notificationPayload);
+
+      return true;
+    } catch (e) {
+      logger.error('Error sending Gotify notification', {
+        label: 'Notifications',
+        type: Notification[type],
+        subject: payload.subject,
+        errorMessage: e.message,
+        response: e.response?.data,
+      });
+
+      return false;
+    }
+  }
+}
+
+export default GotifyAgent;

server/lib/settings.ts

@@ -189,9 +189,17 @@ export interface NotificationAgentWebhook extends NotificationAgentConfig {
   };
 }
 
+export interface NotificationAgentGotify extends NotificationAgentConfig {
+  options: {
+    url: string;
+    token: string;
+  };
+}
+
 export enum NotificationAgentKey {
   DISCORD = 'discord',
   EMAIL = 'email',
+  GOTIFY = 'gotify',
   PUSHBULLET = 'pushbullet',
   PUSHOVER = 'pushover',
   SLACK = 'slack',
@@ -203,6 +211,7 @@ export enum NotificationAgentKey {
 interface NotificationAgents {
   discord: NotificationAgentDiscord;
   email: NotificationAgentEmail;
+  gotify: NotificationAgentGotify;
   lunasea: NotificationAgentLunaSea;
   pushbullet: NotificationAgentPushbullet;
   pushover: NotificationAgentPushover;
@@ -359,6 +368,14 @@ class Settings {
             enabled: false,
             options: {},
           },
+          gotify: {
+            enabled: false,
+            types: 0,
+            options: {
+              url: '',
+              token: '',
+            },
+          },
         },
       },
       jobs: {

server/routes/settings/notifications.ts

@@ -4,6 +4,7 @@ import { Notification } from '../../lib/notifications';
 import { NotificationAgent } from '../../lib/notifications/agents/agent';
 import DiscordAgent from '../../lib/notifications/agents/discord';
 import EmailAgent from '../../lib/notifications/agents/email';
+import GotifyAgent from '../../lib/notifications/agents/gotify';
 import LunaSeaAgent from '../../lib/notifications/agents/lunasea';
 import PushbulletAgent from '../../lib/notifications/agents/pushbullet';
 import PushoverAgent from '../../lib/notifications/agents/pushover';
@@ -377,4 +378,46 @@ notificationRoutes.post('/lunasea/test', async (req, res, next) => {
   }
 });
 
+notificationRoutes.get('/gotify', (_req, res) => {
+  const settings = getSettings();
+
+  res.status(200).json(settings.notifications.agents.gotify);
+});
+
+notificationRoutes.post('/gotify', (req, rest) => {
+  const settings = getSettings();
+
+  settings.notifications.agents.gotify = req.body;
+  settings.save();
+
+  rest.status(200).json(settings.notifications.agents.gotify);
+});
+
+notificationRoutes.post('/gotify/test', async (req, rest, next) => {
+  if (!req.user) {
+    return next({
+      status: 500,
+      message: 'User information is missing from request',
+    });
+  }
+
+  const gotifyAgent = new GotifyAgent(req.body);
+  if (
+    await gotifyAgent.send(Notification.TEST_NOTIFICATION, {
+      notifyAdmin: false,
+      notifyUser: req.user,
+      subject: 'Test Notification',
+      message:
+        'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
+    })
+  ) {
+    return rest.status(204).send();
+  } else {
+    return next({
+      status: 500,
+      message: 'Failed to send Gotify notification.',
+    });
+  }
+});
+
 export default notificationRoutes;