actionhero/initializers/exceptions.js

actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks

'use strict'

const os = require('os')

/**
 * Handlers for when things go wrong.
 *
 * @namespace api.exceptions
 */

module.exports = {
  loadPriority: 130,
  initialize: function (api, next) {
    api.exceptionHandlers = {}
    api.exceptionHandlers.reporters = []

    const consoleReporter = function (error, type, name, objects, severity) {
      let extraMessages = []

      if (type === 'loader') {
        extraMessages.push('! Failed to load ' + objects.fullFilePath)
      } else if (type === 'action') {
        extraMessages.push('! uncaught error from action: ' + name)
        extraMessages.push('! connection details:')
        const relevantDetails = ['action', 'remoteIP', 'type', 'params', 'room']
        for (let i in relevantDetails) {
          if (
            objects.connection[relevantDetails[i]] !== null &&
            objects.connection[relevantDetails[i]] !== undefined &&
            typeof objects.connection[relevantDetails[i]] !== 'function'
          ) {
            extraMessages.push('!     ' + relevantDetails[i] + ': ' + JSON.stringify(objects.connection[relevantDetails[i]]))
          }
        }
      } else if (type === 'task') {
        extraMessages.push('! error from task: ' + name + ' on queue ' + objects.queue + ' (worker #' + objects.workerId + ')')
        try {
          extraMessages.push('!     arguments: ' + JSON.stringify(objects.task.args))
        } catch (e) {}
      } else {
        extraMessages.push('! Error: ' + error.message)
        extraMessages.push('!     Type: ' + type)
        extraMessages.push('!     Name: ' + name)
        extraMessages.push('!     Data: ' + JSON.stringify(objects))
      }

      for (let m in extraMessages) {
        api.log(extraMessages[m], severity)
      }
      let lines
      try {
        lines = error.stack.split(os.EOL)
      } catch (e) {
        lines = new Error(error).stack.split(os.EOL)
      }
      for (let l in lines) {
        let line = lines[l]
        api.log('! ' + line, severity)
      }
      api.log('*', severity)
    }

    api.exceptionHandlers.reporters.push(consoleReporter)

    api.exceptionHandlers.report = function (error, type, name, objects, severity) {
      if (!severity) { severity = 'error' }
      for (let i in api.exceptionHandlers.reporters) {
        api.exceptionHandlers.reporters[i](error, type, name, objects, severity)
      }
    }

    // /////////
    // TYPES //
    // /////////

    api.exceptionHandlers.loader = function (fullFilePath, error) {
      let name = 'loader:' + fullFilePath
      api.exceptionHandlers.report(error, 'loader', name, {fullFilePath: fullFilePath}, 'alert')
    }

    api.exceptionHandlers.action = function (error, data, next) {
      let simpleName
      try {
        simpleName = data.action
      } catch (e) {
        simpleName = error.message
      }
      let name = 'action:' + simpleName
      api.exceptionHandlers.report(error, 'action', name, {connection: data.connection}, 'error')
      data.connection.response = {} // no partial responses
      if (typeof next === 'function') { next() }
    }

    api.exceptionHandlers.task = function (error, queue, task, workerId) {
      let simpleName
      try {
        simpleName = task['class']
      } catch (e) {
        simpleName = error.message
      }
      let name = 'task:' + simpleName
      api.exceptionHandlers.report(error, 'task', name, {task: task, queue: queue, workerId: workerId}, api.config.tasks.workerLogging.failure)
    }

    next()
  }
}