feat: allow passing requestParameters to s3 integration

Author: erezrokah

README.md

@@ -176,6 +176,27 @@ Sample request after deploying.
 curl https://xxxxxx.execute-api.us-east-1.amazonaws.com/dev/s3 -d '{"message": "testtest"}' -H 'Content-Type:application/json'
 ```
 
+#### Customizing request parameters
+
+Similar to the [SQS](#sqs) support, you can customize the default request parameters `serverless.yml` like so:
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - s3:
+        path: /s3
+        method: post
+        action: PutObject
+        bucket:
+          Ref: S3Bucket
+        key: static-key.json
+        cors: true
+
+        requestParameters:
+          # use auto generated object key (will override the static key)
+          'integration.request.path.object': 'context.requestId'
+```
+
 ### SNS
 
 Sample syntax for SNS proxy in `serverless.yml`.

lib/apiGateway/schema.js

@@ -157,7 +157,8 @@ const proxiesSchemas = {
         .valid('GetObject', 'PutObject', 'DeleteObject')
         .required(),
       bucket: stringOrRef.required(),
-      key: key.required()
+      key: key.required(),
+      requestParameters
     })
   }),
   sns: Joi.object({

lib/apiGateway/validate.test.js

@@ -581,7 +581,6 @@ describe('#validateServiceProxies()', () => {
 
     const proxiesToTest = [
       { proxy: 'kinesis', props: { streamName: 'streamName' } },
-      { proxy: 's3', props: { bucket: 'bucket', action: 'PutObject', key: 'myKey' } },
       { proxy: 'sns', props: { topicName: 'topicName' } }
     ]
     proxiesToTest.forEach(({ proxy, props }) => {
@@ -1015,6 +1014,18 @@ describe('#validateServiceProxies()', () => {
         { param: 'myKey' }
       )
     })
+
+    it('should throw if requestParameters is not a string to string mapping', () => {
+      shouldError(
+        'child "s3" fails because [child "requestParameters" fails because [child "key2" fails because ["key2" must be a string]]]',
+        'requestParameters',
+        { key1: 'value', key2: [] }
+      )
+    })
+
+    it('should not throw if requestParameters is a string to string mapping', () => {
+      shouldSucceed('requestParameters', { key1: 'value1', key2: 'value2' })
+    })
   })
 
   describe('sns', () => {

lib/package/s3/compileMethodsToS3.js

@@ -141,7 +141,7 @@ module.exports = {
         'Fn::Sub': ['arn:aws:apigateway:${AWS::Region}:s3:path/{bucket}/{object}', {}]
       },
       PassthroughBehavior: 'WHEN_NO_MATCH',
-      RequestParameters: requestParams
+      RequestParameters: _.merge(requestParams, http.requestParameters)
     }
 
     const integrationResponse = {

lib/package/s3/compileMethodsToS3.test.js

@@ -567,4 +567,63 @@ describe('#compileMethodsToS3()', () => {
 
     expect(serverless.service.provider.compiledCloudFormationTemplate.Resources).to.be.empty
   })
+
+  const testRequestParameters = (requestParametersOverride) => {
+    const http = {
+      path: 's3',
+      method: 'post',
+      bucket: {
+        Ref: 'MyBucket'
+      },
+      action: 'PutObject',
+      key: 'static',
+      auth: { authorizationType: 'NONE' },
+      requestParameters: requestParametersOverride
+    }
+
+    const requestParams = {
+      'method.request.header.Content-Type': true
+    }
+
+    const intRequestParams = {
+      'integration.request.path.object': 'method.request.path.key',
+      'integration.request.path.bucket': {
+        'Fn::Sub': [
+          "'${bucket}'",
+          {
+            bucket: {
+              Ref: 'MyBucket'
+            }
+          }
+        ]
+      },
+      'integration.request.header.x-amz-acl': "'authenticated-read'",
+      'integration.request.header.Content-Type': 'method.request.header.Content-Type'
+    }
+
+    const responseParams = {
+      'method.response.header.Content-Type': true,
+      'method.response.header.Content-Length': true
+    }
+
+    const intResponseParams = {
+      'method.response.header.Content-Type': 'integration.response.header.Content-Type',
+      'method.response.header.Content-Length': 'integration.response.header.Content-Length'
+    }
+
+    testSingleProxy({
+      http,
+      logicalId: 'ApiGatewayMethods3Post',
+      method: 'POST',
+      intMethod: 'PUT',
+      requestParams: requestParams,
+      intRequestParams: _.merge(intRequestParams, requestParametersOverride),
+      responseParams,
+      intResponseParams
+    })
+  }
+
+  it('should add custom request parameters mapping', () => {
+    testRequestParameters({ 'integration.request.path.object': 'context.requestId' })
+  })
 })