seneca/lib/actions.ts

A Microservices Framework for Node.js

/* Copyright © 2014-2022 Richard Rodger and other contributors, MIT License. */


import { Legacy } from './legacy'

const Common = require('./common')

function addActions(instance: any) {
  instance.stats = make_action_seneca_stats(instance.private$)

  // Add builtin actions.
  instance
    .add({ role: 'seneca', cmd: 'ping' }, cmd_ping)
    .add({ role: 'seneca', cmd: 'stats' }, instance.stats)
    .add({ role: 'seneca', cmd: 'close' }, action_seneca_close)
    .add({ role: 'seneca', info: 'fatal' }, action_seneca_fatal)
    .add({ role: 'seneca', get: 'options' }, action_options_get)

  // Forward compatibility
  instance
    .translate('sys:seneca', 'role:seneca', ['-sys'])

  // Legacy builtin actions.
  // Remove in Seneca 4.x
  instance.add(
    { role: 'seneca', stats: true, deprecate$: true },
    instance.stats
  )
  instance.add(
    { role: 'options', cmd: 'get', deprecate$: true },
    action_options_get
  )
}


function cmd_ping(this: any, _msg: any, reply: any) {
  let ping = this.ping()
  reply(ping)
}


function action_seneca_fatal(this: any, _msg: any, reply: any) {
  reply()
}


function action_seneca_close(this: any, _msg: any, reply: any) {
  this.emit('close')
  reply()
}


function make_action_seneca_stats(private$: any) {
  return function action_seneca_stats(this: any, msg: any, reply: any) {
    msg = msg || {}
    var stats

    // TODO: review - this is sort of breaking the "type" of the stats result
    if (private$.stats.actmap[msg.pattern]) {
      stats = private$.stats.actmap[msg.pattern]
      stats.time = private$.timestats.calculate(msg.pattern)
    } else {
      stats = Object.assign({}, private$.stats)
      stats.now = new Date()
      stats.uptime = stats.now - stats.start

      stats.now = new Date(stats.now).toISOString()
      stats.start = new Date(stats.start).toISOString()

      var summary = null == msg.summary || Common.boolify(msg.summary)

      if (summary) {
        stats.actmap = void 0
      } else {
        Object.keys(private$.stats.actmap).forEach((p) => {
          private$.stats.actmap[p].time = private$.timestats.calculate(p)
        })
      }
    }

    if (reply) {
      reply(stats)
    }
    return stats
  }
}

function action_options_get(this: any, msg: any, reply: any) {
  var options = this.options()

  var base = msg.base || null
  var top = base ? options[base] || {} : options
  var val = msg.key ? top[msg.key] : top

  reply(Legacy.copydata(val))
}


export {
  addActions
}