advplyr.audiobookshelf/server/managers/NotificationManager.js

const axios = require('axios')
const Logger = require('../Logger')
const SocketAuthority = require('../SocketAuthority')
const Database = require('../Database')
const { notificationData } = require('../utils/notifications')

class NotificationManager {
  constructor() {
    this.sendingNotification = false
    this.notificationQueue = []
  }

  getData() {
    return notificationData
  }

  /**
   *
   * @param {import('../models/LibraryItem')} libraryItem
   * @param {import('../models/PodcastEpisode')} episode
   */
  async onPodcastEpisodeDownloaded(libraryItem, episode) {
    if (!Database.notificationSettings.isUseable) return

    if (!Database.notificationSettings.getHasActiveNotificationsForEvent('onPodcastEpisodeDownloaded')) {
      Logger.debug(`[NotificationManager] onPodcastEpisodeDownloaded: No active notifications`)
      return
    }

    Logger.debug(`[NotificationManager] onPodcastEpisodeDownloaded: Episode "${episode.title}" for podcast ${libraryItem.media.title}`)
    const library = await Database.libraryModel.findByPk(libraryItem.libraryId)
    const eventData = {
      libraryItemId: libraryItem.id,
      libraryId: libraryItem.libraryId,
      libraryName: library?.name || 'Unknown',
      mediaTags: (libraryItem.media.tags || []).join(', '),
      podcastTitle: libraryItem.media.title,
      podcastAuthor: libraryItem.media.author || '',
      podcastDescription: libraryItem.media.description || '',
      podcastGenres: (libraryItem.media.genres || []).join(', '),
      episodeId: episode.id,
      episodeTitle: episode.title,
      episodeSubtitle: episode.subtitle || '',
      episodeDescription: episode.description || ''
    }
    this.triggerNotification('onPodcastEpisodeDownloaded', eventData)
  }

  /**
   *
   * @param {import('../objects/Backup')} backup
   * @param {number} totalBackupCount
   * @param {boolean} removedOldest - If oldest backup was removed
   */
  async onBackupCompleted(backup, totalBackupCount, removedOldest) {
    if (!Database.notificationSettings.isUseable) return

    if (!Database.notificationSettings.getHasActiveNotificationsForEvent('onBackupCompleted')) {
      Logger.debug(`[NotificationManager] onBackupCompleted: No active notifications`)
      return
    }

    Logger.debug(`[NotificationManager] onBackupCompleted: Backup completed`)
    const eventData = {
      completionTime: backup.createdAt,
      backupPath: backup.fullPath,
      backupSize: backup.fileSize,
      backupCount: totalBackupCount || 'Invalid',
      removedOldest: removedOldest || 'false'
    }
    this.triggerNotification('onBackupCompleted', eventData)
  }

  /**
   * Handles scheduled episode download RSS feed request failed
   *
   * @param {string} feedUrl
   * @param {number} numFailed
   * @param {string} title
   */
  async onRSSFeedFailed(feedUrl, numFailed, title) {
    if (!Database.notificationSettings.isUseable) return

    if (!Database.notificationSettings.getHasActiveNotificationsForEvent('onRSSFeedFailed')) {
      Logger.debug(`[NotificationManager] onRSSFeedFailed: No active notifications`)
      return
    }

    Logger.debug(`[NotificationManager] onRSSFeedFailed: RSS feed request failed for ${feedUrl}`)
    const eventData = {
      feedUrl: feedUrl,
      numFailed: numFailed || 0,
      title: title || 'Unknown Title'
    }
    this.triggerNotification('onRSSFeedFailed', eventData)
  }

  /**
   * Handles scheduled episode downloads disabled due to too many failed attempts
   *
   * @param {string} feedUrl
   * @param {number} numFailed
   * @param {string} title
   */
  async onRSSFeedDisabled(feedUrl, numFailed, title) {
    if (!Database.notificationSettings.isUseable) return

    if (!Database.notificationSettings.getHasActiveNotificationsForEvent('onRSSFeedDisabled')) {
      Logger.debug(`[NotificationManager] onRSSFeedDisabled: No active notifications`)
      return
    }

    Logger.debug(`[NotificationManager] onRSSFeedDisabled: Podcast scheduled episode download disabled due to ${numFailed} failed requests for ${feedUrl}`)
    const eventData = {
      feedUrl: feedUrl,
      numFailed: numFailed || 0,
      title: title || 'Unknown Title'
    }
    this.triggerNotification('onRSSFeedDisabled', eventData)
  }

  /**
   *
   * @param {string} errorMsg
   */
  async onBackupFailed(errorMsg) {
    if (!Database.notificationSettings.isUseable) return

    if (!Database.notificationSettings.getHasActiveNotificationsForEvent('onBackupFailed')) {
      Logger.debug(`[NotificationManager] onBackupFailed: No active notifications`)
      return
    }

    Logger.debug(`[NotificationManager] onBackupFailed: Backup failed (${errorMsg})`)
    const eventData = {
      errorMsg: errorMsg || 'Backup failed'
    }
    this.triggerNotification('onBackupFailed', eventData)
  }

  onTest() {
    this.triggerNotification('onTest')
  }

  /**
   *
   * @param {string} eventName
   * @param {any} eventData
   * @param {boolean} [intentionallyFail=false] - If true, will intentionally fail the notification
   */
  async triggerNotification(eventName, eventData, intentionallyFail = false) {
    if (!Database.notificationSettings.isUseable) return

    // Will queue the notification if sendingNotification and queue is not full
    if (!this.checkTriggerNotification(eventName, eventData)) return

    const notifications = Database.notificationSettings.getActiveNotificationsForEvent(eventName)
    for (const notification of notifications) {
      Logger.debug(`[NotificationManager] triggerNotification: Sending ${eventName} notification ${notification.id}`)
      const success = intentionallyFail ? false : await this.sendNotification(notification, eventData)

      notification.updateNotificationFired(success)
      if (!success) {
        // Failed notification
        if (notification.numConsecutiveFailedAttempts >= Database.notificationSettings.maxFailedAttempts) {
          Logger.error(`[NotificationManager] triggerNotification: ${notification.eventName}/${notification.id} reached max failed attempts`)
          notification.enabled = false
        } else {
          Logger.error(`[NotificationManager] triggerNotification: ${notification.eventName}/${notification.id} ${notification.numConsecutiveFailedAttempts} failed attempts`)
        }
      }
    }

    await Database.updateSetting(Database.notificationSettings)
    SocketAuthority.emitter('notifications_updated', Database.notificationSettings.toJSON())

    this.notificationFinished()
  }

  /**
   *
   * @param {string} eventName
   * @param {any} eventData
   * @returns {boolean} - TRUE if notification should be triggered now
   */
  checkTriggerNotification(eventName, eventData) {
    if (this.sendingNotification) {
      if (this.notificationQueue.length >= Database.notificationSettings.maxNotificationQueue) {
        Logger.warn(`[NotificationManager] Notification queue is full - ignoring event ${eventName}`)
      } else {
        Logger.debug(`[NotificationManager] Queueing notification ${eventName} (Queue size: ${this.notificationQueue.length})`)
        this.notificationQueue.push({ eventName, eventData })
      }
      return false
    }
    this.sendingNotification = true
    return true
  }

  notificationFinished() {
    // Delay between events then run next notification in queue
    setTimeout(() => {
      this.sendingNotification = false
      if (this.notificationQueue.length) {
        // Send next notification in queue
        const nextNotificationEvent = this.notificationQueue.shift()
        this.triggerNotification(nextNotificationEvent.eventName, nextNotificationEvent.eventData)
      }
    }, Database.notificationSettings.notificationDelay)
  }

  sendTestNotification(notification) {
    const eventData = notificationData.events.find((e) => e.name === notification.eventName)
    if (!eventData) {
      Logger.error(`[NotificationManager] sendTestNotification: Event not found ${notification.eventName}`)
      return false
    }

    return this.sendNotification(notification, eventData.testData)
  }

  sendNotification(notification, eventData) {
    const payload = notification.getApprisePayload(eventData)
    return axios
      .post(Database.notificationSettings.appriseApiUrl, payload, { timeout: 6000 })
      .then((response) => {
        Logger.debug(`[NotificationManager] sendNotification: ${notification.eventName}/${notification.id} response=`, response.data)
        return true
      })
      .catch((error) => {
        Logger.error(`[NotificationManager] sendNotification: ${notification.eventName}/${notification.id} error=`, error)
        return false
      })
  }
}
module.exports = new NotificationManager()