Skip to content

Validation cleanup #4441

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 1 commit into
base: master
Choose a base branch
from
+80 −32
Open

Validation cleanup #4441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 52 additions & 32 deletions src/main/java/graphql/validation/OperationValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,15 @@
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Deque;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;

Expand Down Expand Up @@ -301,7 +304,8 @@ public class OperationValidator implements DocumentVisitor {
private final Set<String> visitedFragmentSpreads = new HashSet<>();

// --- State: NoFragmentCycles ---
private final Map<String, Set<String>> fragmentSpreadsMap = new HashMap<>();
private final Map<String, Set<String>> fragmentSpreadsMap = new LinkedHashMap<>();
private final Set<String> fragmentsWithCycleErrors = new HashSet<>();

// --- State: NoUnusedFragments ---
private final List<FragmentDefinition> allDeclaredFragments = new ArrayList<>();
Expand Down Expand Up @@ -368,7 +372,10 @@ public OperationValidator(ValidationContext validationContext, ValidationErrorCo
this.rulePredicate = rulePredicate;
this.allRulesEnabled = detectAllRulesEnabled(rulePredicate);
this.complexityLimits = validationContext.getQueryComplexityLimits();
prepareFragmentSpreadsMap();
if (isRuleEnabled(OperationValidationRule.NO_FRAGMENT_CYCLES)) {
prepareFragmentSpreadsMap();
findFragmentCycles();
}
}

private static boolean detectAllRulesEnabled(Predicate<OperationValidationRule> predicate) {
Expand Down Expand Up @@ -1306,7 +1313,7 @@ private void prepareFragmentSpreadsMap() {
}

private Set<String> gatherSpreads(FragmentDefinition fragmentDefinition) {
final Set<String> spreads = new HashSet<>();
final Set<String> spreads = new LinkedHashSet<>();
DocumentVisitor visitor = new DocumentVisitor() {
@Override
public void enter(Node node, List<Node> path) {
Expand All @@ -1324,44 +1331,57 @@ public void leave(Node node, List<Node> path) {
}

private void validateNoFragmentCycles(FragmentDefinition fragmentDefinition) {
ArrayList<String> path = new ArrayList<>();
path.add(fragmentDefinition.getName());
Map<String, Set<String>> transitiveSpreads = buildTransitiveSpreads(path, new HashMap<>());
if (!fragmentsWithCycleErrors.contains(fragmentDefinition.getName())) {
return;
}
String message = i18n(FragmentCycle, "NoFragmentCycles.cyclesNotAllowed");
addError(FragmentCycle, Collections.singletonList(fragmentDefinition), message);
}

for (Map.Entry<String, Set<String>> entry : transitiveSpreads.entrySet()) {
if (entry.getValue().contains(entry.getKey())) {
String message = i18n(FragmentCycle, "NoFragmentCycles.cyclesNotAllowed");
addError(FragmentCycle, Collections.singletonList(fragmentDefinition), message);
private void findFragmentCycles() {
Set<String> visitedFragments = new HashSet<>();
for (Map.Entry<String, Set<String>> entry : fragmentSpreadsMap.entrySet()) {
if (!visitedFragments.add(entry.getKey())) {
continue;
}
findFragmentCycles(entry.getKey(), entry.getValue(), visitedFragments);
}
}

private Map<String, Set<String>> buildTransitiveSpreads(ArrayList<String> path, Map<String, Set<String>> transitiveSpreads) {
String name = path.get(path.size() - 1);
if (transitiveSpreads.containsKey(name)) {
return transitiveSpreads;
}
Set<String> spreads = fragmentSpreadsMap.get(name);
if (spreads == null || spreads.isEmpty()) {
return transitiveSpreads;
}
for (String ancestor : path) {
Set<String> ancestorSpreads = transitiveSpreads.get(ancestor);
if (ancestorSpreads == null) {
ancestorSpreads = new HashSet<>();
private void findFragmentCycles(String firstFragment, Set<String> firstSpreads, Set<String> visitedFragments) {
Set<String> visitingFragments = new HashSet<>();
Deque<String> fragmentStack = new ArrayDeque<>();
Deque<Iterator<String>> spreadIteratorStack = new ArrayDeque<>();
visitingFragments.add(firstFragment);
fragmentStack.push(firstFragment);
spreadIteratorStack.push(firstSpreads.iterator());

while (!fragmentStack.isEmpty()) {
Iterator<String> spreadIterator = spreadIteratorStack.getFirst();
if (!spreadIterator.hasNext()) {
visitingFragments.remove(fragmentStack.pop());
spreadIteratorStack.pop();
continue;
}
ancestorSpreads.addAll(spreads);
transitiveSpreads.put(ancestor, ancestorSpreads);
}
for (String child : spreads) {
if (path.contains(child) || transitiveSpreads.containsKey(child)) {

String childFragment = spreadIterator.next();
Set<String> childSpreads = fragmentSpreadsMap.get(childFragment);
if (childSpreads == null) {
continue;
}
if (visitingFragments.contains(childFragment)) {
fragmentsWithCycleErrors.add(childFragment);
fragmentsWithCycleErrors.add(fragmentStack.getFirst());
continue;
}
if (!visitedFragments.add(childFragment)) {
continue;
}
ArrayList<String> childPath = new ArrayList<>(path);
childPath.add(child);
buildTransitiveSpreads(childPath, transitiveSpreads);

visitingFragments.add(childFragment);
fragmentStack.push(childFragment);
spreadIteratorStack.push(childSpreads.iterator());
}
return transitiveSpreads;
}

// --- NoUndefinedVariables ---
Expand Down
28 changes: 28 additions & 0 deletions src/test/groovy/graphql/validation/NoFragmentCyclesTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,4 +240,32 @@ class NoFragmentCyclesTest extends Specification {
errorCollector.containsValidationError(ValidationErrorType.FragmentCycle)
errorCollector.getErrors()[0].message == "Validation error (FragmentCycle@[MyFrag]) : Fragment cycles not allowed"
}

def "long acyclic fragment chains are valid"() {
when:
traverse(fragmentChain(1_000, false))

then:
errorCollector.getErrors().isEmpty()
}

def "cycles at the end of long fragment chains are detected"() {
when:
traverse(fragmentChain(1_000, true))

then:
errorCollector.containsValidationError(ValidationErrorType.FragmentCycle)
}

private static String fragmentChain(int fragmentCount, boolean cycle) {
(0..<fragmentCount).collect { index ->
String selection = "name"
if (index < fragmentCount - 1) {
selection = "...F${index + 1}"
} else if (cycle) {
selection = "...F${fragmentCount.intdiv(2)}"
}
"fragment F${index} on Dog { ${selection} }"
}.join("\n")
}
}
Loading