Merge branch 'master' of github.com:serverless-operations/serverless-step-functions

Author: horike37

README.md

@@ -42,6 +42,7 @@ Serverless Framework v2.32.0 or later is required.
          - [Enabling / Disabling](#enabling--disabling)
          - [Specify Name and Description](#specify-name-and-description)
          - [Scheduled Events IAM Role](#scheduled-events-iam-role)
+         - [Specify InputTransformer](#specify-inputtransformer)
      - [CloudWatch Event](#cloudwatch-event)
          - [Simple event definition](#simple-event-definition)
          - [Enabling / Disabling](#enabling--disabling-1)
@@ -929,6 +930,26 @@ events:
       role: arn:aws:iam::xxxxxxxx:role/yourRole
 ```
 
+#### Specify InputTransformer
+
+You can specify input values ​​to the Lambda function.
+
+```yml
+stepFunctions:
+  stateMachines:
+    stateMachineScheduled:
+      events:
+        - schedule: 
+            rate: cron(30 12 ? * 1-5 *)
+            inputTransformer:
+              inputPathsMap: 
+                time: '$.time'
+                stage: '$.stageVariables'
+              inputTemplate: '{"time": <time>, "stage" : <stage> }'
+      definition:
+        ...
+```
+
 ### CloudWatch Event / EventBridge
 
 #### Simple event definition

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);
+    });
   });
 });

lib/deploy/stepFunctions/compileIamRole.js

@@ -433,6 +433,8 @@ function getIamPermissions(taskStates) {
         return getDynamoDBPermissions('dynamodb:GetItem', state);
       case 'arn:aws:states:::dynamodb:deleteItem':
         return getDynamoDBPermissions('dynamodb:DeleteItem', state);
+      case 'arn:aws:states:::aws-sdk:dynamodb:updateTable':
+        return getDynamoDBPermissions('dynamodb:UpdateTable', state);
 
       case 'arn:aws:states:::batch:submitJob.sync':
       case 'arn:aws:states:::batch:submitJob':

lib/deploy/stepFunctions/compileIamRole.test.js

@@ -549,10 +549,17 @@ describe('#compileIamRole', () => {
             },
             End: true,
           },
+          E: {
+            Type: 'Task',
+            Resource: 'arn:aws:states:::aws-sdk:dynamodb:updateTable',
+            Parameters: {
+              TableName: tableName,
+            },
+            End: true,
+          },
         },
       },
     });
-
     serverless.service.stepFunctions = {
       stateMachines: {
         myStateMachine1: genStateMachine('StateMachine1', helloTable, ['arn:aws:states:::dynamodb:updateItem', 'arn:aws:states:::dynamodb:putItem']),
@@ -577,6 +584,7 @@ describe('#compileIamRole', () => {
           'dynamodb:PutItem',
           'dynamodb:GetItem',
           'dynamodb:DeleteItem',
+          'dynamodb:UpdateTable',
         ]);
     });