refactor(incremental): introduce StreamRecord type

Author: yaacovCR

src/execution/IncrementalGraph.ts

@@ -7,6 +7,7 @@ import type {
   IncrementalDataRecord,
   IncrementalDataRecordResult,
   ReconcilableDeferredGroupedFieldSetResult,
+  StreamRecord,
   SubsequentResultRecord,
 } from './types.js';
 import { isDeferredGroupedFieldSetRecord } from './types.js';
@@ -27,11 +28,11 @@ function isDeferredFragmentNode(
 
 function isStreamNode(
   subsequentResultNode: SubsequentResultNode,
-): subsequentResultNode is SubsequentResultRecord {
+): subsequentResultNode is StreamRecord {
   return 'path' in subsequentResultNode;
 }
 
-type SubsequentResultNode = DeferredFragmentNode | SubsequentResultRecord;
+type SubsequentResultNode = DeferredFragmentNode | StreamRecord;
 
 /**
  * @internal
@@ -215,7 +216,7 @@ export class IncrementalGraph {
     }
   }
 
-  removeStream(streamRecord: SubsequentResultRecord): void {
+  removeStream(streamRecord: StreamRecord): void {
     this._removePending(streamRecord);
   }
 

src/execution/execute.ts

@@ -70,7 +70,7 @@ import type {
   IncrementalDataRecord,
   StreamItemsRecord,
   StreamItemsResult,
-  SubsequentResultRecord,
+  StreamRecord,
 } from './types.js';
 import { isReconcilableStreamItemsResult } from './types.js';
 import {
@@ -1094,12 +1094,12 @@ async function completeAsyncIteratorValue(
   while (true) {
     if (streamUsage && index >= streamUsage.initialCount) {
       const returnFn = asyncIterator.return;
-      let streamRecord: SubsequentResultRecord | CancellableStreamRecord;
+      let streamRecord: StreamRecord | CancellableStreamRecord;
       if (returnFn === undefined) {
         streamRecord = {
           label: streamUsage.label,
           path,
-        } as SubsequentResultRecord;
+        } as StreamRecord;
       } else {
         streamRecord = {
           label: streamUsage.label,
@@ -1266,7 +1266,7 @@ function completeIterableValue(
     const item = iteration.value;
 
     if (streamUsage && index >= streamUsage.initialCount) {
-      const streamRecord: SubsequentResultRecord = {
+      const streamRecord: StreamRecord = {
         label: streamUsage.label,
         path,
       };
@@ -2212,7 +2212,7 @@ function getDeferredFragmentRecords(
 }
 
 function firstSyncStreamItems(
-  streamRecord: SubsequentResultRecord,
+  streamRecord: StreamRecord,
   initialItem: PromiseOrValue<unknown>,
   initialIndex: number,
   iterator: Iterator<unknown>,
@@ -2315,7 +2315,7 @@ function prependNextResolvedStreamItems(
 }
 
 function firstAsyncStreamItems(
-  streamRecord: SubsequentResultRecord,
+  streamRecord: StreamRecord,
   path: Path,
   initialIndex: number,
   asyncIterator: AsyncIterator<unknown>,
@@ -2341,7 +2341,7 @@ function firstAsyncStreamItems(
 }
 
 async function getNextAsyncStreamItemsResult(
-  streamRecord: SubsequentResultRecord,
+  streamRecord: StreamRecord,
   path: Path,
   index: number,
   asyncIterator: AsyncIterator<unknown>,
@@ -2395,7 +2395,7 @@ async function getNextAsyncStreamItemsResult(
 }
 
 function completeStreamItems(
-  streamRecord: SubsequentResultRecord,
+  streamRecord: StreamRecord,
   itemPath: Path,
   item: unknown,
   exeContext: ExecutionContext,
@@ -2495,7 +2495,7 @@ function completeStreamItems(
 
 function buildStreamItemsResult(
   errors: ReadonlyArray<GraphQLError> | undefined,
-  streamRecord: SubsequentResultRecord,
+  streamRecord: StreamRecord,
   result: GraphQLWrappedResult<unknown>,
 ): StreamItemsResult {
   return {

src/execution/types.ts

@@ -209,20 +209,22 @@ export interface DeferredGroupedFieldSetRecord {
   result: PromiseOrValue<DeferredGroupedFieldSetResult>;
 }
 
-export interface SubsequentResultRecord {
+export type SubsequentResultRecord = DeferredFragmentRecord | StreamRecord;
+
+export interface DeferredFragmentRecord {
   path: Path | undefined;
   label: string | undefined;
   id?: string | undefined;
+  parent: DeferredFragmentRecord | undefined;
 }
 
-export interface DeferredFragmentRecord extends SubsequentResultRecord {
-  path: Path | undefined;
+export interface StreamRecord {
+  path: Path;
   label: string | undefined;
   id?: string | undefined;
-  parent: DeferredFragmentRecord | undefined;
 }
 
-export interface CancellableStreamRecord extends SubsequentResultRecord {
+export interface CancellableStreamRecord extends StreamRecord {
   earlyReturn: () => Promise<unknown>;
 }
 
@@ -233,7 +235,7 @@ export function isCancellableStreamRecord(
 }
 
 interface ReconcilableStreamItemsResult {
-  streamRecord: SubsequentResultRecord;
+  streamRecord: StreamRecord;
   result: BareStreamItemsResult;
   incrementalDataRecords: ReadonlyArray<IncrementalDataRecord> | undefined;
   errors?: never;
@@ -246,14 +248,14 @@ export function isReconcilableStreamItemsResult(
 }
 
 interface TerminatingStreamItemsResult {
-  streamRecord: SubsequentResultRecord;
+  streamRecord: StreamRecord;
   result?: never;
   incrementalDataRecords?: never;
   errors?: never;
 }
 
 interface NonReconcilableStreamItemsResult {
-  streamRecord: SubsequentResultRecord;
+  streamRecord: StreamRecord;
   errors: ReadonlyArray<GraphQLError>;
   result?: never;
 }
@@ -264,7 +266,7 @@ export type StreamItemsResult =
   | NonReconcilableStreamItemsResult;
 
 export interface StreamItemsRecord {
-  streamRecord: SubsequentResultRecord;
+  streamRecord: StreamRecord;
   result: PromiseOrValue<StreamItemsResult>;
 }