Adding support for ID scalar type to Pattern, NotEmpty, NotBlank and Size (#24)

* Adding support for ID scalar type to Pattern, NotEmpty, NotBlank and Size constraints as per #21

* Update README.md

(cherry picked from commit 9d6efff)

* Update README.md

tweaks

(cherry picked from commit d8ba27b)

Co-authored-by: Brad Baker <[email protected]>

Author: setchy

README.md

@@ -9,13 +9,8 @@
 This library provides extended validation of fields and field arguments for [graphql-java](https://github.com/graphql-java/graphql-java)
 
 
-# Status
+# Using
 
-This code is currently under construction.  It is fairly complete in providing powerful validation
-but as it has NOT been consumed by a production like project then its API usefulness has not been tested
-and battle tested. 
-
-But the project welcomes all feedback and input on code design and validation requirements.
 
 ```xml
 <dependency>
@@ -37,7 +32,7 @@ compile 'com.graphql-java:graphql-java-extended-validation:14.0.1'
 > use 14.0.1 or above for graphql-java 14.x and above
 
 
-Its currently available from JCenter repo and Maven central is pending.
+Its currently available from JCenter repo and Maven central.
 
 
 # SDL @Directive constraints
@@ -390,7 +385,7 @@ The String must contain at least one non-whitespace character, according to Java
 
 - Example : `updateAccident( accidentNotes : String @NotBlank) : DriverDetails`
 
-- Applies to : `String`
+- Applies to : `String`, `ID`
 
 - SDL : `directive @NotBlank(message : String = "graphql.validation.NotBlank.message") on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION`
 
@@ -403,7 +398,7 @@ The element must have a non zero size.
 
 - Example : `updateAccident( accidentNotes : [Notes]! @NotEmpty) : DriverDetails`
 
-- Applies to : `String`, `Lists`, `Input Objects`
+- Applies to : `String`, `ID`, `Lists`, `Input Objects`
 
 - SDL : `directive @NotEmpty(message : String = "graphql.validation.NotEmpty.message") on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION`
 
@@ -414,9 +409,9 @@ The element must have a non zero size.
 
 The String must match the specified regular expression, which follows the Java regular expression conventions.
 
-- Example : `updateDriver( licencePlate : String @Patttern(regex : "[A-Z][A-Z][A-Z]-[0-9][0-9][0-9]") : DriverDetails`
+- Example : `updateDriver( licencePlate : String @Pattern(regexp : "[A-Z][A-Z][A-Z]-[0-9][0-9][0-9]") : DriverDetails`
 
-- Applies to : `String`, `Lists`
+- Applies to : `String`, `ID`, `Lists`
 
 - SDL : `directive @Pattern(regexp : String! =".*", message : String = "graphql.validation.Pattern.message") on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION`
 
@@ -468,7 +463,7 @@ The element size must be between the specified `min` and `max` boundaries (inclu
 
 - Example : `updateDrivingNotes( drivingNote : String @Size( min : 1000, max : 100000)) : DriverDetails`
 
-- Applies to : `String`, `Lists`, `Input Objects`
+- Applies to : `String`, `ID`, `Lists`, `Input Objects`
 
 - SDL : `directive @Size(min : Int = 0, max : Int = 2147483647, message : String = "graphql.validation.Size.message") on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION`
 

src/main/java/graphql/validation/constraints/AbstractDirectiveConstraint.java

@@ -160,7 +160,7 @@ private List<GraphQLError> runConstraintOnDirectives(ValidationEnvironment valid
      * @param inputType   the type to check
      * @param scalarTypes the array of scalar types
      *
-     * @return true ifits oneof them
+     * @return true if its one of them
      */
     protected boolean isOneOfTheseTypes(GraphQLInputType inputType, GraphQLScalarType... scalarTypes) {
         GraphQLInputType type = Util.unwrapNonNull(inputType);
@@ -303,19 +303,31 @@ protected List<GraphQLError> mkError(ValidationEnvironment validationEnvironment
     }
 
     /**
-     * Return true if the type is a String or List type or {@link graphql.schema.GraphQLInputObjectType}, regardless of non null ness
+     * Return true if the type is a String or ID or List type or {@link graphql.schema.GraphQLInputObjectType}, regardless of non null ness
      *
      * @param inputType the type to check
      *
      * @return true if one of the above
      */
-    protected boolean isStringOrListOrMap(GraphQLInputType inputType) {
+    protected boolean isStringOrIDOrListOrMap(GraphQLInputType inputType) {
         GraphQLInputType unwrappedType = Util.unwrapOneAndAllNonNull(inputType);
-        return Scalars.GraphQLString.equals(unwrappedType) ||
+        return isStringOrID(inputType) ||
                 isList(inputType) ||
                 (unwrappedType instanceof GraphQLInputObjectType);
     }
 
+    /**
+     * Return true if the type is a String or ID
+     *
+     * @param inputType the type to check
+     *
+     * @return true if one of the above
+     */
+    protected boolean isStringOrID(GraphQLInputType inputType) {
+        GraphQLInputType unwrappedType = Util.unwrapNonNull(inputType);
+        return Scalars.GraphQLString.equals(unwrappedType) || Scalars.GraphQLID.equals(unwrappedType);
+    }
+
     /**
      * Casts the object as a Map with an assertion of it is not one
      *
@@ -373,18 +385,18 @@ protected boolean asBoolean(Object value) {
     }
 
     /**
-     * Returns the length of a String of the size of a list or size of a Map
+     * Returns the length of a String, ID, size of a list or size of a Map
      *
      * @param inputType the input type
      * @param value     the value
      *
      * @return the length of a String or Map or List
      */
-    protected int getStringOrObjectOrMapLength(GraphQLInputType inputType, Object value) {
+    protected int getStringOrIDOrObjectOrMapLength(GraphQLInputType inputType, Object value) {
         int valLen;
         if (value == null) {
             valLen = 0;
-        } else if (Scalars.GraphQLString.equals(Util.unwrapNonNull(inputType))) {
+        } else if (isStringOrID(inputType)) {
             valLen = String.valueOf(value).length();
         } else if (isList(inputType)) {
             valLen = getListLength(value);

src/main/java/graphql/validation/constraints/standard/NotBlankRule.java

@@ -26,7 +26,7 @@ public Documentation getDocumentation() {
 
                 .example("updateAccident( accidentNotes : String @NotBlank) : DriverDetails")
 
-                .applicableTypeNames(Scalars.GraphQLString.getName())
+                .applicableTypeNames(Scalars.GraphQLString.getName(), Scalars.GraphQLID.getName())
 
                 .directiveSDL("directive @NotBlank(message : String = \"%s\") " +
                                 "on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION",
@@ -36,7 +36,7 @@ public Documentation getDocumentation() {
 
     @Override
     public boolean appliesToType(GraphQLInputType inputType) {
-        return isOneOfTheseTypes(inputType, Scalars.GraphQLString);
+        return isStringOrID(inputType);
     }
 
     @Override

src/main/java/graphql/validation/constraints/standard/NotEmptyRule.java

@@ -7,7 +7,6 @@
 import graphql.validation.constraints.AbstractDirectiveConstraint;
 import graphql.validation.constraints.Documentation;
 import graphql.validation.rules.ValidationEnvironment;
-
 import java.util.Collections;
 import java.util.List;
 
@@ -26,7 +25,7 @@ public Documentation getDocumentation() {
 
                 .example("updateAccident( accidentNotes : [Notes]! @NotEmpty) : DriverDetails")
 
-                .applicableTypeNames(Scalars.GraphQLString.getName(), "Lists", "Input Objects")
+                .applicableTypeNames(Scalars.GraphQLString.getName(), Scalars.GraphQLID.getName(), "Lists", "Input Objects")
 
                 .directiveSDL("directive @NotEmpty(message : String = \"%s\") " +
                                 "on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION",
@@ -36,7 +35,7 @@ public Documentation getDocumentation() {
 
     @Override
     public boolean appliesToType(GraphQLInputType inputType) {
-        return isStringOrListOrMap(inputType);
+        return isStringOrIDOrListOrMap(inputType);
     }
 
     @Override
@@ -45,7 +44,7 @@ protected List<GraphQLError> runConstraint(ValidationEnvironment validationEnvir
         GraphQLInputType argumentType = validationEnvironment.getValidatedType();
 
         GraphQLDirective directive = validationEnvironment.getContextObject(GraphQLDirective.class);
-        int size = getStringOrObjectOrMapLength(argumentType, validatedValue);
+        int size = getStringOrIDOrObjectOrMapLength(argumentType, validatedValue);
 
         if (size <= 0) {
             return mkError(validationEnvironment, directive, mkMessageParams(validatedValue, validationEnvironment,

src/main/java/graphql/validation/constraints/standard/PatternConstraint.java

@@ -35,7 +35,7 @@ public Documentation getDocumentation() {
 
                 .example("updateDriver( licencePlate : String @Pattern(regexp : \"[A-Z][A-Z][A-Z]-[0-9][0-9][0-9]\") : DriverDetails")
 
-                .applicableTypeNames(Scalars.GraphQLString.getName(), "Lists")
+                .applicableTypeNames(Scalars.GraphQLString.getName(), Scalars.GraphQLID.getName(), "Lists")
 
                 .directiveSDL("directive @Pattern(regexp : String! =\".*\", message : String = \"%s\") " +
                                 "on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION",
@@ -45,8 +45,7 @@ public Documentation getDocumentation() {
 
     @Override
     public boolean appliesToType(GraphQLInputType inputType) {
-        return isOneOfTheseTypes(inputType,
-            Scalars.GraphQLString) || isList(inputType);
+        return isStringOrID(inputType) || isList(inputType);
     }
 
     @Override

src/main/java/graphql/validation/constraints/standard/SizeConstraint.java

@@ -28,7 +28,7 @@ public Documentation getDocumentation() {
 
                 .example("updateDrivingNotes( drivingNote : String @Size( min : 1000, max : 100000)) : DriverDetails")
 
-                .applicableTypeNames(Scalars.GraphQLString.getName(), "Lists", "Input Objects")
+                .applicableTypeNames(Scalars.GraphQLString.getName(), Scalars.GraphQLID.getName(), "Lists", "Input Objects")
 
                 .directiveSDL("directive @Size(min : Int = 0, max : Int = %d, message : String = \"%s\") " +
                                 "on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION",
@@ -39,7 +39,7 @@ Integer.MAX_VALUE, getMessageTemplate())
 
     @Override
     public boolean appliesToType(GraphQLInputType inputType) {
-        return isStringOrListOrMap(inputType);
+        return isStringOrIDOrListOrMap(inputType);
     }
 
     @Override
@@ -52,7 +52,7 @@ protected List<GraphQLError> runConstraint(ValidationEnvironment validationEnvir
         int max = getIntArg(directive, "max");
 
 
-        int size = getStringOrObjectOrMapLength(argType, validatedValue);
+        int size = getStringOrIDOrObjectOrMapLength(argType, validatedValue);
 
         if (size < min) {
             return mkError(validationEnvironment, directive, mkParams(validatedValue, validationEnvironment, min, max, size));

src/test/groovy/graphql/validation/constraints/standard/NoEmptyBlankConstraintTest.groovy

@@ -20,12 +20,17 @@ class NoEmptyBlankConstraintTest extends BaseConstraintTestSupport {
         where:
 
         fieldDeclaration                       | argVal     | expectedMessage
+        // strings
         'field( arg : String @NotBlank ) : ID' | "\t\n\r "  | 'NotBlank;path=/arg;val:\t\n\r ;\t'
         'field( arg : String @NotBlank ) : ID' | ""         | 'NotBlank;path=/arg;val:;\t'
         'field( arg : String @NotBlank ) : ID' | "\t\n\r X" | ''
-
-        // nulls are INVALID
         'field( arg : String @NotBlank ) : ID' | null       | 'NotBlank;path=/arg;val:null;\t'
+
+        // IDs
+        'field( arg : ID @NotBlank ) : ID' | "\t\n\r "  | 'NotBlank;path=/arg;val:\t\n\r ;\t'
+        'field( arg : ID @NotBlank ) : ID' | ""         | 'NotBlank;path=/arg;val:;\t'
+        'field( arg : ID @NotBlank ) : ID' | "\t\n\r X" | ''
+        'field( arg : ID @NotBlank ) : ID' | null       | 'NotBlank;path=/arg;val:null;\t'
     }
 
     @Unroll
@@ -47,6 +52,13 @@ class NoEmptyBlankConstraintTest extends BaseConstraintTestSupport {
         'field( arg : String @NotEmpty ) : ID'      | "\t\n\r"    | ''
         'field( arg : String @NotEmpty ) : ID'      | "ABC"       | ''
 
+        // IDs
+        'field( arg : ID @NotEmpty ) : ID'      | ""          | 'NotEmpty;path=/arg;val:;\t'
+        'field( arg : ID @NotEmpty ) : ID'      | null        | 'NotEmpty;path=/arg;val:null;\t'
+        'field( arg : ID @NotEmpty ) : ID'      | "\t\n\r"    | ''
+        'field( arg : ID @NotEmpty ) : ID'      | "ABC"       | ''
+
+
         // objects
         'field( arg : InputObject @NotEmpty ) : ID' | [:]         | 'NotEmpty;path=/arg;val:[:];\t'
         'field( arg : InputObject @NotEmpty ) : ID' | null        | 'NotEmpty;path=/arg;val:null;\t'
@@ -56,6 +68,9 @@ class NoEmptyBlankConstraintTest extends BaseConstraintTestSupport {
         'field( arg : [String] @NotEmpty ) : ID'    | []          | 'NotEmpty;path=/arg;val:[];\t'
         'field( arg : [String] @NotEmpty ) : ID'    | null        | 'NotEmpty;path=/arg;val:null;\t'
         'field( arg : [String] @NotEmpty ) : ID'    | ["x"]       | ''
+        'field( arg : [ID] @NotEmpty ) : ID'    | []          | 'NotEmpty;path=/arg;val:[];\t'
+        'field( arg : [ID] @NotEmpty ) : ID'    | null        | 'NotEmpty;path=/arg;val:null;\t'
+        'field( arg : [ID] @NotEmpty ) : ID'    | ["x"]       | ''
 
     }
 

src/test/groovy/graphql/validation/constraints/standard/PatternConstraintTest.groovy

@@ -22,8 +22,12 @@ class PatternConstraintTest extends BaseConstraintTestSupport {
         fieldDeclaration                                       | argVal | expectedMessage
         'field( arg : String @Pattern(regexp:"[A-Z]*") ) : ID' | "ABCd" | 'Pattern;path=/arg;val:ABCd;\t'
         'field( arg : String @Pattern(regexp:"[A-Z]*") ) : ID' | "ABC"  | ''
+        'field( arg : ID @Pattern(regexp:"[A-Z]*") ) : ID' | "ABCd" | 'Pattern;path=/arg;val:ABCd;\t'
+        'field( arg : ID @Pattern(regexp:"[A-Z]*") ) : ID' | "ABC"  | ''
         'field( arg : [String] @Pattern(regexp:"[A-Z]*") ) : ID' | ["ABC"]  | ''
         'field( arg : [String] @Pattern(regexp:"[A-Z]*") ) : ID' | ["ABC", "ABCd"]  | 'Pattern;path=/arg;val:[ABC, ABCd];\t'
+        'field( arg : [ID] @Pattern(regexp:"[A-Z]*") ) : ID' | ["ABC"]  | ''
+        'field( arg : [ID] @Pattern(regexp:"[A-Z]*") ) : ID' | ["ABC", "ABCd"]  | 'Pattern;path=/arg;val:[ABC, ABCd];\t'
 
         // nulls are valid
         'field( arg : String @Pattern(regexp:"[A-Z]*") ) : ID' | null   | ''

src/test/groovy/graphql/validation/constraints/standard/SizeConstraintTest.groovy

@@ -20,11 +20,20 @@ class SizeConstraintTest extends BaseConstraintTestSupport {
         where:
 
         fieldDeclaration                                                | argVal          | expectedMessage
+        // strings
         "field( arg : String @Size(max : 10) ) : ID"                    | "1234567891011" | "Size;path=/arg;val:1234567891011;\t"
         "field( arg : String @Size(max : 100) ) : ID"                   | "1234567891011" | ""
         "field( arg : String @Size(max : 10, min : 5) ) : ID"           | "123"           | "Size;path=/arg;val:123;\t"
 
         'field( arg : String @Size(min : 5, message : "custom") ) : ID' | "123"           | "custom;path=/arg;val:123;\t"
         "field( arg : String @Size(min : 5) ) : ID"                     | null            | "Size;path=/arg;val:null;\t"
+
+        //IDs
+        "field( arg : ID @Size(max : 10) ) : ID"                    | "1234567891011" | "Size;path=/arg;val:1234567891011;\t"
+        "field( arg : ID @Size(max : 100) ) : ID"                   | "1234567891011" | ""
+        "field( arg : ID @Size(max : 10, min : 5) ) : ID"           | "123"           | "Size;path=/arg;val:123;\t"
+
+        'field( arg : ID @Size(min : 5, message : "custom") ) : ID' | "123"           | "custom;path=/arg;val:123;\t"
+        "field( arg : ID @Size(min : 5) ) : ID"                     | null            | "Size;path=/arg;val:null;\t"
     }
 }