FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Simplify circular default value validation by andimarek · Pull Request #4460 · graphql-java/graphql-java · GitHub

/ graphql-java Public

Simplify circular default value validation #4460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andimarek wants to merge 2 commits into
base: master
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 1 Commits 2 Checks 11 Files changed
Open

Simplify circular default value validation #4460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e617f0
Simplify circular default value validation
andimarek Aug 23, 2026
f180dcf
Restore circular default integration coverage
andimarek Aug 23, 2026
File filter

Filter by extension

Filter by extension .groovy  (2) .java  (3) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
16 changes: 13 additions & 3 deletions src/main/java/graphql/schema/validation/DefaultValuesAreValid.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public TraversalControl visitGraphQLInputObjectField(GraphQLInputObjectField inp
!validationUtil.isValidLiteralValue((Value<?>) defaultValue.getValue(), inputObjectField.getType(), schema, graphQLContext, Locale.getDefault())) {
invalid = true;
} else if (defaultValue.isExternal() &&
!isValidExternalValue(schema, defaultValue.getValue(), inputObjectField.getType(), graphQLContext)) {
!isValidExternalValue(schema, defaultValue.getValue(), inputObjectField.getType(), graphQLContext, errorCollector)) {
invalid = true;
}
if (invalid) {
Expand All @@ -70,7 +70,7 @@ public TraversalControl visitGraphQLArgument(GraphQLArgument argument, Traverser
!validationUtil.isValidLiteralValue((Value<?>) defaultValue.getValue(), argument.getType(), schema, graphQLContext, Locale.getDefault())) {
invalid = true;
} else if (defaultValue.isExternal() &&
!isValidExternalValue(schema, defaultValue.getValue(), argument.getType(), graphQLContext)) {
!isValidExternalValue(schema, defaultValue.getValue(), argument.getType(), graphQLContext, errorCollector)) {
invalid = true;
}
if (invalid) {
Expand All @@ -80,7 +80,17 @@ public TraversalControl visitGraphQLArgument(GraphQLArgument argument, Traverser
return TraversalControl.CONTINUE;
}

private boolean isValidExternalValue(GraphQLSchema schema, Object externalValue, GraphQLInputType type, GraphQLContext graphQLContext) {
private boolean isValidExternalValue(
GraphQLSchema schema,
Object externalValue,
GraphQLInputType type,
GraphQLContext graphQLContext,
SchemaValidationErrorCollector errorCollector
) {
// Coercion expands nested field defaults. Avoid recursing into a cycle that has already made the schema invalid.
if (errorCollector.containsValidationError(SchemaValidationErrorType.DefaultValueCircularRef)) {
return true;
}
try {
ValuesResolver.externalValueToInternalValue(schema.getCodeRegistry().getFieldVisibility(), externalValue, type, graphQLContext, Locale.getDefault());
return true;
Expand Down
237 changes: 94 additions & 143 deletions src/main/java/graphql/schema/validation/NoDefaultValueCircularRefs.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@
import graphql.language.ObjectField;
import graphql.language.ObjectValue;
import graphql.language.Value;
import graphql.schema.GraphQLArgument;
import graphql.schema.GraphQLInputObjectField;
import graphql.schema.GraphQLInputObjectType;
import graphql.schema.GraphQLSchemaElement;
import graphql.schema.GraphQLType;
import graphql.schema.GraphQLTypeVisitorStub;
import graphql.schema.InputValueWithState;
import graphql.util.FpKit;
import graphql.util.TraversalControl;
import graphql.util.TraverserContext;
import org.jspecify.annotations.Nullable;

import java.util.ArrayList;
import java.util.LinkedHashMap;
Expand Down Expand Up @@ -42,198 +45,146 @@
@Internal
public class NoDefaultValueCircularRefs extends GraphQLTypeVisitorStub {

// Coordinates already fully traversed without finding a cycle, used to avoid duplicate error reports
// when the same coordinate is reachable from multiple input object types.
private final Set<String> fullyExplored = new LinkedHashSet<>();

// The spec's "visitedFields" set, tracked as coordinate strings ("Type.field").
// The spec creates a new immutable set at each step; this implementation mutates and backtracks
// for the same effect.
private final LinkedHashSet<String> visitedFields = new LinkedHashSet<>();
private final Set<String> checkedFields = new LinkedHashSet<>();
private final LinkedHashSet<String> fieldPath = new LinkedHashSet<>();

@Override
public TraversalControl visitGraphQLInputObjectType(GraphQLInputObjectType type, TraverserContext<GraphQLSchemaElement> context) {
SchemaValidationErrorCollector errorCollector = context.getVarFromParents(SchemaValidationErrorCollector.class);

// Implements InputObjectDefaultValueHasCycle(inputObject) from the spec:
// "If defaultValue is not provided, initialize it to an empty unordered map."
inputObjectDefaultValueHasCycle(type, ObjectValue.newObjectValue().build(), errorCollector);

checkType(type, getErrorCollector(context));
return TraversalControl.CONTINUE;
}

/**
* Implements {@code InputObjectDefaultValueHasCycle(inputObject, defaultValue, visitedFields)}
* from the spec, for literal (AST) default values.
*/
private void inputObjectDefaultValueHasCycle(
GraphQLInputObjectType inputObject,
Value<?> defaultValue,
SchemaValidationErrorCollector errorCollector
) {
// "If defaultValue is a list: for each itemValue in defaultValue..."
if (defaultValue instanceof ArrayValue) {
for (Value<?> itemValue : ((ArrayValue) defaultValue).getValues()) {
inputObjectDefaultValueHasCycle(inputObject, itemValue, errorCollector);
}
return;
}

// "Otherwise, if defaultValue is an unordered map..."
if (!(defaultValue instanceof ObjectValue)) {
return;
}

ObjectValue objectValue = (ObjectValue) defaultValue;
Map<String, Value<?>> defaultValueMap = new LinkedHashMap<>();
for (ObjectField field : objectValue.getObjectFields()) {
defaultValueMap.put(field.getName(), field.getValue());
@Override
public TraversalControl visitGraphQLArgument(GraphQLArgument argument, TraverserContext<GraphQLSchemaElement> context) {
GraphQLType namedType = unwrapAll(argument.getType());
if (namedType instanceof GraphQLInputObjectType) {
checkType((GraphQLInputObjectType) namedType, getErrorCollector(context));
}
return TraversalControl.CONTINUE;
}

// "For each field in inputObject: if InputFieldDefaultValueHasCycle(...)"
for (GraphQLInputObjectField field : inputObject.getFieldDefinitions()) {
String fieldName = field.getName();
boolean hasDefaultValue = defaultValueMap.containsKey(fieldName);
if (!hasDefaultValue && field.getInputFieldDefaultValue().isNotSet()) {
continue;
}

GraphQLType namedFieldType = unwrapAll(field.getType());
if (!(namedFieldType instanceof GraphQLInputObjectType)) {
private void checkType(GraphQLInputObjectType type, SchemaValidationErrorCollector errorCollector) {
for (GraphQLInputObjectField field : type.getFieldDefinitions()) {
GraphQLInputObjectType fieldType = getInputObjectType(field);
if (fieldType == null) {
continue;
}

GraphQLInputObjectType fieldInputObject = (GraphQLInputObjectType) namedFieldType;
if (hasDefaultValue) {
// "Let fieldDefaultValue be the value for fieldName in defaultValue.
// If fieldDefaultValue exists: InputObjectDefaultValueHasCycle(namedFieldType, fieldDefaultValue, visitedFields)"
inputObjectDefaultValueHasCycle(fieldInputObject, defaultValueMap.get(fieldName), errorCollector);
} else {
// "Otherwise: let fieldDefaultValue be the default value of field..."
inputFieldDefaultValueHasCycle(field, fieldInputObject, inputObject.getName(), errorCollector);
}
checkFieldDefaultValue(field, fieldType, type.getName(), errorCollector);
}
}

/**
* Implements {@code InputObjectDefaultValueHasCycle(inputObject, defaultValue, visitedFields)}
* from the spec, for external (programmatic Map/List) default values.
*/
private void inputObjectDefaultValueHasCycle(
private void checkValue(
GraphQLInputObjectType inputObject,
Object defaultValue,
@Nullable Object value,
SchemaValidationErrorCollector errorCollector
) {
// "If defaultValue is a list: for each itemValue in defaultValue..."
if (defaultValue instanceof Iterable) {
for (Object itemValue : (Iterable<?>) defaultValue) {
if (itemValue != null) {
inputObjectDefaultValueHasCycle(inputObject, itemValue, errorCollector);
}
if (value == null) {
return;
}
if (value instanceof ArrayValue) {
for (Value<?> itemValue : ((ArrayValue) value).getValues()) {
checkValue(inputObject, itemValue, errorCollector);
}
return;
}

// "Otherwise, if defaultValue is an unordered map..."
if (!(defaultValue instanceof Map)) {
if (FpKit.isIterable(value)) {
for (Object itemValue : FpKit.toIterable(value)) {
checkValue(inputObject, itemValue, errorCollector);
}
return;
}

@SuppressWarnings("unchecked")
Map<String, Object> defaultValueMap = (Map<String, Object>) defaultValue;
Map<?, ?> valueMap = getValueMap(value);
if (valueMap == null) {
return;
}
checkObjectValue(inputObject, valueMap, errorCollector);
}

// "For each field in inputObject: if InputFieldDefaultValueHasCycle(...)"
private void checkObjectValue(
GraphQLInputObjectType inputObject,
Map<?, ?> valueMap,
SchemaValidationErrorCollector errorCollector
) {
for (GraphQLInputObjectField field : inputObject.getFieldDefinitions()) {
String fieldName = field.getName();
boolean hasDefaultValue = defaultValueMap.containsKey(fieldName);
if (!hasDefaultValue && field.getInputFieldDefaultValue().isNotSet()) {
boolean hasValue = valueMap.containsKey(field.getName());
if (!hasValue && field.getInputFieldDefaultValue().isNotSet()) {
continue;
}

GraphQLType namedFieldType = unwrapAll(field.getType());
if (!(namedFieldType instanceof GraphQLInputObjectType)) {
GraphQLInputObjectType fieldType = getInputObjectType(field);
if (fieldType == null) {
continue;
}

GraphQLInputObjectType fieldInputObject = (GraphQLInputObjectType) namedFieldType;
if (hasDefaultValue) {
// "Let fieldDefaultValue be the value for fieldName in defaultValue.
// If fieldDefaultValue exists: InputObjectDefaultValueHasCycle(namedFieldType, fieldDefaultValue, visitedFields)"
Object fieldDefaultValue = defaultValueMap.get(fieldName);
if (fieldDefaultValue != null) {
inputObjectDefaultValueHasCycle(fieldInputObject, fieldDefaultValue, errorCollector);
}
} else {
// "Otherwise: let fieldDefaultValue be the default value of field..."
inputFieldDefaultValueHasCycle(field, fieldInputObject, inputObject.getName(), errorCollector);
if (hasValue) {
checkValue(fieldType, valueMap.get(field.getName()), errorCollector);
continue;
}
checkFieldDefaultValue(field, fieldType, inputObject.getName(), errorCollector);
}
}

/**
* Implements the "Otherwise" branch of {@code InputFieldDefaultValueHasCycle(field, defaultValue, visitedFields)}
* from the spec — called when the field is not present in the parent's default value,
* so the field's own default will be used at runtime.
*/
private void inputFieldDefaultValueHasCycle(
private void checkFieldDefaultValue(
GraphQLInputObjectField field,
GraphQLInputObjectType namedFieldType,
GraphQLInputObjectType fieldType,
String parentTypeName,
SchemaValidationErrorCollector errorCollector
) {
// "Let fieldDefaultValue be the default value of field.
// If fieldDefaultValue does not exist: return false."
InputValueWithState fieldDefaultValue = field.getInputFieldDefaultValue();
if (fieldDefaultValue.isNotSet()) {
InputValueWithState defaultValue = field.getInputFieldDefaultValue();
if (!defaultValue.isLiteral() && !defaultValue.isExternal()) {
return;
}

String coordinate = parentTypeName + "." + field.getName();
if (fieldPath.contains(coordinate)) {
addError(coordinate, errorCollector);
return;
}
if (!checkedFields.add(coordinate)) {
return;
}

// "If field is within visitedFields: return true."
if (visitedFields.contains(coordinate)) {
// Cycle found — collect intermediate nodes (everything after the coordinate itself)
List<String> intermediaries = new ArrayList<>();
boolean found = false;
for (String entry : visitedFields) {
if (found) {
intermediaries.add(entry);
}
if (entry.equals(coordinate)) {
found = true;
}
}
fieldPath.add(coordinate);
checkValue(fieldType, defaultValue.getValue(), errorCollector);
fieldPath.remove(coordinate);
}

String message;
if (intermediaries.isEmpty()) {
message = "Invalid circular reference. The default value of Input Object field "
+ coordinate + " references itself.";
} else {
message = "Invalid circular reference. The default value of Input Object field "
+ coordinate + " references itself via the default values of: "
+ String.join(", ", intermediaries) + ".";
}
private void addError(String coordinate, SchemaValidationErrorCollector errorCollector) {
List<String> path = new ArrayList<>(fieldPath);
List<String> intermediaries = path.subList(path.indexOf(coordinate) + 1, path.size());
String via = intermediaries.isEmpty()
? ""
: " via the default values of: " + String.join(", ", intermediaries);
String message = "Invalid circular reference. The default value of Input Object field "
+ coordinate + " references itself" + via + ".";
errorCollector.addError(new SchemaValidationError(
SchemaValidationErrorType.DefaultValueCircularRef, message));
}

errorCollector.addError(new SchemaValidationError(
SchemaValidationErrorType.DefaultValueCircularRef, message));
return;
private @Nullable GraphQLInputObjectType getInputObjectType(GraphQLInputObjectField field) {
GraphQLType type = unwrapAll(field.getType());
if (type instanceof GraphQLInputObjectType) {
return (GraphQLInputObjectType) type;
}
return null;
}

if (fullyExplored.contains(coordinate)) {
return;
private @Nullable Map<?, ?> getValueMap(Object value) {
if (value instanceof Map) {
return (Map<?, ?>) value;
}
if (!(value instanceof ObjectValue)) {
return null;
}
fullyExplored.add(coordinate);

// "Let nextVisitedFields be a new set containing field and everything from visitedFields.
// Return InputObjectDefaultValueHasCycle(namedFieldType, fieldDefaultValue, nextVisitedFields)."
visitedFields.add(coordinate);

if (fieldDefaultValue.isLiteral() && fieldDefaultValue.getValue() instanceof Value) {
inputObjectDefaultValueHasCycle(namedFieldType, (Value<?>) fieldDefaultValue.getValue(), errorCollector);
} else if (fieldDefaultValue.isExternal() && fieldDefaultValue.getValue() != null) {
inputObjectDefaultValueHasCycle(namedFieldType, fieldDefaultValue.getValue(), errorCollector);
Map<String, Value<?>> valueMap = new LinkedHashMap<>();
for (ObjectField field : ((ObjectValue) value).getObjectFields()) {
valueMap.put(field.getName(), field.getValue());
}
return valueMap;
}

visitedFields.remove(coordinate);
private SchemaValidationErrorCollector getErrorCollector(TraverserContext<GraphQLSchemaElement> context) {
return context.getVarFromParents(SchemaValidationErrorCollector.class);
}
}
11 changes: 3 additions & 8 deletions src/main/java/graphql/schema/validation/SchemaValidator.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@
@Internal
public class SchemaValidator {


private final List<GraphQLTypeVisitor> rules = new ArrayList<>();

public SchemaValidator() {
public List<GraphQLTypeVisitor> getRules() {
List<GraphQLTypeVisitor> rules = new ArrayList<>();
rules.add(new NoUnbrokenInputCycles());
rules.add(new NoDefaultValueCircularRefs());
rules.add(new TypesImplementInterfaces());
Expand All @@ -28,9 +26,6 @@ public SchemaValidator() {
rules.add(new InputAndOutputTypesUsedAppropriately());
rules.add(new OneOfInputObjectRules());
rules.add(new DeprecatedInputObjectAndArgumentsAreValid());
}

public List<GraphQLTypeVisitor> getRules() {
return rules;
}

Expand All @@ -39,7 +34,7 @@ public Set<SchemaValidationError> validateSchema(GraphQLSchema schema) {
Map<Class<?>, Object> rootVars = new LinkedHashMap<>();
rootVars.put(GraphQLSchema.class, schema);
rootVars.put(SchemaValidationErrorCollector.class, validationErrorCollector);
new SchemaTraverser().depthFirstFullSchema(rules, schema, rootVars);
new SchemaTraverser().depthFirstFullSchema(getRules(), schema, rootVars);
return validationErrorCollector.getErrors();
}

Expand Down
Loading
Loading
Back | FazBrowse Home | New Git URL