Skip to content

Commit 42dc83f

Browse files
committed
#438 now with double checks in null values that might come out of coercion
1 parent a0096cb commit 42dc83f

5 files changed

Lines changed: 150 additions & 19 deletions

File tree

‎src/main/java/graphql/execution/Execution.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ private GraphQLObjectType getOperationRootType(GraphQLSchema graphQLSchema, Oper
5656
} else if (operation == QUERY) {
5757
return graphQLSchema.getQueryType();
5858

59-
} else if (operation == SUBSCRIPTION) {
59+
} else if (operation == SUBSCRIPTION) {
6060
return graphQLSchema.getSubscriptionType();
6161

6262
} else {
@@ -90,10 +90,14 @@ private ExecutionResult executeOperation(
9090

9191
Map<String, List<Field>> fields = fieldCollector.collectFields(collectorParameters, operationDefinition.getSelectionSet());
9292

93+
TypeInfo typeInfo = newTypeInfo().type(operationRootType).build();
94+
NonNullableFieldValidator nonNullableFieldValidator = new NonNullableFieldValidator(executionContext, typeInfo);
95+
9396
ExecutionParameters parameters = newParameters()
94-
.typeInfo(newTypeInfo().type(operationRootType))
97+
.typeInfo(typeInfo)
9598
.source(root)
9699
.fields(fields)
100+
.nonNullFieldValidator(nonNullableFieldValidator)
97101
.build();
98102

99103
ExecutionResult result;

‎src/main/java/graphql/execution/ExecutionParameters.java‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package graphql.execution;
22

3+
import graphql.Assert;
34
import graphql.language.Field;
45

56
import java.util.List;
@@ -15,12 +16,14 @@ public class ExecutionParameters {
1516
private final Object source;
1617
private final Map<String, Object> arguments;
1718
private final Map<String, List<Field>> fields;
19+
private final NonNullableFieldValidator nonNullableFieldValidator;
1820

19-
private ExecutionParameters(TypeInfo typeInfo, Object source, Map<String, List<Field>> fields, Map<String, Object> arguments) {
21+
private ExecutionParameters(TypeInfo typeInfo, Object source, Map<String, List<Field>> fields, Map<String, Object> arguments, NonNullableFieldValidator nonNullableFieldValidator) {
2022
this.typeInfo = assertNotNull(typeInfo, "typeInfo is null");
2123
this.fields = assertNotNull(fields, "fields is null");
2224
this.source = source;
2325
this.arguments = arguments;
26+
this.nonNullableFieldValidator = nonNullableFieldValidator;
2427
}
2528

2629
public TypeInfo typeInfo() {
@@ -39,6 +42,10 @@ public Map<String, Object> arguments() {
3942
return arguments;
4043
}
4144

45+
public NonNullableFieldValidator nonNullFieldValidator() {
46+
return nonNullableFieldValidator;
47+
}
48+
4249
public static Builder newParameters() {
4350
return new Builder();
4451
}
@@ -54,6 +61,7 @@ public static class Builder {
5461
Object source;
5562
Map<String, List<Field>> fields;
5663
Map<String, Object> arguments;
64+
NonNullableFieldValidator nonNullableFieldValidator;
5765

5866
public Builder typeInfo(TypeInfo type) {
5967
this.typeInfo = type;
@@ -79,9 +87,14 @@ public Builder arguments(Map<String, Object> arguments) {
7987
this.arguments = arguments;
8088
return this;
8189
}
90+
91+
public Builder nonNullFieldValidator(NonNullableFieldValidator nonNullableFieldValidator) {
92+
this.nonNullableFieldValidator = Assert.assertNotNull(nonNullableFieldValidator,"requires a NonNullValidator");
93+
return this;
94+
}
8295

8396
public ExecutionParameters build() {
84-
return new ExecutionParameters(typeInfo, source, fields, arguments);
97+
return new ExecutionParameters(typeInfo, source, fields, arguments, nonNullableFieldValidator);
8598
}
8699
}
87100
}

‎src/main/java/graphql/execution/ExecutionStrategy.java‎

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ public abstract class ExecutionStrategy {
6060
* @param argumentValues the map of arguments
6161
* @param e the exception that occurred
6262
*/
63+
@SuppressWarnings("unused")
6364
protected void handleDataFetchingException(
6465
ExecutionContext executionContext,
6566
GraphQLFieldDefinition fieldDef,
@@ -113,11 +114,15 @@ protected ExecutionResult resolveField(ExecutionContext executionContext, Execut
113114
.build();
114115

115116

117+
NonNullableFieldValidator nonNullableFieldValidator = new NonNullableFieldValidator(executionContext, fieldTypeInfo);
118+
116119
ExecutionParameters newParameters = ExecutionParameters.newParameters()
117120
.typeInfo(fieldTypeInfo)
118121
.fields(parameters.fields())
119122
.arguments(argumentValues)
120-
.source(resolvedValue).build();
123+
.source(resolvedValue)
124+
.nonNullFieldValidator(nonNullableFieldValidator)
125+
.build();
121126

122127
ExecutionResult result = completeValue(executionContext, newParameters, fields);
123128

@@ -131,19 +136,13 @@ protected ExecutionResult completeValue(ExecutionContext executionContext, Execu
131136
GraphQLType fieldType = parameters.typeInfo().type();
132137

133138
if (result == null) {
134-
if (typeInfo.typeIsNonNull()) {
135-
// see http://facebook.github.io/graphql/#sec-Errors-and-Non-Nullability
136-
NonNullableFieldWasNullException nonNullException = new NonNullableFieldWasNullException(typeInfo);
137-
executionContext.addError(nonNullException);
138-
throw nonNullException;
139-
}
140-
return null;
139+
return parameters.nonNullFieldValidator().validate(null);
141140
} else if (fieldType instanceof GraphQLList) {
142141
return completeValueForList(executionContext, parameters, fields, toIterable(result));
143142
} else if (fieldType instanceof GraphQLScalarType) {
144-
return completeValueForScalar((GraphQLScalarType) fieldType, result);
143+
return completeValueForScalar((GraphQLScalarType) fieldType, parameters, result);
145144
} else if (fieldType instanceof GraphQLEnumType) {
146-
return completeValueForEnum((GraphQLEnumType) fieldType, result);
145+
return completeValueForEnum((GraphQLEnumType) fieldType, parameters, result);
147146
}
148147

149148

@@ -179,9 +178,13 @@ protected ExecutionResult completeValue(ExecutionContext executionContext, Execu
179178

180179
Map<String, List<Field>> subFields = fieldCollector.collectFields(collectorParameters, fields);
181180

181+
TypeInfo newTypeInfo = typeInfo.asType(resolvedType);
182+
NonNullableFieldValidator nonNullableFieldValidator = new NonNullableFieldValidator(executionContext, newTypeInfo);
183+
182184
ExecutionParameters newParameters = ExecutionParameters.newParameters()
183-
.typeInfo(typeInfo.asType(resolvedType))
185+
.typeInfo(newTypeInfo)
184186
.fields(subFields)
187+
.nonNullFieldValidator(nonNullableFieldValidator)
185188
.source(result).build();
186189

187190
// Calling this from the executionContext to ensure we shift back from mutation strategy to the query strategy.
@@ -215,16 +218,19 @@ protected GraphQLObjectType resolveTypeForUnion(TypeResolutionParameters params)
215218
return result;
216219
}
217220

218-
protected ExecutionResult completeValueForEnum(GraphQLEnumType enumType, Object result) {
219-
return new ExecutionResultImpl(enumType.getCoercing().serialize(result), null);
221+
protected ExecutionResult completeValueForEnum(GraphQLEnumType enumType, ExecutionParameters parameters, Object result) {
222+
Object serialized = enumType.getCoercing().serialize(result);
223+
serialized = parameters.nonNullFieldValidator().validate(serialized);
224+
return new ExecutionResultImpl(serialized, null);
220225
}
221226

222-
protected ExecutionResult completeValueForScalar(GraphQLScalarType scalarType, Object result) {
227+
protected ExecutionResult completeValueForScalar(GraphQLScalarType scalarType, ExecutionParameters parameters, Object result) {
223228
Object serialized = scalarType.getCoercing().serialize(result);
224229
//6.6.1 http://facebook.github.io/graphql/#sec-Field-entries
225230
if (serialized instanceof Double && ((Double) serialized).isNaN()) {
226231
serialized = null;
227232
}
233+
serialized = parameters.nonNullFieldValidator().validate(serialized);
228234
return new ExecutionResultImpl(serialized, null);
229235
}
230236

@@ -234,9 +240,13 @@ protected ExecutionResult completeValueForList(ExecutionContext executionContext
234240
GraphQLList fieldType = typeInfo.castType(GraphQLList.class);
235241
for (Object item : result) {
236242

243+
TypeInfo wrappedTypeInfo = typeInfo.asType(fieldType.getWrappedType());
244+
NonNullableFieldValidator nonNullableFieldValidator = new NonNullableFieldValidator(executionContext, wrappedTypeInfo);
245+
237246
ExecutionParameters newParameters = ExecutionParameters.newParameters()
238-
.typeInfo(typeInfo.asType(fieldType.getWrappedType()))
247+
.typeInfo(wrappedTypeInfo)
239248
.fields(parameters.fields())
249+
.nonNullFieldValidator(nonNullableFieldValidator)
240250
.source(item).build();
241251

242252
ExecutionResult completedValue = completeValue(executionContext, newParameters, fields);
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
package graphql.execution;
2+
3+
4+
/**
5+
* This will check that a value is non null when the type definition says it must be and it will throw {@link NonNullableFieldWasNullException}
6+
* if this is not the case.
7+
*
8+
* See: http://facebook.github.io/graphql/#sec-Errors-and-Non-Nullability
9+
*/
10+
public class NonNullableFieldValidator {
11+
private final ExecutionContext executionContext;
12+
private final TypeInfo typeInfo;
13+
14+
public NonNullableFieldValidator(ExecutionContext executionContext, TypeInfo typeInfo) {
15+
this.executionContext = executionContext;
16+
this.typeInfo = typeInfo;
17+
}
18+
19+
/**
20+
* Called to check that a value is non null if the type requires it to be non null
21+
*
22+
* @param result the result to check
23+
*
24+
* @return the result back
25+
*
26+
* @throws NonNullableFieldWasNullException if the value is null but the type requires it to be non null
27+
*/
28+
<T> T validate(T result) throws NonNullableFieldWasNullException {
29+
if (result == null) {
30+
if (typeInfo.typeIsNonNull()) {
31+
// see http://facebook.github.io/graphql/#sec-Errors-and-Non-Nullability
32+
NonNullableFieldWasNullException nonNullException = new NonNullableFieldWasNullException(typeInfo);
33+
executionContext.addError(nonNullException);
34+
throw nonNullException;
35+
}
36+
}
37+
return result;
38+
}
39+
40+
}

‎src/test/groovy/graphql/execution/ExecutionStrategyTest.groovy‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@ import graphql.ExecutionResult
44
import graphql.GraphQLException
55
import graphql.Scalars
66
import graphql.language.Field
7+
import graphql.schema.Coercing
78
import graphql.schema.GraphQLList
9+
import graphql.schema.GraphQLScalarType
810
import spock.lang.Specification
911

1012
import static graphql.execution.ExecutionParameters.newParameters
13+
import static graphql.schema.GraphQLNonNull.nonNull
1114

15+
@SuppressWarnings("GroovyPointlessBoolean")
1216
class ExecutionStrategyTest extends Specification {
1317

1418
ExecutionStrategy executionStrategy
@@ -86,4 +90,64 @@ class ExecutionStrategyTest extends Specification {
8690

8791
}
8892

93+
def "completing a scalar null value for a non null type throws an exception"() {
94+
95+
GraphQLScalarType NullProducingScalar = new GraphQLScalarType("Custom", "It Can Produce Nulls", new Coercing<Double, Double>() {
96+
@Override
97+
Double serialize(Object input) {
98+
if (input == 0xCAFED00Dd) {
99+
return null
100+
}
101+
return 0xCAFEBABEd
102+
}
103+
104+
@Override
105+
Double parseValue(Object input) {
106+
throw new UnsupportedOperationException("Not implemented")
107+
}
108+
109+
@Override
110+
Double parseLiteral(Object input) {
111+
throw new UnsupportedOperationException("Not implemented")
112+
}
113+
})
114+
115+
116+
ExecutionContext executionContext = buildContext()
117+
def fieldType = NullProducingScalar
118+
def typeInfo = TypeInfo.newTypeInfo().type(nonNull(fieldType)).build()
119+
NonNullableFieldValidator nullableFieldValidator = new NonNullableFieldValidator(executionContext,typeInfo)
120+
121+
when:
122+
def parameters = newParameters()
123+
.typeInfo(TypeInfo.newTypeInfo().type(fieldType))
124+
.source(result)
125+
.fields(["dummy": []])
126+
.nonNullFieldValidator(nullableFieldValidator)
127+
.build()
128+
129+
Exception actualException = null
130+
try {
131+
executionStrategy.completeValue(executionContext, parameters, [new Field()])
132+
} catch (Exception e) {
133+
actualException = e
134+
}
135+
136+
then:
137+
if (errorExpected) {
138+
actualException instanceof NonNullableFieldWasNullException
139+
executionContext.errors.size() == 1
140+
} else {
141+
actualException != null
142+
executionContext.errors.size() == 0
143+
}
144+
145+
146+
where:
147+
result || errorExpected
148+
1.0d || false
149+
0xCAFED00Dd || true
150+
null || true
151+
}
152+
89153
}

0 commit comments

Comments
 (0)