Merge pull request #1340 from nyaruka/better_validation_errors

For validation errors that relate to limits, include the count in the message

Author: rowanseymour

flows/definition/flow.go

@@ -21,12 +21,6 @@ import (
 	"github.com/nyaruka/goflow/utils"
 )
 
-const (
-	maxNodesPerFlow   = 1000 // max number of nodes in a flow
-	maxActionsPerNode = 100  // max number of actions in a node
-	maxExitsPerNode   = 100  // max number of exits in a node
-)
-
 // CurrentSpecVersion is the flow spec version supported by this library
 var CurrentSpecVersion = semver.MustParse("14.0.0")
 var CurrentSupportedSpecs, _ = semver.NewConstraint(">= 11.0.0, < 14.1.0")
@@ -110,8 +104,8 @@ func (f *flow) ExpireAfter() time.Duration {
 }
 
 func (f *flow) validate() error {
-	if len(f.nodes) > maxNodesPerFlow {
-		return fmt.Errorf("flow can't have more than %d nodes", maxNodesPerFlow)
+	if len(f.nodes) > flows.MaxNodesPerFlow {
+		return fmt.Errorf("flow can't have more than %d nodes (has %d)", flows.MaxNodesPerFlow, len(f.nodes))
 	}
 
 	// track UUIDs used by nodes and actions to ensure that they are unique

flows/definition/flow_test.go

@@ -104,19 +104,19 @@ func TestBrokenFlows(t *testing.T) {
 		},
 		{
 			"too_many_nodes.json",
-			"flow can't have more than 1000 nodes",
+			"flow can't have more than 1000 nodes (has 1001)",
 		},
 		{
 			"too_many_actions.json",
-			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: node can't have more than 100 actions",
+			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: node can't have more than 100 actions (has 101)",
 		},
 		{
 			"too_many_exits.json",
-			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: node can't have more than 100 exits",
+			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: node can't have more than 100 exits (has 101)",
 		},
 		{
 			"too_many_categories.json",
-			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: invalid router: router can't have more than 100 categories",
+			"invalid node[uuid=a58be63b-907d-4a1a-856b-0bb5579d7507]: invalid router: router can't have more than 100 categories (has 101)",
 		},
 	}
 

flows/definition/node.go

@@ -38,11 +38,11 @@ func (n *node) Router() flows.Router    { return n.router }
 func (n *node) Exits() []flows.Exit     { return n.exits }
 
 func (n *node) Validate(flow flows.Flow, seenUUIDs map[uuids.UUID]bool) error {
-	if len(n.actions) > maxActionsPerNode {
-		return fmt.Errorf("node can't have more than %d actions", maxActionsPerNode)
+	if len(n.actions) > flows.MaxActionsPerNode {
+		return fmt.Errorf("node can't have more than %d actions (has %d)", flows.MaxActionsPerNode, len(n.actions))
 	}
-	if len(n.exits) > maxExitsPerNode {
-		return fmt.Errorf("node can't have more than %d exits", maxExitsPerNode)
+	if len(n.exits) > flows.MaxExitsPerNode {
+		return fmt.Errorf("node can't have more than %d exits (has %d)", flows.MaxExitsPerNode, len(n.exits))
 	}
 
 	// validate all the node's actions

flows/interfaces.go

@@ -16,6 +16,13 @@ import (
 	"github.com/nyaruka/goflow/utils"
 )
 
+const (
+	MaxNodesPerFlow        = 1000 // max number of nodes in a flow
+	MaxActionsPerNode      = 100  // max number of actions in a node
+	MaxExitsPerNode        = 100  // max number of exits in a node
+	MaxCategoriesPerRouter = 100  // max number of categories a router can have
+)
+
 // NodeUUID is a UUID of a flow node
 type NodeUUID uuids.UUID
 

flows/routers/base.go

@@ -18,10 +18,6 @@ import (
 	"github.com/nyaruka/goflow/utils"
 )
 
-const (
-	maxCategoriesPerRouter = 100 // max number of categories a router can have
-)
-
 var registeredTypes = map[string](func() flows.Router){}
 
 // registers a new type of router
@@ -95,8 +91,8 @@ func (r *baseRouter) EnumerateLocalizables(include func(uuids.UUID, string, []st
 }
 
 func (r *baseRouter) validate(flow flows.Flow, exits []flows.Exit) error {
-	if len(r.categories) > maxCategoriesPerRouter {
-		return fmt.Errorf("router can't have more than %d categories", maxCategoriesPerRouter)
+	if len(r.categories) > flows.MaxCategoriesPerRouter {
+		return fmt.Errorf("router can't have more than %d categories (has %d)", flows.MaxCategoriesPerRouter, len(r.categories))
 	}
 
 	// check wait timeout category is valid