Merge pull request #178 from jlangsu/master

lopburny · web-flow · commit 715b02f12605 · 2022-09-02T17:12:45.000+09:00
feat(dynamodb): add response template support for dynamodb
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ This Serverless Framework plugin supports the AWS service proxy integration feat
   - [SNS](#sns)
     - [Customizing responses](#customizing-responses-2)
   - [DynamoDB](#dynamodb)
+    - [Customizing responses](#customizing-responses-3)
   - [EventBridge](#eventbridge)
 - [Common API Gateway features](#common-api-gateway-features)
   - [Enabling CORS](#enabling-cors)
@@ -446,7 +447,7 @@ custom:
           template:
             # `success` is used when the integration response is 200
             success: |-
-              { "message: "accepted" }
+              { "message": "accepted" }
             # `clientError` is used when the integration response is 400
             clientError: |-
               { "message": "there is an error in your request" }
@@ -568,6 +569,69 @@ curl -XPUT https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/dynamodb/<has
  -H 'Content-Type:application/json'
 ```
 
+#### Customizing responses
+
+##### Simplified response template customization
+
+You can get a simple customization of the responses by providing a template for the possible responses. The template returns the same kind of response for both `application/json` and `application/x-www-form-urlendcoded`.
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - dynamodb:
+        path: /dynamodb
+        method: get
+        tableName: { Ref: 'YourTable' }
+        hashKey:
+          queryStringParam: id # use query string parameter
+          attributeType: S
+        rangeKey:
+          queryStringParam: sort
+          attributeType: S
+        action: GetItem
+        cors: true
+        response:
+          template:
+            # `success` is used when the integration response is 200
+            success: |-
+              #set($item = $input.path('$.Item')){ "Item": $item }
+            # `clientError` is used when the integration response is 400
+            clientError: |-
+              { "message": "there is an error in your request" }
+            # `serverError` is used when the integration response is 500
+            serverError: |-
+              { "message": "there was an error handling your request" }
+```
+
+##### Full response customization
+
+If you want more control over the integration response, you can
+provide an array of objects for the `response` value:
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - dynamodb:
+        path: /dynamodb
+        method: get
+        tableName: { Ref: 'YourTable' }
+        hashKey:
+          queryStringParam: id # use query string parameter
+          attributeType: S
+        rangeKey:
+          queryStringParam: sort
+          attributeType: S
+        action: GetItem
+        cors: true
+        response:
+          - statusCode: 200
+            selectionPattern: '2\\d{2}'
+            responseParameters: {}
+            responseTemplates:
+              application/json: |-
+                #set($item = $input.path('$.Item')){ "Item": $item }
+
+```
 
 ### EventBridge
 
diff --git a/lib/apiGateway/schema.js b/lib/apiGateway/schema.js
@@ -300,7 +300,9 @@ const proxiesSchemas = {
       condition: Joi.string(),
       hashKey: dynamodbDefaultKeyScheme.required(),
       rangeKey: dynamodbDefaultKeyScheme,
-      request
+      requestParameters,
+      request,
+      response: extendedResponse
     })
   }),
   eventbridge: Joi.object({
diff --git a/lib/package/dynamodb/compileMethodsToDynamodb.js b/lib/package/dynamodb/compileMethodsToDynamodb.js
@@ -14,7 +14,7 @@ module.exports = {
           Type: 'AWS::ApiGateway::Method',
           Properties: {
             HttpMethod: event.http.method.toUpperCase(),
-            RequestParameters: {},
+            RequestParameters: event.http.acceptParameters || {},
             AuthorizationType: event.http.auth.authorizationType,
             AuthorizationScopes: event.http.auth.authorizationScopes,
             AuthorizerId: event.http.auth.authorizerId,
@@ -58,30 +58,68 @@ module.exports = {
         ]
       },
       PassthroughBehavior: 'NEVER',
+      RequestParameters: this.getDynamodbIntegrationRequestParameters(http),
       RequestTemplates: this.getDynamodbIntegrationRequestTemplates(http)
     }
 
-    const integrationResponse = {
-      IntegrationResponses: [
-        {
-          StatusCode: 200,
-          SelectionPattern: '2\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: this.getDefaultDynamodbResponseTemplates(http)
-        },
-        {
-          StatusCode: 400,
-          SelectionPattern: '4\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: {}
-        },
-        {
-          StatusCode: 500,
-          SelectionPattern: '5\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: {}
-        }
-      ]
+    let integrationResponse
+
+    if (_.get(http.response, 'template.success')) {
+      // support a simplified model
+      integrationResponse = {
+        IntegrationResponses: [
+          {
+            StatusCode: 200,
+            SelectionPattern: 200,
+            ResponseParameters: {},
+            ResponseTemplates: this.getDynamodbResponseTemplates(http, 'success')
+          },
+          {
+            StatusCode: 400,
+            SelectionPattern: 400,
+            ResponseParameters: {},
+            ResponseTemplates: this.getDynamodbResponseTemplates(http, 'clientError')
+          },
+          {
+            StatusCode: 500,
+            SelectionPattern: 500,
+            ResponseParameters: {},
+            ResponseTemplates: this.getDynamodbResponseTemplates(http, 'serverError')
+          }
+        ]
+      }
+    } else if (_.isArray(http.response)) {
+      integrationResponse = {
+        IntegrationResponses: http.response.map((i) => ({
+          StatusCode: i.statusCode,
+          SelectionPattern: i.selectionPattern || i.statusCode,
+          ResponseParameters: i.responseParameters || {},
+          ResponseTemplates: i.responseTemplates || {}
+        }))
+      }
+    } else {
+      integrationResponse = {
+        IntegrationResponses: [
+          {
+            StatusCode: 200,
+            SelectionPattern: '2\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: this.getDefaultDynamodbResponseTemplates(http, 'success')
+          },
+          {
+            StatusCode: 400,
+            SelectionPattern: '4\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: {}
+          },
+          {
+            StatusCode: 500,
+            SelectionPattern: '5\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: {}
+          }
+        ]
+      }
     }
 
     this.addCors(http, integrationResponse)
@@ -107,6 +145,15 @@ module.exports = {
     }
   },
 
+  getDynamodbIntegrationRequestParameters(http) {
+    const defaultRequestParameters = this.buildDefaultDynamodbRequestParameters(http)
+    return Object.assign(defaultRequestParameters, _.get(http, ['requestParameters']))
+  },
+
+  buildDefaultDynamodbRequestParameters(http) {
+    return _.merge({}, http.requestParameters)
+  },
+
   getDynamodbObjectHashkeyParameter(http) {
     if (http.hashKey.pathParam) {
       return {
@@ -143,6 +190,17 @@ module.exports = {
     }
   },
 
+  getDynamodbResponseTemplates(http, statusType) {
+    const template = _.get(http, ['response', 'template', statusType])
+    return Object.assign(
+      {},
+      template && {
+        'application/json': template,
+        'application/x-www-form-urlendcoded': template
+      }
+    )
+  },
+
   getDefaultDynamodbResponseTemplates(http) {
     if (http.action === 'GetItem') {
       return {
diff --git a/lib/package/dynamodb/compileMethodsToDynamodb.test.js b/lib/package/dynamodb/compileMethodsToDynamodb.test.js
@@ -84,7 +84,15 @@ describe('#compileMethodsToDynamodb()', () => {
   })
 
   const testSingleProxy = (opts) => {
-    const { http, logicalId, method, intRequestTemplates, uri, intResponseTemplates } = opts
+    const {
+      http,
+      logicalId,
+      method,
+      requestParams,
+      intRequestTemplates,
+      uri,
+      intResponseTemplates
+    } = opts
 
     serverlessApigatewayServiceProxy.validated = {
       events: [
@@ -112,6 +120,7 @@ describe('#compileMethodsToDynamodb()', () => {
         AuthorizerId: http.auth.authorizerId,
         Integration: {
           Uri: uri,
+          RequestParameters: requestParams,
           RequestTemplates: intRequestTemplates,
           IntegrationResponses: [
             {
@@ -158,7 +167,7 @@ describe('#compileMethodsToDynamodb()', () => {
       logicalId: `ApiGatewayMethoddynamodb${http.method.substring(0, 1).toUpperCase() +
         http.method.substring(1)}`,
       method: http.method.toUpperCase(),
-      requestParams,
+      requestParams: params.RequestParameters || requestParams,
       intRequestTemplates,
       uri,
       intResponseTemplates
@@ -786,6 +795,7 @@ describe('#compileMethodsToDynamodb()', () => {
                 ]
               },
               PassthroughBehavior: 'NEVER',
+              RequestParameters: {},
               RequestTemplates: {
                 'application/json': {
                   'Fn::Sub': [
@@ -902,6 +912,7 @@ describe('#compileMethodsToDynamodb()', () => {
                 ]
               },
               PassthroughBehavior: 'NEVER',
+              RequestParameters: {},
               RequestTemplates: {
                 'application/json': {
                   'Fn::Sub': [
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "serverless-apigateway-service-proxy",
   "version": "2.0.0",
-  "description": "The Serverless Framewrok plugin for supporting AWS service proxy integration of API Gateway",
+  "description": "The Serverless Framework plugin for supporting AWS service proxy integration of API Gateway",
   "main": "lib/index.js",
   "scripts": {
     "lint": "eslint .",

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "serverless-apigateway-service-proxy",`
`3`	`3`	`"version": "2.0.0",`
`4`		`- "description": "The Serverless Framewrok plugin for supporting AWS service proxy integration of API Gateway",`
	`4`	`+ "description": "The Serverless Framework plugin for supporting AWS service proxy integration of API Gateway",`
`5`	`5`	`"main": "lib/index.js",`
`6`	`6`	`"scripts": {`
`7`	`7`	`"lint": "eslint .",`