Merge pull request #86 from metrics-credit-partners/master

feat(sqs): add request template support for sqs

Author: horike37

README.md

@@ -29,6 +29,7 @@ This Serverless Framework plugin supports the AWS service proxy integration feat
   - [Customizing API Gateway parameters](#customizing-api-gateway-parameters)
   - [Customizing request body mapping templates](#customizing-request-body-mapping-templates)
     - [Kinesis](#kinesis-1)
+    - [SQS](#sqs-1)
     - [SNS](#sns-1)
 
 ## Install
@@ -156,6 +157,12 @@ custom:
           'integration.request.querystring.MessageAttribute.2.Value.DataType': "'String'"
 ```
 
+The preferred way to pass `MessageAttribute` parameters is via a request body mapping template. Any `requestParameters` keys that begin with `integration.request.querystring.` will be automatically placed in the request body to maintain backward compatibility with existing implementations.
+
+#### Customizing request body mapping templates
+
+See the [SQS section](#sqs-1) under [Customizing request body mapping templates](#customizing-request-body-mapping-templates)
+
 #### Customizing responses
 
 ##### Simplified response template customization
@@ -705,6 +712,36 @@ custom:
 
 Source: [How to connect SNS to Kinesis for cross-account delivery via API Gateway](https://theburningmonk.com/2019/07/how-to-connect-sns-to-kinesis-for-cross-account-delivery-via-api-gateway/)
 
+#### SQS
+
+Customizing SQS request templates requires us to force all requests to use an `application/x-www-form-urlencoded` style body. The plugin sets the `Content-Type` to `application/x-www-form-urlencoded` for you, but API Gateway will still look for the template under the `application/json` request template type, so that is where you need to configure you request body in `serverless.yml`:
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - sqs:
+        path: /{version}/event/receiver
+        method: post
+        queueName: { 'Fn::GetAtt': ['SqsQueue', 'QueueName'] }
+        request:
+          template:
+            application/json: |-
+              #set ($body = $util.parseJson($input.body))
+              Action=SendMessage##
+              &MessageGroupId=$util.urlEncode($body.event_type)##
+              &MessageDeduplicationId=$util.urlEncode($body.event_id)##
+              &MessageAttribute.1.Name=$util.urlEncode("X-Custom-Signature")##
+              &MessageAttribute.1.Value.DataType=String##
+              &MessageAttribute.1.Value.StringValue=$util.urlEncode($input.params("X-Custom-Signature"))##
+              &MessageBody=$util.urlEncode($input.body)
+```
+
+Note that the `##` at the end of each line is an empty comment. In VTL this has the effect of stripping the newline from the end of the line (as it is commented out), which makes API Gateway read all the lines in the template as one line.
+
+Be careful when mixing additional `requestParameters` into your SQS endpoint as you may overwrite the `integration.request.header.Content-Type` and stop the request template from being parsed correctly. You may also unintentionally create conflicts between parameters passed using `requestParameters` and those in your request template. Typically you should only use the request template if you need to manipulate the incoming request body in some way.
+
+Your custom template must also set the `Action` and `MessageBody` parameters, as these will not be added for you by the plugin.
+
 #### SNS
 
 Similar to the [Kinesis](#kinesis-1) support, you can customize the default request mapping templates in `serverless.yml` like so:

lib/apiGateway/schema.js

@@ -266,6 +266,7 @@ const proxiesSchemas = {
     sqs: proxy.append({
       queueName: stringOrGetAtt('queueName', 'QueueName').required(),
       requestParameters,
+      request,
       response: sqsResponse
     })
   }),

lib/apiGateway/validate.test.js

@@ -1555,6 +1555,63 @@ describe('#validateServiceProxies()', () => {
 
       expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.not.throw()
     })
+
+    it('should throw error if request is missing the template property', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sqs: {
+              path: '/sqs',
+              method: 'post',
+              queueName: 'queueName',
+              request: { xxx: { 'application/json': 'mappingTemplate' } }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        'child "sqs" fails because [child "request" fails because [child "template" fails because ["template" is required]]]'
+      )
+    })
+
+    it('should throw error if request is not a mapping template object', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sqs: {
+              path: '/sqs',
+              method: 'post',
+              queueName: 'queueName',
+              request: { template: [] }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        'child "sqs" fails because [child "request" fails because [child "template" fails because ["template" must be an object]]]'
+      )
+    })
+
+    it('should not throw error if request is a mapping template object', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sqs: {
+              path: '/sqs',
+              method: 'post',
+              queueName: 'queueName',
+              request: { template: { 'application/json': 'mappingTemplate' } }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.not.throw()
+    })
   })
 
   describe('dynamodb', () => {

lib/package/sqs/compileMethodsToSqs.js

@@ -2,6 +2,9 @@
 
 const _ = require('lodash')
 
+const requestParameterIsQuerystring = (_value, parameter) =>
+  parameter.trim().startsWith('integration.request.querystring.')
+
 module.exports = {
   compileMethodsToSqs() {
     this.validated.events.forEach((event) => {
@@ -58,14 +61,14 @@ module.exports = {
           { queueName: http.queueName }
         ]
       },
+      PassthroughBehavior: 'NEVER',
       RequestParameters: _.merge(
         {
-          'integration.request.querystring.Action': "'SendMessage'",
-          'integration.request.querystring.MessageBody': 'method.request.body'
+          'integration.request.header.Content-Type': "'application/x-www-form-urlencoded'"
         },
-        http.requestParameters
+        _.omitBy(http.requestParameters, requestParameterIsQuerystring)
       ),
-      RequestTemplates: { 'application/json': '{statusCode:200}' }
+      RequestTemplates: this.getSqsIntegrationRequestTemplates(http)
     }
 
     let integrationResponse
@@ -140,6 +143,45 @@ module.exports = {
     }
   },
 
+  getSqsIntegrationRequestTemplates(http) {
+    const defaultRequestTemplates = this.getDefaultSqsRequestTemplates(http)
+    const customRequestTemplates = _.get(http, ['request', 'template'])
+    let requestParametersQuerystrings = _.pickBy(
+      http.requestParameters,
+      requestParameterIsQuerystring
+    )
+
+    if (_.isEmpty(customRequestTemplates) && !_.isEmpty(requestParametersQuerystrings)) {
+      requestParametersQuerystrings = _.map(requestParametersQuerystrings, (value, parameter) => {
+        return [
+          parameter.trim().replace('integration.request.querystring.', ''),
+          value
+            .trim()
+            .replace(/^context\.(.+)$/, '$$util.urlEncode($$context.$1)')
+            .replace(/(^')|('$)/g, '')
+        ].join('=')
+      })
+
+      return {
+        'application/json': `${
+          defaultRequestTemplates['application/json']
+        }&${requestParametersQuerystrings.join('&')}`
+      }
+    }
+
+    return Object.assign(defaultRequestTemplates, customRequestTemplates)
+  },
+
+  getDefaultSqsRequestTemplates() {
+    return {
+      'application/json': this.buildDefaultSqsRequestTemplate()
+    }
+  },
+
+  buildDefaultSqsRequestTemplate() {
+    return 'Action=SendMessage&MessageBody=$util.urlEncode($input.body)'
+  },
+
   getSQSIntegrationResponseTemplate(http, statusType) {
     const template = _.get(http, ['response', 'template', statusType])
     return Object.assign({}, template && { 'application/json': template })