Skip to content

Validate directive definition cycles #4365

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

Draft
jbellenger wants to merge 2 commits into
base: master
Choose a base branch
from
+637 −9
Draft

Validate directive definition cycles #4365

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
b19be22
Validate directive definition cycles
jbellenger Apr 8, 2026
d3b295f
simplify
jbellenger Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 199 additions & 3 deletions src/main/java/graphql/schema/idl/SchemaTypeDirectivesChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,19 @@
import graphql.language.Directive;
import graphql.language.DirectiveDefinition;
import graphql.language.EnumTypeDefinition;
import graphql.language.EnumTypeExtensionDefinition;
import graphql.language.EnumValueDefinition;
import graphql.language.FieldDefinition;
import graphql.language.InputObjectTypeDefinition;
import graphql.language.InputObjectTypeExtensionDefinition;
import graphql.language.InputValueDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.NamedNode;
import graphql.language.Node;
import graphql.language.NonNullType;
import graphql.language.ObjectTypeDefinition;
import graphql.language.ScalarTypeDefinition;
import graphql.language.ScalarTypeExtensionDefinition;
import graphql.language.SchemaDefinition;
import graphql.language.TypeDefinition;
import graphql.language.TypeName;
Expand All @@ -30,10 +33,14 @@
import graphql.schema.idl.errors.MissingTypeError;
import graphql.schema.idl.errors.NotAnInputTypeError;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static graphql.introspection.Introspection.DirectiveLocation.ARGUMENT_DEFINITION;
import static graphql.introspection.Introspection.DirectiveLocation.ENUM;
Expand Down Expand Up @@ -184,16 +191,205 @@ private static boolean isNoNullArgWithoutDefaultValue(InputValueDefinition defin
private void commonCheck(Collection<DirectiveDefinition> directiveDefinitions, List<GraphQLError> errors) {
directiveDefinitions.forEach(directiveDefinition -> {
assertTypeName(directiveDefinition, errors);
directiveDefinition.getInputValueDefinitions().forEach(inputValueDefinition -> {
boolean hasDirectSelfReference = false;
for (InputValueDefinition inputValueDefinition : directiveDefinition.getInputValueDefinitions()) {
assertTypeName(inputValueDefinition, errors);
assertExistAndIsInputType(inputValueDefinition, errors);
if (inputValueDefinition.hasDirective(directiveDefinition.getName())) {
errors.add(new DirectiveIllegalReferenceError(directiveDefinition, inputValueDefinition));
hasDirectSelfReference = true;
}
});
}
if (hasDirectSelfReference) {
return;
}

String cycle = findDirectiveCycle(directiveDefinition);
if (cycle != null) {
errors.add(new DirectiveIllegalReferenceError(directiveDefinition, cycle));
}
});
}

private String findDirectiveCycle(DirectiveDefinition directiveDefinition) {
List<String> path = new ArrayList<>();
path.add(directiveName(directiveDefinition.getName()));

Set<String> visited = new LinkedHashSet<>();
visited.add(directiveName(directiveDefinition.getName()));

return findCycleFromInputValueDefinitions(directiveDefinition.getInputValueDefinitions(), directiveDefinition.getName(), path, visited);
}

private String findCycleFromInputValueDefinitions(List<InputValueDefinition> inputValueDefinitions, String startDirectiveName, List<String> path, Set<String> visited) {
for (InputValueDefinition inputValueDefinition : inputValueDefinitions) {
String cycle = findCycleFromDirectives(inputValueDefinition.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

cycle = findCycleFromInputType(inputValueDefinition.getType(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private String findCycleFromDirectives(List<Directive> directives, String startDirectiveName, List<String> path, Set<String> visited) {
for (Directive directive : directives) {
String cycle = findCycleFromDirectiveReference(directive.getName(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private String findCycleFromDirectiveReference(String directiveName, String startDirectiveName, List<String> path, Set<String> visited) {
String displayName = directiveName(directiveName);
if (directiveName.equals(startDirectiveName)) {
return cyclePath(path, displayName);
}
if (visited.contains(displayName)) {
return null;
}

Optional<DirectiveDefinition> directiveDefinition = typeRegistry.getDirectiveDefinition(directiveName);
if (directiveDefinition.isEmpty()) {
return null;
}

return findCycleFromInputValueDefinitions(
directiveDefinition.get().getInputValueDefinitions(),
startDirectiveName,
addToPath(path, displayName),
addToVisited(visited, displayName)
);
}

private String findCycleFromInputType(graphql.language.Type<?> type, String startDirectiveName, List<String> path, Set<String> visited) {
TypeDefinition<?> typeDefinition = findTypeDefFromRegistry(TypeUtil.unwrapAll(type).getName(), typeRegistry);
if (typeDefinition == null) {
return null;
}
if (visited.contains(typeDefinition.getName())) {
return null;
}

List<String> nextPath = addToPath(path, typeDefinition.getName());
Set<String> nextVisited = addToVisited(visited, typeDefinition.getName());

if (typeDefinition instanceof ScalarTypeDefinition) {
return findCycleFromScalarType((ScalarTypeDefinition) typeDefinition, startDirectiveName, nextPath, nextVisited);
}
if (typeDefinition instanceof EnumTypeDefinition) {
return findCycleFromEnumType((EnumTypeDefinition) typeDefinition, startDirectiveName, nextPath, nextVisited);
}
if (typeDefinition instanceof InputObjectTypeDefinition) {
return findCycleFromInputObjectType((InputObjectTypeDefinition) typeDefinition, startDirectiveName, nextPath, nextVisited);
}
return null;
}

private String findCycleFromScalarType(ScalarTypeDefinition typeDefinition, String startDirectiveName, List<String> path, Set<String> visited) {
String cycle = findCycleFromDirectives(typeDefinition.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

List<ScalarTypeExtensionDefinition> extensions = typeRegistry.scalarTypeExtensions().getOrDefault(typeDefinition.getName(), Collections.emptyList());
for (ScalarTypeExtensionDefinition extension : extensions) {
cycle = findCycleFromDirectives(extension.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private String findCycleFromEnumType(EnumTypeDefinition typeDefinition, String startDirectiveName, List<String> path, Set<String> visited) {
String cycle = findCycleFromDirectives(typeDefinition.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

cycle = findCycleFromEnumValues(typeDefinition.getEnumValueDefinitions(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

List<EnumTypeExtensionDefinition> extensions = typeRegistry.enumTypeExtensions().getOrDefault(typeDefinition.getName(), Collections.emptyList());
for (EnumTypeExtensionDefinition extension : extensions) {
cycle = findCycleFromDirectives(extension.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

cycle = findCycleFromEnumValues(extension.getEnumValueDefinitions(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private String findCycleFromEnumValues(List<EnumValueDefinition> enumValueDefinitions, String startDirectiveName, List<String> path, Set<String> visited) {
for (EnumValueDefinition enumValueDefinition : enumValueDefinitions) {
String cycle = findCycleFromDirectives(enumValueDefinition.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private String findCycleFromInputObjectType(InputObjectTypeDefinition typeDefinition, String startDirectiveName, List<String> path, Set<String> visited) {
String cycle = findCycleFromDirectives(typeDefinition.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

cycle = findCycleFromInputValueDefinitions(typeDefinition.getInputValueDefinitions(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

List<InputObjectTypeExtensionDefinition> extensions = typeRegistry.inputObjectTypeExtensions().getOrDefault(typeDefinition.getName(), Collections.emptyList());
for (InputObjectTypeExtensionDefinition extension : extensions) {
cycle = findCycleFromDirectives(extension.getDirectives(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}

cycle = findCycleFromInputValueDefinitions(extension.getInputValueDefinitions(), startDirectiveName, path, visited);
if (cycle != null) {
return cycle;
}
}
return null;
}

private List<String> addToPath(List<String> path, String element) {
List<String> nextPath = new ArrayList<>(path);
nextPath.add(element);
return nextPath;
}

private Set<String> addToVisited(Set<String> visited, String element) {
Set<String> nextVisited = new LinkedHashSet<>(visited);
nextVisited.add(element);
return nextVisited;
}

private String cyclePath(List<String> path, String cycleElement) {
return String.join(" -> ", addToPath(path, cycleElement));
}

private String directiveName(String directiveName) {
return "@" + directiveName;
}

private static void assertTypeName(NamedNode<?> node, List<GraphQLError> errors) {
if (node.getName().length() >= 2 && node.getName().startsWith("__")) {
errors.add((new IllegalNameError(node)));
Expand Down Expand Up @@ -224,4 +420,4 @@ private static TypeDefinition<?> findTypeDefFromRegistry(String typeName, TypeDe
}
return typeRegistry.scalars().get(typeName);
}
}
}
9 changes: 8 additions & 1 deletion src/main/java/graphql/schema/idl/errors/DirectiveIllegalReferenceError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,11 @@ public DirectiveIllegalReferenceError(DirectiveDefinition directive, NamedNode l
directive.getName(), location.getName(), lineCol(location)
));
}
}

public DirectiveIllegalReferenceError(DirectiveDefinition directive, String cycle) {
super(directive,
String.format("'%s' must not form a circular reference: %s",
directive.getName(), cycle
));
}
}
Loading
Loading