mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
347 lines
10 KiB
JavaScript
347 lines
10 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Action: Function Deploy
|
|
* - Deploys Function Code
|
|
* - Validates Function paths
|
|
* - Loops sequentially through each Region in specified Stage
|
|
* - Passes Function paths to Sub-Actions for deployment
|
|
* - Handles concurrent processing of Sub-Actions for faster deploys
|
|
*/
|
|
|
|
module.exports = function(SPlugin, serverlessPath) {
|
|
|
|
const path = require('path'),
|
|
SError = require(path.join(serverlessPath, 'Error')),
|
|
SCli = require(path.join(serverlessPath, 'utils/cli')),
|
|
BbPromise = require('bluebird'),
|
|
async = require('async'),
|
|
fse = BbPromise.promisifyAll(require('fs-extra'));
|
|
let SUtils;
|
|
|
|
|
|
class FunctionDeploy extends SPlugin {
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
|
|
constructor(S, config) {
|
|
super(S, config);
|
|
SUtils = S.utils;
|
|
}
|
|
|
|
/**
|
|
* Get Name
|
|
*/
|
|
|
|
static getName() {
|
|
return 'serverless.core.' + FunctionDeploy.name;
|
|
}
|
|
|
|
/**
|
|
* Register Plugin Actions
|
|
*/
|
|
|
|
registerActions() {
|
|
|
|
this.S.addAction(this.functionDeploy.bind(this), {
|
|
handler: 'functionDeploy',
|
|
description: 'Deploys the code or endpoint of a function, or both',
|
|
context: 'function',
|
|
contextAction: 'deploy',
|
|
options: [
|
|
{
|
|
option: 'stage',
|
|
shortcut: 's',
|
|
description: 'Optional if only one stage is defined in project'
|
|
}, {
|
|
option: 'region',
|
|
shortcut: 'r',
|
|
description: 'Optional - Target one region to deploy to'
|
|
}, {
|
|
option: 'aliasFunction', // TODO: Implement
|
|
shortcut: 'f',
|
|
description: 'Optional - Provide a custom Alias to your Functions'
|
|
}, {
|
|
option: 'all',
|
|
shortcut: 'a',
|
|
description: 'Optional - Deploy all Functions'
|
|
}
|
|
, {
|
|
option: 'dontRemoveTmp',
|
|
shortcut: 't',
|
|
description: 'Optional - Do not remove `_tmp` folder'
|
|
}
|
|
],
|
|
parameters: [
|
|
{
|
|
parameter: 'names', // Only accepting paths makes it easier for plugin developers. Otherwise, people should use dash deploy
|
|
description: 'One or multiple function names',
|
|
position: '0->'
|
|
}
|
|
]
|
|
});
|
|
|
|
return BbPromise.resolve();
|
|
}
|
|
|
|
/**
|
|
* Function Deploy
|
|
*/
|
|
|
|
functionDeploy(evt) {
|
|
|
|
let _this = this;
|
|
_this.evt = evt;
|
|
|
|
// Flow
|
|
return new BbPromise(function(resolve, reject) {
|
|
|
|
// Prompt: Stage
|
|
if (!_this.S.config.interactive || _this.evt.options.stage) return resolve();
|
|
|
|
if (!_this.S.getProject().getAllStages().length) return reject(new SError('No existing stages in the project'));
|
|
|
|
return _this.cliPromptSelectStage('Function Deployer - Choose a stage: ', _this.evt.options.stage, false)
|
|
.then(stage => {
|
|
_this.evt.options.stage = stage;
|
|
return resolve();
|
|
})
|
|
})
|
|
.bind(_this)
|
|
.then(_this._validateAndPrepare)
|
|
.then(_this._processDeployment)
|
|
.then(_this._removeTmpFolder)
|
|
.then(function() {
|
|
|
|
// Line for neatness
|
|
SCli.log('------------------------');
|
|
|
|
// Display Failed Function Deployments
|
|
if (_this.failed) {
|
|
SCli.log('Failed to deploy the following functions in "'
|
|
+ _this.evt.options.stage
|
|
+ '" to the following regions:');
|
|
// Display Errors
|
|
for (let i = 0; i < Object.keys(_this.failed).length; i++) {
|
|
let region = _this.failed[Object.keys(_this.failed)[i]];
|
|
SCli.log(Object.keys(_this.failed)[i] + ' ------------------------');
|
|
for (let j = 0; j < region.length; j++) {
|
|
SCli.log(' ' + region[j].functionName + ': ' + region[j].message );
|
|
SUtils.sDebug(region[j].stack);
|
|
}
|
|
}
|
|
|
|
// Throw error for CI
|
|
throw new SError('Function Deployment Failed');
|
|
}
|
|
|
|
// Display Successful Function Deployments
|
|
if (_this.deployed) {
|
|
|
|
// Status
|
|
SCli.log('Successfully deployed functions in "'
|
|
+ _this.evt.options.stage
|
|
+ '" to the following regions: ');
|
|
|
|
// Display Functions & ARNs
|
|
for (let i = 0; i < Object.keys(_this.deployed).length; i++) {
|
|
let region = _this.deployed[Object.keys(_this.deployed)[i]];
|
|
SCli.log(Object.keys(_this.deployed)[i] + ' ------------------------');
|
|
for (let j = 0; j < region.length; j++) {
|
|
SCli.log(' ' + region[j].functionName + ' (' + region[j].lambdaName + '): ' + region[j].Arn );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return EVT
|
|
*/
|
|
|
|
_this.evt.data.deployed = _this.deployed;
|
|
_this.evt.data.failed = _this.failed;
|
|
return _this.evt;
|
|
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Validate And Prepare
|
|
* - If CLI, maps CLI input to event object
|
|
*/
|
|
|
|
_validateAndPrepare() {
|
|
|
|
let _this = this;
|
|
|
|
// Set Defaults
|
|
_this.functions = [];
|
|
_this.evt.options.names = _this.evt.options.names ? _this.evt.options.names : [];
|
|
_this.evt.options.stage = _this.evt.options.stage ? _this.evt.options.stage : null;
|
|
_this.evt.options.aliasFunction = _this.evt.options.aliasFunction ? _this.evt.options.aliasFunction : null;
|
|
|
|
// Instantiate Classes
|
|
_this.project = _this.S.getProject();
|
|
|
|
// Set Deploy Regions
|
|
_this.regions = _this.evt.options.region ? [_this.evt.options.region] : _this.S.getProject().getAllRegionNames(_this.evt.options.stage);
|
|
|
|
if (_this.evt.options.names.length) {
|
|
_this.evt.options.names.forEach(function(name) {
|
|
let func = _this.project.getFunction(name);
|
|
if (!func) throw new SError(`Function "${name}" doesn't exist in your project`);
|
|
_this.functions.push(_this.project.getFunction(name));
|
|
});
|
|
}
|
|
|
|
// If CLI and no function names targeted, deploy from CWD
|
|
if (_this.S.cli &&
|
|
!_this.evt.options.names.length &&
|
|
!_this.evt.options.all) {
|
|
|
|
_this.functions = SUtils.getFunctionsByCwd(_this.S.getProject().getAllFunctions());
|
|
}
|
|
|
|
// If --all is selected, load all paths
|
|
if (_this.evt.options.all) {
|
|
_this.functions = _this.S.getProject().getAllFunctions();
|
|
}
|
|
|
|
// Ensure tmp folder exists in _meta
|
|
if (!SUtils.dirExistsSync(_this.S.getProject().getRootPath('_meta', '_tmp'))) {
|
|
fse.mkdirSync(_this.S.getProject().getRootPath('_meta', '_tmp'));
|
|
}
|
|
|
|
if (_this.functions.length === 0) throw new SError(`You don't have any functions in your project`);
|
|
|
|
// Validate Stage
|
|
if (!_this.evt.options.stage) throw new SError(`Stage is required`);
|
|
|
|
return BbPromise.resolve();
|
|
}
|
|
|
|
/**
|
|
* Process Deployment
|
|
*/
|
|
|
|
_processDeployment() {
|
|
|
|
let _this = this;
|
|
|
|
// Status
|
|
SCli.log('Deploying functions in "'
|
|
+ _this.evt.options.stage
|
|
+ '" to the following regions: '
|
|
+ _this.regions.join(', '));
|
|
|
|
_this._spinner = SCli.spinner();
|
|
_this._spinner.start();
|
|
|
|
return BbPromise.try(function() {
|
|
return _this.regions;
|
|
})
|
|
.bind(_this)
|
|
.each(function(region) {
|
|
|
|
// Deploy Function Code in each region
|
|
return _this._deployCodeByRegion(region);
|
|
})
|
|
.then(function() {
|
|
|
|
// Stop Spinner
|
|
_this._spinner.stop(true);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Deploy Code By Region
|
|
*/
|
|
|
|
_deployCodeByRegion(region) {
|
|
|
|
let _this = this;
|
|
|
|
return new BbPromise(function(resolve, reject) {
|
|
|
|
/**
|
|
* Package, Upload, Deploy, Alias functions' code concurrently
|
|
* - Package must be redone for each region because ENV vars and IAM Roles are set for each region
|
|
*/
|
|
|
|
async.eachLimit(_this.functions, 5, function(func, cb) {
|
|
|
|
return BbPromise.try(function() {
|
|
|
|
let newEvt = {
|
|
options: {
|
|
stage: _this.evt.options.stage,
|
|
region: region,
|
|
name: func.name
|
|
}
|
|
};
|
|
|
|
// Package Code
|
|
return _this.S.actions.codePackageLambda(newEvt)
|
|
.bind(_this)
|
|
.then(function(result) {
|
|
let newEvt = {
|
|
options: {
|
|
stage: result.options.stage,
|
|
region: result.options.region,
|
|
name: func.name,
|
|
pathDist: result.data.pathDist,
|
|
pathsPackaged: result.data.pathsPackaged
|
|
}
|
|
};
|
|
|
|
return _this.S.actions.codeDeployLambda(newEvt);
|
|
});
|
|
})
|
|
.then(function(result) {
|
|
|
|
// Add Function and Region
|
|
if (!_this.deployed) _this.deployed = {};
|
|
if (!_this.deployed[region]) _this.deployed[region] = [];
|
|
|
|
|
|
_this.deployed[region].push({
|
|
lambdaName: result.data.functioName,
|
|
functionName: func.name,
|
|
Arn: result.data.lambdaAliasArn
|
|
});
|
|
|
|
return cb();
|
|
|
|
})
|
|
.catch(function(e) {
|
|
|
|
// Stash Failed Function Code
|
|
if (!_this.failed) _this.failed = {};
|
|
if (!_this.failed[region]) _this.failed[region] = [];
|
|
_this.failed[region].push({
|
|
functionName: func.name,
|
|
message: e.message,
|
|
stack: e.stack
|
|
});
|
|
|
|
return cb();
|
|
});
|
|
|
|
}, function() {
|
|
return resolve(region);
|
|
});
|
|
});
|
|
}
|
|
|
|
_removeTmpFolder() {
|
|
if (!this.evt.options.dontRemoveTmp) {
|
|
return fse.removeAsync(this.S.getProject().getRootPath('_meta', '_tmp'));
|
|
} else {
|
|
SCli.log('Skipping `_tmp` folder removal');
|
|
}
|
|
}
|
|
}
|
|
|
|
return( FunctionDeploy );
|
|
}; |