Skip to content

polish: fix stream test cases #4812

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

Merged
yaacovCR merged 1 commit into from
Jun 12, 2026
Merged

polish: fix stream test cases #4812

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
45 changes: 42 additions & 3 deletions src/execution/incremental/__tests__/stream-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2324,6 +2324,28 @@ describe('Execute: stream directive', () => {
]);
});
it('Handles overlapping deferred and non-deferred streams', async () => {
// NOTE: This is an *invalid* query, but it should be an *executable* query.
// Validation rejects the overlapping @stream selections. See
// https://github.com/graphql/defer-stream-wg/discussions/100.
//
// The query selects the same stream field twice. The non-deferred selection
// asks for `id`. The deferred stream selection asks for `id`, `name`, and
// an inner deferred `innerName`.
//
// Stream item completion later sees one merged stream. Without rewriting
// the stream field details to clear inherited defer usage, `name` would be
// treated as still belonging to the outer @defer instead of to the stream
// item. The bad stream payload would be `items: [{ id: '1' }]` and then
// `items: [{ id: '2' }]`; the `name` fields would be dropped even though
// the `innerName` payloads would still be emitted.
//
// `getStreamUsage` avoids that by rewriting the stream field details to
// clear inherited defer usage before those details are reused to complete
// stream items.
//
// The inner @defer is included only because it forces stream item
// completion through execution planning. Without it, a fast path executes
// all collected fields directly and this bug would not be exposed.
const document = parse(`
query {
nestedObject {
Expand All @@ -2336,6 +2358,9 @@ describe('Execute: stream directive', () => {
nestedFriendList @stream(initialCount: 0) {
id
name
... @defer {
innerName: name
}
}
}
}
Expand All @@ -2360,29 +2385,43 @@ describe('Execute: stream directive', () => {
hasNext: true,
},
{
pending: [{ id: '1', path: ['nestedObject', 'nestedFriendList', 0] }],
incremental: [
{
items: [{ id: '1', name: 'Luke' }],
id: '0',
},
{
data: { innerName: 'Luke' },
id: '1',
},
],
completed: [{ id: '1' }],
hasNext: true,
},
{
pending: [{ id: '2', path: ['nestedObject', 'nestedFriendList', 1] }],
incremental: [
{
items: [{ id: '2', name: 'Han' }],
id: '0',
},
{
data: { innerName: 'Han' },
id: '2',
},
],
completed: [{ id: '0' }],
completed: [{ id: '0' }, { id: '2' }],
hasNext: false,
},
]);
});
it('Re-promotes a completed stream when a slower sibling defer resolves later', async () => {
const { promise: slowFieldPromise, resolve: resolveSlowField } =
promiseWithResolvers<string>();
// NOTE: This is an *invalid* query, but it should be an *executable* query.
// Validation rejects the overlapping @stream selections. See
// https://github.com/graphql/defer-stream-wg/discussions/100.
const document = parse(`
query {
nestedObject {
Expand Down Expand Up @@ -2584,7 +2623,7 @@ describe('Execute: stream directive', () => {
const document = parse(`
query {
friendList @stream(label:"stream-label") {
...NameFragment @defer(label: "DeferName") @defer(label: "DeferName")
...NameFragment @defer(label: "DeferName")
id
}
}
Expand Down Expand Up @@ -2689,7 +2728,7 @@ describe('Execute: stream directive', () => {
const document = parse(`
query {
friendList @stream(initialCount: 1, label:"stream-label") {
...NameFragment @defer(label: "DeferName") @defer(label: "DeferName")
...NameFragment @defer(label: "DeferName")
id
}
}
Expand Down
40 changes: 38 additions & 2 deletions src/execution/legacyIncremental/__tests__/legacy-stream-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2117,6 +2117,28 @@ describe('Execute: stream directive (legacy)', () => {
]);
});
it('Handles overlapping deferred and non-deferred streams', async () => {
// NOTE: This is an *invalid* query, but it should be an *executable* query.
// Validation rejects the overlapping @stream selections. See
// https://github.com/graphql/defer-stream-wg/discussions/100.
//
// The query selects the same stream field twice. The non-deferred selection
// asks for `id`. The deferred stream selection asks for `id`, `name`, and
// an inner deferred `innerName`.
//
// Stream item completion later sees one merged stream. Without rewriting
// the stream field details to clear inherited defer usage, `name` would be
// treated as still belonging to the outer @defer instead of to the stream
// item. The bad stream payload would be `items: [{ id: '1' }]` and then
// `items: [{ id: '2' }]`; the `name` fields would be dropped even though
// the `innerName` payloads would still be emitted.
//
// `getStreamUsage` avoids that by rewriting the stream field details to
// clear inherited defer usage before those details are reused to complete
// stream items.
//
// The inner @defer is included only because it forces stream item
// completion through execution planning. Without it, a fast path executes
// all collected fields directly and this bug would not be exposed.
const document = parse(`
query {
nestedObject {
Expand All @@ -2129,6 +2151,9 @@ describe('Execute: stream directive (legacy)', () => {
nestedFriendList @stream(initialCount: 0) {
id
name
... @defer {
innerName: name
}
}
}
}
Expand Down Expand Up @@ -2176,6 +2201,10 @@ describe('Execute: stream directive (legacy)', () => {
items: [{ id: '2' }],
path: ['nestedObject', 'nestedFriendList', 1],
},
{
data: { innerName: 'Luke' },
path: ['nestedObject', 'nestedFriendList', 0],
},
],
hasNext: true,
},
Expand All @@ -2185,6 +2214,10 @@ describe('Execute: stream directive (legacy)', () => {
items: [{ id: '2', name: 'Han' }],
path: ['nestedObject', 'nestedFriendList', 1],
},
{
data: { innerName: 'Han' },
path: ['nestedObject', 'nestedFriendList', 1],
},
],
hasNext: false,
},
Expand All @@ -2193,6 +2226,9 @@ describe('Execute: stream directive (legacy)', () => {
it('Re-promotes a completed stream when a slower sibling defer resolves later', async () => {
const { promise: slowFieldPromise, resolve: resolveSlowField } =
promiseWithResolvers<string>();
// NOTE: This is an *invalid* query, but it should be an *executable* query.
// Validation rejects the overlapping @stream selections. See
// https://github.com/graphql/defer-stream-wg/discussions/100.
const document = parse(`
query {
nestedObject {
Expand Down Expand Up @@ -2397,7 +2433,7 @@ describe('Execute: stream directive (legacy)', () => {
const document = parse(`
query {
friendList @stream(label:"stream-label") {
...NameFragment @defer(label: "DeferName") @defer(label: "DeferName")
...NameFragment @defer(label: "DeferName")
id
}
}
Expand Down Expand Up @@ -2500,7 +2536,7 @@ describe('Execute: stream directive (legacy)', () => {
const document = parse(`
query {
friendList @stream(initialCount: 1, label:"stream-label") {
...NameFragment @defer(label: "DeferName") @defer(label: "DeferName")
...NameFragment @defer(label: "DeferName")
id
}
}
Expand Down
Loading