Merge pull request #400 from lewgordon/support-wait-seconds-number

fix: handles issue when Ref value is passed to Seconds for Wait task

Author: horike37

lib/deploy/stepFunctions/compileStateMachines.js

@@ -58,7 +58,7 @@ function* getIntrinsicFunctions(obj) {
         const paramName = generateSubVariableName(value);
         // eslint-disable-next-line no-param-reassign
         obj[key] = `\${${paramName}}`;
-        yield [paramName, value];
+        yield [paramName, value, (obj.Type === 'Wait' && key === 'Seconds')];
       } else if (typeof value === 'object') {
         const innerFuncs = Array.from(getIntrinsicFunctions(value));
         for (const x of innerFuncs) {
@@ -144,18 +144,27 @@ module.exports = {
               };
             } else {
               const f = translateLocalFunctionNames.bind(this);
+              let processedDefinitionString = definitionString;
+              functionMappings.forEach((functionMapping) => {
+                if (functionMapping[2]) {
+                  processedDefinitionString = processedDefinitionString.replace(
+                    // eslint-disable-next-line no-useless-escape
+                    new RegExp(`\\\"(\\\$\\\{${functionMapping[0]}\\\})\\\"`, 'g'),
+                    '$1',
+                  );
+                }
+              });
               const params = _.fromPairs(functionMappings.map(([k, v]) => [k, f(v)]));
 
               DefinitionString = {
                 'Fn::Sub': [
-                  definitionString,
+                  processedDefinitionString,
                   params,
                 ],
               };
             }
           }
         }
-
         if (stateMachineObj.useExactVersion === true && DefinitionString['Fn::Sub']) {
           const params = DefinitionString['Fn::Sub'][1];
           const f = convertToFunctionVersion.bind(this);

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -370,6 +370,112 @@ describe('#compileStateMachines', () => {
     expect(actual).to.equal(JSON.stringify(definition, undefined, 2));
   });
 
+  it('should use raw values for Seconds for Wait task', () => {
+    const definition = {
+      Comment: 'Hello World',
+      StartAt: 'HelloWorld',
+      States: {
+        HelloWorld: {
+          Type: 'Wait',
+          Seconds: { Ref: 'SomeSeconds' },
+          End: true,
+        },
+      },
+    };
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          name: 'stateMachineBeta1',
+          definition,
+        },
+      },
+    };
+
+    serverlessStepFunctions.compileStateMachines();
+    const actual = serverlessStepFunctions
+      .serverless
+      .service
+      .provider
+      .compiledCloudFormationTemplate
+      .Resources
+      .StateMachineBeta1
+      .Properties
+      .DefinitionString;
+
+    expect(actual['Fn::Sub'][0]).to.equal(`
+{
+  "Comment": "Hello World",
+  "StartAt": "HelloWorld",
+  "States": {
+    "HelloWorld": {
+      "Type": "Wait",
+      "Seconds": \${4dfb8832166d083d5c26a32fbfcaebf9},
+      "End": true
+    }
+  }
+}
+`.trim());
+  });
+
+  it('should not use raw values for Seconds in other task', () => {
+    const definition = {
+      Comment: 'Hello World',
+      StartAt: 'HelloWorld',
+      States: {
+        HelloWorld: {
+          Type: 'Task',
+          Resource: 'arn:aws:states:::glue:startJobRun.sync',
+          Parameters: {
+            Seconds: { Ref: 'SomeSeconds' },
+          },
+          TimeoutSecondsPath: '$.params.maxTime',
+          HeartbeatSecondsPath: '$.params.heartbeat',
+          End: true,
+        },
+      },
+    };
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          name: 'stateMachineBeta1',
+          definition,
+        },
+      },
+    };
+
+    serverlessStepFunctions.compileStateMachines();
+    const actual = serverlessStepFunctions
+      .serverless
+      .service
+      .provider
+      .compiledCloudFormationTemplate
+      .Resources
+      .StateMachineBeta1
+      .Properties
+      .DefinitionString;
+
+    expect(actual['Fn::Sub'][0]).to.equal(`
+{
+  "Comment": "Hello World",
+  "StartAt": "HelloWorld",
+  "States": {
+    "HelloWorld": {
+      "Type": "Task",
+      "Resource": "arn:aws:states:::glue:startJobRun.sync",
+      "Parameters": {
+        "Seconds": "\${4dfb8832166d083d5c26a32fbfcaebf9}"
+      },
+      "TimeoutSecondsPath": "$.params.maxTime",
+      "HeartbeatSecondsPath": "$.params.heartbeat",
+      "End": true
+    }
+  }
+}
+`.trim());
+  });
+
   it('should add dependsOn resources', () => {
     serverless.service.stepFunctions = {
       stateMachines: {