scheduled expression doesn't work with custom eventbus

mapbox · Feb 6, 2024 · e7cc5fb · e7cc5fb
1 parent 22570c4
commit e7cc5fb
Show file tree

Hide file tree

Showing 18 changed files with 27 additions and 105 deletions.
diff --git a/lib/shortcuts/api.md b/lib/shortcuts/api.md
@@ -707,7 +707,6 @@ a Lambda permission.
 | --- | --- | --- | --- |
 | options | <code>Object</code> |  | Extends the options for [`Lambda`](#lambda) with the following additional attributes: |
 | options.ScheduleExpression | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression). |
-| [options.EventBusName] | <code>String</code> | <code>&#x27;default&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname). |
 | [options.State] | <code>String</code> | <code>&#x27;ENABLED&#x27;</code> | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state). |
 
 **Example**  
@@ -725,32 +724,6 @@ const lambda = new cf.shortcuts.ScheduledLambda({
   ScheduleExpression: 'cron(45 * * * ? *)',
 });
 
-module.exports = cf.merge(myTemplate, lambda);
-```
-**Example**  
-```js
-const cf = require('@mapbox/cloudfriend');
-
-const myTemplate = {
-  ...
-  Resources: {
-    MyEventBus: {
-      Type: 'AWS::Events::EventBus',
-      Properties: { ... }
-    }
-  }
-};
-
-const lambda = new cf.shortcuts.ScheduledLambda({
-  LogicalName: 'MyLambda',
-  Code: {
-    S3Bucket: 'my-code-bucket',
-    S3Key: 'path/to/code.zip'
-  },
-  EventBusName: cf.ref('MyEventBus'),
-  ScheduleExpression: 'cron(45 * * * ? *)',
-});
-
 module.exports = cf.merge(myTemplate, lambda);
 ```
 <a name="ServiceRole"></a>

diff --git a/lib/shortcuts/event-lambda.js b/lib/shortcuts/event-lambda.js
@@ -73,7 +73,7 @@ class EventLambda extends Lambda {
 
     const {
       EventPattern,
-      EventBusName,
+      EventBusName = 'default',
       State = 'ENABLED'
     } = options;
 
@@ -93,6 +93,7 @@ class EventLambda extends Lambda {
           ]
         },
         State,
+        EventBusName,
         EventPattern,
         Targets: [
           {
@@ -105,10 +106,6 @@ class EventLambda extends Lambda {
       }
     };
 
-    if (EventBusName) {
-      this.Resources[`${this.LogicalName}Trigger`].Properties.EventBusName = EventBusName;
-    }
-
     this.Resources[`${this.LogicalName}Permission`] = {
       Type: 'AWS::Lambda::Permission',
       Condition: this.Condition,

diff --git a/lib/shortcuts/scheduled-lambda.js b/lib/shortcuts/scheduled-lambda.js
@@ -9,7 +9,6 @@ const Lambda = require('./lambda');
  *
  * @param {Object} options - Extends the options for [`Lambda`](#lambda) with the following additional attributes:
  * @param {String} options.ScheduleExpression - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression).
- * @param {String} [options.EventBusName='default'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname).
  * @param {String} [options.State='ENABLED'] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state).
  *
  * @example
@@ -27,40 +26,13 @@ const Lambda = require('./lambda');
  * });
  *
  * module.exports = cf.merge(myTemplate, lambda);
- *
- * @example
- * const cf = require('@mapbox/cloudfriend');
- *
- * const myTemplate = {
- *   ...
- *   Resources: {
- *     MyEventBus: {
- *       Type: 'AWS::Events::EventBus',
- *       Properties: { ... }
- *     }
- *   }
- * };
- *
- * const lambda = new cf.shortcuts.ScheduledLambda({
- *   LogicalName: 'MyLambda',
- *   Code: {
- *     S3Bucket: 'my-code-bucket',
- *     S3Key: 'path/to/code.zip'
- *   },
- *   EventBusName: cf.ref('MyEventBus'),
- *   ScheduleExpression: 'cron(45 * * * ? *)',
- * });
- *
- * module.exports = cf.merge(myTemplate, lambda);
- *
  */
 class ScheduledLambda extends Lambda {
   constructor(options) {
     if (!options) throw new Error('Options required');
     super(options);
 
     const {
-      EventBusName,
       ScheduleExpression,
       State = 'ENABLED'
     } = options;
@@ -93,10 +65,6 @@ class ScheduledLambda extends Lambda {
       }
     };
 
-    if (EventBusName) {
-      this.Resources[`${this.LogicalName}Schedule`].Properties.EventBusName = EventBusName;
-    }
-
     this.Resources[`${this.LogicalName}Permission`] = {
       Type: 'AWS::Lambda::Permission',
       Condition: this.Condition,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/cloudfriend",
-  "version": "7.2.0-0",
+  "version": "7.2.0-1",
   "description": "Helper functions for assembling CloudFormation templates in JavaScript",
   "main": "index.js",
   "engines": {

diff --git a/test/fixtures/shortcuts/event-lambda-custom-eventbus.json b/test/fixtures/shortcuts/event-lambda-custom-eventbus.json
@@ -145,6 +145,7 @@
           ]
         },
         "State": "DISABLED",
+        "EventBusName": "my-cool-eventbus",
         "EventPattern": {
           "source": [
             "aws.ec2"
@@ -170,8 +171,7 @@
               ]
             }
           }
-        ],
-        "EventBusName": "my-cool-eventbus"
+        ]
       }
     },
     "MyLambdaPermission": {

diff --git a/test/fixtures/shortcuts/event-lambda-defaults.json b/test/fixtures/shortcuts/event-lambda-defaults.json
@@ -145,6 +145,7 @@
           ]
         },
         "State": "ENABLED",
+        "EventBusName": "default",
         "EventPattern": {
           "source": [
             "aws.ec2"

diff --git a/test/fixtures/shortcuts/event-lambda-full.json b/test/fixtures/shortcuts/event-lambda-full.json
@@ -145,6 +145,7 @@
           ]
         },
         "State": "DISABLED",
+        "EventBusName": "default",
         "EventPattern": {
           "source": [
             "aws.ec2"

diff --git a/test/fixtures/shortcuts/hookshot-github-secret-ref.json b/test/fixtures/shortcuts/hookshot-github-secret-ref.json
@@ -28,7 +28,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -47,7 +47,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-github-secret-string.json b/test/fixtures/shortcuts/hookshot-github-secret-string.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-github.json b/test/fixtures/shortcuts/hookshot-github.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough-access-log-format.json b/test/fixtures/shortcuts/hookshot-passthrough-access-log-format.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -52,7 +52,7 @@
         }
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough-alarms.json b/test/fixtures/shortcuts/hookshot-passthrough-alarms.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough-enhanced-logging.json b/test/fixtures/shortcuts/hookshot-passthrough-enhanced-logging.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough-full-blown-logging.json b/test/fixtures/shortcuts/hookshot-passthrough-full-blown-logging.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough-logging.json b/test/fixtures/shortcuts/hookshot-passthrough-logging.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/fixtures/shortcuts/hookshot-passthrough.json b/test/fixtures/shortcuts/hookshot-passthrough.json
@@ -24,7 +24,7 @@
       "Type": "AWS::ApiGateway::Stage",
       "Properties": {
         "DeploymentId": {
-          "Ref": "PassDeployment41d722f6"
+          "Ref": "PassDeployment2d092515"
         },
         "StageName": "hookshot",
         "RestApiId": {
@@ -43,7 +43,7 @@
         ]
       }
     },
-    "PassDeployment41d722f6": {
+    "PassDeployment2d092515": {
       "Type": "AWS::ApiGateway::Deployment",
       "DependsOn": "PassMethod",
       "Properties": {

diff --git a/test/shortcuts.test.js b/test/shortcuts.test.js
@@ -345,24 +345,6 @@ test('[shortcuts] scheduled-lambda', (assert) => {
     fixtures.get('scheduled-lambda-full'),
     'expected resources generated without defaults'
   );
-
-  lambda = new cf.shortcuts.ScheduledLambda({
-    LogicalName: 'MyLambda',
-    Code: {
-      S3Bucket: 'my-code-bucket',
-      S3Key: 'path/to/code.zip'
-    },
-    EventBusName: 'my-cool-eventbus',
-    ScheduleExpression: 'rate(1 hour)',
-    State: 'DISABLED'
-  });
-  template = cf.merge(lambda);
-  if (update) fixtures.update('scheduled-lambda-custom-eventbus', template);
-  assert.deepEqual(
-    noUndefined(template),
-    fixtures.get('scheduled-lambda-custom-eventbus'),
-    'expected resources generated without defaults and a custom eventbus'
-  );
   assert.end();
 });