@mapbox/cloudfriend 8.1.0-dev → 8.1.0

package/lib/shortcuts/api.md

@@ -394,7 +394,6 @@ Log Group, a Role, an Alarm on function errors, and the Lambda Function itself.
 | [options.DeadLetterConfig] | <code>Object</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig). |
 | [options.Description] | <code>String</code> | <code>&#x27;${logical name} in the ${stack name} stack&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description). |
 | [options.Environment] | <code>Object</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment). |
-| [options.FilterCriteria] | <code>Object</code> |  | See [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) |
 | [options.FunctionName] | <code>String</code> | <code>&#x27;${stack name}-${logical name}&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname). |
 | [options.Handler] | <code>String</code> | <code>&#x27;index.handler&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler). |
 | [options.KmsKeyArn] | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn). |
@@ -783,6 +782,7 @@ source mapping.
 | [options.MaximumBatchingWindowInSeconds] | <code>Number</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds). |
 | [options.Enabled] | <code>Boolean</code> | <code>true</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled). |
 | [options.StartingPosition] | <code>String</code> | <code>&#x27;LATEST&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition). |
+| [options.FilterCriteria] | <code>Object</code> |  | See [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). |
 
 **Example**  
 ```js
@@ -796,8 +796,25 @@ const lambda = new cf.shortcuts.StreamLambda({
     S3Bucket: 'my-code-bucket',
     S3Key: 'path/to/code.zip'
   },
-  EventSourceArn: cf.getAtt('MyStream', 'Arn')
+  EventSourceArn: cf.getAtt('MyStream', 'Arn'),
 });
 
-module.exports = cf.merge(myTemplate, lambda);
+// This lambda only gets invoked for 'INSERT' events for the DynamoDb event source
+const lambdaWithFilterCriteria = new cf.shortcuts.StreamLambda({
+ LogicalName: 'MyLambdaWithFilterCriteria',
+ Code: {
+   S3Bucket: 'my-code-bucket',
+   S3Key: 'path/to/code.zip'
+ },
+ EventSourceArn: cf.getAtt('MyDynamoDbStream', 'Arn'),
+ FilterCriteria: {
+   Filters: [
+     {
+       Pattern: JSON.stringify({ eventName: ['INSERT'] }),
+     }
+   ]
+ }
+});
+
+module.exports = cf.merge(myTemplate, lambda, lambdaWithFilterCriteria);
 ```

package/lib/shortcuts/stream-lambda.js

@@ -26,10 +26,27 @@ const Lambda = require('./lambda');
  *     S3Bucket: 'my-code-bucket',
  *     S3Key: 'path/to/code.zip'
  *   },
- *   EventSourceArn: cf.getAtt('MyStream', 'Arn')
+ *   EventSourceArn: cf.getAtt('MyStream', 'Arn'),
  * });
  *
- * module.exports = cf.merge(myTemplate, lambda);
+ * // This lambda only gets invoked for 'INSERT' events for the DynamoDb event source
+ * const lambdaWithFilterCriteria = new cf.shortcuts.StreamLambda({
+ *  LogicalName: 'MyLambdaWithFilterCriteria',
+ *  Code: {
+ *    S3Bucket: 'my-code-bucket',
+ *    S3Key: 'path/to/code.zip'
+ *  },
+ *  EventSourceArn: cf.getAtt('MyDynamoDbStream', 'Arn'),
+ *  FilterCriteria: {
+ *    Filters: [
+ *      {
+ *        Pattern: JSON.stringify({ eventName: ['INSERT'] }),
+ *      }
+ *    ]
+ *  }
+ * });
+ *
+ * module.exports = cf.merge(myTemplate, lambda, lambdaWithFilterCriteria);
  */
 class StreamLambda extends Lambda {
   constructor(options) {
@@ -61,8 +78,23 @@ class StreamLambda extends Lambda {
         StartingPosition
       }
     };
-
     if (FilterCriteria) {
+      if (Object.prototype.toString.call(FilterCriteria) !== '[object Object]'){
+        throw new Error('`FilterCriteria` must be a JSON-like object');
+      }
+      if (!(FilterCriteria.Filters && Array.isArray(FilterCriteria.Filters))){
+        throw new Error('`FilterCriteria` must contain property `Filter` of type array');
+      }
+      for (const filter of FilterCriteria.Filters){
+        if (!filter.Pattern){
+          throw new Error('An object in `FilterCriteria.Filter` was missing the required property `Pattern`');
+        }
+        try {
+          JSON.parse(filter.Pattern);
+        } catch (error) {
+          throw new Error('An object in `FilterCriteria.Filter` contains a `Pattern` property that is not a JSON parseable string');
+        }
+      }
       this.Resources[`${this.LogicalName}EventSource`].Properties.FilterCriteria = FilterCriteria;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/cloudfriend",
-  "version": "8.1.0-dev",
+  "version": "8.1.0",
   "description": "Helper functions for assembling CloudFormation templates in JavaScript",
   "main": "index.js",
   "engines": {

package/test/fixtures/shortcuts/stream-lambda-no-defaults.json

@@ -167,6 +167,13 @@
       "Properties": {
         "BatchSize": 10000,
         "MaximumBatchingWindowInSeconds": 300,
+        "FilterCriteria": {
+          "Filters": [
+            {
+              "Pattern": "{\"eventName\":[\"INSERT\",\"MODIFY\"]}"
+            }
+          ]
+        },
         "Enabled": false,
         "EventSourceArn": "arn:aws:kinesis:us-east-1:123456789012:stream/fake",
         "FunctionName": {
@@ -177,4 +184,4 @@
     }
   },
   "Outputs": {}
-}
+}

package/test/shortcuts.test.js

@@ -475,6 +475,13 @@ test('[shortcuts] stream-lambda', (assert) => {
       S3Key: 'path/to/code.zip'
     },
     EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+    FilterCriteria: {
+      Filters: [
+        {
+          Pattern: JSON.stringify({ eventName: ['INSERT', 'MODIFY'] })
+        }
+      ]
+    },
     BatchSize: 10000,
     MaximumBatchingWindowInSeconds: 300,
     Enabled: false,
@@ -492,6 +499,90 @@ test('[shortcuts] stream-lambda', (assert) => {
   assert.end();
 });
 
+test('[shortcuts] StreamLambda FilterCriteria', (assert) => {
+  assert.throws(
+    () => new cf.shortcuts.StreamLambda({
+      LogicalName: 'MyLambda',
+      Code: {
+        S3Bucket: 'my-code-bucket',
+        S3Key: 'path/to/code.zip'
+      },
+      EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+      FilterCriteria: ['test']
+    }),
+    '`FilterCriteria` must be a JSON-like object',
+  );
+  assert.throws(
+    () => new cf.shortcuts.StreamLambda({
+      LogicalName: 'MyLambda',
+      Code: {
+        S3Bucket: 'my-code-bucket',
+        S3Key: 'path/to/code.zip'
+      },
+      EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+      FilterCriteria: {}
+    }),
+    '`FilterCriteria` must contain property `Filter` of type array',
+  );
+  assert.throws(
+    () => new cf.shortcuts.StreamLambda({
+      LogicalName: 'MyLambda',
+      Code: {
+        S3Bucket: 'my-code-bucket',
+        S3Key: 'path/to/code.zip'
+      },
+      EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+      FilterCriteria: {
+        Filter: 613
+      }
+    }),
+    '`FilterCriteria` must contain property `Filter` of type array',
+  );
+  assert.throws(
+    () => new cf.shortcuts.StreamLambda({
+      LogicalName: 'MyLambda',
+      Code: {
+        S3Bucket: 'my-code-bucket',
+        S3Key: 'path/to/code.zip'
+      },
+      EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+      FilterCriteria: {
+        Filters: [
+          {
+            NotPattern: JSON.stringify({ eventName: ['INSERT', 'MODIFY'] })
+          },
+          {
+            Pattern: JSON.stringify({ eventName: ['INSERT', 'MODIFY'] })
+          }
+        ]
+      }
+    }),
+    'An object in `FilterCriteria.Filter` was missing the required property `Pattern`',
+  );
+  assert.throws(
+    () => new cf.shortcuts.StreamLambda({
+      LogicalName: 'MyLambda',
+      Code: {
+        S3Bucket: 'my-code-bucket',
+        S3Key: 'path/to/code.zip'
+      },
+      EventSourceArn: 'arn:aws:kinesis:us-east-1:123456789012:stream/fake',
+      FilterCriteria: {
+        Filters: [
+          {
+            Pattern: '{"eventName":["INSERT","MODIFY"]}'
+          },
+          {
+            Pattern: { eventName: ['INSERT', 'MODIFY'] }
+          }
+        ]
+      }
+    }),
+    'An object in `FilterCriteria.Filter` contains a `Pattern` property that is not a JSON parseable string',
+  );
+  assert.end();
+});
+
 test('[shortcuts] log-subscription-lambda', (assert) => {
   assert.throws(
     () => new cf.shortcuts.LogSubscriptionLambda(),

package/.idea/cloudfriend.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/cloudfriend.iml" filepath="$PROJECT_DIR$/.idea/cloudfriend.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>