add API Gateway + Step Functions

Author: horike37

lib/deploy/events/apiGateway/apigateway-to-stepfunctions-assume-role.json

@@ -0,0 +1,34 @@
+{
+  "Type": "AWS::IAM::Role",
+  "Properties": {
+    "AssumeRolePolicyDocument": {
+      "Version": "2012-10-17",
+      "Statement": [
+        {
+          "Effect": "Allow",
+          "Principal": {
+            "Service": "apigateway.amazonaws.com"
+          },
+          "Action": "sts:AssumeRole"
+        }
+      ]
+    },
+    "Policies": [
+      {
+        "PolicyName": "apigatewaytostepfunctions",
+        "PolicyDocument": {
+          "Version": "2012-10-17",
+          "Statement": [
+            {
+              "Effect": "Allow",
+              "Action": [
+                "states:StartExecution"
+              ],
+              "Resource": "*"
+            }
+          ]
+        }
+      }
+    ]
+  }
+}

lib/deploy/events/apiGateway/deployment.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const _ = require('lodash');
+const BbPromise = require('bluebird');
+
+module.exports = {
+  compileDeployment() {
+    this.apiGatewayDeploymentLogicalId = this.provider.naming
+      .generateApiGatewayDeploymentLogicalId();
+
+    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
+      [this.apiGatewayDeploymentLogicalId]: {
+        Type: 'AWS::ApiGateway::Deployment',
+        Properties: {
+          RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
+          StageName: this.options.stage,
+        },
+        DependsOn: this.apiGatewayMethodLogicalIds,
+      },
+    });
+
+    // create CLF Output for endpoint
+    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Outputs, {
+      ServiceEndpoint: {
+        Description: 'URL of the service endpoint',
+        Value: {
+          'Fn::Join': ['',
+            [
+              'https://',
+              { Ref: this.apiGatewayRestApiLogicalId },
+              `.execute-api.${this.options.region}.amazonaws.com/${this.options.stage}`,
+            ],
+          ],
+        },
+      },
+    });
+    return BbPromise.resolve();
+  },
+};

lib/deploy/events/apiGateway/methods.js

@@ -8,6 +8,18 @@ module.exports = {
   compileMethods() {
     this.apiGatewayMethodLogicalIds = [];
 
+    if (this.isCoreHttpevents()) {
+      _.forEach(this.serverless.service.functions, (functionObject) => {
+        _.forEach(functionObject.events, (event) => {
+          if (_.has(event, 'http')) {
+            const methodLogicalId = this.provider.naming
+              .getMethodLogicalId(this.getResourceName(event.http.path), event.http.method);
+            this.apiGatewayMethodLogicalIds.push(methodLogicalId);
+          }
+        });
+      });
+    }
+
     this.pluginhttpValidated.events.forEach((event) => {
       const resourceId = this.getResourceId(event.http.path);
       const resourceName = this.getResourceName(event.http.path);
@@ -18,6 +30,7 @@ module.exports = {
         Properties: {
           HttpMethod: event.http.method.toUpperCase(),
           RequestParameters: requestParameters,
+          AuthorizationType: 'NONE',
           ResourceId: resourceId,
           RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
         },
@@ -28,8 +41,8 @@ module.exports = {
       }
 
       _.merge(template,
-        this.getMethodIntegration(event.http, event.stateMachineName)
-//        this.getMethodResponses(event.http)
+        this.getMethodIntegration(event.stateMachineName),
+        this.getMethodResponses()
       );
 
       const methodLogicalId = this.provider.naming
@@ -45,14 +58,15 @@ module.exports = {
     return BbPromise.resolve();
   },
 
-  getMethodIntegration(http, stateMachineName) {
+  getMethodIntegration(stateMachineName) {
     const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName);
+    const apiToStepFunctionsIamRoleLogicalId = this.getApiToStepFunctionsIamRoleLogicalId();
     const integration = {
       IntegrationHttpMethod: 'POST',
       Type: 'AWS',
       Credentials: {
         'Fn::GetAtt': [
-          'APIAssumeRolePolicyDocument',
+          `${apiToStepFunctionsIamRoleLogicalId}`,
           'Arn',
         ],
       },
@@ -105,4 +119,23 @@ module.exports = {
       },
     };
   },
+
+  getMethodResponses() {
+    return {
+      Properties: {
+        MethodResponses: [
+          {
+            ResponseParameters: {},
+            ResponseModels: {},
+            StatusCode: 200,
+          },
+          {
+            ResponseParameters: {},
+            ResponseModels: {},
+            StatusCode: 400,
+          },
+        ],
+      },
+    };
+  },
 };

lib/deploy/events/apiGateway/role.js

@@ -0,0 +1,23 @@
+'use strict';
+const _ = require('lodash');
+const BbPromise = require('bluebird');
+const path = require('path');
+
+module.exports = {
+  compileHttpIamRole() {
+    const iamRoleApiGatewayToStepFunctionsTemplate =
+      JSON.stringify(this.serverless.utils.readFileSync(
+      path.join(__dirname,
+        'apigateway-to-stepfunctions-assume-role.json'))
+    );
+
+    const getApiToStepFunctionsIamRoleLogicalId = this.getApiToStepFunctionsIamRoleLogicalId();
+    const newIamRoleStateMachineExecutionObject = {
+      [getApiToStepFunctionsIamRoleLogicalId]: JSON.parse(iamRoleApiGatewayToStepFunctionsTemplate),
+    };
+
+    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources,
+      newIamRoleStateMachineExecutionObject);
+    return BbPromise.resolve();
+  },
+};

lib/index.js

@@ -7,11 +7,16 @@ const compileIamRole = require('./deploy/stepFunctions/compileIamRole');
 const httpValidate = require('./deploy/events/apiGateway/validate');
 const httpResources = require('./deploy/events/apiGateway/resources');
 const httpMethods = require('./deploy/events/apiGateway/methods');
+const httpIamRole = require('./deploy/events/apiGateway/role');
+const httpDeployment = require('./deploy/events/apiGateway/deployment');
 const coreCompileRestApi =
   require('serverless/lib/plugins/aws/deploy/compile/events/apiGateway/lib/restApi');
+const coreInfo =
+  require('serverless/lib/plugins/aws/info/getStackInfo');
 const yamlParser = require('./yamlParser');
 const naming = require('./naming');
 const _ = require('lodash');
+const chalk = require('chalk');
 
 class ServerlessStepFunctions {
   constructor(serverless, options) {
@@ -38,9 +43,12 @@ class ServerlessStepFunctions {
       compileActivities,
       compileIamRole,
       coreCompileRestApi,
+      coreInfo,
       httpValidate,
       httpResources,
       httpMethods,
+      httpIamRole,
+      httpDeployment,
       yamlParser,
       naming
     );
@@ -100,16 +108,49 @@ class ServerlessStepFunctions {
           return BbPromise.bind(this)
             .then(this.compileRestApi)
             .then(this.compileResources)
-            .then(this.compileMethods);
+            .then(this.compileMethods)
+            .then(this.compileHttpIamRole)
+            .then(this.compileDeployment);
         }
         return BbPromise.bind(this)
           .then(this.compileResources);
       },
+      'after:deploy:deploy': () => BbPromise.bind(this)
+        .then(this.getStackInfo)
+        .then(this.display),
     };
   }
 
   invoke() {
 
   }
+
+  display() {
+    let message = '';
+
+    const info = this.gatheredData.info;
+    message += `${chalk.yellow.underline('Serverless StepFunctions OutPut')}\n`;
+    message += `${chalk.yellow('endpoints:')}`;
+    _.forEach(this.getAllStateMachines(), (stateMachineName) => {
+      const stateMachineObj = this.getStateMachine(stateMachineName);
+      stateMachineObj.events.forEach(event => {
+        if (event.http) {
+          let method;
+          let path;
+
+          if (typeof event.http === 'object') {
+            method = event.http.method.toUpperCase();
+            path = event.http.path;
+          } else {
+            method = event.http.split(' ')[0].toUpperCase();
+            path = event.http.split(' ')[1];
+          }
+          path = path !== '/' ? `/${path.split('/').filter(p => p !== '').join('/')}` : '';
+          message += `\n  ${method} - ${info.endpoint}${path}`;
+        }
+      });
+    });
+    this.serverless.cli.consoleLog(message);
+  }
 }
 module.exports = ServerlessStepFunctions;

lib/naming.js

@@ -31,4 +31,8 @@ module.exports = {
   getApiGatewayName() {
     return `${this.provider.getStage()}-${this.provider.serverless.service.service}-stepfunctions`;
   },
+
+  getApiToStepFunctionsIamRoleLogicalId() {
+    return 'ApigatewayToStepFunctionsRole';
+  },
 };