Skip to content

Fix dataloader dispatch in @defer when multiple deferred fragments exist #4270

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
timward60 wants to merge 3 commits into
base: master
Choose a base branch
from
+178 −2
Open

Fix dataloader dispatch in @defer when multiple deferred fragments exist #4270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9c873d
Add tests for dataloader dispatch with multiple @defer fragments
timward60 Feb 17, 2026
54bb6c2
Fix dataloader dispatch in @defer with multiple deferred fragments
timward60 Feb 17, 2026
2385ec3
Merge branch 'master' into fix/defer-dataloader-dispatch-field-count
timward60 Feb 26, 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
3 changes: 1 addition & 2 deletions src/main/java/graphql/execution/incremental/DeferredExecutionSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,8 @@ public Set<IncrementalCall<? extends IncrementalPayload>> createCalls() {

private DeferredFragmentCall createDeferredFragmentCall(DeferredExecution deferredExecution) {
int level = parameters.getPath().getLevel() + 1;
AlternativeCallContext alternativeCallContext = new AlternativeCallContext(level, deferredFields.size());

List<MergedField> mergedFields = deferredExecutionToFields.get(deferredExecution);
AlternativeCallContext alternativeCallContext = new AlternativeCallContext(level, mergedFields.size());

List<Supplier<CompletableFuture<DeferredFragmentCall.FieldWithExecutionResult>>> calls = FpKit.arrayListSizedTo(mergedFields);
for (MergedField currentField : mergedFields) {
Expand Down
177 changes: 177 additions & 0 deletions src/test/groovy/graphql/execution/instrumentation/dataloader/DeferWithDataLoaderTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,183 @@ class DeferWithDataLoaderTest extends Specification {

}

@Unroll
def "multiple separate defer fragments with dataloader fields dispatch correctly"() {
given:
def query = """
query {
shops {
id
name
... @defer(label: "deferred1") {
departments {
name
}
}
... @defer(label: "deferred2") {
expensiveDepartments {
name
}
}
}
}
"""

def expectedInitialData = [
data : [
shops: [
[id: "shop-1", name: "Shop 1"],
[id: "shop-2", name: "Shop 2"],
[id: "shop-3", name: "Shop 3"],
]
],
hasNext: true
]

when:
ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.query(query)
.dataLoaderRegistry(dataLoaderRegistry)
.graphQLContext([(ENABLE_INCREMENTAL_SUPPORT): true])
.build()
executionInput.getGraphQLContext().putAll(contextKey == null ? Collections.emptyMap() : [(contextKey): true])

IncrementalExecutionResult result = graphQL.execute(executionInput)

then:
result.toSpecification() == expectedInitialData

when:
def incrementalResults = getIncrementalResults(result)

then:
assertIncrementalResults(incrementalResults, [["shops", 0], ["shops", 1], ["shops", 2], ["shops", 0], ["shops", 1], ["shops", 2]])

when:
def combined = combineExecutionResults(result.toSpecification(), incrementalResults)
then:
combined.errors == null
combined.data == [
shops: [
[id : "shop-1", name: "Shop 1",
departments : [[name: "Department 1"],
[name: "Department 2"],
[name: "Department 3"]],
expensiveDepartments: [[name: "Department 1"],
[name: "Department 2"],
[name: "Department 3"]]],
[id : "shop-2", name: "Shop 2",
departments : [[name: "Department 4"],
[name: "Department 5"],
[name: "Department 6"]],
expensiveDepartments: [[name: "Department 4"],
[name: "Department 5"],
[name: "Department 6"]]],
[id : "shop-3", name: "Shop 3",
departments : [[name: "Department 7"],
[name: "Department 8"],
[name: "Department 9"]],
expensiveDepartments: [[name: "Department 7"],
[name: "Department 8"],
[name: "Department 9"]]]]
]

where:
contextKey << [ENABLE_DATA_LOADER_CHAINING, ENABLE_DATA_LOADER_EXHAUSTED_DISPATCHING, null]
}

@Unroll
def "mixed deferred and non-deferred fields with dataloaders dispatch correctly"() {
given:
def query = """
query {
shops {
id
name
departments {
name
}
... @defer(label: "deferred1") {
expensiveDepartments {
name
}
}
}
}
"""

def expectedInitialData = [
data : [
shops: [
[id: "shop-1", name: "Shop 1",
departments: [[name: "Department 1"],
[name: "Department 2"],
[name: "Department 3"]]],
[id: "shop-2", name: "Shop 2",
departments: [[name: "Department 4"],
[name: "Department 5"],
[name: "Department 6"]]],
[id: "shop-3", name: "Shop 3",
departments: [[name: "Department 7"],
[name: "Department 8"],
[name: "Department 9"]]],
]
],
hasNext: true
]

when:
ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.query(query)
.dataLoaderRegistry(dataLoaderRegistry)
.graphQLContext([(ENABLE_INCREMENTAL_SUPPORT): true])
.build()
executionInput.getGraphQLContext().putAll(contextKey == null ? Collections.emptyMap() : [(contextKey): true])

IncrementalExecutionResult result = graphQL.execute(executionInput)

then:
result.toSpecification() == expectedInitialData

when:
def incrementalResults = getIncrementalResults(result)

then:
assertIncrementalResults(incrementalResults, [["shops", 0], ["shops", 1], ["shops", 2]])

when:
def combined = combineExecutionResults(result.toSpecification(), incrementalResults)
then:
combined.errors == null
combined.data == [
shops: [
[id : "shop-1", name: "Shop 1",
departments : [[name: "Department 1"],
[name: "Department 2"],
[name: "Department 3"]],
expensiveDepartments: [[name: "Department 1"],
[name: "Department 2"],
[name: "Department 3"]]],
[id : "shop-2", name: "Shop 2",
departments : [[name: "Department 4"],
[name: "Department 5"],
[name: "Department 6"]],
expensiveDepartments: [[name: "Department 4"],
[name: "Department 5"],
[name: "Department 6"]]],
[id : "shop-3", name: "Shop 3",
departments : [[name: "Department 7"],
[name: "Department 8"],
[name: "Department 9"]],
expensiveDepartments: [[name: "Department 7"],
[name: "Department 8"],
[name: "Department 9"]]]]
]

where:
contextKey << [ENABLE_DATA_LOADER_CHAINING, ENABLE_DATA_LOADER_EXHAUSTED_DISPATCHING, null]
}

@Unroll
@RepeatUntilFailure(maxAttempts = 20, ignoreRest = false)
def "dataloader in initial result and chained dataloader inside nested defer block"() {
Expand Down
Loading