Filter out negative line and column locations from toSpecification

dondonz · dondonz · commit 69569de374a0 · 2024-11-24T14:51:40.000+11:00
diff --git a/src/main/java/graphql/GraphqlErrorHelper.java b/src/main/java/graphql/GraphqlErrorHelper.java
@@ -7,7 +7,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-import static graphql.collect.ImmutableKit.map;
+import static graphql.collect.ImmutableKit.mapAndDropNulls;
 
 /**
  * This little helper allows GraphQlErrors to implement
@@ -51,14 +51,20 @@ public static Map<String, Object> toSpecification(GraphQLError error) {
     }
 
     public static Object locations(List<SourceLocation> locations) {
-        return map(locations, GraphqlErrorHelper::location);
+        return mapAndDropNulls(locations, GraphqlErrorHelper::location);
     }
 
+    /**
+     *  Positive integers starting from 1 required for error locations,
+     *  from the spec <a href="https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format">...</a>
+     */
     public static Object location(SourceLocation location) {
-        Map<String, Integer> map = new LinkedHashMap<>();
-        map.put("line", location.getLine());
-        map.put("column", location.getColumn());
-        return map;
+        int line = location.getLine();
+        int column = location.getColumn();
+        if (line < 1 || column < 1) {
+            return null;
+        }
+        return Map.of("line", line, "column", column);
     }
 
     public static int hashCode(GraphQLError dis) {
diff --git a/src/test/groovy/graphql/GraphQLErrorTest.groovy b/src/test/groovy/graphql/GraphQLErrorTest.groovy
@@ -31,7 +31,7 @@ class GraphQLErrorTest extends Specification {
                 .description("Test ValidationError")
                 .build()                                                                               |
                 [
-                        locations: [[line: 666, column: 999], [line: 333, column: 0]],
+                        locations: [[line: 666, column: 999], [line: 333, column: 1]],
                         message  : "Test ValidationError",
                         extensions:[classification:"ValidationError"],
                 ]
@@ -44,7 +44,7 @@ class GraphQLErrorTest extends Specification {
 
         new InvalidSyntaxError(mkLocations(), "Not good syntax m'kay")                                 |
                 [
-                        locations: [[line: 666, column: 999], [line: 333, column: 0]],
+                        locations: [[line: 666, column: 999], [line: 333, column: 1]],
                         message  : "Not good syntax m'kay",
                         extensions:[classification:"InvalidSyntax"],
                 ]
@@ -72,6 +72,28 @@ class GraphQLErrorTest extends Specification {
 
     }
 
+    def "toSpecification filters out error locations with line and column not starting at 1, as required in spec"() {
+        // See specification wording: https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format
+
+        given:
+        def error = ValidationError.newValidationError()
+                .validationErrorType(ValidationErrorType.UnknownType)
+                .sourceLocations([mkLocation(-1, -1), mkLocation(333, 1)])
+                .description("Test ValidationError")
+                .build()
+
+        def expectedMap = [
+                locations: [
+                        [line: 333, column: 1]
+                ],
+                message: "Test ValidationError",
+                extensions: [classification:"ValidationError"]
+        ]
+
+        expect:
+        error.toSpecification() == expectedMap
+    }
+
     class CustomException extends RuntimeException implements GraphQLError {
         private LinkedHashMap<String, String> map
 
@@ -110,7 +132,7 @@ class GraphQLErrorTest extends Specification {
     }
 
     List<SourceLocation> mkLocations() {
-        return [mkLocation(666, 999), mkLocation(333, 0)]
+        return [mkLocation(666, 999), mkLocation(333, 1)]
     }
 
     SourceLocation mkLocation(int line, int column) {
