Replace GraphQLError with GraphQlResponseError

This allows exposing additional conveniences for inspecting errors.

See gh-10

Author: rstoyanchev

spring-graphql-test/src/main/java/org/springframework/graphql/test/tester/AbstractDirectTransport.java

@@ -19,13 +19,13 @@
 import java.util.List;
 
 import graphql.ExecutionResult;
-import graphql.GraphQLError;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import org.springframework.graphql.GraphQlRequest;
 import org.springframework.graphql.GraphQlResponse;
+import org.springframework.graphql.GraphQlResponseError;
 import org.springframework.graphql.RequestOutput;
 import org.springframework.graphql.client.GraphQlTransport;
 import org.springframework.test.util.AssertionErrors;
@@ -58,7 +58,7 @@ public Flux<GraphQlResponse> executeSubscription(GraphQlRequest request) {
 				Object data = output.getData();
 				AssertionErrors.assertTrue("Not a Publisher: " + data, data instanceof Publisher);
 
-				List<GraphQLError> errors = output.getErrors();
+				List<GraphQlResponseError> errors = output.getErrors();
 				AssertionErrors.assertTrue("Subscription errors: " + errors, CollectionUtils.isEmpty(errors));
 
 				return Flux.from((Publisher<ExecutionResult>) data)

spring-graphql-test/src/main/java/org/springframework/graphql/test/tester/AbstractGraphQlTesterBuilder.java

@@ -24,8 +24,8 @@
 import com.jayway.jsonpath.spi.json.JacksonJsonProvider;
 import com.jayway.jsonpath.spi.mapper.JacksonMappingProvider;
 import com.jayway.jsonpath.spi.mapper.MappingProvider;
-import graphql.GraphQLError;
 
+import org.springframework.graphql.GraphQlResponseError;
 import org.springframework.graphql.client.AbstractGraphQlClientBuilder;
 import org.springframework.graphql.client.GraphQlTransport;
 import org.springframework.graphql.support.CachingDocumentSource;
@@ -57,7 +57,7 @@ public abstract class AbstractGraphQlTesterBuilder<B extends AbstractGraphQlTest
 
 
 	@Nullable
-	private Predicate<GraphQLError> errorFilter;
+	private Predicate<GraphQlResponseError> errorFilter;
 
 	private DocumentSource documentSource = new CachingDocumentSource(new ResourceDocumentSource());
 
@@ -67,7 +67,7 @@ public abstract class AbstractGraphQlTesterBuilder<B extends AbstractGraphQlTest
 
 
 	@Override
-	public B errorFilter(Predicate<GraphQLError> predicate) {
+	public B errorFilter(Predicate<GraphQlResponseError> predicate) {
 		this.errorFilter = (this.errorFilter != null ? errorFilter.and(predicate) : predicate);
 		return self();
 	}

spring-graphql-test/src/main/java/org/springframework/graphql/test/tester/DefaultGraphQlTester.java

@@ -31,12 +31,12 @@
 import com.jayway.jsonpath.DocumentContext;
 import com.jayway.jsonpath.JsonPath;
 import com.jayway.jsonpath.TypeRef;
-import graphql.GraphQLError;
 
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.core.ResolvableType;
 import org.springframework.graphql.GraphQlRequest;
 import org.springframework.graphql.GraphQlResponse;
+import org.springframework.graphql.GraphQlResponseError;
 import org.springframework.graphql.client.GraphQlTransport;
 import org.springframework.graphql.support.DocumentSource;
 import org.springframework.lang.Nullable;
@@ -61,7 +61,7 @@ final class DefaultGraphQlTester implements GraphQlTester {
 	private final GraphQlTransport transport;
 
 	@Nullable
-	private final Predicate<GraphQLError> errorFilter;
+	private final Predicate<GraphQlResponseError> errorFilter;
 
 	private final Configuration jsonPathConfig;
 
@@ -76,7 +76,7 @@ final class DefaultGraphQlTester implements GraphQlTester {
 	 * Package private constructor for use from {@link AbstractGraphQlTesterBuilder}.
 	 */
 	DefaultGraphQlTester(
-			GraphQlTransport transport, @Nullable Predicate<GraphQLError> errorFilter,
+			GraphQlTransport transport, @Nullable Predicate<GraphQlResponseError> errorFilter,
 			Configuration jsonPathConfig, DocumentSource documentSource, Duration timeout,
 			Consumer<AbstractGraphQlTesterBuilder<?>> builderInitializer) {
 
@@ -209,15 +209,15 @@ private final static class ResponseDelegate {
 
 		private final Supplier<String> jsonContent;
 
-		private final List<GraphQLError> errors;
+		private final List<GraphQlResponseError> errors;
 
-		private final List<GraphQLError> unexpectedErrors;
+		private final List<GraphQlResponseError> unexpectedErrors;
 
 		private final Consumer<Runnable> assertDecorator;
 
 
 		private ResponseDelegate(
-				GraphQlResponse response, @Nullable Predicate<GraphQLError> errorFilter,
+				GraphQlResponse response, @Nullable Predicate<GraphQlResponseError> errorFilter,
 				Consumer<Runnable> assertDecorator, Configuration jsonPathConfig) {
 
 			this.jsonDoc = JsonPath.parse(response.toMap(), jsonPathConfig);
@@ -253,9 +253,9 @@ void doAssert(Runnable task) {
 			this.assertDecorator.accept(task);
 		}
 
-		boolean filterErrors(Predicate<GraphQLError> predicate) {
+		boolean filterErrors(Predicate<GraphQlResponseError> predicate) {
 			boolean filtered = false;
-			for (GraphQLError error : this.errors) {
+			for (GraphQlResponseError error : this.errors) {
 				if (predicate.test(error)) {
 					this.unexpectedErrors.remove(error);
 					filtered = true;
@@ -264,12 +264,12 @@ boolean filterErrors(Predicate<GraphQLError> predicate) {
 			return filtered;
 		}
 
-		void expectErrors(Predicate<GraphQLError> predicate) {
+		void expectErrors(Predicate<GraphQlResponseError> predicate) {
 			boolean filtered = filterErrors(predicate);
 			this.assertDecorator.accept(() -> AssertionErrors.assertTrue("No matching errors.", filtered));
 		}
 
-		void consumeErrors(Consumer<List<GraphQLError>> consumer) {
+		void consumeErrors(Consumer<List<GraphQlResponseError>> consumer) {
 			filterErrors(error -> true);
 			consumer.accept(this.errors);
 		}
@@ -293,7 +293,7 @@ private static final class DefaultResponse implements Response, Errors {
 		private final ResponseDelegate delegate;
 
 		private DefaultResponse(
-				GraphQlResponse response, @Nullable Predicate<GraphQLError> errorFilter,
+				GraphQlResponse response, @Nullable Predicate<GraphQlResponseError> errorFilter,
 				Consumer<Runnable> assertDecorator, Configuration jsonPathConfig) {
 
 			this.delegate = new ResponseDelegate(response, errorFilter, assertDecorator, jsonPathConfig);
@@ -311,13 +311,13 @@ public Errors errors() {
 		}
 
 		@Override
-		public Errors filter(Predicate<GraphQLError> predicate) {
+		public Errors filter(Predicate<GraphQlResponseError> predicate) {
 			this.delegate.filterErrors(predicate);
 			return this;
 		}
 
 		@Override
-		public Errors expect(Predicate<GraphQLError> predicate) {
+		public Errors expect(Predicate<GraphQlResponseError> predicate) {
 			this.delegate.expectErrors(predicate);
 			return this;
 		}
@@ -329,7 +329,7 @@ public Traversable verify() {
 		}
 
 		@Override
-		public Traversable satisfy(Consumer<List<GraphQLError>> consumer) {
+		public Traversable satisfy(Consumer<List<GraphQlResponseError>> consumer) {
 			this.delegate.consumeErrors(consumer);
 			return this;
 		}

spring-graphql-test/src/main/java/org/springframework/graphql/test/tester/GraphQlTester.java

@@ -21,10 +21,10 @@
 import java.util.function.Consumer;
 import java.util.function.Predicate;
 
-import graphql.GraphQLError;
 import reactor.core.publisher.Flux;
 
 import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.graphql.GraphQlResponseError;
 import org.springframework.graphql.client.GraphQlTransport;
 import org.springframework.graphql.support.DocumentSource;
 import org.springframework.graphql.support.ResourceDocumentSource;
@@ -103,7 +103,7 @@ interface Builder<B extends Builder<B>> {
 		 * @param predicate the error filter to add
 		 * @return the same builder instance
 		 */
-		B errorFilter(Predicate<GraphQLError> predicate);
+		B errorFilter(Predicate<GraphQlResponseError> predicate);
 
 		/**
 		 * Configure a {@link DocumentSource} for use with
@@ -448,7 +448,7 @@ interface Errors {
 		 * @param errorPredicate the error filter to add
 		 * @return the same spec to add more filters before {@link #verify()}
 		 */
-		Errors filter(Predicate<GraphQLError> errorPredicate);
+		Errors filter(Predicate<GraphQlResponseError> errorPredicate);
 
 		/**
 		 * Use this to declare errors that are expected.
@@ -461,7 +461,7 @@ interface Errors {
 		 * @param errorPredicate the predicate for the expected error
 		 * @return the same spec to add more filters or expected errors
 		 */
-		Errors expect(Predicate<GraphQLError> errorPredicate);
+		Errors expect(Predicate<GraphQlResponseError> errorPredicate);
 
 		/**
 		 * Verify there are either no errors or that there no unexpected errors that have
@@ -477,7 +477,7 @@ interface Errors {
 		 * @param errorsConsumer to inspect errors with
 		 * @return a spec to switch to a data path
 		 */
-		Traversable satisfy(Consumer<List<GraphQLError>> errorsConsumer);
+		Traversable satisfy(Consumer<List<GraphQlResponseError>> errorsConsumer);
 
 	}
 

spring-graphql/src/main/java/org/springframework/graphql/GraphQlResponse.java

@@ -20,8 +20,6 @@
 import java.util.List;
 import java.util.Map;
 
-import graphql.GraphQLError;
-
 import org.springframework.lang.Nullable;
 
 /**
@@ -61,7 +59,7 @@ public interface GraphQlResponse {
 	 * response is not {@link #isValid() valid} and/or "field errors" for a
 	 * partial response.
 	 */
-	List<GraphQLError> getErrors();
+	List<GraphQlResponseError> getErrors();
 
 	/**
 	 * Return implementor specific, protocol extensions, if any.

spring-graphql/src/main/java/org/springframework/graphql/GraphQlResponseError.java

@@ -0,0 +1,66 @@
+package org.springframework.graphql;
+
+import java.util.List;
+import java.util.Map;
+
+import graphql.ErrorClassification;
+import graphql.language.SourceLocation;
+
+import org.springframework.lang.Nullable;
+
+/**
+ * Represents a GraphQL response error.
+ *
+ * @author Rossen Stoyanchev
+ * @since 1.0
+ */
+public interface GraphQlResponseError {
+
+	/**
+	 * Return the message with a description of the error intended for the
+	 * developer as a guide to understand and correct the error.
+	 */
+	@Nullable
+	String getMessage();
+
+	/**
+	 * Return a list of locations in the GraphQL document, if the error can be
+	 * associated to a particular point in the document. Each location has a
+	 * line and a column, both positive, starting from 1 and describing the
+	 * beginning of an associated syntax element.
+	 */
+	List<SourceLocation> getLocations();
+
+	/**
+	 * Return a classification for the error that is specific to GraphQL Java.
+	 * This is serialized under {@link #getExtensions() "extensions"} in the
+	 * response map.
+	 * @see graphql.ErrorType
+	 * @see org.springframework.graphql.execution.ErrorType
+	 */
+	@Nullable
+	ErrorClassification getErrorType();
+
+	/**
+	 * Return the path to a response field which experienced the error,
+	 * if the error can be associated to a particular field in the result. This
+	 * allows a client to identify whether a {@code null} result is intentional
+	 * or caused by an error.
+	 * <p>This list contains path segments starting at the root of the response
+	 * and ending with the field associated with the error. Path segments that
+	 * represent fields are strings, and path segments that represent list
+	 * indices are 0-indexed integers. If the error happens in an aliased field,
+	 * the path uses the aliased name, since it represents a path in the
+	 * response, not in the request.
+	 */
+	@Nullable
+	List<Object> getPath();
+
+	/**
+	 * Return a map with GraphQL Java specific error details such as the
+	 * {@link #getErrorType()}.
+	 */
+	@Nullable
+	Map<String, Object> getExtensions();
+
+}

spring-graphql/src/main/java/org/springframework/graphql/RequestOutput.java

@@ -18,10 +18,13 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
+import graphql.ErrorClassification;
 import graphql.ExecutionInput;
 import graphql.ExecutionResult;
 import graphql.GraphQLError;
+import graphql.language.SourceLocation;
 
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
@@ -55,9 +58,7 @@ public RequestOutput(ExecutionInput input, ExecutionResult result) {
 	 * Constructor to re-wrap from transport specific subclass.
 	 */
 	protected RequestOutput(RequestOutput requestOutput) {
-		Assert.notNull(requestOutput, "RequestOutput is required.");
-		this.input = requestOutput.getExecutionInput();
-		this.result = requestOutput.result;
+		this(requestOutput.getExecutionInput(), requestOutput.result);
 	}
 
 
@@ -84,8 +85,8 @@ public <T> T getData() {
 		return this.result.getData();
 	}
 
-	public List<GraphQLError> getErrors() {
-		return this.result.getErrors();
+	public List<GraphQlResponseError> getErrors() {
+		return this.result.getErrors().stream().map(OutputError::new).collect(Collectors.toList());
 	}
 
 	public Map<Object, Object> getExtensions() {
@@ -102,4 +103,41 @@ public String toString() {
 		return this.result.toString();
 	}
 
+
+	private static class OutputError implements GraphQlResponseError {
+
+		private final GraphQLError delegate;
+
+		OutputError(GraphQLError delegate) {
+			this.delegate = delegate;
+		}
+
+		@Override
+		public String getMessage() {
+			return this.delegate.getMessage();
+		}
+
+		@Override
+		public List<SourceLocation> getLocations() {
+			return this.delegate.getLocations();
+		}
+
+		@Override
+		public ErrorClassification getErrorType() {
+			return this.delegate.getErrorType();
+		}
+
+		@Override
+		public List<Object> getPath() {
+			return this.delegate.getPath();
+		}
+
+		@Override
+		public Map<String, Object> getExtensions() {
+			return this.delegate.getExtensions();
+		}
+
+	}
+
+
 }