Skip to content

Commit d921d60

Browse files
yaacovCRyaacovCR
committed
upgrade executor to non-duplicating incremental delivery format
1 parent 0b2bab6 commit d921d60

28 files changed

Lines changed: 6053 additions & 1607 deletions

‎.changeset/fifty-bobcats-jog.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
'@graphql-tools/executor': major
3+
'@graphql-tools/utils': minor
4+
---
5+
6+
Upgrade to non-duplicating Incremental Delivery format
7+
8+
## Description
9+
10+
GraphQL Incremental Delivery is moving to a [new response format without duplication](https://github.com/graphql/defer-stream-wg/discussions/69).
11+
12+
This PR updates the executor within graphql-tools to follow the new format, a BREAKING CHANGE.
13+
14+
Incremental Delivery has now been disabled for subscriptions, also a BREAKING CHANGE. The GraphQL Working Group has decided to disable incremental delivery support for subscriptions (1) to gather more information about use cases and (2) explore how to interleaving the incremental response streams generated from different source events into one overall subscription response stream.

‎packages/executor/src/execution/AccumulatorMap.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
* ES6 Map with additional `add` method to accumulate items.
3+
*/
4+
export class AccumulatorMap<K, T> extends Map<K, Array<T>> {
5+
get [Symbol.toStringTag]() {
6+
return 'AccumulatorMap';
7+
}
8+
9+
add(key: K, item: T): void {
10+
const group = this.get(key);
11+
if (group === undefined) {
12+
this.set(key, [item]);
13+
} else {
14+
group.push(item);
15+
}
16+
}
17+
}

‎packages/executor/src/execution/BoxedPromiseOrValue.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { isPromise } from '@graphql-tools/utils';
2+
import type { MaybePromise } from '@graphql-tools/utils';
3+
4+
/**
5+
* A BoxedPromiseOrValue is a container for a value or promise where the value
6+
* will be updated when the promise resolves.
7+
*
8+
* A BoxedPromiseOrValue may only be used with promises whose possible
9+
* rejection has already been handled, otherwise this will lead to unhandled
10+
* promise rejections.
11+
*
12+
* @internal
13+
* */
14+
export class BoxedPromiseOrValue<T> {
15+
value: MaybePromise<T>;
16+
17+
constructor(value: MaybePromise<T>) {
18+
this.value = value;
19+
if (isPromise(value)) {
20+
value.then(resolved => {
21+
this.value = resolved;
22+
});
23+
}
24+
}
25+
}

‎packages/executor/src/execution/IncrementalGraph.ts‎

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
import type { GraphQLError } from 'graphql';
2+
import { isPromise } from '@graphql-tools/utils';
3+
import { BoxedPromiseOrValue } from './BoxedPromiseOrValue.js';
4+
import { invariant } from './invariant.js';
5+
import { promiseWithResolvers } from './promiseWithResolvers.js';
6+
import type {
7+
DeferredFragmentRecord,
8+
DeferredGroupedFieldSetRecord,
9+
DeferredGroupedFieldSetResult,
10+
IncrementalDataRecord,
11+
IncrementalDataRecordResult,
12+
ReconcilableDeferredGroupedFieldSetResult,
13+
StreamItemRecord,
14+
StreamRecord,
15+
SubsequentResultRecord,
16+
} from './types.js';
17+
import { isDeferredFragmentRecord, isDeferredGroupedFieldSetRecord } from './types.js';
18+
19+
/**
20+
* @internal
21+
*/
22+
export class IncrementalGraph {
23+
private _rootNodes: Set<SubsequentResultRecord>;
24+
25+
private _completedQueue: Array<IncrementalDataRecordResult>;
26+
private _nextQueue: Array<
27+
(iterable: IteratorResult<Iterable<IncrementalDataRecordResult>>) => void
28+
>;
29+
30+
constructor() {
31+
this._rootNodes = new Set();
32+
this._completedQueue = [];
33+
this._nextQueue = [];
34+
}
35+
36+
getNewPending(
37+
incrementalDataRecords: ReadonlyArray<IncrementalDataRecord>,
38+
): ReadonlyArray<SubsequentResultRecord> {
39+
const initialResultChildren = new Set<SubsequentResultRecord>();
40+
this._addIncrementalDataRecords(incrementalDataRecords, undefined, initialResultChildren);
41+
return this._promoteNonEmptyToRoot(initialResultChildren);
42+
}
43+
44+
addCompletedReconcilableDeferredGroupedFieldSet(
45+
reconcilableResult: ReconcilableDeferredGroupedFieldSetResult,
46+
): void {
47+
for (const deferredFragmentRecord of reconcilableResult.deferredGroupedFieldSetRecord
48+
.deferredFragmentRecords) {
49+
deferredFragmentRecord.deferredGroupedFieldSetRecords.delete(
50+
reconcilableResult.deferredGroupedFieldSetRecord,
51+
);
52+
deferredFragmentRecord.reconcilableResults.add(reconcilableResult);
53+
}
54+
55+
const incrementalDataRecords = reconcilableResult.incrementalDataRecords;
56+
if (incrementalDataRecords !== undefined) {
57+
this._addIncrementalDataRecords(
58+
incrementalDataRecords,
59+
reconcilableResult.deferredGroupedFieldSetRecord.deferredFragmentRecords,
60+
);
61+
}
62+
}
63+
64+
completedIncrementalData() {
65+
return {
66+
[Symbol.asyncIterator]() {
67+
return this;
68+
},
69+
next: (): Promise<IteratorResult<Iterable<IncrementalDataRecordResult>>> => {
70+
const firstResult = this._completedQueue.shift();
71+
if (firstResult !== undefined) {
72+
return Promise.resolve({
73+
value: this._yieldCurrentCompletedIncrementalData(firstResult),
74+
done: false,
75+
});
76+
}
77+
const { promise, resolve } =
78+
promiseWithResolvers<IteratorResult<Iterable<IncrementalDataRecordResult>>>();
79+
this._nextQueue.push(resolve);
80+
return promise;
81+
},
82+
return: (): Promise<IteratorResult<Iterable<IncrementalDataRecordResult>>> => {
83+
for (const resolve of this._nextQueue) {
84+
resolve({ value: undefined, done: true });
85+
}
86+
return Promise.resolve({ value: undefined, done: true });
87+
},
88+
};
89+
}
90+
91+
hasNext(): boolean {
92+
return this._rootNodes.size > 0;
93+
}
94+
95+
completeDeferredFragment(deferredFragmentRecord: DeferredFragmentRecord):
96+
| {
97+
newPending: ReadonlyArray<SubsequentResultRecord>;
98+
reconcilableResults: ReadonlyArray<ReconcilableDeferredGroupedFieldSetResult>;
99+
}
100+
| undefined {
101+
if (
102+
!this._rootNodes.has(deferredFragmentRecord) ||
103+
deferredFragmentRecord.deferredGroupedFieldSetRecords.size > 0
104+
) {
105+
return;
106+
}
107+
const reconcilableResults = Array.from(deferredFragmentRecord.reconcilableResults);
108+
this._removePending(deferredFragmentRecord);
109+
for (const reconcilableResult of reconcilableResults) {
110+
for (const otherDeferredFragmentRecord of reconcilableResult.deferredGroupedFieldSetRecord
111+
.deferredFragmentRecords) {
112+
otherDeferredFragmentRecord.reconcilableResults.delete(reconcilableResult);
113+
}
114+
}
115+
const newPending = this._promoteNonEmptyToRoot(deferredFragmentRecord.children);
116+
return { newPending, reconcilableResults };
117+
}
118+
119+
removeDeferredFragment(deferredFragmentRecord: DeferredFragmentRecord): boolean {
120+
if (!this._rootNodes.has(deferredFragmentRecord)) {
121+
return false;
122+
}
123+
this._removePending(deferredFragmentRecord);
124+
return true;
125+
}
126+
127+
removeStream(streamRecord: StreamRecord): void {
128+
this._removePending(streamRecord);
129+
}
130+
131+
private _removePending(subsequentResultRecord: SubsequentResultRecord): void {
132+
this._rootNodes.delete(subsequentResultRecord);
133+
if (this._rootNodes.size === 0) {
134+
for (const resolve of this._nextQueue) {
135+
resolve({ value: undefined, done: true });
136+
}
137+
}
138+
}
139+
140+
private _addIncrementalDataRecords(
141+
incrementalDataRecords: ReadonlyArray<IncrementalDataRecord>,
142+
parents: ReadonlyArray<DeferredFragmentRecord> | undefined,
143+
initialResultChildren?: Set<SubsequentResultRecord> | undefined,
144+
): void {
145+
for (const incrementalDataRecord of incrementalDataRecords) {
146+
if (isDeferredGroupedFieldSetRecord(incrementalDataRecord)) {
147+
for (const deferredFragmentRecord of incrementalDataRecord.deferredFragmentRecords) {
148+
this._addDeferredFragment(deferredFragmentRecord, initialResultChildren);
149+
deferredFragmentRecord.deferredGroupedFieldSetRecords.add(incrementalDataRecord);
150+
}
151+
if (this._hasPendingFragment(incrementalDataRecord)) {
152+
this._onDeferredGroupedFieldSet(incrementalDataRecord);
153+
}
154+
} else if (parents === undefined) {
155+
invariant(initialResultChildren !== undefined);
156+
initialResultChildren.add(incrementalDataRecord);
157+
} else {
158+
for (const parent of parents) {
159+
this._addDeferredFragment(parent, initialResultChildren);
160+
parent.children.add(incrementalDataRecord);
161+
}
162+
}
163+
}
164+
}
165+
166+
private _promoteNonEmptyToRoot(
167+
maybeEmptyNewPending: Set<SubsequentResultRecord>,
168+
): ReadonlyArray<SubsequentResultRecord> {
169+
const newPending: Array<SubsequentResultRecord> = [];
170+
for (const subsequentResultRecord of maybeEmptyNewPending) {
171+
if (isDeferredFragmentRecord(subsequentResultRecord)) {
172+
if (subsequentResultRecord.deferredGroupedFieldSetRecords.size > 0) {
173+
subsequentResultRecord.setAsPending();
174+
for (const deferredGroupedFieldSetRecord of subsequentResultRecord.deferredGroupedFieldSetRecords) {
175+
if (!this._hasPendingFragment(deferredGroupedFieldSetRecord)) {
176+
this._onDeferredGroupedFieldSet(deferredGroupedFieldSetRecord);
177+
}
178+
}
179+
this._rootNodes.add(subsequentResultRecord);
180+
newPending.push(subsequentResultRecord);
181+
continue;
182+
}
183+
for (const child of subsequentResultRecord.children) {
184+
maybeEmptyNewPending.add(child);
185+
}
186+
} else {
187+
this._rootNodes.add(subsequentResultRecord);
188+
newPending.push(subsequentResultRecord);
189+
190+
this._onStreamItems(subsequentResultRecord);
191+
}
192+
}
193+
return newPending;
194+
}
195+
196+
private _hasPendingFragment(
197+
deferredGroupedFieldSetRecord: DeferredGroupedFieldSetRecord,
198+
): boolean {
199+
return deferredGroupedFieldSetRecord.deferredFragmentRecords.some(deferredFragmentRecord =>
200+
this._rootNodes.has(deferredFragmentRecord),
201+
);
202+
}
203+
204+
private _addDeferredFragment(
205+
deferredFragmentRecord: DeferredFragmentRecord,
206+
subsequentResultRecords: Set<SubsequentResultRecord> | undefined,
207+
): void {
208+
if (this._rootNodes.has(deferredFragmentRecord)) {
209+
return;
210+
}
211+
const parent = deferredFragmentRecord.parent;
212+
if (parent === undefined) {
213+
invariant(subsequentResultRecords !== undefined);
214+
subsequentResultRecords.add(deferredFragmentRecord);
215+
return;
216+
}
217+
parent.children.add(deferredFragmentRecord);
218+
this._addDeferredFragment(parent, subsequentResultRecords);
219+
}
220+
221+
private _onDeferredGroupedFieldSet(
222+
deferredGroupedFieldSetRecord: DeferredGroupedFieldSetRecord,
223+
): void {
224+
const result = (
225+
deferredGroupedFieldSetRecord.result as BoxedPromiseOrValue<DeferredGroupedFieldSetResult>
226+
).value;
227+
if (isPromise(result)) {
228+
result.then(resolved => this._enqueue(resolved));
229+
} else {
230+
this._enqueue(result);
231+
}
232+
}
233+
234+
private async _onStreamItems(streamRecord: StreamRecord): Promise<void> {
235+
let items: Array<unknown> = [];
236+
let errors: Array<GraphQLError> = [];
237+
let incrementalDataRecords: Array<IncrementalDataRecord> = [];
238+
const streamItemQueue = streamRecord.streamItemQueue;
239+
let streamItemRecord: StreamItemRecord | undefined;
240+
while ((streamItemRecord = streamItemQueue.shift()) !== undefined) {
241+
let result =
242+
streamItemRecord instanceof BoxedPromiseOrValue
243+
? streamItemRecord.value
244+
: streamItemRecord().value;
245+
if (isPromise(result)) {
246+
if (items.length > 0) {
247+
this._enqueue({
248+
streamRecord,
249+
result:
250+
// TODO add additional test case or rework for coverage
251+
errors.length > 0 /* c8 ignore start */
252+
? { items, errors } /* c8 ignore stop */
253+
: { items },
254+
incrementalDataRecords,
255+
});
256+
items = [];
257+
errors = [];
258+
incrementalDataRecords = [];
259+
}
260+
result = await result;
261+
// wait an additional tick to coalesce resolving additional promises
262+
// within the queue
263+
await Promise.resolve();
264+
}
265+
if (result.item === undefined) {
266+
if (items.length > 0) {
267+
this._enqueue({
268+
streamRecord,
269+
result: errors.length > 0 ? { items, errors } : { items },
270+
incrementalDataRecords,
271+
});
272+
}
273+
this._enqueue(
274+
result.errors === undefined
275+
? { streamRecord }
276+
: {
277+
streamRecord,
278+
errors: result.errors,
279+
},
280+
);
281+
return;
282+
}
283+
items.push(result.item);
284+
if (result.errors !== undefined) {
285+
errors.push(...result.errors);
286+
}
287+
if (result.incrementalDataRecords !== undefined) {
288+
incrementalDataRecords.push(...result.incrementalDataRecords);
289+
}
290+
}
291+
}
292+
293+
private *_yieldCurrentCompletedIncrementalData(
294+
first: IncrementalDataRecordResult,
295+
): Generator<IncrementalDataRecordResult> {
296+
yield first;
297+
let completed;
298+
while ((completed = this._completedQueue.shift()) !== undefined) {
299+
yield completed;
300+
}
301+
}
302+
303+
private _enqueue(completed: IncrementalDataRecordResult): void {
304+
const next = this._nextQueue.shift();
305+
if (next !== undefined) {
306+
next({
307+
value: this._yieldCurrentCompletedIncrementalData(completed),
308+
done: false,
309+
});
310+
return;
311+
}
312+
this._completedQueue.push(completed);
313+
}
314+
}

0 commit comments

Comments
 (0)