Spring/spring-graphql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Raise exception for any field error in retrieve

Browse Source 
This commit aligns the behavior of retrieve with its Javadoc such that
any field error, including errors on nested fields, raises a
FieldAccessException

Closes gh-499
This commit is contained in:
rstoyanchev
2022-11-03 17:11:23 +00:00
parent 11fab7dafd
commit 02f96b6bf4
4 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-graphql/src/main/java/org/springframework/graphql/client/DefaultGraphQlClient.java
View File

@@ -186,13 +186,16 @@ final class DefaultGraphQlClient implements GraphQlClient {
} }
/** /**
* Return the field if valid, or {@code null} if {@code null} without errors. * Return the field or {@code null}, but only if the response is valid
* @throws FieldAccessException for invalid response or failed field * and there are no field errors, or raise {@link FieldAccessException}
* otherwise.
* @throws FieldAccessException in case of an invalid response or any
* field error at, above or below the field path
*/ */
@Nullable @Nullable
protected ClientResponseField getValidField(ClientGraphQlResponse response) { protected ClientResponseField getValidField(ClientGraphQlResponse response) {
ClientResponseField field = response.field(this.path); ClientResponseField field = response.field(this.path);
if (!response.isValid() || field.getError() != null) { if (!response.isValid() || !field.getErrors().isEmpty()) {
throw new FieldAccessException( throw new FieldAccessException(
((DefaultClientGraphQlResponse) response).getRequest(), response, field); ((DefaultClientGraphQlResponse) response).getRequest(), response, field);
} }

4
spring-graphql/src/main/java/org/springframework/graphql/client/GraphQlClient.java
View File

@@ -191,8 +191,8 @@ public interface GraphQlClient {
* client.document("..").execute().map(response -> response.toEntity(..)) * client.document("..").execute().map(response -> response.toEntity(..))
* </pre> * </pre>
* @return a spec with decoding options * @return a spec with decoding options
* @throws FieldAccessException if the target field has any errors, * @throws FieldAccessException if the field has any field errors,
* including nested errors. * including errors at, above or below the field path.
*/ */
RetrieveSpec retrieve(String path); RetrieveSpec retrieve(String path);

4
spring-graphql/src/main/java/org/springframework/graphql/support/AbstractGraphQlResponse.java
View File

@@ -133,7 +133,7 @@ public abstract class AbstractGraphQlResponse implements GraphQlResponse {
} }
/** /**
* Return field errors whose path starts with the given field path. * Return errors whose path is at, above, or below the given path.
* @param path the field path to match * @param path the field path to match
* @return errors whose path starts with the dataPath * @return errors whose path starts with the dataPath
*/ */
@@ -144,7 +144,7 @@ public abstract class AbstractGraphQlResponse implements GraphQlResponse {
return response.getErrors().stream() return response.getErrors().stream()
.filter(error -> { .filter(error -> {
String errorPath = error.getPath(); String errorPath = error.getPath();
return !errorPath.isEmpty() && (errorPath.startsWith(path) || path.startsWith(errorPath)); return (!errorPath.isEmpty() && (errorPath.startsWith(path) || path.startsWith(errorPath)));
}) })
.collect(Collectors.toList()); .collect(Collectors.toList());
} }

17
spring-graphql/src/test/java/org/springframework/graphql/client/GraphQlClientTests.java
View File

@@ -130,14 +130,23 @@ public class GraphQlClientTests extends GraphQlClientTestSupport {
} }
@Test @Test
void retrievePartialResponse() { void retrieveFieldErrorAt() {
String document = "fieldErrorResponse";
getGraphQlService().setDataAsJsonAndErrors(document, "{\"me\": null}", errorForPath("/me"));
testRetrieveFieldAccessException(document, "me");
}
@Test // gh-499
void retrieveFieldErrorBelow() {
String document = "fieldErrorResponse"; String document = "fieldErrorResponse";
getGraphQlService().setDataAsJsonAndErrors(document, "{\"me\": {\"name\":null}}", errorForPath("/me/name")); getGraphQlService().setDataAsJsonAndErrors(document, "{\"me\": {\"name\":null}}", errorForPath("/me/name"));
testRetrieveFieldAccessException(document, "me");
}
MovieCharacter character = graphQlClient().document(document).retrieve("me").toEntity(MovieCharacter.class).block(); @Test
assertThat(character).isNotNull().extracting(MovieCharacter::getName).isNull(); void retrieveFieldErrorAbove() {
String document = "fieldErrorResponse";
getGraphQlService().setDataAsJsonAndErrors(document, "{\"me\": null}", errorForPath("/me"));
testRetrieveFieldAccessException(document, "me.name"); testRetrieveFieldAccessException(document, "me.name");
} }