@mapbox/cloudfriend 8.1.0-dev.2 → 8.2.0

package/changelog.md

@@ -1,8 +1,12 @@
 # Changelog
 
+## 8.2.0
+
+- Add `LogRetentionInDays` option to Lambda shortcuts
+
 ## 8.1.0
 
-- Allow `FilterCriteria` property to be defined for Lambda shortcuts
+- Allow `FilterCriteria` property to be defined for Stream Lambda shortcuts
 
 ## 8.0.0
 
@@ -25,7 +29,7 @@ When you make this update, you will no longer see a trigger on your scheduled la
 ## 7.1.0
 
 - Add support for `Fn::ForEach`. With `Fn::ForEach`, you can replicate parts of your templates with minimal lines of code, as per the [official AWS announcement](https://aws.amazon.com/about-aws/whats-new/2023/07/accelerate-cloudformation-authoring-experience-looping-function/) and [the documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-foreach.html).
-  
+
 ## v7.0.1
 
 - Fixes `hookshot.Passthrough` and `hookshot.Github` shortcuts where inline code lambdas were using AWS SDK v2 while the lambda default runtime is `nodejs18.x`, by switching to AWS SDK v3.
@@ -47,23 +51,29 @@ When you make this update, you will no longer see a trigger on your scheduled la
 - Dependency updates to avoid security vulnerabilities (minimist).
 
 ## v5.1.0
+
 - Lambda shortcuts now support custom Docker images.
 
 ## v5.0.2
+
 - Fixes handling custom access log formats in hookshot shortcuts.
 
 ## v5.0.1
+
 - Improves data type mappings between Glue and Presto when using the `GluePrestoView` shortcut.
 
 ## v5.0.0
+
 - The Lambda shortcuts now use `nodejs12.x` as the default runtime.
 - There is no longer any constraint on the useable Lambda runtimes.
 
 ## v4.6.0
+
 - Adds top-level `Rules` section support to `cf.merge`. Each key in `Rules` must have a unique name.
 - Adds rule-specific intrinsic functions: `contains`, `eachMemberEquals`, `eachMemberIn`, `refAll`, `valueOf`, `valueOfAll`
 
 ## v4.5.1
+
 - Fixes a bug present in v4.4.0 and v4.5.0 where Lambda shortcuts' Conditions were not passed to the generated IAM Roles.
 
 ## v4.5.0
@@ -174,7 +184,7 @@ When you make this update, you will no longer see a trigger on your scheduled la
 ## v2.8.0
 
 - Allows Hookshot callers to bring their own webhook secret. This is used for
-signature-verification in the `.Github()` case.
+  signature-verification in the `.Github()` case.
 
 ## v2.7.0
 

package/lib/shortcuts/api.md

@@ -422,6 +422,7 @@ Log Group, a Role, an Alarm on function errors, and the Lambda Function itself.
 | [options.EvaluateLowSampleCountPercentile] | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile). |
 | [options.ExtendedStatistic] | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic)] |
 | [options.OKActions] | <code>Array.&lt;String&gt;</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions). |
+| [options.LogRetentionInDays] | <code>Number</code> | <code>14</code> | How long to retain CloudWatch logs for this Lambda function. See [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) for allowed values. |
 
 **Example**  
 ```js
@@ -796,8 +797,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/lambda.js

@@ -46,6 +46,7 @@ const ServiceRole = require('./service-role');
  * @param {String} [options.EvaluateLowSampleCountPercentile=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile).
  * @param {String} [options.ExtendedStatistic=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic)]
  * @param {Array<String>} [options.OKActions=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions).
+ * @param {Number} [options.LogRetentionInDays=14] - How long to retain CloudWatch logs for this Lambda function. See [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) for allowed values.
  *
  * @example
  * const cf = require('@mapbox/cloudfriend');
@@ -104,7 +105,8 @@ class Lambda {
       TreatMissingData = 'notBreaching',
       EvaluateLowSampleCountPercentile,
       ExtendedStatistic,
-      OKActions
+      OKActions,
+      LogRetentionInDays = 14
     } = options;
 
     if (options.EvaluationPeriods < Math.ceil(Timeout / Period))
@@ -138,7 +140,7 @@ class Lambda {
           LogGroupName: {
             'Fn::Sub': ['/aws/lambda/${name}', { name: FunctionName }]
           },
-          RetentionInDays: 14
+          RetentionInDays: LogRetentionInDays
         }
       },
 

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) {
@@ -68,9 +85,6 @@ class StreamLambda extends Lambda {
       if (!(FilterCriteria.Filters && Array.isArray(FilterCriteria.Filters))){
         throw new Error('`FilterCriteria` must contain property `Filter` of type array');
       }
-      if (FilterCriteria.Filters.length > 5){
-        throw new Error('`FilterCriteria.Filter` cannot contain more than 5 items, you may request a quota increase with AWS support if required.');
-      }
       for (const filter of FilterCriteria.Filters){
         if (!filter.Pattern){
           throw new Error('An object in `FilterCriteria.Filter` was missing the required property `Pattern`');

package/package.json

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

package/test/fixtures/shortcuts/lambda-full.json

@@ -6,10 +6,7 @@
   "Mappings": {},
   "Conditions": {
     "Always": {
-      "Fn::Equals": [
-        "1",
-        "1"
-      ]
+      "Fn::Equals": ["1", "1"]
     }
   },
   "Resources": {
@@ -28,7 +25,7 @@
             }
           ]
         },
-        "RetentionInDays": 14
+        "RetentionInDays": 30
       }
     },
     "MyLambda": {
@@ -52,9 +49,7 @@
         "FunctionName": "my-function",
         "Handler": "index.something",
         "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/fake",
-        "Layers": [
-          "arn:aws:fake:layer/abc"
-        ],
+        "Layers": ["arn:aws:fake:layer/abc"],
         "MemorySize": 512,
         "ReservedConcurrentExecutions": 10,
         "Runtime": "nodejs18.x",
@@ -63,12 +58,8 @@
           "Mode": "Active"
         },
         "VpcConfig": {
-          "SecurityGroupIds": [
-            "sg-12345"
-          ],
-          "SubnetIds": [
-            "fake"
-          ]
+          "SecurityGroupIds": ["sg-12345"],
+          "SubnetIds": ["fake"]
         },
         "Tags": [
           {
@@ -77,10 +68,7 @@
           }
         ],
         "Role": {
-          "Fn::GetAtt": [
-            "MyLambdaRole",
-            "Arn"
-          ]
+          "Fn::GetAtt": ["MyLambdaRole", "Arn"]
         }
       }
     },
@@ -90,9 +78,7 @@
       "Properties": {
         "AlarmName": "my-alarm",
         "AlarmDescription": "some alarm",
-        "AlarmActions": [
-          "devnull@mapbox.com"
-        ],
+        "AlarmActions": ["devnull@mapbox.com"],
         "Period": 120,
         "EvaluationPeriods": 2,
         "DatapointsToAlarm": 1,
@@ -101,9 +87,7 @@
         "ComparisonOperator": "LessThanThreshold",
         "TreatMissingData": "breaching",
         "EvaluateLowSampleCountPercentile": "ignore",
-        "OKActions": [
-          "devnull@mapbox.com"
-        ],
+        "OKActions": ["devnull@mapbox.com"],
         "Namespace": "AWS/Lambda",
         "Dimensions": [
           {
@@ -134,10 +118,7 @@
               "Effect": "Allow",
               "Action": "logs:*",
               "Resource": {
-                "Fn::GetAtt": [
-                  "MyLambdaLogs",
-                  "Arn"
-                ]
+                "Fn::GetAtt": ["MyLambdaLogs", "Arn"]
               }
             }
           ]
@@ -180,4 +161,4 @@
     }
   },
   "Outputs": {}
-}
+}

package/test/shortcuts.test.js

@@ -190,7 +190,8 @@ test('[shortcuts] lambda', (assert) => {
     TreatMissingData: 'breaching',
     EvaluateLowSampleCountPercentile: 'ignore',
     ExtendedStatistics: 'p100',
-    OKActions: ['devnull@mapbox.com']
+    OKActions: ['devnull@mapbox.com'],
+    LogRetentionInDays: 30
   });
 
   template = cf.merge(
@@ -538,39 +539,6 @@ test('[shortcuts] StreamLambda FilterCriteria', (assert) => {
     }),
     '`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: [
-          {
-            Pattern: JSON.stringify({ eventName: ['1'] })
-          },
-          {
-            Pattern: JSON.stringify({ eventName: ['2'] })
-          },
-          {
-            Pattern: JSON.stringify({ eventName: ['3'] })
-          },
-          {
-            Pattern: JSON.stringify({ eventName: ['4'] })
-          },
-          {
-            Pattern: JSON.stringify({ eventName: ['5'] })
-          },
-          {
-            Pattern: JSON.stringify({ eventName: ['6'] })
-          }
-        ]
-      }
-    }),
-    '`FilterCriteria.Filter` cannot contain more than 5 items, you may request a quota increase with AWS support if required.',
-  );
   assert.throws(
     () => new cf.shortcuts.StreamLambda({
       LogicalName: 'MyLambda',

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>