sugo-actor/lib/emitting/message_formatter.js

Actor component of SUGOS.

/**
 * Formatter for emit message
 * @module messageFormatter
 */
'use strict'

const { AcknowledgeStatus } = require('sg-socket-constants')
const { OK, NG } = AcknowledgeStatus
const { isProduction } = require('asenv')
const { EOL } = require('os')
const { clone } = require('asobj')

module.exports = Object.assign(exports, {
  /**
   * Format ok message
   * @function ok
   * @param {Object} payload - Payload data
   * @param {Object} meta - Meta data
   * @returns {{status: *, payload: *, meta: *}}
   */
  ok (payload, meta) {
    return { status: OK, payload, meta }
  },
  /**
   * Format ng message
   * @function ng
   * @param {Object} error - Payload data
   * @returns {Object}
   */
  ng (error) {
    if (!error) {
      return { status: NG }
    }
    let { message, stack } = error
    return {
      status: NG,
      payload: [
        message || error,
        isProduction() ? null : stack
      ].filter(Boolean).join(EOL),
      meta: {
        additionalInfo: clone(error, {
          without: [ 'message', 'stack' ]
        })
      }
    }
  }
})