-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
incremental: introduce IncrementalGraph class to manage tree of subsequent results #4094
Merged
Merged
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b8c5c0e
refactor: extract incremental graph to separate file
yaacovCR 44da038
refactor: move returnStreamIterators to method
yaacovCR 8bd2cfa
refactor: use asyncIterator instead of extra promise
yaacovCR ffeeb91
refactor: convert IncrementalPublisher class members to method args
yaacovCR fb8dea2
incremental: use invariant for checking id
yaacovCR 3c4aea0
refactor(IncrementalGraph): remove unnecessary method
yaacovCR 00edd3a
refactor(IncrementalGraph): use Subsequent Result nodes to reduce mut…
yaacovCR f5b1c33
refactor(incremental): introduce StreamRecord type
yaacovCR bf62bd5
refactor(IncrementalGraph): use set of pending deferred grouped field…
yaacovCR a86b207
fix(incremental): emit only single completion when multiple deferred …
yaacovCR 2766922
refactor(incremental): enqueue only released records
yaacovCR 64894d9
refactor(incremental): introduce BoxedPromiseOrValue to save resolved…
yaacovCR 09ae45a
polish: remove outdated coverage ignore statement
yaacovCR File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,309 @@ | ||
import { isPromise } from '../jsutils/isPromise.js'; | ||
import { promiseWithResolvers } from '../jsutils/promiseWithResolvers.js'; | ||
|
||
import type { | ||
DeferredFragmentRecord, | ||
DeferredGroupedFieldSetRecord, | ||
IncrementalDataRecord, | ||
IncrementalDataRecordResult, | ||
ReconcilableDeferredGroupedFieldSetResult, | ||
StreamItemsRecord, | ||
StreamRecord, | ||
SubsequentResultRecord, | ||
} from './types.js'; | ||
import { isDeferredGroupedFieldSetRecord } from './types.js'; | ||
|
||
interface DeferredFragmentNode { | ||
deferredFragmentRecord: DeferredFragmentRecord; | ||
deferredGroupedFieldSetRecords: Set<DeferredGroupedFieldSetRecord>; | ||
reconcilableResults: Set<ReconcilableDeferredGroupedFieldSetResult>; | ||
children: Array<DeferredFragmentNode>; | ||
} | ||
|
||
function isDeferredFragmentNode( | ||
node: DeferredFragmentNode | undefined, | ||
): node is DeferredFragmentNode { | ||
return node !== undefined; | ||
} | ||
|
||
function isStreamNode( | ||
subsequentResultNode: SubsequentResultNode, | ||
): subsequentResultNode is StreamRecord { | ||
return 'path' in subsequentResultNode; | ||
} | ||
|
||
type SubsequentResultNode = DeferredFragmentNode | StreamRecord; | ||
|
||
/** | ||
* @internal | ||
*/ | ||
export class IncrementalGraph { | ||
private _pending: Set<SubsequentResultNode>; | ||
private _deferredFragmentNodes: Map< | ||
DeferredFragmentRecord, | ||
DeferredFragmentNode | ||
>; | ||
|
||
private _newPending: Set<SubsequentResultNode>; | ||
private _newIncrementalDataRecords: Set<IncrementalDataRecord>; | ||
private _completedQueue: Array<IncrementalDataRecordResult>; | ||
private _nextQueue: Array< | ||
(iterable: IteratorResult<Iterable<IncrementalDataRecordResult>>) => void | ||
>; | ||
|
||
constructor() { | ||
this._pending = new Set(); | ||
this._deferredFragmentNodes = new Map(); | ||
this._newIncrementalDataRecords = new Set(); | ||
this._newPending = new Set(); | ||
this._completedQueue = []; | ||
this._nextQueue = []; | ||
} | ||
|
||
addIncrementalDataRecords( | ||
incrementalDataRecords: ReadonlyArray<IncrementalDataRecord>, | ||
): void { | ||
for (const incrementalDataRecord of incrementalDataRecords) { | ||
if (isDeferredGroupedFieldSetRecord(incrementalDataRecord)) { | ||
this._addDeferredGroupedFieldSetRecord(incrementalDataRecord); | ||
} else { | ||
this._addStreamItemsRecord(incrementalDataRecord); | ||
} | ||
} | ||
} | ||
|
||
addCompletedReconcilableDeferredGroupedFieldSet( | ||
reconcilableResult: ReconcilableDeferredGroupedFieldSetResult, | ||
): void { | ||
const deferredFragmentNodes: Array<DeferredFragmentNode> = | ||
reconcilableResult.deferredGroupedFieldSetRecord.deferredFragmentRecords | ||
.map((deferredFragmentRecord) => | ||
this._deferredFragmentNodes.get(deferredFragmentRecord), | ||
) | ||
.filter<DeferredFragmentNode>(isDeferredFragmentNode); | ||
for (const deferredFragmentNode of deferredFragmentNodes) { | ||
deferredFragmentNode.deferredGroupedFieldSetRecords.delete( | ||
reconcilableResult.deferredGroupedFieldSetRecord, | ||
); | ||
deferredFragmentNode.reconcilableResults.add(reconcilableResult); | ||
} | ||
} | ||
|
||
getNewPending(): ReadonlyArray<SubsequentResultRecord> { | ||
const newPending: Array<SubsequentResultRecord> = []; | ||
for (const node of this._newPending) { | ||
if (isStreamNode(node)) { | ||
this._pending.add(node); | ||
newPending.push(node); | ||
} else if (node.deferredGroupedFieldSetRecords.size > 0) { | ||
for (const deferredGroupedFieldSetNode of node.deferredGroupedFieldSetRecords) { | ||
this._newIncrementalDataRecords.add(deferredGroupedFieldSetNode); | ||
} | ||
this._pending.add(node); | ||
newPending.push(node.deferredFragmentRecord); | ||
} else { | ||
for (const child of node.children) { | ||
this._newPending.add(child); | ||
} | ||
} | ||
} | ||
this._newPending.clear(); | ||
|
||
for (const incrementalDataRecord of this._newIncrementalDataRecords) { | ||
const result = incrementalDataRecord.result.value; | ||
if (isPromise(result)) { | ||
// eslint-disable-next-line @typescript-eslint/no-floating-promises | ||
result.then((resolved) => this._enqueue(resolved)); | ||
} else { | ||
this._enqueue(result); | ||
} | ||
} | ||
this._newIncrementalDataRecords.clear(); | ||
|
||
return newPending; | ||
} | ||
|
||
completedIncrementalData() { | ||
return { | ||
[Symbol.asyncIterator]() { | ||
return this; | ||
}, | ||
next: (): Promise< | ||
IteratorResult<Iterable<IncrementalDataRecordResult>> | ||
> => { | ||
const firstResult = this._completedQueue.shift(); | ||
if (firstResult !== undefined) { | ||
return Promise.resolve({ | ||
value: this._yieldCurrentCompletedIncrementalData(firstResult), | ||
done: false, | ||
}); | ||
} | ||
const { promise, resolve } = | ||
promiseWithResolvers< | ||
IteratorResult<Iterable<IncrementalDataRecordResult>> | ||
>(); | ||
this._nextQueue.push(resolve); | ||
return promise; | ||
}, | ||
return: (): Promise< | ||
IteratorResult<Iterable<IncrementalDataRecordResult>> | ||
> => { | ||
for (const resolve of this._nextQueue) { | ||
resolve({ value: undefined, done: true }); | ||
} | ||
return Promise.resolve({ value: undefined, done: true }); | ||
}, | ||
}; | ||
} | ||
|
||
hasNext(): boolean { | ||
return this._pending.size > 0; | ||
} | ||
|
||
completeDeferredFragment( | ||
deferredFragmentRecord: DeferredFragmentRecord, | ||
): Array<ReconcilableDeferredGroupedFieldSetResult> | undefined { | ||
const deferredFragmentNode = this._deferredFragmentNodes.get( | ||
deferredFragmentRecord, | ||
); | ||
// TODO: add test case? | ||
/* c8 ignore next 3 */ | ||
if (deferredFragmentNode === undefined) { | ||
return undefined; | ||
} | ||
if (deferredFragmentNode.deferredGroupedFieldSetRecords.size > 0) { | ||
return; | ||
} | ||
const reconcilableResults = Array.from( | ||
deferredFragmentNode.reconcilableResults, | ||
); | ||
for (const reconcilableResult of reconcilableResults) { | ||
for (const otherDeferredFragmentRecord of reconcilableResult | ||
.deferredGroupedFieldSetRecord.deferredFragmentRecords) { | ||
const otherDeferredFragmentNode = this._deferredFragmentNodes.get( | ||
otherDeferredFragmentRecord, | ||
); | ||
if (otherDeferredFragmentNode === undefined) { | ||
continue; | ||
} | ||
otherDeferredFragmentNode.reconcilableResults.delete( | ||
reconcilableResult, | ||
); | ||
} | ||
} | ||
this._removePending(deferredFragmentNode); | ||
for (const child of deferredFragmentNode.children) { | ||
this._newPending.add(child); | ||
} | ||
return reconcilableResults; | ||
} | ||
|
||
removeDeferredFragment( | ||
deferredFragmentRecord: DeferredFragmentRecord, | ||
): boolean { | ||
const deferredFragmentNode = this._deferredFragmentNodes.get( | ||
deferredFragmentRecord, | ||
); | ||
// TODO: add test case? | ||
/* c8 ignore next 3 */ | ||
if (deferredFragmentNode === undefined) { | ||
return false; | ||
} | ||
this._removePending(deferredFragmentNode); | ||
this._deferredFragmentNodes.delete(deferredFragmentRecord); | ||
// TODO: add test case for an erroring deferred fragment with child defers | ||
/* c8 ignore next 3 */ | ||
for (const child of deferredFragmentNode.children) { | ||
this.removeDeferredFragment(child.deferredFragmentRecord); | ||
} | ||
return true; | ||
} | ||
|
||
removeStream(streamRecord: StreamRecord): void { | ||
this._removePending(streamRecord); | ||
} | ||
|
||
private _removePending(subsequentResultNode: SubsequentResultNode): void { | ||
this._pending.delete(subsequentResultNode); | ||
if (this._pending.size === 0) { | ||
for (const resolve of this._nextQueue) { | ||
resolve({ value: undefined, done: true }); | ||
} | ||
} | ||
} | ||
|
||
private _addDeferredGroupedFieldSetRecord( | ||
deferredGroupedFieldSetRecord: DeferredGroupedFieldSetRecord, | ||
): void { | ||
for (const deferredFragmentRecord of deferredGroupedFieldSetRecord.deferredFragmentRecords) { | ||
const deferredFragmentNode = this._addDeferredFragmentNode( | ||
deferredFragmentRecord, | ||
); | ||
if (this._pending.has(deferredFragmentNode)) { | ||
this._newIncrementalDataRecords.add(deferredGroupedFieldSetRecord); | ||
} | ||
deferredFragmentNode.deferredGroupedFieldSetRecords.add( | ||
deferredGroupedFieldSetRecord, | ||
); | ||
} | ||
} | ||
|
||
private _addStreamItemsRecord(streamItemsRecord: StreamItemsRecord): void { | ||
const streamRecord = streamItemsRecord.streamRecord; | ||
if (!this._pending.has(streamRecord)) { | ||
this._newPending.add(streamRecord); | ||
} | ||
this._newIncrementalDataRecords.add(streamItemsRecord); | ||
} | ||
|
||
private _addDeferredFragmentNode( | ||
deferredFragmentRecord: DeferredFragmentRecord, | ||
): DeferredFragmentNode { | ||
let deferredFragmentNode = this._deferredFragmentNodes.get( | ||
deferredFragmentRecord, | ||
); | ||
if (deferredFragmentNode !== undefined) { | ||
return deferredFragmentNode; | ||
} | ||
deferredFragmentNode = { | ||
deferredFragmentRecord, | ||
deferredGroupedFieldSetRecords: new Set(), | ||
reconcilableResults: new Set(), | ||
children: [], | ||
}; | ||
this._deferredFragmentNodes.set( | ||
deferredFragmentRecord, | ||
deferredFragmentNode, | ||
); | ||
const parent = deferredFragmentRecord.parent; | ||
if (parent === undefined) { | ||
this._newPending.add(deferredFragmentNode); | ||
return deferredFragmentNode; | ||
} | ||
const parentNode = this._addDeferredFragmentNode(parent); | ||
parentNode.children.push(deferredFragmentNode); | ||
return deferredFragmentNode; | ||
} | ||
|
||
private *_yieldCurrentCompletedIncrementalData( | ||
first: IncrementalDataRecordResult, | ||
): Generator<IncrementalDataRecordResult> { | ||
yield first; | ||
let completed; | ||
while ((completed = this._completedQueue.shift()) !== undefined) { | ||
yield completed; | ||
} | ||
} | ||
|
||
private _enqueue(completed: IncrementalDataRecordResult): void { | ||
const next = this._nextQueue.shift(); | ||
if (next !== undefined) { | ||
next({ | ||
value: this._yieldCurrentCompletedIncrementalData(completed), | ||
done: false, | ||
}); | ||
return; | ||
} | ||
this._completedQueue.push(completed); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these lines can be removed, a test case was added
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
09ae45a