serverless/lib/classes/PluginManager.js

'use strict';

const Utils = require('./Utils');
const path = require('path');
const has = require('lodash').has;
const forEach = require('lodash').forEach;

class PluginManager {
  constructor(serverless) {
    this._serverless = serverless;
    this._pluginInstances = [];
    this._commandsList = [];
    this._commands = {};
  }

  loadAllPlugins() {
    this._loadCorePlugins();
    // this._loadServicePlugins(); // TODO: uncomment once implemented
  }

  runCommand(command) {
    const events = this._getEvents(command.split(' '), this._commands);
    // collect all relevant hooks
    let hooks = [];
    events.forEach((event) => {
      const hooksForEvent = [];
      this._pluginInstances.forEach((pluginInstance) => {
        forEach(pluginInstance.hooks, (hook, hookKey) => {
          if (hookKey === event) {
            hooksForEvent.push(hook);
          }
        });
      });
      hooks = hooks.concat(hooksForEvent);
    });

    // run all relevant hooks one after another
    hooks.forEach((hook) => {
      const returnValue = hook();

      // check if a Promise is returned
      if (returnValue.then instanceof Function) {
        returnValue.then((value) => {
          return value;
        });
      }
    });
  }

  _addPlugin(Plugin) {
    this._pluginInstances.push(new Plugin());

    this._loadCommands(Plugin);
  }

  _loadCorePlugins() {
    const utils = new Utils();
    const pluginsDirectoryPath = path.join(__dirname, '../plugins');

    const corePlugins = utils.readFileSync(path.join(pluginsDirectoryPath, 'Plugins.json')).plugins;

    corePlugins.forEach((corePlugin) => {
      const Plugin = require(path.join(pluginsDirectoryPath, corePlugin));

      this._addPlugin(Plugin);
    });
  }

  _loadServicePlugins() {
    // TODO implement
  }

  _loadCommands(Plugin) {
    this._commandsList.push((new Plugin()).commands);

    // TODO: refactor ASAP as it slows down overall performance
    // rebuild the commands
    forEach(this._commandsList, (commands) => {
      forEach(commands, (commandDetails, command) => {
        this._commands[command] = commandDetails;
      });
    });
  }

  _getEvents(commandsArray, availableCommands, prefix) {
    prefix = (typeof prefix !== 'undefined' ? prefix : '');
    const commandPart = commandsArray[0];

    if (has(availableCommands, commandPart)) {
      const commandDetails = availableCommands[commandPart];
      if (commandsArray.length === 1) {
        const events = [];
        commandDetails.lifeCycleEvents.forEach((event) => {
          events.push(`${prefix}${commandPart}:${event}Pre`);
          events.push(`${prefix}${commandPart}:${event}`);
          events.push(`${prefix}${commandPart}:${event}Post`);
        });
        return events;
      }
      if (has(commandDetails, 'commands')) {
        return this._getEvents(commandsArray.slice(1, commandsArray.length),
          commandDetails.commands, `${commandPart}:`);
      }
    }

    return [];
  }
}

module.exports = PluginManager;