graphql-java#253 - hash code and equals on error helper

bbakerman · bbakerman · commit 4afab48ba43f · 2016-12-18T08:19:53.000+11:00
diff --git a/src/main/java/graphql/ExceptionWhileDataFetching.java b/src/main/java/graphql/ExceptionWhileDataFetching.java
@@ -39,4 +39,19 @@ public String toString() {
                 "exception=" + exception +
                 '}';
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ExceptionWhileDataFetching that = (ExceptionWhileDataFetching) o;
+
+        return Helper.equals(this, that);
+    }
+
+    @Override
+    public int hashCode() {
+        return Helper.hashCode(this);
+    }
 }
diff --git a/src/main/java/graphql/GraphQLError.java b/src/main/java/graphql/GraphQLError.java
@@ -13,4 +13,55 @@ public interface GraphQLError {
 
     ErrorType getErrorType();
 
+
+    /**
+     * This little helper allows GraphQlErrors to implement
+     * common things (hashcode/ equals) more easily
+     */
+    @SuppressWarnings("SimplifiableIfStatement")
+    class Helper {
+
+        String message;
+        List<SourceLocation> locations;
+        ErrorType errorType;
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+
+            Helper helper = (Helper) o;
+
+            if (message != null ? !message.equals(helper.message) : helper.message != null) return false;
+            if (locations != null ? !locations.equals(helper.locations) : helper.locations != null) return false;
+            return errorType == helper.errorType;
+        }
+
+        @Override
+        public int hashCode() {
+            int result = message != null ? message.hashCode() : 0;
+            result = 31 * result + (locations != null ? locations.hashCode() : 0);
+            result = 31 * result + errorType.hashCode();
+            return result;
+        }
+
+        public static int hashCode(GraphQLError dis) {
+            int result = dis.getMessage() != null ? dis.getMessage().hashCode() : 0;
+            result = 31 * result + (dis.getLocations() != null ? dis.getLocations().hashCode() : 0);
+            result = 31 * result + dis.getErrorType().hashCode();
+            return result;
+        }
+
+        public static boolean equals(GraphQLError dis, GraphQLError dat) {
+            if (dis == dat) {
+                return true;
+            }
+            if (dis.getMessage() != null ? !dis.getMessage().equals(dat.getMessage()) : dat.getMessage() != null)
+                return false;
+            if (dis.getLocations() != null ? !dis.getLocations().equals(dat.getLocations()) : dat.getLocations() != null)
+                return false;
+            return dis.getErrorType() == dat.getErrorType();
+        }
+    }
+
 }
diff --git a/src/main/java/graphql/InvalidSyntaxError.java b/src/main/java/graphql/InvalidSyntaxError.java
@@ -44,4 +44,18 @@ public String toString() {
                 '}';
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        InvalidSyntaxError that = (InvalidSyntaxError) o;
+
+        return Helper.equals(this,that);
+    }
+
+    @Override
+    public int hashCode() {
+        return Helper.hashCode(this);
+    }
 }
diff --git a/src/main/java/graphql/validation/ValidationError.java b/src/main/java/graphql/validation/ValidationError.java
@@ -61,4 +61,20 @@ public String toString() {
                 ", description='" + description + '\'' +
                 '}';
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ValidationError that = (ValidationError) o;
+
+        return Helper.equals(this, that);
+    }
+
+    @Override
+    public int hashCode() {
+        return Helper.hashCode(this);
+    }
+
 }
diff --git a/src/test/groovy/graphql/ErrorsTest.groovy b/src/test/groovy/graphql/ErrorsTest.groovy
@@ -0,0 +1,62 @@
+package graphql
+
+import graphql.language.SourceLocation
+import graphql.validation.ValidationError
+import graphql.validation.ValidationErrorType
+import spock.lang.Specification
+
+
+@SuppressWarnings("ChangeToOperator")
+class ErrorsTest extends Specification {
+
+    def src(int line, int col) {
+        new SourceLocation(line,col)
+    }
+
+
+    private static void commonAssert(GraphQLError same1, GraphQLError same2, GraphQLError different1) {
+        same1.equals(same2)
+        same1.hashCode() == same2.hashCode()
+
+        same2.equals(same1)
+
+        // we should equal ourselves
+        same1.equals(same1)
+
+        !same1.equals(different1)
+        same1.hashCode() != different1.hashCode()
+    }
+
+    def "InvalidSyntaxError equals and hashcode works"() {
+        expect:
+
+        def same1 = new InvalidSyntaxError(src(15,34))
+        def same2 = new InvalidSyntaxError(src(15,34))
+        def different1 = new InvalidSyntaxError([src(24,100), src(15,34)])
+
+        commonAssert(same1, same2, different1)
+    }
+
+    def "ValidationError equals and hashcode works"() {
+        expect:
+
+        def same1 = new ValidationError(ValidationErrorType.BadValueForDefaultArg,[src(15,34),src(23,567)],"bad ju ju")
+        def same2 = new ValidationError(ValidationErrorType.BadValueForDefaultArg,[src(15,34),src(23,567)],"bad ju ju")
+        def different1 = new ValidationError(ValidationErrorType.FieldsConflict,[src(15,34),src(23,567)],"bad ju ju")
+
+        commonAssert(same1, same2, different1)
+    }
+
+    def "ExceptionWhileDataFetching equals and hashcode works"() {
+        expect:
+
+        def same1 = new ExceptionWhileDataFetching(new RuntimeException("bad ju ju"))
+        def same2 = new ExceptionWhileDataFetching(new RuntimeException("bad ju ju"))
+        def different1 = new ExceptionWhileDataFetching(new RuntimeException("unexpected ju ju"))
+
+        commonAssert(same1, same2, different1)
+    }
+
+
+
+}
