mc-core/src/extensions/registry.js

Deployments made simple

'use strict'

//let validator = require('mc-extension-validator')
let glob = require('glob')

const EXT_PATH = process.cwd() + '/node_modules/mc-ext-*'

let registry = {

  _extensions: {},
  _typesByFqids: {},

  /**
   * Resolve all `mc-ext-*` modules and register them
   *
   * @param  {string} dir Path mission control extensions
   */
  resolve: function resolve(dir) {
    let modules = glob.sync(dir)
    modules.forEach(module => {
      this.register(require(module))
    })
  },

  /**
   * Reload all extensions
   */
  reload: function reload() {

    // Reset all of our internal registry pieces
    this._extensions = {}
    this._typesByFqids = {}

    // Reload the modules
    this.resolve(EXT_PATH)
  },

  /**
   * [register provided module]
   * @param  {Object} module [Module instance]
   */
  register: function register(module) {

    if (typeof this._extensions[module.vendor] !== 'object') {
      this._extensions[module.vendor] = {}
    }

    // TODO: validate extension index

    this._extensions[module.vendor][module.id] = {
      vendor: module.vendor,
      id: module.id,
      name: module.name,
      description: module.description
    }

    this.registerStageTypes(module)
    this.registerLogTypes(module)

  },

  registerStageTypes: function registerStageTypes(module) {

    if (Array.isArray(module.stages)) {

      module.stages.forEach(stage => {

        // TODO: validate stage type

        // Register the stage as vendor.extension_id.stages.example
        let fqid = module.vendor + '.' + module.id + '.stages.' + stage.id
        this._typesByFqids[fqid] = stage

      })
    }

  },

  registerLogTypes: function registerLogTypes(module) {

    if (Array.isArray(module.logs)) {

      module.logs.forEach(log => {

        // TODO: validate log type

        // Register the stage as vendor.extension_id.stages.example
        let fqid = module.vendor + '.' + module.id + '.logs.' + log.id
        this._typesByFqids[fqid] = log

      })
    }

  },

  /**
   * Get an item/type from the extension via the FQID (full-qualified identifier)
   *
   * @param  {string} name [dot syntax path]
   * @return {object}      [resolved extension path]
   */
  get: function get(name) {
    if (typeof this._typesByFqids[name] !== 'undefined') {
      return this._typesByFqids[name]
    } else {
      throw new Error('Extension FQID "' + name + '" not found')
    }
  },

  /**
   * Get stage types
   *
   * @return {Array}
   */
  getStageTypes: function getStageTypes() {
    let stages = []

    for (let fqid in this._typesByFqids) {
      // Shallow clone so we don't mutate the stage object
      let stage = Object.assign({}, this._typesByFqids[fqid])
      stage.fqid = fqid
      stages.push(stage)
    }

    return stages
  }

}

// Initially load extensions
registry.resolve(EXT_PATH)

module.exports = registry