Merge pull request #297 from horike37/feature/api_gw_response_template

feat: support response headers and template

Author: theburningmonk

README.md

@@ -29,6 +29,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
          - [Shared Authorizer](#shared-authorizer)
          - [LAMBDA_PROXY request template](#lambda_proxy-request-template)
          - [Customizing request body mapping templates](#customizing-request-body-mapping-templates)
+         - [Customizing response headers and templates](#customizing-response-headers-and-templates)
          - [Send request to an API](#send-request-to-an-api)
          - [Setting API keys for your Rest API](#setting-api-keys-for-your-rest-api)
      - [Schedule](#schedule)
@@ -696,6 +697,31 @@ stepFunctions:
       definition:
 ```
 
+#### Customizing response headers and templates
+
+If you'd like to add custom headers in the HTTP response, or customize the default response template (which just returns the response from Step Function's StartExecution API), then you can do so by including your custom headers and [API Gateway response mapping template](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in `serverless.yml` like so:
+
+```yml
+stepFunctions:
+  stateMachines:
+    hello:
+      events:
+        - http:
+            path: posts/create
+            method: POST
+            response:
+              headers:
+                Content-Type: "'application/json'"
+                X-Application-Id: "'my-app'"
+              template:
+                application/json: |
+                  {
+                    "status": 200,
+                    "info": "OK"
+                  }
+      definition:
+```
+
 #### Send request to an API
 
 You can input an value as json in request body, the value is passed as the input value of your statemachine

lib/deploy/events/apiGateway/methods.js

@@ -182,13 +182,19 @@ module.exports = {
       ),
     };
 
+    const responseParams = _.mapKeys(
+      _.get(http, 'response.headers', {}),
+      (value, key) => `method.response.header.${key}`,
+    );
+    const responseTemplates = _.get(http, 'response.template', {});
+
     const integrationResponse = {
       IntegrationResponses: [
         {
           StatusCode: 200,
           SelectionPattern: 200,
-          ResponseParameters: {},
-          ResponseTemplates: {},
+          ResponseParameters: responseParams,
+          ResponseTemplates: responseTemplates,
         },
         {
           StatusCode: 400,
@@ -206,9 +212,8 @@ module.exports = {
       }
 
       integrationResponse.IntegrationResponses.forEach((val, i) => {
-        integrationResponse.IntegrationResponses[i].ResponseParameters = {
-          'method.response.header.Access-Control-Allow-Origin': `'${origin}'`,
-        };
+        integrationResponse.IntegrationResponses[i]
+          .ResponseParameters['method.response.header.Access-Control-Allow-Origin'] = `'${origin}'`;
       });
     }
 
@@ -298,11 +303,15 @@ module.exports = {
   },
 
   getMethodResponses(http) {
+    const responseParams = _.mapKeys(
+      _.get(http, 'response.headers', {}),
+      (value, key) => `method.response.header.${key}`,
+    );
     const methodResponse = {
       Properties: {
         MethodResponses: [
           {
-            ResponseParameters: {},
+            ResponseParameters: responseParams,
             ResponseModels: {},
             StatusCode: 200,
           },
@@ -322,9 +331,8 @@ module.exports = {
       }
 
       methodResponse.Properties.MethodResponses.forEach((val, i) => {
-        methodResponse.Properties.MethodResponses[i].ResponseParameters = {
-          'method.response.header.Access-Control-Allow-Origin': `'${origin}'`,
-        };
+        methodResponse.Properties.MethodResponses[i]
+          .ResponseParameters['method.response.header.Access-Control-Allow-Origin'] = `'${origin}'`;
       });
     }
 

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

@@ -141,6 +141,52 @@ describe('#methods()', () => {
         }).Properties.Integration.Uri['Fn::Join'][1][2])
           .to.equal(':states:action/DescribeExecution');
       });
+
+    it('should return a custom template for application/json when one is given',
+      () => {
+        const httpWithResponseTemplate = {
+          path: 'foo/bar1',
+          method: 'post',
+          response: {
+            template: {
+              'application/json': 'custom template',
+            },
+          },
+        };
+        const resource = serverlessStepFunctions
+          .getMethodIntegration('stateMachine', undefined, httpWithResponseTemplate);
+        const responseTemplates = resource
+          .Properties.Integration.IntegrationResponses
+          .find(x => x.StatusCode === 200)
+          .ResponseTemplates;
+        expect(responseTemplates['application/json'])
+          .to.be.equal('custom template');
+      });
+
+    it('should return custom headers when one is given',
+      () => {
+        const httpWithResponseHeaders = {
+          path: 'foo/bar1',
+          method: 'post',
+          response: {
+            headers: {
+              'Content-Type': 'text',
+              'X-Application-Id': 'id',
+            },
+          },
+        };
+        const resource = serverlessStepFunctions
+          .getMethodIntegration('stateMachine', undefined, httpWithResponseHeaders);
+
+        const intResponseParams = resource
+          .Properties.Integration.IntegrationResponses
+          .find(x => x.StatusCode === 200)
+          .ResponseParameters;
+        expect(intResponseParams['method.response.header.Content-Type'])
+          .to.be.equal('text');
+        expect(intResponseParams['method.response.header.X-Application-Id'])
+          .to.be.equal('id');
+      });
   });
 
   describe('#getIntegrationRequestTemplates()', () => {
@@ -322,6 +368,19 @@ describe('#methods()', () => {
           .ResponseParameters['method.response.header.Access-Control-Allow-Origin'])
           .to.equal('\'*\'');
       });
+
+    it('should set custom custom headers when one is given',
+      () => {
+        expect(serverlessStepFunctions.getMethodResponses({
+          response: {
+            headers: {
+              'X-Application-Id': 'id',
+            },
+          },
+        }).Properties.MethodResponses[0]
+          .ResponseParameters['method.response.header.X-Application-Id'])
+          .to.equal('id');
+      });
   });
 
   describe('#getMethodAuthorization()', () => {