Resolves #26 - Improves error handling so that consumers can return 4…

…00 and not 500 on unrecognized operators

README.md

@@ -27,6 +27,9 @@ func Example(headerValue string) (*epsearchast_v3.AstNode, error) {
 
 ```
 
+If the error that comes back is a ValidationErr you should treat it as a 400 to the caller.
+
+
 
 ### Aliases
 

docker-compose.yml

@@ -31,6 +31,7 @@ services:
       - '20003:9200'
     environment:
       discovery.type: single-node
+      ES_JAVA_OPTS: "-Xms1024m -Xmx1024m"
     healthcheck:
       test: [ "CMD-SHELL", "curl -f http://localhost:9200/_cat/health" ]
       interval: 10s

external/epsearchast/v3/ast.go

@@ -68,7 +68,7 @@ func GetAst(jsonTxt string) (*AstNode, error) {
 		// we receive something that doesn't make any sense like ge(a). The main argument case where we should
 		// treat this as a validation is an unknown operator. However, in theory the upstream generator
 		// passing us something likely means we should treat it as unsupported if we are out of date.
-		return nil, NewValidationErr(fmt.Errorf("error validating filter (%s) :%w", astNode.AsFilter(), err))
+		return nil, NewValidationErr(fmt.Errorf("(%s): %w", astNode.AsFilter(), err))
 	} else {
 		return astNode, nil
 	}

external/epsearchast/v3/ast_test.go

@@ -49,7 +49,34 @@ func TestInvalidObjectReturnsError(t *testing.T) {
 
 	// Verify
 	require.Error(t, err)
-	require.EqualError(t, err, "error validating filter: unsupported operator foo()")
+	require.EqualError(t, err, "error validating filter: (foo()): unsupported operator foo()")
+	require.ErrorAs(t, err, &ValidationErr{})
+	require.Nil(t, astNode)
+}
+
+func TestUnrecognizedOperatorWithChildReturnsError(t *testing.T) {
+	// Fixture Setup
+
+	//language=JSON
+	jsonTxt := `{
+	  "type": "NOT",
+	  "children": [
+		{
+		  "type": "EQ",
+		  "args": [
+			"status",
+			"paid"
+		  ]
+		}
+	  ]
+	}
+`
+	// Execute SUT
+	astNode, err := GetAst(jsonTxt)
+
+	// Verify
+	require.Error(t, err)
+	require.EqualError(t, err, "error validating filter: (not()): unsupported operator not()")
 	require.ErrorAs(t, err, &ValidationErr{})
 	require.Nil(t, astNode)
 }

external/epsearchast/v3/validate.go

@@ -45,5 +45,11 @@ func ValidateAstFieldAndOperatorsWithAliasesAndValueValidationAndFieldTypes(astN
 		return err
 	}
 
-	return astNode.Accept(visitor)
+	err = astNode.Accept(visitor)
+
+	if err != nil {
+		return NewValidationErr(err)
+	}
+
+	return nil
 }

external/epsearchast/v3/validate_test.go

@@ -61,7 +61,7 @@ func TestValidationReturnsErrorForBinaryOperatorsWhenAstUsesUnknownField(t *test
 			err = ValidateAstFieldAndOperators(ast, map[string][]string{"other_field": {otherBinOp}, "another_field": {otherBinOp}})
 
 			// Verification
-			require.EqualError(t, err, fmt.Sprintf("unknown field [amount] specified in search filter, allowed fields are [another_field other_field]"))
+			require.EqualError(t, err, fmt.Sprintf("error validating filter: unknown field [amount] specified in search filter, allowed fields are [another_field other_field]"))
 		})
 	}