msgflo/src/common.coffee

Polyglot FBP runtime based on message queues

uuid = require 'uuid'

# Based on Underscore.js (MIT)
# Returns a function, that, as long as it continues to be invoked, will not
# be triggered. The function will be called after it stops being called for
# N milliseconds. If `immediate` is passed, trigger the function on the
# leading edge, instead of the trailing.
exports.debounce = (func, wait, immediate) ->
  timeout = null
  return ->
    context = this
    args = arguments

    later = ->
      timeout = null
      if !immediate
        func.apply context, args
      return

    callNow = immediate and !timeout
    clearTimeout timeout
    timeout = setTimeout(later, wait)
    if callNow
      func.apply context, args
    return

exports.clone = clone = (obj) ->
  if not obj? or typeof obj isnt 'object'
    return obj

  if obj instanceof Date
    return new Date(obj.getTime())

  if obj instanceof RegExp
    flags = ''
    flags += 'g' if obj.global?
    flags += 'i' if obj.ignoreCase?
    flags += 'm' if obj.multiline?
    flags += 'y' if obj.sticky?
    return new RegExp(obj.source, flags)

  newInstance = new obj.constructor()

  for key of obj
    newInstance[key] = clone obj[key]

  return newInstance

exports.readGraph = (filepath, callback) ->
  path = require 'path'
  fs = require 'fs'
  fbp = require 'fbp'

  ext = path.extname filepath
  fs.readFile filepath, { encoding: 'utf-8' }, (err, contents) ->
    return callback err if err
    try
      if ext == '.fbp'
        graph = fbp.parse contents
      else
        graph = JSON.parse contents
    catch e
      return callback e
    return callback null, graph

exports.normalizeOptions = (options) ->
  options.broker = process.env['MSGFLO_BROKER'] if not options.broker
  options.broker = process.env['CLOUDAMQP_URL'] if not options.broker
  options.broker = 'amqp://localhost' if not options.broker

  options.runtimeId = process.env['MSGFLO_RUNTIME_ID'] if not options.runtimeId
  options.runtimeId = uuid.v4() if not options.runtimeId

  if not options.pingInterval and process.env['MSGFLO_PING_INTERVAL']
    options.pingInterval = parseInt process.env['MSGFLO_PING_INTERVAL']
  options.pingInterval = 0 if not options.pingInterval # default: never
  options.pingMethod = process.env['MSGFLO_PING_METHOD'] if not options.pingMethod
  options.pingMethod = 'POST' if not options.pingMethod
  options.pingUrl = process.env['MSGFLO_PING_URL'] if not options.pingUrl
  options.pingUrl = "https://api.flowhub.io/runtimes/$RUNTIME_ID" if not options.pingUrl
  options.pingUrl = options.pingUrl.replace '$RUNTIME_ID', options.runtimeId

  return options

# Note: relies on convention
exports.queueName = (role, port) ->
  return "#{role}.#{port.toUpperCase()}"

exports.isParticipant = (p) ->
  return p.component? and p.component != 'msgflo/RoundRobin' and p.component != 'msgflo/PubSub'

exports.iipsForRole = (graph, role) ->
  iips = {}
  for conn in graph.connections
    continue if not conn.data?
    continue if conn.tgt.process != role
    iips[conn.tgt.port] = conn.data
  return iips