@mapbox/cloudfriend 8.1.0 → 8.3.0-1

package/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 8.3.0
+
+- Support a default value for cf.findInMap (Fn::FindInMap).
+
+## 8.2.0
+
+- Add `LogRetentionInDays` option to Lambda shortcuts
+
 ## 8.1.0
 
 - Allow `FilterCriteria` property to be defined for Stream Lambda shortcuts
@@ -25,7 +33,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 +55,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 +188,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/intrinsic.js

@@ -48,10 +48,16 @@ intrinsic.cidr = (ipBlock, count, cidrBits) => {
  * key-value pairs.
  * @param {string} attr - The second-level key name, which is set to one of the
  * keys from the list assigned to key.
+ * @param {string} defaultValue - The value that will resolve to if the key and/or attr can not be found from the mapping map.
+ * This field is optional and requires AWS::LanguageExtensions to be defined in the template.
  * @returns The value that is assigned to SecondLevelKey.
  */
-intrinsic.findInMap = (mapping, key, attr) => {
-  return { 'Fn::FindInMap': [mapping, key, attr] };
+intrinsic.findInMap = (mapping, key, attr, defaultValue) => {
+  const lookup = [mapping, key, attr];
+  if (defaultValue) {
+    lookup.push({ DefaultValue: defaultValue });
+  }
+  return { 'Fn::FindInMap': lookup };
 };
 
 /**

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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/cloudfriend",
-  "version": "8.1.0",
+  "version": "8.3.0-1",
   "description": "Helper functions for assembling CloudFormation templates in JavaScript",
   "main": "index.js",
   "engines": {
@@ -11,6 +11,7 @@
     "lint": "eslint index.js test lib bin cloudformation",
     "lint:fix": "npm run lint -- --fix",
     "test": "nyc tape test/*.test.js | tap-spec",
+    "test:update": "UPDATE=1 npm run test",
     "coverage": "nyc --reporter html tape test/*.test.js && opener coverage/index.html",
     "build-ci-template": "bin/build-template.js cloudformation/ci.template.js > cloudformation/ci.template.json",
     "shortcuts-api-doc": "jsdoc2md lib/shortcuts/*.js > lib/shortcuts/api.md"

package/test/fixtures/shortcuts/hookshot-github-secret-ref.json

@@ -28,7 +28,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -47,7 +47,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-github-secret-string.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-github.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-access-log-format.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -52,7 +52,7 @@
         }
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-alarms.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-enhanced-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-full-blown-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough-logging.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

package/test/fixtures/shortcuts/hookshot-passthrough.json

@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeploymentac7cb6b9"
+          "Ref": "PassDeployment2a35d33e"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeploymentac7cb6b9": {
+    "PassDeployment2a35d33e": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

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

@@ -28,7 +28,7 @@
             }
           ]
         },
-        "RetentionInDays": 14
+        "RetentionInDays": 30
       }
     },
     "MyLambda": {

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

@@ -167,21 +167,21 @@
       "Properties": {
         "BatchSize": 10000,
         "MaximumBatchingWindowInSeconds": 300,
+        "Enabled": false,
+        "EventSourceArn": "arn:aws:kinesis:us-east-1:123456789012:stream/fake",
+        "FunctionName": {
+          "Ref": "MyLambda"
+        },
+        "StartingPosition": "TRIM_HORIZON",
         "FilterCriteria": {
           "Filters": [
             {
               "Pattern": "{\"eventName\":[\"INSERT\",\"MODIFY\"]}"
             }
           ]
-        },
-        "Enabled": false,
-        "EventSourceArn": "arn:aws:kinesis:us-east-1:123456789012:stream/fake",
-        "FunctionName": {
-          "Ref": "MyLambda"
-        },
-        "StartingPosition": "TRIM_HORIZON"
+        }
       }
     }
   },
   "Outputs": {}
-}
+}

package/test/index.test.js

@@ -11,6 +11,7 @@ test('intrinsic functions', (assert) => {
   assert.deepEqual(cloudfriend.base64('secret'), { 'Fn::Base64': 'secret' }, 'base64');
   assert.deepEqual(cloudfriend.cidr('ipBlock', 1, 2), { 'Fn::Cidr': ['ipBlock', 1, 2] }, 'cidr');
   assert.deepEqual(cloudfriend.findInMap('mapping', 'key', 'value'), { 'Fn::FindInMap': ['mapping', 'key', 'value'] }, 'lookup');
+  assert.deepEqual(cloudfriend.findInMap('mapping', 'key', 'value', 'hello-world'), { 'Fn::FindInMap': ['mapping', 'key', 'value', { DefaultValue: 'hello-world' }] }, 'lookup with default value');
   assert.deepEqual(
     cloudfriend.forEach('somethings', 'topic', ['abra', 'cadabra'], 'magic', {
       Type: 'AWS::SNS::Topic',

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(