Merge pull request #144 from theburningmonk/feature/json_prettify

JSON prettify when the state definition is a JSON object instead of raw string

Author: horike37

lib/deploy/stepFunctions/compileStateMachines.js

@@ -12,7 +12,12 @@ module.exports = {
         let DependsOn;
 
         if (stateMachineObj.definition) {
-          DefinitionString = JSON.stringify(stateMachineObj.definition);
+          if (typeof stateMachineObj.definition === 'string') {
+            DefinitionString = JSON.stringify(stateMachineObj.definition)
+              .replace(/\\n|\\r|\\n\\r/g, '');
+          } else {
+            DefinitionString = JSON.stringify(stateMachineObj.definition, undefined, 2);
+          }
         } else {
           const errorMessage = [
             `Missing "definition" property in stateMachine ${stateMachineName}`,
@@ -25,7 +30,7 @@ module.exports = {
         if (stateMachineObj.role) {
           if (typeof stateMachineObj.role === 'string') {
             if (stateMachineObj.role.startsWith('arn:aws')) {
-              RoleArn = `"${stateMachineObj.role}"`;
+              RoleArn = stateMachineObj.role;
             } else {
               const errorMessage = [
                 `role property in stateMachine "${stateMachineName}" is not ARN`,
@@ -43,29 +48,31 @@ module.exports = {
             .Error(errorMessage);
           }
         } else {
-          RoleArn = '{ "Fn::GetAtt": ["IamRoleStateMachineExecution", "Arn"] }';
+          RoleArn = {
+            'Fn::GetAtt': [
+              'IamRoleStateMachineExecution',
+              'Arn',
+            ],
+          };
           DependsOn = 'IamRoleStateMachineExecution';
         }
 
         const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName,
           stateMachineObj);
         const stateMachineOutputLogicalId = this
-                        .getStateMachineOutputLogicalId(stateMachineName, stateMachineObj);
-
-        const stateMachineTemplate = `
+          .getStateMachineOutputLogicalId(stateMachineName, stateMachineObj);
+        const stateMachineTemplate =
           {
-            "Type": "AWS::StepFunctions::StateMachine",
-            "Properties": {
-              "DefinitionString": ${JSON.stringify(DefinitionString
-                .replace(/\\n|\\r|\\n\\r/g, ''))},
-              "RoleArn": ${RoleArn}
-            }
-            ${DependsOn ? `,"DependsOn": "${DependsOn}"` : ''}
-          }
-        `;
+            Type: 'AWS::StepFunctions::StateMachine',
+            Properties: {
+              DefinitionString,
+              RoleArn,
+            },
+            DependsOn,
+          };
 
         const newStateMachineObject = {
-          [stateMachineLogicalId]: JSON.parse(stateMachineTemplate),
+          [stateMachineLogicalId]: stateMachineTemplate,
         };
 
         if (stateMachineObj.name) {

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -330,4 +330,40 @@ describe('#compileStateMachines', () => {
       .provider.compiledCloudFormationTemplate.Resources
     ).to.deep.equal({});
   });
+
+  it('should print pretty JSON for the state machine definition', () => {
+    const definition = {
+      Comment: 'Hello World',
+      StartAt: 'HelloWorld',
+      States: {
+        HelloWorld: {
+          Type: 'Task',
+          Resource: 'arn:aws:lambda:#{AWS::Region}:#{AWS::AccountId}:function:hello',
+          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).to.equal(JSON.stringify(definition, undefined, 2));
+  });
 });