Merge pull request #261 from agiledigital-labs/master

feat: pass through batching window parameter

Author: Sean Dawson

README.md

@@ -48,6 +48,7 @@ functions:
           name: TestEvent # Required - choose a name prefix for the event queue
           topicArn: !Ref Topic # Required - SNS topic to subscribe to
           batchSize: 2 # Optional - default value is 10
+          maximumBatchingWindowInSeconds: 10 # optional - default is 0 (no batch window)
           maxRetryCount: 2 # Optional - default value is 5
           kmsMasterKeyId: alias/aws/sqs # optional - default is none (no encryption)
           kmsDataKeyReusePeriodSeconds: 600 # optional - AWS default is 300 seconds

example-service/serverless.yml

@@ -17,6 +17,7 @@ functions:
           name: ResourcePrefix
           topicArn: ${self:custom.topicArn}
           batchSize: 2
+          maximumBatchingWindowInSeconds: 30
           maxRetryCount: 2
           kmsMasterKeyId: alias/aws/sqs
           kmsDataKeyReusePeriodSeconds: 600

lib/__snapshots__/serverless-sns-sqs-lambda.test.ts.snap

@@ -47,6 +47,7 @@ Object {
             "Arn",
           ],
         },
+        "MaximumBatchingWindowInSeconds": 99,
       },
       "Type": "AWS::Lambda::EventSourceMapping",
     },
@@ -95,6 +96,7 @@ Object {
             "Arn",
           ],
         },
+        "MaximumBatchingWindowInSeconds": 0,
       },
       "Type": "AWS::Lambda::EventSourceMapping",
     },
@@ -143,6 +145,7 @@ Object {
             "Arn",
           ],
         },
+        "MaximumBatchingWindowInSeconds": 0,
       },
       "Type": "AWS::Lambda::EventSourceMapping",
     },

lib/serverless-sns-sqs-lambda.test.ts

@@ -88,6 +88,7 @@ describe("Test Serverless SNS SQS Lambda", () => {
         name: "some name",
         topicArn: "some arn",
         batchSize: 7,
+        maximumBatchingWindowInSeconds: 99,
         prefix: "some prefix",
         maxRetryCount: 4,
         kmsMasterKeyId: "some key",

lib/serverless-sns-sqs-lambda.ts

@@ -13,6 +13,7 @@ type Config = {
   funcName: string;
   prefix: string;
   batchSize: number;
+  maximumBatchingWindowInSeconds: number;
   maxRetryCount: number;
   kmsMasterKeyId: string;
   kmsDataKeyReusePeriodSeconds: number;
@@ -61,16 +62,19 @@ const pascalCase = camelCase =>
  *         handler: handler.handler
  *         events:
  *           - snsSqs:
- *               name: Event
- *               topicArn: !Ref TopicArn
- *               maxRetryCount: 2                   # optional - default is 5
- *               batchSize: 1                       # optional - default is 10
- *               kmsMasterKeyId: alias/aws/sqs      # optional - default is none (no encryption)
- *               kmsDataKeyReusePeriodSeconds: 600  # optional - AWS default is 300 seconds
- *               filterPolicy:KmsMasterKeyId
- *                 pet:
- *                   - dog
- *                   - cat
+ *             name: ResourcePrefix
+ *             topicArn: ${self:custom.topicArn}
+ *             batchSize: 2
+ *             maximumBatchingWindowInSeconds: 30
+ *             maxRetryCount: 2
+ *             kmsMasterKeyId: alias/aws/sqs
+ *             kmsDataKeyReusePeriodSeconds: 600
+ *             visibilityTimeout: 120
+ *             rawMessageDelivery: true
+ *             filterPolicy:
+ *               pet:
+ *                 - dog
+ *                 - cat
  */
 export default class ServerlessSnsSqsLambda {
   serverless: any;
@@ -185,6 +189,7 @@ Usage
             prefix: some-prefix                              # optional - default is \`\${this.serviceName}-\${stage}-\${funcNamePascalCase}\`
             maxRetryCount: 2                                 # optional - default is 5
             batchSize: 1                                     # optional - default is 10
+            batchWindow: 10                                  # optional - default is 0 (no batch window)
             kmsMasterKeyId: alias/aws/sqs                    # optional - default is none (no encryption)
             kmsDataKeyReusePeriodSeconds: 600                # optional - AWS default is 300 seconds
             deadLetterMessageRetentionPeriodSeconds: 1209600 # optional - AWS default is 345600 secs (4 days)
@@ -230,14 +235,15 @@ Usage
    */
   addEventSourceMapping(
     template,
-    { funcName, name, batchSize, enabled }: Config
+    { funcName, name, batchSize, maximumBatchingWindowInSeconds, enabled }: Config
   ) {
     const enabledWithDefault = enabled !== undefined ? enabled : true;
     template.Resources[`${funcName}EventSourceMappingSQS${name}Queue`] = {
       Type: "AWS::Lambda::EventSourceMapping",
       DependsOn: "IamRoleLambdaExecution",
       Properties: {
         BatchSize: batchSize,
+        MaximumBatchingWindowInSeconds: maximumBatchingWindowInSeconds !== undefined ? maximumBatchingWindowInSeconds : 0,
         EventSourceArn: { "Fn::GetAtt": [`${name}Queue`, "Arn"] },
         FunctionName: { "Fn::GetAtt": [`${funcName}LambdaFunction`, "Arn"] },
         Enabled: enabledWithDefault ? "True" : "False"