feat: capture state machine schema explicitly

Author: theburningmonk

lib/deploy/stepFunctions/compileStateMachines.js

@@ -1,8 +1,10 @@
 'use strict';
 
 const _ = require('lodash');
-const BbPromise = require('bluebird');
+const Joi = require('@hapi/joi');
 const Chance = require('chance');
+const BbPromise = require('bluebird');
+const schema = require('./compileStateMachines.schema');
 const { isIntrinsic, translateLocalFunctionNames } = require('../../utils/aws');
 
 const chance = new Chance();
@@ -14,22 +16,14 @@ function randomName() {
   });
 }
 
-function toTags(obj, serverless) {
+function toTags(obj) {
   const tags = [];
 
   if (!obj) {
     return tags;
   }
 
-  if (_.isPlainObject(obj)) {
-    _.forEach(
-      obj,
-      (Value, Key) => tags.push({ Key, Value: Value.toString() }),
-    );
-  } else {
-    throw new serverless.classes
-      .Error('Unable to parse tags, it should be an object.');
-  }
+  _.forEach(obj, (Value, Key) => tags.push({ Key, Value: Value.toString() }));
 
   return tags;
 }
@@ -75,7 +69,15 @@ module.exports = {
         let DefinitionString;
         let RoleArn;
         let DependsOn = [];
-        const Tags = toTags(this.serverless.service.provider.tags, this.serverless);
+        const Tags = toTags(this.serverless.service.provider.tags);
+
+        const { error } = Joi.validate(stateMachineObj, schema, { allowUnknown: false });
+        if (error) {
+          const errorMessage = `State machine [${stateMachineName}] is malformed. `
+            + 'Please check the README for more info. '
+            + `${error}`;
+          throw new this.serverless.classes.Error(errorMessage);
+        }
 
         if (stateMachineObj.definition) {
           if (typeof stateMachineObj.definition === 'string') {
@@ -98,38 +100,10 @@ module.exports = {
               };
             }
           }
-        } else {
-          const errorMessage = [
-            `Missing "definition" property in stateMachine ${stateMachineName}`,
-            ' Please check the README for more info.',
-          ].join('');
-          throw new this.serverless.classes
-            .Error(errorMessage);
         }
 
         if (stateMachineObj.role) {
-          if (typeof stateMachineObj.role === 'string') {
-            if (stateMachineObj.role.startsWith('arn:aws')) {
-              RoleArn = stateMachineObj.role;
-            } else {
-              const errorMessage = [
-                `role property in stateMachine "${stateMachineName}" is not ARN`,
-                ' Please check the README for more info.',
-              ].join('');
-              throw new this.serverless.classes
-                .Error(errorMessage);
-            }
-          } else if (isIntrinsic(stateMachineObj.role)) {
-            RoleArn = stateMachineObj.role;
-          } else {
-            const errorMessage = [
-              `role property in stateMachine "${stateMachineName}" is neither a string`,
-              ' nor a CloudFormation intrinsic function',
-              ' Please check the README for more info.',
-            ].join('');
-            throw new this.serverless.classes
-              .Error(errorMessage);
-          }
+          RoleArn = stateMachineObj.role;
         } else {
           RoleArn = {
             'Fn::GetAtt': [
@@ -143,22 +117,15 @@ module.exports = {
         if (stateMachineObj.dependsOn) {
           const dependsOn = stateMachineObj.dependsOn;
 
-          if (_.isArray(dependsOn) && _.every(dependsOn, _.isString)) {
+          if (_.isArray(dependsOn)) {
             DependsOn = _.concat(DependsOn, dependsOn);
-          } else if (_.isString(dependsOn)) {
-            DependsOn.push(dependsOn);
           } else {
-            const errorMessage = [
-              `dependsOn property in stateMachine "${stateMachineName}" is neither a string`,
-              ' nor an array of strings',
-            ].join('');
-            throw new this.serverless.classes
-              .Error(errorMessage);
+            DependsOn.push(dependsOn);
           }
         }
 
         if (stateMachineObj.tags) {
-          const stateMachineTags = toTags(stateMachineObj.tags, this.serverless);
+          const stateMachineTags = toTags(stateMachineObj.tags);
           _.forEach(stateMachineTags, tag => Tags.push(tag));
         }
 

lib/deploy/stepFunctions/compileStateMachines.schema.js

@@ -0,0 +1,42 @@
+const Joi = require('@hapi/joi');
+
+const arn = Joi.alternatives().try(
+  Joi.string().regex(/^arn:aws/, 'ARN'),
+  Joi.object().keys({
+    Ref: Joi.string(),
+  }),
+  Joi.object().keys({
+    'Fn::GetAtt': Joi.array().items(Joi.string()),
+  }),
+);
+
+const definition = Joi.alternatives().try(
+  Joi.string(),
+  Joi.object(),
+);
+
+const dependsOn = Joi.alternatives().try(
+  Joi.string(),
+  Joi.array().items(Joi.string()),
+);
+
+const id = Joi.string();
+const tags = Joi.object();
+const name = Joi.string();
+const events = Joi.array();
+const alarms = Joi.object();
+const notifications = Joi.object();
+
+const schema = Joi.object().keys({
+  id,
+  events,
+  name,
+  role: arn,
+  definition: definition.required(),
+  dependsOn,
+  tags,
+  alarms,
+  notifications,
+});
+
+module.exports = schema;

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -204,7 +204,7 @@ describe('#compileStateMachines', () => {
         myStateMachine1: {
           name: 'stateMachineWithIntrinsicRole1',
           definition: 'definition1\n',
-          role: { 'Fn::Attr': ['RoleID', 'Arn'] },
+          role: { 'Fn::GetAtt': ['RoleID', 'Arn'] },
         },
         myStateMachine2: {
           name: 'stateMachineWithIntrinsicRole2',
@@ -216,7 +216,7 @@ describe('#compileStateMachines', () => {
     serverlessStepFunctions.compileStateMachines();
     expect(serverlessStepFunctions.serverless.service
       .provider.compiledCloudFormationTemplate.Resources
-      .StateMachineWithIntrinsicRole1.Properties.RoleArn).to.deep.equal({ 'Fn::Attr': ['RoleID', 'Arn'] });
+      .StateMachineWithIntrinsicRole1.Properties.RoleArn).to.deep.equal({ 'Fn::GetAtt': ['RoleID', 'Arn'] });
     expect(serverlessStepFunctions.serverless.service
       .provider.compiledCloudFormationTemplate.Resources
       .StateMachineWithIntrinsicRole2.Properties.RoleArn).to.deep.equal({ Ref: 'CloudformationId' });