feat(aws-events): update eventfield to support embedded string variables

https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_InputTransformer.html fixes aws#9191
thantos · Mar 9, 2021 · 3076cf0 · 3076cf0
1 parent c4dc3bc
commit 3076cf0
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 23 deletions.
diff --git a/packages/@aws-cdk/aws-events-targets/test/ecs/event-rule-target.test.ts b/packages/@aws-cdk/aws-events-targets/test/ecs/event-rule-target.test.ts
@@ -49,7 +49,7 @@ test('Can use EC2 taskdef as EventRule target', () => {
           InputPathsMap: {
             'detail-event': '$.detail.event',
           },
-          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo",<detail-event>]}]}',
+          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo","<detail-event>"]}]}',
         },
         RoleArn: { 'Fn::GetAtt': ['TaskDefEventsRoleFB3B67B8', 'Arn'] },
         Id: 'Target0',
@@ -134,7 +134,7 @@ test('Can import an EC2 task definition from task definition attributes as Event
           InputPathsMap: {
             'detail-event': '$.detail.event',
           },
-          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo",<detail-event>]}]}',
+          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo","<detail-event>"]}]}',
         },
         RoleArn: { 'Fn::GetAtt': ['TaskDefEventsRoleFB3B67B8', 'Arn'] },
         Id: 'Target0',
@@ -213,7 +213,7 @@ test('Can import a Fargate task definition from task definition attributes as Ev
           InputPathsMap: {
             'detail-event': '$.detail.event',
           },
-          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo",<detail-event>]}]}',
+          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo","<detail-event>"]}]}',
         },
         RoleArn: { 'Fn::GetAtt': ['TaskDefEventsRoleFB3B67B8', 'Arn'] },
         Id: 'Target0',
@@ -292,7 +292,7 @@ test('Can import a Task definition from task definition attributes as EventRule
           InputPathsMap: {
             'detail-event': '$.detail.event',
           },
-          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo",<detail-event>]}]}',
+          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo","<detail-event>"]}]}',
         },
         RoleArn: { 'Fn::GetAtt': ['TaskDefEventsRoleFB3B67B8', 'Arn'] },
         Id: 'Target0',
@@ -361,7 +361,7 @@ test('Can use Fargate taskdef as EventRule target', () => {
           InputPathsMap: {
             'detail-event': '$.detail.event',
           },
-          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo",<detail-event>]}]}',
+          InputTemplate: '{"containerOverrides":[{"name":"TheContainer","command":["echo","<detail-event>"]}]}',
         },
         RoleArn: { 'Fn::GetAtt': ['TaskDefEventsRoleFB3B67B8', 'Arn'] },
         Id: 'Target0',

diff --git a/packages/@aws-cdk/aws-events/lib/input.ts b/packages/@aws-cdk/aws-events/lib/input.ts
@@ -206,8 +206,7 @@ class FieldAwareEventInput extends RuleTargetInput {
    * return a bracing that's unlikely to occur naturally (like tokens).
    */
   private keyPlaceholder(key: string) {
-    if (this.inputType !== InputType.Object) { return `<${key}>`; }
-    return UNLIKELY_OPENING_STRING + key + UNLIKELY_CLOSING_STRING;
+    return `<${key}>`;
   }
 
   /**
@@ -230,19 +229,13 @@ class FieldAwareEventInput extends RuleTargetInput {
         }
         return resolved;
       } else if (typeof(resolved) === 'string') {
-        return resolved.replace(OPENING_STRING_REGEX, '<').replace(CLOSING_STRING_REGEX, '>');
+        return resolved;
       }
       return resolved;
     }
   }
 }
 
-const UNLIKELY_OPENING_STRING = '<<${';
-const UNLIKELY_CLOSING_STRING = '}>>';
-
-const OPENING_STRING_REGEX = new RegExp(regexQuote('"' + UNLIKELY_OPENING_STRING), 'g');
-const CLOSING_STRING_REGEX = new RegExp(regexQuote(UNLIKELY_CLOSING_STRING + '"'), 'g');
-
 /**
  * Represents a field in the event pattern
  */
@@ -339,10 +332,3 @@ function isEventField(x: any): x is EventField {
 }
 
 const EVENT_FIELD_SYMBOL = Symbol.for('@aws-cdk/aws-events.EventField');
-
-/**
- * Quote a string for use in a regex
- */
-function regexQuote(s: string) {
-  return s.replace(/[.?*+^$[\]\\(){}|-]/g, '\\$&');
-}
diff --git a/packages/@aws-cdk/aws-events/test/test.input.ts b/packages/@aws-cdk/aws-events/test/test.input.ts
@@ -53,7 +53,85 @@ export = {
                 'Fn::Join': [
                   '',
                   [
-                    '{"data":<f1>,"stackName":"',
+                    '{"data":"<f1>","stackName":"',
+                    { Ref: 'AWS::StackName' },
+                    '"}',
+                  ],
+                ],
+              },
+            },
+          },
+        ],
+      }));
+
+      test.done();
+    },
+
+    'can use joined JSON containing refs in JSON object and concat'(test: Test) {
+      // GIVEN
+      const stack = new cdk.Stack();
+      const rule = new Rule(stack, 'Rule', {
+        schedule: Schedule.rate(cdk.Duration.minutes(1)),
+      });
+
+      // WHEN
+      rule.addTarget(new SomeTarget(RuleTargetInput.fromObject({
+        data: `more text ${EventField.fromPath('$')}`,
+        stackName: cdk.Aws.STACK_NAME,
+      })));
+
+      // THEN
+      expect(stack).to(haveResourceLike('AWS::Events::Rule', {
+        Targets: [
+          {
+            InputTransformer: {
+              InputPathsMap: {
+                f1: '$',
+              },
+              InputTemplate: {
+                'Fn::Join': [
+                  '',
+                  [
+                    '{"data":"more text <f1>","stackName":"',
+                    { Ref: 'AWS::StackName' },
+                    '"}',
+                  ],
+                ],
+              },
+            },
+          },
+        ],
+      }));
+
+      test.done();
+    },
+
+    'can use joined JSON containing refs in JSON object and quotes'(test: Test) {
+      // GIVEN
+      const stack = new cdk.Stack();
+      const rule = new Rule(stack, 'Rule', {
+        schedule: Schedule.rate(cdk.Duration.minutes(1)),
+      });
+
+      // WHEN
+      rule.addTarget(new SomeTarget(RuleTargetInput.fromObject({
+        data: `more text "${EventField.fromPath('$')}"`,
+        stackName: cdk.Aws.STACK_NAME,
+      })));
+
+      // THEN
+      expect(stack).to(haveResourceLike('AWS::Events::Rule', {
+        Targets: [
+          {
+            InputTransformer: {
+              InputPathsMap: {
+                f1: '$',
+              },
+              InputTemplate: {
+                'Fn::Join': [
+                  '',
+                  [
+                    '{"data":"more text \\\"<f1>\\\"","stackName":"',
                     { Ref: 'AWS::StackName' },
                     '"}',
                   ],

diff --git a/packages/@aws-cdk/aws-events/test/test.rule.ts b/packages/@aws-cdk/aws-events/test/test.rule.ts
@@ -365,7 +365,7 @@ export = {
                   'InputPathsMap': {
                     'detail-bar': '$.detail.bar',
                   },
-                  'InputTemplate': '{"foo":<detail-bar>}',
+                  'InputTemplate': '{"foo":"<detail-bar>"}',
                 },
               },
               {