feat: input transformer for schedule events

Author: Alanfb

lib/deploy/events/schedule/compileScheduledEvents.js

@@ -17,6 +17,9 @@ module.exports = {
             let State;
             let Input;
             let InputPath;
+            let InputTransformer;
+            let InputTemplate;
+            let InputPathsMap;
             let Name;
             let Description;
 
@@ -39,10 +42,13 @@ module.exports = {
               }
               Input = event.schedule.input;
               InputPath = event.schedule.inputPath;
+              InputTransformer = event.schedule.inputTransformer;
+              InputPathsMap = InputTransformer && event.schedule.inputTransformer.inputPathsMap;
+              InputTemplate = InputTransformer && event.schedule.inputTransformer.inputTemplate;
               Name = event.schedule.name;
               Description = event.schedule.description;
 
-              if (Input && InputPath) {
+              if ([Input, InputPath, InputTransformer].filter(Boolean).length > 1) {
                 const errorMessage = [
                   'You can\'t set both input & inputPath properties at the',
                   'same time for schedule events.',
@@ -59,6 +65,15 @@ module.exports = {
                 // escape quotes to favor JSON.parse
                 Input = Input.replace(/\"/g, '\\"'); // eslint-disable-line
               }
+              // no need to escape quotes in inputPathsMap
+              // because we add it as an object to the template
+              if (InputPathsMap && typeof InputPathsMap === 'object') {
+                InputPathsMap = JSON.stringify(InputPathsMap);
+              }
+              if (InputTemplate && typeof InputTemplate === 'string') {
+                // escape quotes to favor JSON.parse
+                InputTemplate = InputTemplate.replace(/\"/g, '\\"'); // eslint-disable-line
+              }
             } else if (typeof event.schedule === 'string') {
               ScheduleExpression = event.schedule;
               State = 'ENABLED';
@@ -104,6 +119,10 @@ module.exports = {
                   "Targets": [{
                     ${Input ? `"Input": "${Input}",` : ''}
                     ${InputPath ? `"InputPath": "${InputPath}",` : ''}
+                    ${InputTransformer ? `"InputTransformer": {
+                      "InputPathsMap": ${InputPathsMap},
+                      "InputTemplate": "${InputTemplate}"
+                    },` : ''}
                     "Arn": { "Ref": "${stateMachineLogicalId}" },
                     "Id": "${scheduleId}",
                     "RoleArn": ${roleArn}

lib/deploy/events/schedule/compileScheduledEvents.test.js

@@ -360,5 +360,67 @@ describe('#httpValidate()', () => {
           .Resources,
       ).to.deep.equal({});
     });
+
+
+    it('should respect inputTransformer variable', () => {
+      serverlessStepFunctions.serverless.service.stepFunctions = {
+        stateMachines: {
+          first: {
+            events: [
+              {
+                schedule: {
+                  rate: 'rate(10 minutes)',
+                  enabled: false,
+                  inputTransformer: {
+                    inputPathsMap: {
+                      stage: '$.stageVariables',
+                    },
+                    inputTemplate: '{ "stage": <stage> }',
+                  },
+                },
+              },
+            ],
+          },
+        },
+      };
+
+      serverlessStepFunctions.compileScheduledEvents();
+
+      expect(serverlessStepFunctions.serverless.service
+        .provider.compiledCloudFormationTemplate.Resources.FirstStepFunctionsEventsRuleSchedule1
+        .Properties.Targets[0].InputTransformer.InputPathsMap).to.have.property('stage', '$.stageVariables');
+      expect(serverlessStepFunctions.serverless.service
+        .provider.compiledCloudFormationTemplate.Resources.FirstStepFunctionsEventsRuleSchedule1
+        .Properties.Targets[0].InputTransformer.InputTemplate).to.equal('{ "stage": <stage> }');
+    });
+
+    it('should throw an error when Input and InputPath and InputTransformer are set', () => {
+      serverlessStepFunctions.serverless.service.stepFunctions = {
+        stateMachines: {
+          first: {
+            events: [
+              {
+                schedule: {
+                  rate: 'rate(10 minutes)',
+                  enabled: false,
+                  input: {
+                    key: 'value',
+                  },
+                  inputPath: '$.stageVariables',
+                  inputTransformer: {
+                    inputPathsMap: {
+                      stage: '$.stageVariables',
+                    },
+                    inputTemplate: '{ "stage": <stage> }',
+                  },
+                },
+              },
+            ],
+          },
+        },
+      };
+
+      expect(() => serverlessStepFunctions.compileScheduledEvents()).to.throw(Error);
+    });
   });
 });