Merge branch 'master' into add_authorizer_support

Author: vlewin

CHANGELOG.md

@@ -1,7 +1,3 @@
-# 1.5.1(10.07.2018)
-## Features
-- Added support for Shared API Gateway
-
 # 0.2.0(08.01.2017)
 ## Breaking Changes
 The service name is added to the statemachine prefix.

README.md

@@ -169,6 +169,53 @@ stepFunctions:
       definition:
 ```
 
+#### Share API Gateway and API Resources
+
+You can [share the same API Gateway](https://serverless.com/framework/docs/providers/aws/events/apigateway/#share-api-gateway-and-api-resources) between multiple projects by referencing its REST API ID and Root Resource ID in serverless.yml as follows:
+
+```yml
+service: service-name
+provider:
+  name: aws
+  apiGateway:
+    # REST API resource ID. Default is generated by the framework
+    restApiId: xxxxxxxxxx
+    # Root resource, represent as / path
+    restApiRootResourceId: xxxxxxxxxx
+
+functions:
+  ...
+```
+If your application has many nested paths, you might also want to break them out into smaller services.
+
+However, Cloudformation will throw an error if we try to generate an existing path resource. To avoid that, we reference the resource ID:
+
+```yml
+service: service-a
+provider:
+  apiGateway:
+    restApiId: xxxxxxxxxx
+    restApiRootResourceId: xxxxxxxxxx
+    # List of existing resources that were created in the REST API. This is required or the stack will be conflicted
+    restApiResources:
+      /users: xxxxxxxxxx
+
+functions:
+  ...
+```
+
+Now we can define endpoints using existing API Gateway ressources
+
+```yml
+stepFunctions:
+  stateMachines:
+    hello:
+      events:
+        - http:
+            path: users/create
+            method: POST
+```
+
 #### Enabling CORS
 
 To set CORS configurations for your HTTP endpoints, simply modify your event configurations as follows:
@@ -210,6 +257,21 @@ stepFunctions:
 
 Configuring the cors property sets Access-Control-Allow-Origin, Access-Control-Allow-Headers, Access-Control-Allow-Methods,Access-Control-Allow-Credentials headers in the CORS preflight response.
 
+To enable the Access-Control-Max-Age preflight response header, set the maxAge property in the cors object:
+
+```yml
+stepFunctions:
+  stateMachines:
+    SfnApiGateway:
+      events:
+        - http:
+            path: /playground/start
+            method: post
+            cors:
+              origin: '*'
+              maxAge: 86400
+```
+
 #### Customizing request body mapping templates
 
 The plugin generates default body mapping templates for `application/json` and `application/x-www-form-urlencoded` content types. If you'd like to add more content types or customize the default ones, you can do so by including them in `serverless.yml`:

lib/deploy/events/apiGateway/validate.js

@@ -26,6 +26,11 @@ module.exports = {
             cors.origin = http.cors.origin || '*';
             cors.allowCredentials = cors.allowCredentials || http.cors.allowCredentials;
 
+            // when merging, last one defined wins
+            if (_.has(http.cors, 'maxAge')) {
+              cors.maxAge = http.cors.maxAge;
+            }
+
             corsPreflight[http.path] = cors;
           }
 

lib/deploy/events/apiGateway/validate.test.js

@@ -413,4 +413,29 @@ describe('#httpValidate()', () => {
     expect(validated.events).to.be.an('Array').with.length(1);
     expect(validated.events[0].http.cors.methods).to.deep.equal(['POST', 'OPTIONS']);
   });
+
+  it('should set cors Access-Control-Max-Age headers', () => {
+    serverlessStepFunctions.serverless.service.stepFunctions = {
+      stateMachines: {
+        first: {
+          events: [
+            {
+              http: {
+                method: 'POST',
+                path: '/foo/bar',
+                cors: {
+                  origin: '*',
+                  maxAge: 86400,
+                },
+              },
+            },
+          ],
+        },
+      },
+    };
+
+    const validated = serverlessStepFunctions.httpValidate();
+    expect(validated.events[0].http.cors.origin).to.equal('*');
+    expect(validated.events[0].http.cors.maxAge).to.equal(86400);
+  });
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-step-functions",
-  "version": "1.6.0",
+  "version": "1.5.0",
   "description": "The module is AWS Step Functions plugin for Serverless Framework",
   "main": "lib/index.js",
   "scripts": {
@@ -32,7 +32,7 @@
     "istanbul": "^0.4.4",
     "mocha": "^5.2.0",
     "mocha-lcov-reporter": "^1.2.0",
-    "serverless": "^1.28.0",
+    "serverless": "^1.27.3",
     "sinon": "^1.17.5"
   },
   "dependencies": {