'use strict'; /** * Serverless Component Class */ const SError = require('./ServerlessError'), SUtils = require('./utils/index'), BbPromise = require('bluebird'), path = require('path'), _ = require('lodash'), fs = require('fs'); class ServerlessComponent { /** * Constructor */ constructor(Serverless, project, config) { // Validate required attributes if (!config.component && !config.sPath) throw new SError('config.sPath is required'); let _this = this; _this._S = Serverless; _this._config = { sPath: undefined, fullPath: undefined }; _this._project = project; _this.updateConfig(config); // Default Properties _this.name = _this._config.sPath || 'component' + SUtils.generateShortId(6); _this.custom = {}; _this.functions = {}; _this.templates = {}; _this.setRuntime( config.runtime || 'nodejs' ); } getRuntime() { return this._runtime; } setRuntime( runtimeName ) { let runtime = SUtils.supportedRuntimes[ runtimeName ]; if( runtime ) { // TODO: get rid of that set()/get()/_.assign/_.cloneDeep so this can be cleaner this.runtime = runtimeName; this._runtime = new runtime( this._S ); } else { throw new SError( `Runtime ${runtimeName} is not supported!` ); } } getAllFunctions() { return _.values( this.functions ); } setFunction( func ){ this.functions[ func.getSPath() ] = func; } /** * Update Config * - Takes config.component */ updateConfig(config) { if (!config) return; // Temp fix to support config.component if (config.component && !config.sPath) config.sPath = config.component; // Set sPath if (config.sPath) { this._config.sPath = config.sPath; } // Make full path if (this._S.hasProject() && this._config.sPath) { this._config.fullPath = this.getProject().getFilePath(this._config.sPath); } } /** * Load * - Load from source (i.e., file system); * - Returns promise */ load() { let _this = this, reserved = ['node_modules', 'lib', '.DS_Store'], componentJson, componentContents; // Helper to instantiate functions let loadFn = function(sPath) { let func = new _this._S.classes.Function(_this._S, _this, { sPath: sPath }); return func.load() .then(function(instance) { componentJson.functions[sPath] = instance; }); }; // Load component, then traverse component dirs to get all functions return BbPromise.try(function() { // Validate: Check project path is set if (!_this._S.hasProject()) throw new SError('Component could not be loaded because no project path has been set on Serverless instance'); // Validate: Check component exists if (!SUtils.fileExistsSync(path.join(_this._config.fullPath, 's-component.json'))) { throw new SError('Component could not be loaded because it does not exist in your project: ' + _this._config.sPath); } componentJson = SUtils.readAndParseJsonSync(path.join(_this._config.fullPath, 's-component.json')); componentJson.functions = {}; componentContents = fs.readdirSync(_this._config.fullPath); return componentContents; }) .each(function(sf) { let fPath1 = path.join(_this._config.fullPath, sf); // Skip reserved names and files if (reserved.indexOf(sf.trim()) !== -1 || !fs.lstatSync(fPath1).isDirectory()) return; // If s-function.json doesn't exist, look in subfolders if (_this._S.classes.Function.isFunctionDir(fPath1)) { return loadFn(path.join(_this.name, sf)); } else { // Loop through 1st level subfolders looking for more functions return BbPromise.resolve(fs.readdirSync(path.join(_this._config.fullPath, sf))) .each(function(sf2) { let fPath2 = path.join(fPath1, sf2); // Skip reserved names and files if (reserved.indexOf(sf2.trim()) !== -1 || !fs.lstatSync(fPath2).isDirectory()) return; // If s-function.json doesn't exist, look in 2 subfolders if (_this._S.classes.Function.isFunctionDir(fPath2)) { return loadFn(path.join(_this.name, sf, sf2)); } else { // Loop through 2nd level subfolders looking for more functions return BbPromise.resolve(fs.readdirSync(path.join(_this._config.fullPath, sf, sf2))) .each(function(sf3) { let fPath3 = path.join(fPath2, sf3); // Skip reserved names and files if (reserved.indexOf(sf3.trim()) !== -1 || !fs.lstatSync(fPath3).isDirectory()) return; // If s-function.json doesn't exist, look in 2 subfolders if (_this._S.classes.Function.isFunctionDir(fPath3)) { return loadFn(path.join(_this.name, sf, sf2, sf3)); } }); } }); } }) .then(function() { // Get templates if (_this._config.fullPath && SUtils.fileExistsSync(path.join(_this._config.fullPath, 's-templates.json'))) { componentJson.templates = require(path.join(_this._config.fullPath, 's-templates.json')); } }) .then(function() { // Merge _this.setRuntime( componentJson.runtime ); delete componentJson.runtime; _.assign(_this, componentJson); return _this; }); } /** * Set * - Set data * - Accepts a data object */ set(data) { let _this = this; // Instantiate Components for (let prop in data.functions) { let instance = new _this._S.classes.Function(_this._S, _this, { sPath: prop }); data.functions[prop] = instance.set(data.functions[prop]); } // Merge in _this.setRuntime( data.runtime ); delete data.runtime; _this = _.extend(_this, data); return _this; } /** * Get * - Returns clone of data */ get() { let clone = _.cloneDeep(this); for (let prop in this.functions) { clone.functions[prop] = this.functions[prop].get(); } return SUtils.exportClassData(clone); } /** * getPopulated * - Fill in templates then variables */ getPopulated(options) { let _this = this; options = options || {}; // Validate: Check Stage & Region if (!options.stage || !options.region) throw new SError('Both "stage" and "region" params are required'); // Validate: Check project path is set if (!_this._S.hasProject()) throw new SError('Component could not be populated because no project path has been set on Serverless instance'); // Populate let clone = _this.get(); clone = SUtils.populate(_this._S.state.getMeta(), this.getTemplates(), clone, options.stage, options.region); clone.functions = {}; for (let prop in _this.functions) { clone.functions[prop] = _this.functions[prop].getPopulated(options); } return clone; } /** * Get Templates * - Returns clone of templates * - Inherits parent templates */ getTemplates() { return _.merge( this.getProject().getTemplates(), _.cloneDeep(this.templates) ); } /** * Save * - Saves data to file system * - Returns promise */ save(options) { let _this = this; return new BbPromise.try(function() { // Validate: Check project path is set if (!_this._S.hasProject()) throw new SError('Component could not be saved because no project path has been set on Serverless instance'); // Create if does not exist if (!SUtils.fileExistsSync(path.join(_this._config.fullPath, 's-component.json'))) { return _this._create(); } }) .then(function() { // Save all nested functions if (options && options.deep) { return BbPromise.try(function () { return Object.keys(_this.functions); }) .each(function(fnKey) { return _this.functions[fnKey].save(); }) } }) .then(function() { // If templates, save templates if (_this.templates && Object.keys(_this.templates).length) { return SUtils.writeFile(path.join(_this._config.fullPath, 's-templates.json'), JSON.stringify(_this.templates, null, 2)); } }) .then(function() { let clone = _this.get(); // Strip properties if (clone.functions) delete clone.functions; if (clone.templates) delete clone.templates; // Write file return SUtils.writeFile(path.join(_this._config.fullPath, 's-component.json'), JSON.stringify(clone, null, 2)); }) .then(function() { return _this; }) } /** * Create (scaffolding) * - Returns promise */ _create() { let _this = this; return BbPromise.try(function() { fs.mkdirSync(_this._config.fullPath); fs.mkdirSync(path.join(_this._config.fullPath, 'lib')); return( _this.getRuntime().populateComponentFolder( _this._config.fullPath ) ); }); } /** * Get Project * - Returns reference to the instance */ getProject() { return this._project; } getSPath() { return this._config.sPath; } getFullPath() { return this._config.fullPath; } static isComponentDir( dir ) { return SUtils.fileExistsSync(path.join(dir, 's-component.json')); } } module.exports = ServerlessComponent;