optimize setCompletedIterator behavior

Author: yaacovCR

src/execution/__tests__/stream-test.ts

@@ -594,9 +594,6 @@ describe('Execute: stream directive', () => {
             path: ['friendList', 2],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -634,9 +631,6 @@ describe('Execute: stream directive', () => {
             path: ['friendList', 2],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -676,7 +670,7 @@ describe('Execute: stream directive', () => {
         }
       }
     `);
-    const result = await completeAsync(document, 3, {
+    const result = await completeAsync(document, 2, {
       async *friendList() {
         yield await Promise.resolve(friends[0]);
         yield await Promise.resolve(friends[1]);
@@ -705,10 +699,9 @@ describe('Execute: stream directive', () => {
               path: ['friendList', 2],
             },
           ],
-          hasNext: true,
+          hasNext: false,
         },
       },
-      { done: false, value: { hasNext: false } },
       { done: true, value: undefined },
     ]);
   });
@@ -1128,9 +1121,6 @@ describe('Execute: stream directive', () => {
             path: ['friendList', 2],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1175,9 +1165,6 @@ describe('Execute: stream directive', () => {
             ],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1246,9 +1233,6 @@ describe('Execute: stream directive', () => {
             ],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1327,9 +1311,6 @@ describe('Execute: stream directive', () => {
             ],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1353,25 +1334,19 @@ describe('Execute: stream directive', () => {
         } /* c8 ignore stop */,
       },
     });
-    expectJSON(result).toDeepEqual([
-      {
-        errors: [
-          {
-            message:
-              'Cannot return null for non-nullable field NestedObject.nonNullScalarField.',
-            locations: [{ line: 4, column: 11 }],
-            path: ['nestedObject', 'nonNullScalarField'],
-          },
-        ],
-        data: {
-          nestedObject: null,
+    expectJSON(result).toDeepEqual({
+      errors: [
+        {
+          message:
+            'Cannot return null for non-nullable field NestedObject.nonNullScalarField.',
+          locations: [{ line: 4, column: 11 }],
+          path: ['nestedObject', 'nonNullScalarField'],
         },
-        hasNext: true,
-      },
-      {
-        hasNext: false,
+      ],
+      data: {
+        nestedObject: null,
       },
-    ]);
+    });
   });
   it('Filters payloads that are nulled by a later synchronous error', async () => {
     const document = parse(`
@@ -1557,9 +1532,6 @@ describe('Execute: stream directive', () => {
             ],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1707,9 +1679,6 @@ describe('Execute: stream directive', () => {
             path: ['friendList', 2],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1771,9 +1740,6 @@ describe('Execute: stream directive', () => {
             path: ['nestedObject', 'nestedFriendList', 1],
           },
         ],
-        hasNext: true,
-      },
-      {
         hasNext: false,
       },
     ]);
@@ -1854,17 +1820,12 @@ describe('Execute: stream directive', () => {
             path: ['nestedObject', 'nestedFriendList', 1],
           },
         ],
-        hasNext: true,
+        hasNext: false,
       },
       done: false,
     });
     const result5 = await iterator.next();
     expectJSON(result5).toDeepEqual({
-      value: { hasNext: false },
-      done: false,
-    });
-    const result6 = await iterator.next();
-    expectJSON(result6).toDeepEqual({
       value: undefined,
       done: true,
     });

src/execution/execute.ts

@@ -2295,12 +2295,12 @@ async function executeStreamAsyncIteratorItem(
   try {
     const iteration = await iterator.next();
     if (!exeContext.streams.has(streamRecord.streamContext)) {
-      streamRecord.setIsCompletedIterator();
+      streamRecord.remove();
       return { done: true, value: undefined };
     }
     const { value, done } = iteration;
     if (done) {
-      streamRecord.setIsCompletedIterator();
+      streamRecord.remove();
       return { done, value: undefined };
     }
     item = value;
@@ -2487,10 +2487,6 @@ function getCompletedIncrementalResults(
     exeContext.subsequentPayloads.delete(asyncPayloadRecord);
     if (isStreamPayload(asyncPayloadRecord)) {
       const items = asyncPayloadRecord.items;
-      if (asyncPayloadRecord.isCompletedIterator) {
-        // async iterable resolver just finished but there may be pending payloads
-        continue;
-      }
       (incrementalResult as IncrementalStreamResult).items = items ?? null;
       if (asyncPayloadRecord.streamContext.label !== undefined) {
         incrementalResult.label = asyncPayloadRecord.streamContext.label;
@@ -2747,7 +2743,6 @@ class StreamRecord {
   items: Array<unknown> | null;
   promise: Promise<void>;
   parents: Array<AsyncPayloadRecord> | undefined;
-  isCompletedIterator?: boolean;
   isCompleted: boolean;
   _exeContext: ExecutionContext;
   _resolve?: (arg: PromiseOrValue<Array<unknown> | null>) => void;
@@ -2785,8 +2780,9 @@ class StreamRecord {
     this._resolve?.(items);
   }
 
-  setIsCompletedIterator() {
-    this.isCompletedIterator = true;
+  remove() {
+    this._exeContext.subsequentPayloads.delete(this);
+    this._resolve?.(null);
   }
 }