graphql 17.0.0-alpha.8 → 17.0.0-beta.0

package/execution/incremental/IncrementalPublisher.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncrementalPublisher = void 0;
+const Path_js_1 = require("../../jsutils/Path.js");
+const ensureGraphQLError_js_1 = require("../../error/ensureGraphQLError.js");
+const mapAsyncIterable_js_1 = require("../mapAsyncIterable.js");
+const withConcurrentAbruptClose_js_1 = require("../withConcurrentAbruptClose.js");
+const WorkQueue_js_1 = require("./WorkQueue.js");
+/**
+ * @internal
+ */
+class IncrementalPublisher {
+    constructor() {
+        this._ids = new Map();
+        this._nextId = 0;
+    }
+    buildResponse(data, errors, work, abortSignal, onFinished) {
+        const { initialGroups, initialStreams, events } = (0, WorkQueue_js_1.createWorkQueue)(work);
+        function abort() {
+            subsequentResults.throw(abortSignal?.reason).catch(() => {
+                // Ignore errors
+            });
+        }
+        if (abortSignal) {
+            abortSignal.addEventListener('abort', abort);
+        }
+        const onWorkQueueFinished = () => {
+            onFinished();
+            abortSignal?.removeEventListener('abort', abort);
+        };
+        const pending = this._toPendingResults(initialGroups, initialStreams);
+        const initialResult = errors.length
+            ? { errors, data, pending, hasNext: true }
+            : { data, pending, hasNext: true };
+        const subsequentResults = (0, withConcurrentAbruptClose_js_1.withConcurrentAbruptClose)((0, mapAsyncIterable_js_1.mapAsyncIterable)(events, (batch) => this._handleBatch(batch, onWorkQueueFinished)), () => onWorkQueueFinished());
+        return {
+            initialResult,
+            subsequentResults,
+        };
+    }
+    _ensureId(deferredFragmentOrStream) {
+        let id = this._ids.get(deferredFragmentOrStream);
+        if (id !== undefined) {
+            return id;
+        }
+        id = String(this._nextId++);
+        this._ids.set(deferredFragmentOrStream, id);
+        return id;
+    }
+    _toPendingResults(newGroups, newStreams) {
+        const pendingResults = [];
+        for (const collection of [newGroups, newStreams]) {
+            for (const node of collection) {
+                const id = this._ensureId(node);
+                const pendingResult = {
+                    id,
+                    path: (0, Path_js_1.pathToArray)(node.path),
+                };
+                if (node.label !== undefined) {
+                    pendingResult.label = node.label;
+                }
+                pendingResults.push(pendingResult);
+            }
+        }
+        return pendingResults;
+    }
+    _handleBatch(batch, onWorkQueueFinished) {
+        const context = {
+            pending: [],
+            incremental: [],
+            completed: [],
+            hasNext: true,
+        };
+        for (const event of batch) {
+            this._handleWorkQueueEvent(event, context, onWorkQueueFinished);
+        }
+        const { incremental, completed, pending, hasNext } = context;
+        const result = { hasNext };
+        if (pending.length > 0) {
+            result.pending = pending;
+        }
+        if (incremental.length > 0) {
+            result.incremental = incremental;
+        }
+        if (completed.length > 0) {
+            result.completed = completed;
+        }
+        return result;
+    }
+    _handleWorkQueueEvent(event, context, onWorkQueueFinished) {
+        switch (event.kind) {
+            case 'GROUP_VALUES': {
+                const group = event.group;
+                const id = this._ensureId(group);
+                for (const value of event.values) {
+                    const { bestId, subPath } = this._getBestIdAndSubPath(id, group, value);
+                    const incrementalEntry = {
+                        id: bestId,
+                        data: value.data,
+                    };
+                    if (value.errors !== undefined) {
+                        incrementalEntry.errors = value.errors;
+                    }
+                    if (subPath !== undefined) {
+                        incrementalEntry.subPath = subPath;
+                    }
+                    context.incremental.push(incrementalEntry);
+                }
+                break;
+            }
+            case 'GROUP_SUCCESS': {
+                const group = event.group;
+                const id = this._ensureId(group);
+                context.completed.push({ id });
+                this._ids.delete(group);
+                if (event.newGroups.length > 0 || event.newStreams.length > 0) {
+                    context.pending.push(...this._toPendingResults(event.newGroups, event.newStreams));
+                }
+                break;
+            }
+            case 'GROUP_FAILURE': {
+                const { group, error } = event;
+                const id = this._ensureId(group);
+                context.completed.push({
+                    id,
+                    errors: [(0, ensureGraphQLError_js_1.ensureGraphQLError)(error)],
+                });
+                this._ids.delete(group);
+                break;
+            }
+            case 'STREAM_VALUES': {
+                const stream = event.stream;
+                const id = this._ensureId(stream);
+                const { values, newGroups, newStreams } = event;
+                const items = [];
+                const errors = [];
+                for (const value of values) {
+                    items.push(value.item);
+                    if (value.errors !== undefined) {
+                        errors.push(...value.errors);
+                    }
+                }
+                context.incremental.push(errors.length > 0 ? { id, items, errors } : { id, items });
+                if (newGroups.length > 0 || newStreams.length > 0) {
+                    context.pending.push(...this._toPendingResults(newGroups, newStreams));
+                }
+                break;
+            }
+            case 'STREAM_SUCCESS': {
+                const stream = event.stream;
+                context.completed.push({
+                    id: this._ensureId(stream),
+                });
+                this._ids.delete(stream);
+                break;
+            }
+            case 'STREAM_FAILURE': {
+                const stream = event.stream;
+                context.completed.push({
+                    id: this._ensureId(stream),
+                    errors: [(0, ensureGraphQLError_js_1.ensureGraphQLError)(event.error)],
+                });
+                this._ids.delete(stream);
+                break;
+            }
+            case 'WORK_QUEUE_TERMINATION': {
+                onWorkQueueFinished?.();
+                context.hasNext = false;
+                break;
+            }
+        }
+    }
+    _getBestIdAndSubPath(initialId, initialDeferredFragmentRecord, executionGroupValue) {
+        let maxLength = (0, Path_js_1.pathToArray)(initialDeferredFragmentRecord.path).length;
+        let bestId = initialId;
+        for (const deliveryGroup of executionGroupValue.deliveryGroups) {
+            if (deliveryGroup === initialDeferredFragmentRecord) {
+                continue;
+            }
+            const id = this._ids.get(deliveryGroup);
+            // TODO: add test case for when an group has not been released, but might be processed for the shortest path.
+            /* c8 ignore next 3 */
+            if (id === undefined) {
+                continue;
+            }
+            const path = (0, Path_js_1.pathToArray)(deliveryGroup.path);
+            const length = path.length;
+            if (length > maxLength) {
+                maxLength = length;
+                bestId = id;
+            }
+        }
+        const subPath = executionGroupValue.path.slice(maxLength);
+        return {
+            bestId,
+            subPath: subPath.length > 0 ? subPath : undefined,
+        };
+    }
+}
+exports.IncrementalPublisher = IncrementalPublisher;
+//# sourceMappingURL=IncrementalPublisher.js.map

package/execution/incremental/IncrementalPublisher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalPublisher.js","sourceRoot":"","sources":["../../../src/execution/incremental/IncrementalPublisher.ts"],"names":[],"mappings":";;;AACA,mDAAoD;AAEpD,6EAAuE;AAGvE,gEAA0D;AAC1D,kFAA4E;AAiB5E,iDAAiD;AASjD;;GAEG;AACH,MAAa,oBAAoB;IAI/B;QACE,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,aAAa,CACX,IAAqB,EACrB,MAAmC,EACnC,IAAqB,EACrB,WAAoC,EACpC,UAAsB;QAEtB,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,IAAA,8BAAe,EAK/D,IAAI,CAAC,CAAC;QAER,SAAS,KAAK;YACZ,iBAAiB,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;gBACtD,gBAAgB;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,mBAAmB,GAAG,GAAG,EAAE;YAC/B,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEtE,MAAM,aAAa,GAAsC,MAAM,CAAC,MAAM;YACpE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;YAC1C,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAErC,MAAM,iBAAiB,GAAG,IAAA,wDAAyB,EACjD,IAAA,sCAAgB,EAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CACjC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAC9C,EACD,GAAG,EAAE,CAAC,mBAAmB,EAAE,CAC5B,CAAC;QAEF,OAAO;YACL,aAAa;YACb,iBAAiB;SAClB,CAAC;IACJ,CAAC;IAEO,SAAS,CACf,wBAAoD;QAEpD,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACjD,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;QAC5C,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,iBAAiB,CACvB,SAAuC,EACvC,UAAqC;QAErC,MAAM,cAAc,GAAyB,EAAE,CAAC;QAChD,KAAK,MAAM,UAAU,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;gBAC9B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAChC,MAAM,aAAa,GAAkB;oBACnC,EAAE;oBACF,IAAI,EAAE,IAAA,qBAAW,EAAC,IAAI,CAAC,IAAI,CAAC;iBAC7B,CAAC;gBACF,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC7B,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;gBACnC,CAAC;gBACD,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,YAAY,CAClB,KAOC,EACD,mBAA6C;QAE7C,MAAM,OAAO,GAAgD;YAC3D,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE7D,MAAM,MAAM,GAAyC,EAAE,OAAO,EAAE,CAAC;QACjE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB,CAC3B,KAKC,EACD,OAAoD,EACpD,mBAA6C;QAE7C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,oBAAoB,CACnD,EAAE,EACF,KAAK,EACL,KAAK,CACN,CAAC;oBACF,MAAM,gBAAgB,GAA2B;wBAC/C,EAAE,EAAE,MAAM;wBACV,IAAI,EAAE,KAAK,CAAC,IAAI;qBACjB,CAAC;oBACF,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC/B,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;oBACzC,CAAC;oBACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;wBAC1B,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;oBACrC,CAAC;oBACD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAC7C,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxB,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9D,OAAO,CAAC,OAAO,CAAC,IAAI,CAClB,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAC7D,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;gBAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE;oBACF,MAAM,EAAE,CAAC,IAAA,0CAAkB,EAAC,KAAK,CAAC,CAAC;iBACpC,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxB,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;gBAChD,MAAM,KAAK,GAAmB,EAAE,CAAC;gBACjC,MAAM,MAAM,GAAwB,EAAE,CAAC;gBACvC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACvB,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,WAAW,CAAC,IAAI,CACtB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAC1D,CAAC;gBACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAClB,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,CACjD,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;iBAC3B,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;oBAC1B,MAAM,EAAE,CAAC,IAAA,0CAAkB,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAC1C,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM;YACR,CAAC;YACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;gBAC9B,mBAAmB,EAAE,EAAE,CAAC;gBACxB,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;gBACxB,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAEO,oBAAoB,CAC1B,SAAiB,EACjB,6BAA4C,EAC5C,mBAAwC;QAExC,IAAI,SAAS,GAAG,IAAA,qBAAW,EAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QACvE,IAAI,MAAM,GAAG,SAAS,CAAC;QAEvB,KAAK,MAAM,aAAa,IAAI,mBAAmB,CAAC,cAAc,EAAE,CAAC;YAC/D,IAAI,aAAa,KAAK,6BAA6B,EAAE,CAAC;gBACpD,SAAS;YACX,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACxC,6GAA6G;YAC7G,sBAAsB;YACtB,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,IAAA,qBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;gBACvB,SAAS,GAAG,MAAM,CAAC;gBACnB,MAAM,GAAG,EAAE,CAAC;YACd,CAAC;QACH,CAAC;QACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO;YACL,MAAM;YACN,OAAO,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;SAClD,CAAC;IACJ,CAAC;CACF;AArQD,oDAqQC","sourcesContent":["import type { ObjMap } from '../../jsutils/ObjMap.js';\nimport { pathToArray } from '../../jsutils/Path.js';\n\nimport { ensureGraphQLError } from '../../error/ensureGraphQLError.js';\nimport type { GraphQLError } from '../../error/GraphQLError.js';\n\nimport { mapAsyncIterable } from '../mapAsyncIterable.js';\nimport { withConcurrentAbruptClose } from '../withConcurrentAbruptClose.js';\n\nimport type {\n  CompletedResult,\n  DeliveryGroup,\n  ExecutionGroupValue,\n  ExperimentalIncrementalExecutionResults,\n  IncrementalDeferResult,\n  IncrementalResult,\n  IncrementalWork,\n  InitialIncrementalExecutionResult,\n  ItemStream,\n  PendingResult,\n  StreamItemValue,\n  SubsequentIncrementalExecutionResult,\n} from './IncrementalExecutor.js';\nimport type { WorkQueueEvent } from './WorkQueue.js';\nimport { createWorkQueue } from './WorkQueue.js';\n\ninterface SubsequentIncrementalExecutionResultContext {\n  pending: Array<PendingResult>;\n  incremental: Array<IncrementalResult>;\n  completed: Array<CompletedResult>;\n  hasNext: boolean;\n}\n\n/**\n * @internal\n */\nexport class IncrementalPublisher {\n  private _ids: Map<DeliveryGroup | ItemStream, string>;\n  private _nextId: number;\n\n  constructor() {\n    this._ids = new Map();\n    this._nextId = 0;\n  }\n\n  buildResponse(\n    data: ObjMap<unknown>,\n    errors: ReadonlyArray<GraphQLError>,\n    work: IncrementalWork,\n    abortSignal: AbortSignal | undefined,\n    onFinished: () => void,\n  ): ExperimentalIncrementalExecutionResults {\n    const { initialGroups, initialStreams, events } = createWorkQueue<\n      ExecutionGroupValue,\n      StreamItemValue,\n      DeliveryGroup,\n      ItemStream\n    >(work);\n\n    function abort(): void {\n      subsequentResults.throw(abortSignal?.reason).catch(() => {\n        // Ignore errors\n      });\n    }\n\n    if (abortSignal) {\n      abortSignal.addEventListener('abort', abort);\n    }\n    const onWorkQueueFinished = () => {\n      onFinished();\n      abortSignal?.removeEventListener('abort', abort);\n    };\n\n    const pending = this._toPendingResults(initialGroups, initialStreams);\n\n    const initialResult: InitialIncrementalExecutionResult = errors.length\n      ? { errors, data, pending, hasNext: true }\n      : { data, pending, hasNext: true };\n\n    const subsequentResults = withConcurrentAbruptClose(\n      mapAsyncIterable(events, (batch) =>\n        this._handleBatch(batch, onWorkQueueFinished),\n      ),\n      () => onWorkQueueFinished(),\n    );\n\n    return {\n      initialResult,\n      subsequentResults,\n    };\n  }\n\n  private _ensureId(\n    deferredFragmentOrStream: DeliveryGroup | ItemStream,\n  ): string {\n    let id = this._ids.get(deferredFragmentOrStream);\n    if (id !== undefined) {\n      return id;\n    }\n    id = String(this._nextId++);\n    this._ids.set(deferredFragmentOrStream, id);\n    return id;\n  }\n\n  private _toPendingResults(\n    newGroups: ReadonlyArray<DeliveryGroup>,\n    newStreams: ReadonlyArray<ItemStream>,\n  ): Array<PendingResult> {\n    const pendingResults: Array<PendingResult> = [];\n    for (const collection of [newGroups, newStreams]) {\n      for (const node of collection) {\n        const id = this._ensureId(node);\n        const pendingResult: PendingResult = {\n          id,\n          path: pathToArray(node.path),\n        };\n        if (node.label !== undefined) {\n          pendingResult.label = node.label;\n        }\n        pendingResults.push(pendingResult);\n      }\n    }\n    return pendingResults;\n  }\n\n  private _handleBatch(\n    batch: ReadonlyArray<\n      WorkQueueEvent<\n        ExecutionGroupValue,\n        StreamItemValue,\n        DeliveryGroup,\n        ItemStream\n      >\n    >,\n    onWorkQueueFinished: (() => void) | undefined,\n  ): SubsequentIncrementalExecutionResult {\n    const context: SubsequentIncrementalExecutionResultContext = {\n      pending: [],\n      incremental: [],\n      completed: [],\n      hasNext: true,\n    };\n\n    for (const event of batch) {\n      this._handleWorkQueueEvent(event, context, onWorkQueueFinished);\n    }\n\n    const { incremental, completed, pending, hasNext } = context;\n\n    const result: SubsequentIncrementalExecutionResult = { hasNext };\n    if (pending.length > 0) {\n      result.pending = pending;\n    }\n    if (incremental.length > 0) {\n      result.incremental = incremental;\n    }\n    if (completed.length > 0) {\n      result.completed = completed;\n    }\n\n    return result;\n  }\n\n  private _handleWorkQueueEvent(\n    event: WorkQueueEvent<\n      ExecutionGroupValue,\n      StreamItemValue,\n      DeliveryGroup,\n      ItemStream\n    >,\n    context: SubsequentIncrementalExecutionResultContext,\n    onWorkQueueFinished: (() => void) | undefined,\n  ): void {\n    switch (event.kind) {\n      case 'GROUP_VALUES': {\n        const group = event.group;\n        const id = this._ensureId(group);\n        for (const value of event.values) {\n          const { bestId, subPath } = this._getBestIdAndSubPath(\n            id,\n            group,\n            value,\n          );\n          const incrementalEntry: IncrementalDeferResult = {\n            id: bestId,\n            data: value.data,\n          };\n          if (value.errors !== undefined) {\n            incrementalEntry.errors = value.errors;\n          }\n          if (subPath !== undefined) {\n            incrementalEntry.subPath = subPath;\n          }\n          context.incremental.push(incrementalEntry);\n        }\n        break;\n      }\n      case 'GROUP_SUCCESS': {\n        const group = event.group;\n        const id = this._ensureId(group);\n        context.completed.push({ id });\n        this._ids.delete(group);\n        if (event.newGroups.length > 0 || event.newStreams.length > 0) {\n          context.pending.push(\n            ...this._toPendingResults(event.newGroups, event.newStreams),\n          );\n        }\n        break;\n      }\n      case 'GROUP_FAILURE': {\n        const { group, error } = event;\n        const id = this._ensureId(group);\n        context.completed.push({\n          id,\n          errors: [ensureGraphQLError(error)],\n        });\n        this._ids.delete(group);\n        break;\n      }\n      case 'STREAM_VALUES': {\n        const stream = event.stream;\n        const id = this._ensureId(stream);\n        const { values, newGroups, newStreams } = event;\n        const items: Array<unknown> = [];\n        const errors: Array<GraphQLError> = [];\n        for (const value of values) {\n          items.push(value.item);\n          if (value.errors !== undefined) {\n            errors.push(...value.errors);\n          }\n        }\n        context.incremental.push(\n          errors.length > 0 ? { id, items, errors } : { id, items },\n        );\n        if (newGroups.length > 0 || newStreams.length > 0) {\n          context.pending.push(\n            ...this._toPendingResults(newGroups, newStreams),\n          );\n        }\n        break;\n      }\n      case 'STREAM_SUCCESS': {\n        const stream = event.stream;\n        context.completed.push({\n          id: this._ensureId(stream),\n        });\n        this._ids.delete(stream);\n        break;\n      }\n      case 'STREAM_FAILURE': {\n        const stream = event.stream;\n        context.completed.push({\n          id: this._ensureId(stream),\n          errors: [ensureGraphQLError(event.error)],\n        });\n        this._ids.delete(stream);\n        break;\n      }\n      case 'WORK_QUEUE_TERMINATION': {\n        onWorkQueueFinished?.();\n        context.hasNext = false;\n        break;\n      }\n    }\n  }\n\n  private _getBestIdAndSubPath(\n    initialId: string,\n    initialDeferredFragmentRecord: DeliveryGroup,\n    executionGroupValue: ExecutionGroupValue,\n  ): { bestId: string; subPath: ReadonlyArray<string | number> | undefined } {\n    let maxLength = pathToArray(initialDeferredFragmentRecord.path).length;\n    let bestId = initialId;\n\n    for (const deliveryGroup of executionGroupValue.deliveryGroups) {\n      if (deliveryGroup === initialDeferredFragmentRecord) {\n        continue;\n      }\n      const id = this._ids.get(deliveryGroup);\n      // TODO: add test case for when an group has not been released, but might be processed for the shortest path.\n      /* c8 ignore next 3 */\n      if (id === undefined) {\n        continue;\n      }\n      const path = pathToArray(deliveryGroup.path);\n      const length = path.length;\n      if (length > maxLength) {\n        maxLength = length;\n        bestId = id;\n      }\n    }\n    const subPath = executionGroupValue.path.slice(maxLength);\n    return {\n      bestId,\n      subPath: subPath.length > 0 ? subPath : undefined,\n    };\n  }\n}\n"]}

package/execution/incremental/IncrementalPublisher.mjs

@@ -0,0 +1,197 @@
+import { pathToArray } from "../../jsutils/Path.mjs";
+import { ensureGraphQLError } from "../../error/ensureGraphQLError.mjs";
+import { mapAsyncIterable } from "../mapAsyncIterable.mjs";
+import { withConcurrentAbruptClose } from "../withConcurrentAbruptClose.mjs";
+import { createWorkQueue } from "./WorkQueue.mjs";
+/**
+ * @internal
+ */
+export class IncrementalPublisher {
+    constructor() {
+        this._ids = new Map();
+        this._nextId = 0;
+    }
+    buildResponse(data, errors, work, abortSignal, onFinished) {
+        const { initialGroups, initialStreams, events } = createWorkQueue(work);
+        function abort() {
+            subsequentResults.throw(abortSignal?.reason).catch(() => {
+                // Ignore errors
+            });
+        }
+        if (abortSignal) {
+            abortSignal.addEventListener('abort', abort);
+        }
+        const onWorkQueueFinished = () => {
+            onFinished();
+            abortSignal?.removeEventListener('abort', abort);
+        };
+        const pending = this._toPendingResults(initialGroups, initialStreams);
+        const initialResult = errors.length
+            ? { errors, data, pending, hasNext: true }
+            : { data, pending, hasNext: true };
+        const subsequentResults = withConcurrentAbruptClose(mapAsyncIterable(events, (batch) => this._handleBatch(batch, onWorkQueueFinished)), () => onWorkQueueFinished());
+        return {
+            initialResult,
+            subsequentResults,
+        };
+    }
+    _ensureId(deferredFragmentOrStream) {
+        let id = this._ids.get(deferredFragmentOrStream);
+        if (id !== undefined) {
+            return id;
+        }
+        id = String(this._nextId++);
+        this._ids.set(deferredFragmentOrStream, id);
+        return id;
+    }
+    _toPendingResults(newGroups, newStreams) {
+        const pendingResults = [];
+        for (const collection of [newGroups, newStreams]) {
+            for (const node of collection) {
+                const id = this._ensureId(node);
+                const pendingResult = {
+                    id,
+                    path: pathToArray(node.path),
+                };
+                if (node.label !== undefined) {
+                    pendingResult.label = node.label;
+                }
+                pendingResults.push(pendingResult);
+            }
+        }
+        return pendingResults;
+    }
+    _handleBatch(batch, onWorkQueueFinished) {
+        const context = {
+            pending: [],
+            incremental: [],
+            completed: [],
+            hasNext: true,
+        };
+        for (const event of batch) {
+            this._handleWorkQueueEvent(event, context, onWorkQueueFinished);
+        }
+        const { incremental, completed, pending, hasNext } = context;
+        const result = { hasNext };
+        if (pending.length > 0) {
+            result.pending = pending;
+        }
+        if (incremental.length > 0) {
+            result.incremental = incremental;
+        }
+        if (completed.length > 0) {
+            result.completed = completed;
+        }
+        return result;
+    }
+    _handleWorkQueueEvent(event, context, onWorkQueueFinished) {
+        switch (event.kind) {
+            case 'GROUP_VALUES': {
+                const group = event.group;
+                const id = this._ensureId(group);
+                for (const value of event.values) {
+                    const { bestId, subPath } = this._getBestIdAndSubPath(id, group, value);
+                    const incrementalEntry = {
+                        id: bestId,
+                        data: value.data,
+                    };
+                    if (value.errors !== undefined) {
+                        incrementalEntry.errors = value.errors;
+                    }
+                    if (subPath !== undefined) {
+                        incrementalEntry.subPath = subPath;
+                    }
+                    context.incremental.push(incrementalEntry);
+                }
+                break;
+            }
+            case 'GROUP_SUCCESS': {
+                const group = event.group;
+                const id = this._ensureId(group);
+                context.completed.push({ id });
+                this._ids.delete(group);
+                if (event.newGroups.length > 0 || event.newStreams.length > 0) {
+                    context.pending.push(...this._toPendingResults(event.newGroups, event.newStreams));
+                }
+                break;
+            }
+            case 'GROUP_FAILURE': {
+                const { group, error } = event;
+                const id = this._ensureId(group);
+                context.completed.push({
+                    id,
+                    errors: [ensureGraphQLError(error)],
+                });
+                this._ids.delete(group);
+                break;
+            }
+            case 'STREAM_VALUES': {
+                const stream = event.stream;
+                const id = this._ensureId(stream);
+                const { values, newGroups, newStreams } = event;
+                const items = [];
+                const errors = [];
+                for (const value of values) {
+                    items.push(value.item);
+                    if (value.errors !== undefined) {
+                        errors.push(...value.errors);
+                    }
+                }
+                context.incremental.push(errors.length > 0 ? { id, items, errors } : { id, items });
+                if (newGroups.length > 0 || newStreams.length > 0) {
+                    context.pending.push(...this._toPendingResults(newGroups, newStreams));
+                }
+                break;
+            }
+            case 'STREAM_SUCCESS': {
+                const stream = event.stream;
+                context.completed.push({
+                    id: this._ensureId(stream),
+                });
+                this._ids.delete(stream);
+                break;
+            }
+            case 'STREAM_FAILURE': {
+                const stream = event.stream;
+                context.completed.push({
+                    id: this._ensureId(stream),
+                    errors: [ensureGraphQLError(event.error)],
+                });
+                this._ids.delete(stream);
+                break;
+            }
+            case 'WORK_QUEUE_TERMINATION': {
+                onWorkQueueFinished?.();
+                context.hasNext = false;
+                break;
+            }
+        }
+    }
+    _getBestIdAndSubPath(initialId, initialDeferredFragmentRecord, executionGroupValue) {
+        let maxLength = pathToArray(initialDeferredFragmentRecord.path).length;
+        let bestId = initialId;
+        for (const deliveryGroup of executionGroupValue.deliveryGroups) {
+            if (deliveryGroup === initialDeferredFragmentRecord) {
+                continue;
+            }
+            const id = this._ids.get(deliveryGroup);
+            // TODO: add test case for when an group has not been released, but might be processed for the shortest path.
+            /* c8 ignore next 3 */
+            if (id === undefined) {
+                continue;
+            }
+            const path = pathToArray(deliveryGroup.path);
+            const length = path.length;
+            if (length > maxLength) {
+                maxLength = length;
+                bestId = id;
+            }
+        }
+        const subPath = executionGroupValue.path.slice(maxLength);
+        return {
+            bestId,
+            subPath: subPath.length > 0 ? subPath : undefined,
+        };
+    }
+}
+//# sourceMappingURL=IncrementalPublisher.js.map

package/execution/incremental/IncrementalPublisher.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalPublisher.js","sourceRoot":"","sources":["../../../src/execution/incremental/IncrementalPublisher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,+BAA8B;AAEpD,OAAO,EAAE,kBAAkB,EAAE,2CAA0C;AAGvE,OAAO,EAAE,gBAAgB,EAAE,gCAA+B;AAC1D,OAAO,EAAE,yBAAyB,EAAE,yCAAwC;AAiB5E,OAAO,EAAE,eAAe,EAAE,wBAAuB;AASjD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAI/B;QACE,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,aAAa,CACX,IAAqB,EACrB,MAAmC,EACnC,IAAqB,EACrB,WAAoC,EACpC,UAAsB;QAEtB,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,eAAe,CAK/D,IAAI,CAAC,CAAC;QAER,SAAS,KAAK;YACZ,iBAAiB,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;gBACtD,gBAAgB;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,mBAAmB,GAAG,GAAG,EAAE;YAC/B,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEtE,MAAM,aAAa,GAAsC,MAAM,CAAC,MAAM;YACpE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;YAC1C,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAErC,MAAM,iBAAiB,GAAG,yBAAyB,CACjD,gBAAgB,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CACjC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAC9C,EACD,GAAG,EAAE,CAAC,mBAAmB,EAAE,CAC5B,CAAC;QAEF,OAAO;YACL,aAAa;YACb,iBAAiB;SAClB,CAAC;IACJ,CAAC;IAEO,SAAS,CACf,wBAAoD;QAEpD,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACjD,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;QAC5C,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,iBAAiB,CACvB,SAAuC,EACvC,UAAqC;QAErC,MAAM,cAAc,GAAyB,EAAE,CAAC;QAChD,KAAK,MAAM,UAAU,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;gBAC9B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAChC,MAAM,aAAa,GAAkB;oBACnC,EAAE;oBACF,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC7B,CAAC;gBACF,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC7B,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;gBACnC,CAAC;gBACD,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,YAAY,CAClB,KAOC,EACD,mBAA6C;QAE7C,MAAM,OAAO,GAAgD;YAC3D,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE7D,MAAM,MAAM,GAAyC,EAAE,OAAO,EAAE,CAAC;QACjE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB,CAC3B,KAKC,EACD,OAAoD,EACpD,mBAA6C;QAE7C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,oBAAoB,CACnD,EAAE,EACF,KAAK,EACL,KAAK,CACN,CAAC;oBACF,MAAM,gBAAgB,GAA2B;wBAC/C,EAAE,EAAE,MAAM;wBACV,IAAI,EAAE,KAAK,CAAC,IAAI;qBACjB,CAAC;oBACF,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC/B,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;oBACzC,CAAC;oBACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;wBAC1B,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;oBACrC,CAAC;oBACD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAC7C,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxB,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9D,OAAO,CAAC,OAAO,CAAC,IAAI,CAClB,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAC7D,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;gBAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE;oBACF,MAAM,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;iBACpC,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxB,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;gBAChD,MAAM,KAAK,GAAmB,EAAE,CAAC;gBACjC,MAAM,MAAM,GAAwB,EAAE,CAAC;gBACvC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACvB,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,WAAW,CAAC,IAAI,CACtB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAC1D,CAAC;gBACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAClB,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,CACjD,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;iBAC3B,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC5B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;oBACrB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;oBAC1B,MAAM,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAC1C,CAAC,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM;YACR,CAAC;YACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;gBAC9B,mBAAmB,EAAE,EAAE,CAAC;gBACxB,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;gBACxB,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAEO,oBAAoB,CAC1B,SAAiB,EACjB,6BAA4C,EAC5C,mBAAwC;QAExC,IAAI,SAAS,GAAG,WAAW,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QACvE,IAAI,MAAM,GAAG,SAAS,CAAC;QAEvB,KAAK,MAAM,aAAa,IAAI,mBAAmB,CAAC,cAAc,EAAE,CAAC;YAC/D,IAAI,aAAa,KAAK,6BAA6B,EAAE,CAAC;gBACpD,SAAS;YACX,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACxC,6GAA6G;YAC7G,sBAAsB;YACtB,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;gBACvB,SAAS,GAAG,MAAM,CAAC;gBACnB,MAAM,GAAG,EAAE,CAAC;YACd,CAAC;QACH,CAAC;QACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO;YACL,MAAM;YACN,OAAO,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;SAClD,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type { ObjMap } from '../../jsutils/ObjMap.js';\nimport { pathToArray } from '../../jsutils/Path.js';\n\nimport { ensureGraphQLError } from '../../error/ensureGraphQLError.js';\nimport type { GraphQLError } from '../../error/GraphQLError.js';\n\nimport { mapAsyncIterable } from '../mapAsyncIterable.js';\nimport { withConcurrentAbruptClose } from '../withConcurrentAbruptClose.js';\n\nimport type {\n  CompletedResult,\n  DeliveryGroup,\n  ExecutionGroupValue,\n  ExperimentalIncrementalExecutionResults,\n  IncrementalDeferResult,\n  IncrementalResult,\n  IncrementalWork,\n  InitialIncrementalExecutionResult,\n  ItemStream,\n  PendingResult,\n  StreamItemValue,\n  SubsequentIncrementalExecutionResult,\n} from './IncrementalExecutor.js';\nimport type { WorkQueueEvent } from './WorkQueue.js';\nimport { createWorkQueue } from './WorkQueue.js';\n\ninterface SubsequentIncrementalExecutionResultContext {\n  pending: Array<PendingResult>;\n  incremental: Array<IncrementalResult>;\n  completed: Array<CompletedResult>;\n  hasNext: boolean;\n}\n\n/**\n * @internal\n */\nexport class IncrementalPublisher {\n  private _ids: Map<DeliveryGroup | ItemStream, string>;\n  private _nextId: number;\n\n  constructor() {\n    this._ids = new Map();\n    this._nextId = 0;\n  }\n\n  buildResponse(\n    data: ObjMap<unknown>,\n    errors: ReadonlyArray<GraphQLError>,\n    work: IncrementalWork,\n    abortSignal: AbortSignal | undefined,\n    onFinished: () => void,\n  ): ExperimentalIncrementalExecutionResults {\n    const { initialGroups, initialStreams, events } = createWorkQueue<\n      ExecutionGroupValue,\n      StreamItemValue,\n      DeliveryGroup,\n      ItemStream\n    >(work);\n\n    function abort(): void {\n      subsequentResults.throw(abortSignal?.reason).catch(() => {\n        // Ignore errors\n      });\n    }\n\n    if (abortSignal) {\n      abortSignal.addEventListener('abort', abort);\n    }\n    const onWorkQueueFinished = () => {\n      onFinished();\n      abortSignal?.removeEventListener('abort', abort);\n    };\n\n    const pending = this._toPendingResults(initialGroups, initialStreams);\n\n    const initialResult: InitialIncrementalExecutionResult = errors.length\n      ? { errors, data, pending, hasNext: true }\n      : { data, pending, hasNext: true };\n\n    const subsequentResults = withConcurrentAbruptClose(\n      mapAsyncIterable(events, (batch) =>\n        this._handleBatch(batch, onWorkQueueFinished),\n      ),\n      () => onWorkQueueFinished(),\n    );\n\n    return {\n      initialResult,\n      subsequentResults,\n    };\n  }\n\n  private _ensureId(\n    deferredFragmentOrStream: DeliveryGroup | ItemStream,\n  ): string {\n    let id = this._ids.get(deferredFragmentOrStream);\n    if (id !== undefined) {\n      return id;\n    }\n    id = String(this._nextId++);\n    this._ids.set(deferredFragmentOrStream, id);\n    return id;\n  }\n\n  private _toPendingResults(\n    newGroups: ReadonlyArray<DeliveryGroup>,\n    newStreams: ReadonlyArray<ItemStream>,\n  ): Array<PendingResult> {\n    const pendingResults: Array<PendingResult> = [];\n    for (const collection of [newGroups, newStreams]) {\n      for (const node of collection) {\n        const id = this._ensureId(node);\n        const pendingResult: PendingResult = {\n          id,\n          path: pathToArray(node.path),\n        };\n        if (node.label !== undefined) {\n          pendingResult.label = node.label;\n        }\n        pendingResults.push(pendingResult);\n      }\n    }\n    return pendingResults;\n  }\n\n  private _handleBatch(\n    batch: ReadonlyArray<\n      WorkQueueEvent<\n        ExecutionGroupValue,\n        StreamItemValue,\n        DeliveryGroup,\n        ItemStream\n      >\n    >,\n    onWorkQueueFinished: (() => void) | undefined,\n  ): SubsequentIncrementalExecutionResult {\n    const context: SubsequentIncrementalExecutionResultContext = {\n      pending: [],\n      incremental: [],\n      completed: [],\n      hasNext: true,\n    };\n\n    for (const event of batch) {\n      this._handleWorkQueueEvent(event, context, onWorkQueueFinished);\n    }\n\n    const { incremental, completed, pending, hasNext } = context;\n\n    const result: SubsequentIncrementalExecutionResult = { hasNext };\n    if (pending.length > 0) {\n      result.pending = pending;\n    }\n    if (incremental.length > 0) {\n      result.incremental = incremental;\n    }\n    if (completed.length > 0) {\n      result.completed = completed;\n    }\n\n    return result;\n  }\n\n  private _handleWorkQueueEvent(\n    event: WorkQueueEvent<\n      ExecutionGroupValue,\n      StreamItemValue,\n      DeliveryGroup,\n      ItemStream\n    >,\n    context: SubsequentIncrementalExecutionResultContext,\n    onWorkQueueFinished: (() => void) | undefined,\n  ): void {\n    switch (event.kind) {\n      case 'GROUP_VALUES': {\n        const group = event.group;\n        const id = this._ensureId(group);\n        for (const value of event.values) {\n          const { bestId, subPath } = this._getBestIdAndSubPath(\n            id,\n            group,\n            value,\n          );\n          const incrementalEntry: IncrementalDeferResult = {\n            id: bestId,\n            data: value.data,\n          };\n          if (value.errors !== undefined) {\n            incrementalEntry.errors = value.errors;\n          }\n          if (subPath !== undefined) {\n            incrementalEntry.subPath = subPath;\n          }\n          context.incremental.push(incrementalEntry);\n        }\n        break;\n      }\n      case 'GROUP_SUCCESS': {\n        const group = event.group;\n        const id = this._ensureId(group);\n        context.completed.push({ id });\n        this._ids.delete(group);\n        if (event.newGroups.length > 0 || event.newStreams.length > 0) {\n          context.pending.push(\n            ...this._toPendingResults(event.newGroups, event.newStreams),\n          );\n        }\n        break;\n      }\n      case 'GROUP_FAILURE': {\n        const { group, error } = event;\n        const id = this._ensureId(group);\n        context.completed.push({\n          id,\n          errors: [ensureGraphQLError(error)],\n        });\n        this._ids.delete(group);\n        break;\n      }\n      case 'STREAM_VALUES': {\n        const stream = event.stream;\n        const id = this._ensureId(stream);\n        const { values, newGroups, newStreams } = event;\n        const items: Array<unknown> = [];\n        const errors: Array<GraphQLError> = [];\n        for (const value of values) {\n          items.push(value.item);\n          if (value.errors !== undefined) {\n            errors.push(...value.errors);\n          }\n        }\n        context.incremental.push(\n          errors.length > 0 ? { id, items, errors } : { id, items },\n        );\n        if (newGroups.length > 0 || newStreams.length > 0) {\n          context.pending.push(\n            ...this._toPendingResults(newGroups, newStreams),\n          );\n        }\n        break;\n      }\n      case 'STREAM_SUCCESS': {\n        const stream = event.stream;\n        context.completed.push({\n          id: this._ensureId(stream),\n        });\n        this._ids.delete(stream);\n        break;\n      }\n      case 'STREAM_FAILURE': {\n        const stream = event.stream;\n        context.completed.push({\n          id: this._ensureId(stream),\n          errors: [ensureGraphQLError(event.error)],\n        });\n        this._ids.delete(stream);\n        break;\n      }\n      case 'WORK_QUEUE_TERMINATION': {\n        onWorkQueueFinished?.();\n        context.hasNext = false;\n        break;\n      }\n    }\n  }\n\n  private _getBestIdAndSubPath(\n    initialId: string,\n    initialDeferredFragmentRecord: DeliveryGroup,\n    executionGroupValue: ExecutionGroupValue,\n  ): { bestId: string; subPath: ReadonlyArray<string | number> | undefined } {\n    let maxLength = pathToArray(initialDeferredFragmentRecord.path).length;\n    let bestId = initialId;\n\n    for (const deliveryGroup of executionGroupValue.deliveryGroups) {\n      if (deliveryGroup === initialDeferredFragmentRecord) {\n        continue;\n      }\n      const id = this._ids.get(deliveryGroup);\n      // TODO: add test case for when an group has not been released, but might be processed for the shortest path.\n      /* c8 ignore next 3 */\n      if (id === undefined) {\n        continue;\n      }\n      const path = pathToArray(deliveryGroup.path);\n      const length = path.length;\n      if (length > maxLength) {\n        maxLength = length;\n        bestId = id;\n      }\n    }\n    const subPath = executionGroupValue.path.slice(maxLength);\n    return {\n      bestId,\n      subPath: subPath.length > 0 ? subPath : undefined,\n    };\n  }\n}\n"]}

package/execution/incremental/Queue.d.mts

@@ -0,0 +1,86 @@
+import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
+interface QueueExecutorOptions<T> {
+    push: (item: PromiseOrValue<T>) => PromiseOrValue<void>;
+    stop: (reason?: unknown) => PromiseOrValue<void>;
+    onStop: (cleanup: (reason?: unknown) => PromiseOrValue<void>) => void;
+    started: Promise<void>;
+}
+/**
+ * A Queue is a lightweight async-generator primitive inspired by Brian Kim's
+ * Repeater (https://repeater.js.org, https://github.com/repeaterjs/repeater).
+ * The ergonomics are similar, but this implementation favors clarity over
+ * performance and gives producers flexibility to remain lazy, become eager, or
+ * live somewhere in between.
+ *
+ * The constructor takes an executor function and an optional `initialCapacity`.
+ * Executors receive `{ push, stop, onStop, started }` and may return `void` or
+ * a promise if they perform asynchronous setup. They call `push` whenever
+ * another item is ready, call `stop` when no more values will be produced
+ * (optionally supplying an error), register stop-time cleanup via `onStop`,
+ * and await `started` when setup should run only after iteration begins.
+ * Because `push`, `stop`, and `onStop` are plain functions, executors can
+ * hoist them into outside scopes or pass them to helpers. If the executor
+ * throws or its returned promise rejects, the queue treats it as `stop(error)`
+ * and propagates the failure.
+ *
+ * The `initialCapacity` argument (default `1`) governs backpressure. Capacity
+ * is the maximum number of buffered items allowed before a push must wait.
+ * When the backlog reaches capacity, `push` returns a promise that settles
+ * once consumption releases space; otherwise it returns `undefined`. Setting
+ * capacity to `1` yields a fully lazy queue (every push waits unless a prior
+ * item has been consumed); higher capacities buffer that many items eagerly.
+ * Capacity can be changed later via `setCapacity` and observed via
+ * `getCapacity`.
+ *
+ * `subscribe(reducer)` returns an async generator whose batches feed a generator
+ * of settled values into the reducer; whatever the reducer returns (other than
+ * `undefined`) becomes the yielded value for that batch. Calling `return()` on
+ * the subscription settles pending `next` calls thanks to `withConcurrent`,
+ * providing direct abort semantics rather than leaving `next()` suspended.
+ *
+ * 'forEachBatch(reducer)` is a convenience method that subscribes with the
+ * given reducer and runs it for each batch until the queue stops.
+ *
+ * Producers can stay lazy by awaiting `started`, using zero capacity, and
+ * awaiting each `push`. Skipping those waits while raising capacity makes the
+ * queue eager up to its configured limit. The `isStopped()` helper exposes
+ * whether the queue has fully stopped, which can be useful when the reducer
+ * function actually performs external work and wants to bail early without
+ * awaiting another `next`.
+ *
+ * @internal
+ */
+export declare class Queue<T> {
+    private _capacity;
+    private _backlog;
+    private _waiters;
+    private _entries;
+    private _isStopped;
+    private _stopRequested;
+    private _stopCleanupCallbacks;
+    private _stopCompletion;
+    private _batchRequests;
+    private _resolveStarted;
+    constructor(executor: ({ push, stop, onStop, started, }: QueueExecutorOptions<T>) => PromiseOrValue<void>, initialCapacity?: number);
+    subscribe<U>(reducer?: (generator: Generator<T, void, void>) => PromiseOrValue<U | undefined>): AsyncGenerator<U, void, void>;
+    cancel(): PromiseOrValue<void>;
+    abort(reason?: unknown): PromiseOrValue<void>;
+    forEachBatch(reducer: (generator: Generator<T, void, void>) => PromiseOrValue<void>): Promise<void>;
+    setCapacity(nextCapacity: number): void;
+    getCapacity(): number;
+    isStopped(): boolean;
+    private _normalizeCapacity;
+    private _flush;
+    private _reserve;
+    private _release;
+    private _onStop;
+    private _runStopCleanup;
+    private _iteratorLoop;
+    private _waitForNextBatch;
+    private _push;
+    private _terminate;
+    private _stop;
+    private _deliverBatchIfReady;
+    private _drainBatch;
+}
+export {};

package/execution/incremental/Queue.d.ts

@@ -0,0 +1,86 @@
+import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
+interface QueueExecutorOptions<T> {
+    push: (item: PromiseOrValue<T>) => PromiseOrValue<void>;
+    stop: (reason?: unknown) => PromiseOrValue<void>;
+    onStop: (cleanup: (reason?: unknown) => PromiseOrValue<void>) => void;
+    started: Promise<void>;
+}
+/**
+ * A Queue is a lightweight async-generator primitive inspired by Brian Kim's
+ * Repeater (https://repeater.js.org, https://github.com/repeaterjs/repeater).
+ * The ergonomics are similar, but this implementation favors clarity over
+ * performance and gives producers flexibility to remain lazy, become eager, or
+ * live somewhere in between.
+ *
+ * The constructor takes an executor function and an optional `initialCapacity`.
+ * Executors receive `{ push, stop, onStop, started }` and may return `void` or
+ * a promise if they perform asynchronous setup. They call `push` whenever
+ * another item is ready, call `stop` when no more values will be produced
+ * (optionally supplying an error), register stop-time cleanup via `onStop`,
+ * and await `started` when setup should run only after iteration begins.
+ * Because `push`, `stop`, and `onStop` are plain functions, executors can
+ * hoist them into outside scopes or pass them to helpers. If the executor
+ * throws or its returned promise rejects, the queue treats it as `stop(error)`
+ * and propagates the failure.
+ *
+ * The `initialCapacity` argument (default `1`) governs backpressure. Capacity
+ * is the maximum number of buffered items allowed before a push must wait.
+ * When the backlog reaches capacity, `push` returns a promise that settles
+ * once consumption releases space; otherwise it returns `undefined`. Setting
+ * capacity to `1` yields a fully lazy queue (every push waits unless a prior
+ * item has been consumed); higher capacities buffer that many items eagerly.
+ * Capacity can be changed later via `setCapacity` and observed via
+ * `getCapacity`.
+ *
+ * `subscribe(reducer)` returns an async generator whose batches feed a generator
+ * of settled values into the reducer; whatever the reducer returns (other than
+ * `undefined`) becomes the yielded value for that batch. Calling `return()` on
+ * the subscription settles pending `next` calls thanks to `withConcurrent`,
+ * providing direct abort semantics rather than leaving `next()` suspended.
+ *
+ * 'forEachBatch(reducer)` is a convenience method that subscribes with the
+ * given reducer and runs it for each batch until the queue stops.
+ *
+ * Producers can stay lazy by awaiting `started`, using zero capacity, and
+ * awaiting each `push`. Skipping those waits while raising capacity makes the
+ * queue eager up to its configured limit. The `isStopped()` helper exposes
+ * whether the queue has fully stopped, which can be useful when the reducer
+ * function actually performs external work and wants to bail early without
+ * awaiting another `next`.
+ *
+ * @internal
+ */
+export declare class Queue<T> {
+    private _capacity;
+    private _backlog;
+    private _waiters;
+    private _entries;
+    private _isStopped;
+    private _stopRequested;
+    private _stopCleanupCallbacks;
+    private _stopCompletion;
+    private _batchRequests;
+    private _resolveStarted;
+    constructor(executor: ({ push, stop, onStop, started, }: QueueExecutorOptions<T>) => PromiseOrValue<void>, initialCapacity?: number);
+    subscribe<U>(reducer?: (generator: Generator<T, void, void>) => PromiseOrValue<U | undefined>): AsyncGenerator<U, void, void>;
+    cancel(): PromiseOrValue<void>;
+    abort(reason?: unknown): PromiseOrValue<void>;
+    forEachBatch(reducer: (generator: Generator<T, void, void>) => PromiseOrValue<void>): Promise<void>;
+    setCapacity(nextCapacity: number): void;
+    getCapacity(): number;
+    isStopped(): boolean;
+    private _normalizeCapacity;
+    private _flush;
+    private _reserve;
+    private _release;
+    private _onStop;
+    private _runStopCleanup;
+    private _iteratorLoop;
+    private _waitForNextBatch;
+    private _push;
+    private _terminate;
+    private _stop;
+    private _deliverBatchIfReady;
+    private _drainBatch;
+}
+export {};