do not use undefined for empty incremental data record array

Author: yaacovCR

src/execution/execute.ts

@@ -214,7 +214,7 @@ export interface StreamUsage {
 
 interface GraphQLWrappedResult<T> {
   rawResult: T;
-  incrementalDataRecords: Array<IncrementalDataRecord> | undefined;
+  incrementalDataRecords: Array<IncrementalDataRecord>;
 }
 
 const UNEXPECTED_EXPERIMENTAL_DIRECTIVES =
@@ -424,7 +424,7 @@ function buildDataResponse(
 ): ExecutionResult | ExperimentalIncrementalExecutionResults {
   const { rawResult: data, incrementalDataRecords } = graphqlWrappedResult;
   const errors = exeContext.errors;
-  if (incrementalDataRecords === undefined) {
+  if (incrementalDataRecords.length === 0) {
     exeContext.abortSignalListener?.disconnect();
     return errors.length ? { errors, data } : { data };
   }
@@ -626,12 +626,12 @@ function withNewExecutionGroups(
 ): PromiseOrValue<GraphQLWrappedResult<ObjMap<unknown>>> {
   if (isPromise(result)) {
     return result.then((resolved) => {
-      addIncrementalDataRecords(resolved, newPendingExecutionGroups);
+      resolved.incrementalDataRecords.push(...newPendingExecutionGroups);
       return resolved;
     });
   }
 
-  addIncrementalDataRecords(result, newPendingExecutionGroups);
+  result.incrementalDataRecords.push(...newPendingExecutionGroups);
   return result;
 }
 
@@ -726,41 +726,25 @@ function executeFieldsSerially(
       if (isPromise(result)) {
         return result.then((resolved) => {
           graphqlWrappedResult.rawResult[responseName] = resolved.rawResult;
-          addIncrementalDataRecords(
-            graphqlWrappedResult,
-            resolved.incrementalDataRecords,
+          graphqlWrappedResult.incrementalDataRecords.push(
+            ...resolved.incrementalDataRecords,
           );
           return graphqlWrappedResult;
         });
       }
       graphqlWrappedResult.rawResult[responseName] = result.rawResult;
-      addIncrementalDataRecords(
-        graphqlWrappedResult,
-        result.incrementalDataRecords,
+      graphqlWrappedResult.incrementalDataRecords.push(
+        ...result.incrementalDataRecords,
       );
       return graphqlWrappedResult;
     },
     {
       rawResult: Object.create(null),
-      incrementalDataRecords: undefined,
+      incrementalDataRecords: [] as Array<IncrementalDataRecord>,
     },
   );
 }
 
-function addIncrementalDataRecords(
-  graphqlWrappedResult: GraphQLWrappedResult<unknown>,
-  incrementalDataRecords: ReadonlyArray<IncrementalDataRecord> | undefined,
-): void {
-  if (incrementalDataRecords === undefined) {
-    return;
-  }
-  if (graphqlWrappedResult.incrementalDataRecords === undefined) {
-    graphqlWrappedResult.incrementalDataRecords = [...incrementalDataRecords];
-  } else {
-    graphqlWrappedResult.incrementalDataRecords.push(...incrementalDataRecords);
-  }
-}
-
 /**
  * Implements the "Executing selection sets" section of the spec
  * for fields that may be executed in parallel.
@@ -777,7 +761,7 @@ function executeFields(
   const results = Object.create(null);
   const graphqlWrappedResult: GraphQLWrappedResult<ObjMap<unknown>> = {
     rawResult: results,
-    incrementalDataRecords: undefined,
+    incrementalDataRecords: [],
   };
   let containsPromise = false;
 
@@ -797,18 +781,16 @@ function executeFields(
       if (result !== undefined) {
         if (isPromise(result)) {
           results[responseName] = result.then((resolved) => {
-            addIncrementalDataRecords(
-              graphqlWrappedResult,
-              resolved.incrementalDataRecords,
+            graphqlWrappedResult.incrementalDataRecords.push(
+              ...resolved.incrementalDataRecords,
             );
             return resolved.rawResult;
           });
           containsPromise = true;
         } else {
           results[responseName] = result.rawResult;
-          addIncrementalDataRecords(
-            graphqlWrappedResult,
-            result.incrementalDataRecords,
+          graphqlWrappedResult.incrementalDataRecords.push(
+            ...result.incrementalDataRecords,
           );
         }
       }
@@ -935,7 +917,7 @@ function executeField(
           path,
           incrementalContext,
         );
-        return { rawResult: null, incrementalDataRecords: undefined };
+        return { rawResult: null, incrementalDataRecords: [] };
       });
     }
     return completed;
@@ -948,7 +930,7 @@ function executeField(
       path,
       incrementalContext,
     );
-    return { rawResult: null, incrementalDataRecords: undefined };
+    return { rawResult: null, incrementalDataRecords: [] };
   }
 }
 
@@ -1068,7 +1050,7 @@ function completeValue(
 
   // If result value is null or undefined then return null.
   if (result == null) {
-    return { rawResult: null, incrementalDataRecords: undefined };
+    return { rawResult: null, incrementalDataRecords: [] };
   }
 
   // If field type is List, complete each item in the list with the inner type
@@ -1090,7 +1072,7 @@ function completeValue(
   if (isLeafType(returnType)) {
     return {
       rawResult: completeLeafValue(returnType, result),
-      incrementalDataRecords: undefined,
+      incrementalDataRecords: [],
     };
   }
 
@@ -1169,7 +1151,7 @@ async function completePromisedValue(
       path,
       incrementalContext,
     );
-    return { rawResult: null, incrementalDataRecords: undefined };
+    return { rawResult: null, incrementalDataRecords: [] };
   }
 }
 
@@ -1269,7 +1251,7 @@ async function completeAsyncIteratorValue(
   const completedResults: Array<unknown> = [];
   const graphqlWrappedResult: GraphQLWrappedResult<Array<unknown>> = {
     rawResult: completedResults,
-    incrementalDataRecords: undefined,
+    incrementalDataRecords: [],
   };
   let index = 0;
   const streamUsage = getStreamUsage(
@@ -1312,7 +1294,7 @@ async function completeAsyncIteratorValue(
           exeContext.cancellableStreams.add(streamRecord);
         }
 
-        addIncrementalDataRecords(graphqlWrappedResult, [streamRecord]);
+        graphqlWrappedResult.incrementalDataRecords.push(streamRecord);
         break;
       }
 
@@ -1462,7 +1444,7 @@ function completeIterableValue(
   const completedResults: Array<unknown> = [];
   const graphqlWrappedResult: GraphQLWrappedResult<Array<unknown>> = {
     rawResult: completedResults,
-    incrementalDataRecords: undefined,
+    incrementalDataRecords: [],
   };
   let index = 0;
   const streamUsage = getStreamUsage(
@@ -1491,7 +1473,7 @@ function completeIterableValue(
         ),
       };
 
-      addIncrementalDataRecords(graphqlWrappedResult, [syncStreamRecord]);
+      graphqlWrappedResult.incrementalDataRecords.push(syncStreamRecord);
       break;
     }
 
@@ -1578,7 +1560,9 @@ function completeListItemValue(
       completedResults.push(
         completedItem.then(
           (resolved) => {
-            addIncrementalDataRecords(parent, resolved.incrementalDataRecords);
+            parent.incrementalDataRecords.push(
+              ...resolved.incrementalDataRecords,
+            );
             return resolved.rawResult;
           },
           (rawError: unknown) => {
@@ -1598,7 +1582,7 @@ function completeListItemValue(
     }
 
     completedResults.push(completedItem.rawResult);
-    addIncrementalDataRecords(parent, completedItem.incrementalDataRecords);
+    parent.incrementalDataRecords.push(...completedItem.incrementalDataRecords);
   } catch (rawError) {
     handleFieldError(
       rawError,
@@ -1643,7 +1627,7 @@ async function completePromisedListItemValue(
     if (isPromise(completed)) {
       completed = await completed;
     }
-    addIncrementalDataRecords(parent, completed.incrementalDataRecords);
+    parent.incrementalDataRecords.push(...completed.incrementalDataRecords);
     return completed.rawResult;
   } catch (rawError) {
     handleFieldError(
@@ -2748,7 +2732,7 @@ function completeStreamItem(
         itemPath,
         incrementalContext,
       );
-      result = { rawResult: null, incrementalDataRecords: undefined };
+      result = { rawResult: null, incrementalDataRecords: [] };
     }
   } catch (error) {
     incrementalContext.completed = true;
@@ -2768,7 +2752,7 @@ function completeStreamItem(
           itemPath,
           incrementalContext,
         );
-        return { rawResult: null, incrementalDataRecords: undefined };
+        return { rawResult: null, incrementalDataRecords: [] };
       })
       .then(
         (resolvedItem) => {