T getValue();
/**
- * Return errors with paths matching that of the field.
+ * Return the first error whose path is equal to the field path.
+ * According to section 6.4.4 "Handling Field Errors" of the GraphQL
+ * spec, only one error should be added to the errors list per field.
*/
- List getErrorsAt();
+ @Nullable
+ GraphQLError getError();
/**
- * Return errors with paths below that of the field.
+ * Return all field errors including those whose path is below the field path.
*/
- List getErrorsBelow();
-
- /**
- * Return errors with paths at or below that of the field.
- */
- List getErrorsAtOrBelow();
+ List getErrors();
/**
* Decode the field to an entity of the given type.
* @param entityType the type to convert to
- * @return the entity instance
+ * @return the decoded entity, possibly {@code null} if the field
+ * {@link #getValue() value} is {@code null}
+ * @throws FieldAccessException if "this" field is not {@link #isValid() valid}
*/
+ @Nullable
D toEntity(Class entityType);
/**
* Variant of {@link #toEntity(Class)} with a {@link ParameterizedTypeReference}.
* @param entityType the type to convert to
- * @return the entity instance
+ * @return the decoded entity, possibly {@code null} if the field
+ * {@link #getValue() value} is {@code null}
+ * @throws FieldAccessException if "this" field is not {@link #isValid() valid}
*/
+ @Nullable
D toEntity(ParameterizedTypeReference entityType);
/**
* Decode the field to a list of entities with the given type.
* @param elementType the type of elements in the list
- * @return the list of entities
+ * @return the decoded list of entities, possibly empty
+ * @throws FieldAccessException if "this" field is not {@link #isValid() valid}
*/
List toEntityList(Class elementType);
/**
* Variant of {@link #toEntityList(Class)} with {@link ParameterizedTypeReference}.
* @param elementType the type of elements in the list
- * @return the list of entities
+ * @return the decoded list of entities, possibly empty
+ * @throws FieldAccessException if "this" field is not {@link #isValid() valid}
*/
List toEntityList(ParameterizedTypeReference elementType);
diff --git a/spring-graphql/src/main/java/org/springframework/graphql/client/WebSocketGraphQlTransport.java b/spring-graphql/src/main/java/org/springframework/graphql/client/WebSocketGraphQlTransport.java
index 5e7405b7..0e0de7ff 100644
--- a/spring-graphql/src/main/java/org/springframework/graphql/client/WebSocketGraphQlTransport.java
+++ b/spring-graphql/src/main/java/org/springframework/graphql/client/WebSocketGraphQlTransport.java
@@ -34,7 +34,6 @@ import reactor.core.publisher.Sinks;
import org.springframework.graphql.GraphQlRequest;
import org.springframework.graphql.GraphQlResponse;
-import org.springframework.graphql.support.MapGraphQlError;
import org.springframework.graphql.support.MapGraphQlResponse;
import org.springframework.graphql.web.support.GraphQlMessage;
import org.springframework.graphql.web.support.GraphQlMessageType;
@@ -509,14 +508,14 @@ final class WebSocketGraphQlTransport implements GraphQlTransport {
}
List> errorList = message.getPayload();
+ GraphQlResponse response = MapGraphQlResponse.forErrorsOnly(errorList);
Sinks.EmitResult emitResult;
if (responseState != null) {
- GraphQlResponse response = MapGraphQlResponse.forErrorsOnly(errorList);
emitResult = responseState.sink().tryEmitValue(response);
}
else {
- List graphQLErrors = MapGraphQlError.from(errorList);
+ List graphQLErrors = response.getErrors();
Exception ex = new SubscriptionErrorException(subscriptionState.request(), graphQLErrors);
emitResult = subscriptionState.sink().tryEmitError(ex);
}
diff --git a/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlError.java b/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlError.java
index f2313a4b..475007f3 100644
--- a/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlError.java
+++ b/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlError.java
@@ -37,14 +37,14 @@ import org.springframework.util.Assert;
* @since 1.0.0
*/
@SuppressWarnings("serial")
-public final class MapGraphQlError implements GraphQLError {
+final class MapGraphQlError implements GraphQLError {
private final Map errorMap;
private final List locations;
- private MapGraphQlError(Map errorMap) {
+ MapGraphQlError(Map errorMap) {
Assert.notNull(errorMap, "'errorMap' is required");
this.errorMap = errorMap;
this.locations = initLocations(errorMap);
@@ -134,14 +134,4 @@ public final class MapGraphQlError implements GraphQLError {
return toSpecification().toString();
}
-
- /**
- * Create a list of {@code GraphQlError} instances from the given
- * deserialized content.
- */
- public static List from(@Nullable List> errors) {
- errors = (errors != null ? errors : Collections.emptyList());
- return errors.stream().map(MapGraphQlError::new).collect(Collectors.toList());
- }
-
}
diff --git a/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlResponse.java b/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlResponse.java
index 7e65ec70..869af2d7 100644
--- a/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlResponse.java
+++ b/spring-graphql/src/main/java/org/springframework/graphql/support/MapGraphQlResponse.java
@@ -16,6 +16,7 @@
package org.springframework.graphql.support;
+import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
@@ -24,7 +25,10 @@ import graphql.ExecutionResult;
import graphql.GraphQLError;
import org.springframework.graphql.GraphQlResponse;
+import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.StringUtils;
/**
* {@link GraphQlResponse} for client use that wraps the GraphQL response map.
@@ -34,6 +38,12 @@ import org.springframework.util.Assert;
*/
public class MapGraphQlResponse implements GraphQlResponse {
+ /**
+ * Returned from {@link #getFieldValue(List)} to indicate a value does not exist.
+ */
+ protected final static Object NO_VALUE = new Object();
+
+
private final Map responseMap;
private final List errors;
@@ -43,7 +53,20 @@ public class MapGraphQlResponse implements GraphQlResponse {
protected MapGraphQlResponse(Map responseMap) {
Assert.notNull(responseMap, "'responseMap' is required");
this.responseMap = responseMap;
- this.errors = MapGraphQlError.from((List>) responseMap.get("errors"));
+ this.errors = wrapErrors(responseMap);
+ }
+
+ @SuppressWarnings("unchecked")
+ private static List wrapErrors(Map responseMap) {
+ List> rawErrors = (List>) responseMap.get("errors");
+ if (CollectionUtils.isEmpty(rawErrors)) {
+ return Collections.emptyList();
+ }
+ List errors = new ArrayList<>(rawErrors.size());
+ for (Map map : rawErrors) {
+ errors.add(new MapGraphQlError(map));
+ }
+ return errors;
}
@@ -74,6 +97,112 @@ public class MapGraphQlResponse implements GraphQlResponse {
return this.responseMap;
}
+ /**
+ * Parse the given field path, producing an output compatible with
+ * {@link graphql.execution.ResultPath#parse(String)} but using "." instead
+ * of "/" as separators.
+ * @param path the path to parse
+ * @return the parsed path segments and offsets, possibly empty
+ * @throws IllegalArgumentException for path syntax issues
+ */
+ protected static List