@graphql-tools/delegate 12.1.1 → 12.1.2-alpha-a25a0e4521aff5261d06903efe4386cd565f2e57

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @graphql-tools/delegate
 
+## 12.1.2-alpha-a25a0e4521aff5261d06903efe4386cd565f2e57
+### Patch Changes
+
+
+
+- [#2555](https://github.com/graphql-hive/gateway/pull/2555) [`a25a0e4`](https://github.com/graphql-hive/gateway/commit/a25a0e4521aff5261d06903efe4386cd565f2e57) Thanks [@enisdenjo](https://github.com/enisdenjo)! - Flush deferred merged fields without blocking the initial payload
+  
+  Deferred fields on merged entity types are now delegated when their deferred resolvers run instead of being included in the initial delegation plan. This allows the initial payload to be delivered before slower merged subgraph fields resolve.
+
 ## 12.1.1
 ### Patch Changes
 

package/dist/index.cjs

@@ -96,18 +96,17 @@ function getSubschema(object, responseKey) {
 function getUnpathedErrors(object) {
   return object[UNPATHED_ERRORS_SYMBOL];
 }
-const EMPTY_ARRAY = [];
 const EMPTY_OBJECT = /* @__PURE__ */ Object.create(null);
 const getActualFieldNodes = utils.memoize1(function(fieldNode) {
   return [fieldNode];
 });
-function mergeFields(mergedTypeInfo, object, sourceSubschema, context, info) {
+function mergeFields(mergedTypeInfo, object, sourceSubschema, context, info, fieldNodes = info.fieldNodes) {
   const delegationMaps = mergedTypeInfo.delegationPlanBuilder(
     info.schema,
     sourceSubschema,
     info.variableValues != null && Object.keys(info.variableValues).length > 0 ? info.variableValues : EMPTY_OBJECT,
     info.fragments != null && Object.keys(info.fragments).length > 0 ? info.fragments : EMPTY_OBJECT,
-    info.fieldNodes?.length ? info.fieldNodes.length === 1 && info.fieldNodes[0] ? getActualFieldNodes(info.fieldNodes[0]) : info.fieldNodes : EMPTY_ARRAY,
+    fieldNodes.length === 1 && fieldNodes[0] ? getActualFieldNodes(fieldNodes[0]) : fieldNodes,
     context,
     info
   );
@@ -2572,9 +2571,9 @@ function defaultMergedResolver(parent, args, context, info) {
       }
       const deferred = promiseHelpers.createDeferredPromise();
       missingDeferredFields.set(responseKey, deferred);
-      const stitchingInfo = info.schema.extensions?.["stitchingInfo"];
-      const parentTypeName = parent?.__typename || info.parentType.name;
-      const fieldNodesByType = stitchingInfo?.fieldNodesByField?.[parentTypeName]?.[info.fieldName];
+      const stitchingInfo2 = info.schema.extensions?.["stitchingInfo"];
+      const parentTypeName2 = parent?.__typename || info.parentType.name;
+      const fieldNodesByType = stitchingInfo2?.fieldNodesByField?.[parentTypeName2]?.[info.fieldName];
       if (fieldNodesByType?.every((fieldNode) => {
         const responseKey2 = fieldNode.alias?.value ?? fieldNode.name.value;
         return Object.prototype.hasOwnProperty.call(parent, responseKey2);
@@ -2588,6 +2587,29 @@ function defaultMergedResolver(parent, args, context, info) {
     if (Object.prototype.hasOwnProperty.call(parent, info.fieldName)) {
       return graphql.defaultFieldResolver(parent, args, context, info);
     }
+    const stitchingInfo = info.schema?.extensions?.["stitchingInfo"];
+    const parentTypeName = parent.__typename || info.parentType?.name;
+    const mergedTypeInfo = parentTypeName ? stitchingInfo?.mergedTypes[parentTypeName] : void 0;
+    const sourceSubschema = parent[OBJECT_SUBSCHEMA_SYMBOL];
+    if (mergedTypeInfo && sourceSubschema) {
+      const fieldNode = {
+        kind: graphql.Kind.FIELD,
+        name: info.fieldNodes[0]?.name ?? {
+          kind: graphql.Kind.NAME,
+          value: info.fieldName
+        },
+        selectionSet: {
+          kind: graphql.Kind.SELECTION_SET,
+          selections: info.fieldNodes
+        }
+      };
+      return promiseHelpers.handleMaybePromise(
+        () => mergeFields(mergedTypeInfo, parent, sourceSubschema, context, info, [
+          fieldNode
+        ]),
+        () => Object.prototype.hasOwnProperty.call(parent, responseKey) ? handleResult(parent, responseKey, context, info) : void 0
+      );
+    }
     return void 0;
   }
   return handleResult(parent, responseKey, context, info);
@@ -3494,7 +3516,6 @@ Object.defineProperty(exports, "createDefaultExecutor", {
   enumerable: true,
   get: function () { return executor.executorFromSchema; }
 });
-exports.EMPTY_ARRAY = EMPTY_ARRAY;
 exports.EMPTY_OBJECT = EMPTY_OBJECT;
 exports.FIELD_SUBSCHEMA_MAP_SYMBOL = FIELD_SUBSCHEMA_MAP_SYMBOL;
 exports.OBJECT_SUBSCHEMA_SYMBOL = OBJECT_SUBSCHEMA_SYMBOL;

package/dist/index.d.cts

@@ -199,10 +199,9 @@ declare function isExternalObject(data: any): data is ExternalObject;
 declare function annotateExternalObject<TContext>(object: any, errors: Array<GraphQLError>, subschema: GraphQLSchema | SubschemaConfig<any, any, any, TContext> | undefined, subschemaMap: Record<string, GraphQLSchema | SubschemaConfig<any, any, any, Record<string, any>>>): ExternalObject;
 declare function getSubschema(object: ExternalObject, responseKey: string): GraphQLSchema | SubschemaConfig;
 declare function getUnpathedErrors(object: ExternalObject): Array<GraphQLError>;
-declare const EMPTY_ARRAY: any[];
 declare const EMPTY_OBJECT: any;
 declare const getActualFieldNodes: (fieldNode: FieldNode) => FieldNode[];
-declare function mergeFields<TContext>(mergedTypeInfo: MergedTypeInfo, object: any, sourceSubschema: Subschema<any, any, any, TContext>, context: any, info: GraphQLResolveInfo): MaybePromise<any>;
+declare function mergeFields<TContext>(mergedTypeInfo: MergedTypeInfo, object: any, sourceSubschema: Subschema<any, any, any, TContext>, context: any, info: GraphQLResolveInfo, fieldNodes?: FieldNode[]): MaybePromise<any>;
 declare function handleResolverResult(resolverResult: any, subschema: Subschema, selectionSet: SelectionSetNode, object: ExternalObject, combinedFieldSubschemaMap: Record<string, GraphQLSchema | SubschemaConfig<any, any, any, Record<string, any>>>, info: GraphQLResolveInfo, path: Array<string | number>, combinedErrors: Array<GraphQLError>): void;
 
 declare function resolveExternalValue<TContext extends Record<string, any>>(result: any, unpathedErrors: Array<GraphQLError>, subschema: GraphQLSchema | SubschemaConfig<any, any, any, TContext>, context?: Record<string, any>, info?: GraphQLResolveInfo, returnType?: GraphQLOutputType, skipTypeMerging?: boolean): any;
@@ -239,4 +238,4 @@ declare function isPrototypePollutingKey(key: string): key is PrototypePolluting
 
 declare const handleOverrideByDelegation: (info: GraphQLResolveInfo$1, context: any, overrideHandler: OverrideHandler) => boolean;
 
-export { type BatchingOptions, type CreateProxyingResolverFn, type Deferred, type DelegationContext, type DelegationPlanBuilder, type DelegationPlanLeftOver, EMPTY_ARRAY, EMPTY_OBJECT, type ExternalObject, FIELD_SUBSCHEMA_MAP_SYMBOL, type ICreateProxyingResolverOptions, type ICreateRequest, type IDelegateRequestOptions, type IDelegateToSchemaOptions, type MergedFieldConfig, type MergedTypeConfig, type MergedTypeEntryPoint, type MergedTypeInfo, type MergedTypeResolver, type MergedTypeResolverOptions, OBJECT_SUBSCHEMA_SYMBOL, type OverrideHandler, PLAN_LEFT_OVER, type RequestTransform, type ResultTransform, type SchemaTransform, type StitchingInfo, Subschema, type SubschemaConfig, type Transform, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };
+export { type BatchingOptions, type CreateProxyingResolverFn, type Deferred, type DelegationContext, type DelegationPlanBuilder, type DelegationPlanLeftOver, EMPTY_OBJECT, type ExternalObject, FIELD_SUBSCHEMA_MAP_SYMBOL, type ICreateProxyingResolverOptions, type ICreateRequest, type IDelegateRequestOptions, type IDelegateToSchemaOptions, type MergedFieldConfig, type MergedTypeConfig, type MergedTypeEntryPoint, type MergedTypeInfo, type MergedTypeResolver, type MergedTypeResolverOptions, OBJECT_SUBSCHEMA_SYMBOL, type OverrideHandler, PLAN_LEFT_OVER, type RequestTransform, type ResultTransform, type SchemaTransform, type StitchingInfo, Subschema, type SubschemaConfig, type Transform, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };

package/dist/index.d.ts

@@ -199,10 +199,9 @@ declare function isExternalObject(data: any): data is ExternalObject;
 declare function annotateExternalObject<TContext>(object: any, errors: Array<GraphQLError>, subschema: GraphQLSchema | SubschemaConfig<any, any, any, TContext> | undefined, subschemaMap: Record<string, GraphQLSchema | SubschemaConfig<any, any, any, Record<string, any>>>): ExternalObject;
 declare function getSubschema(object: ExternalObject, responseKey: string): GraphQLSchema | SubschemaConfig;
 declare function getUnpathedErrors(object: ExternalObject): Array<GraphQLError>;
-declare const EMPTY_ARRAY: any[];
 declare const EMPTY_OBJECT: any;
 declare const getActualFieldNodes: (fieldNode: FieldNode) => FieldNode[];
-declare function mergeFields<TContext>(mergedTypeInfo: MergedTypeInfo, object: any, sourceSubschema: Subschema<any, any, any, TContext>, context: any, info: GraphQLResolveInfo): MaybePromise<any>;
+declare function mergeFields<TContext>(mergedTypeInfo: MergedTypeInfo, object: any, sourceSubschema: Subschema<any, any, any, TContext>, context: any, info: GraphQLResolveInfo, fieldNodes?: FieldNode[]): MaybePromise<any>;
 declare function handleResolverResult(resolverResult: any, subschema: Subschema, selectionSet: SelectionSetNode, object: ExternalObject, combinedFieldSubschemaMap: Record<string, GraphQLSchema | SubschemaConfig<any, any, any, Record<string, any>>>, info: GraphQLResolveInfo, path: Array<string | number>, combinedErrors: Array<GraphQLError>): void;
 
 declare function resolveExternalValue<TContext extends Record<string, any>>(result: any, unpathedErrors: Array<GraphQLError>, subschema: GraphQLSchema | SubschemaConfig<any, any, any, TContext>, context?: Record<string, any>, info?: GraphQLResolveInfo, returnType?: GraphQLOutputType, skipTypeMerging?: boolean): any;
@@ -239,4 +238,4 @@ declare function isPrototypePollutingKey(key: string): key is PrototypePolluting
 
 declare const handleOverrideByDelegation: (info: GraphQLResolveInfo$1, context: any, overrideHandler: OverrideHandler) => boolean;
 
-export { type BatchingOptions, type CreateProxyingResolverFn, type Deferred, type DelegationContext, type DelegationPlanBuilder, type DelegationPlanLeftOver, EMPTY_ARRAY, EMPTY_OBJECT, type ExternalObject, FIELD_SUBSCHEMA_MAP_SYMBOL, type ICreateProxyingResolverOptions, type ICreateRequest, type IDelegateRequestOptions, type IDelegateToSchemaOptions, type MergedFieldConfig, type MergedTypeConfig, type MergedTypeEntryPoint, type MergedTypeInfo, type MergedTypeResolver, type MergedTypeResolverOptions, OBJECT_SUBSCHEMA_SYMBOL, type OverrideHandler, PLAN_LEFT_OVER, type RequestTransform, type ResultTransform, type SchemaTransform, type StitchingInfo, Subschema, type SubschemaConfig, type Transform, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };
+export { type BatchingOptions, type CreateProxyingResolverFn, type Deferred, type DelegationContext, type DelegationPlanBuilder, type DelegationPlanLeftOver, EMPTY_OBJECT, type ExternalObject, FIELD_SUBSCHEMA_MAP_SYMBOL, type ICreateProxyingResolverOptions, type ICreateRequest, type IDelegateRequestOptions, type IDelegateToSchemaOptions, type MergedFieldConfig, type MergedTypeConfig, type MergedTypeEntryPoint, type MergedTypeInfo, type MergedTypeResolver, type MergedTypeResolverOptions, OBJECT_SUBSCHEMA_SYMBOL, type OverrideHandler, PLAN_LEFT_OVER, type RequestTransform, type ResultTransform, type SchemaTransform, type StitchingInfo, Subschema, type SubschemaConfig, type Transform, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };

package/dist/index.js

@@ -96,18 +96,17 @@ function getSubschema(object, responseKey) {
 function getUnpathedErrors(object) {
   return object[UNPATHED_ERRORS_SYMBOL];
 }
-const EMPTY_ARRAY = [];
 const EMPTY_OBJECT = /* @__PURE__ */ Object.create(null);
 const getActualFieldNodes = memoize1(function(fieldNode) {
   return [fieldNode];
 });
-function mergeFields(mergedTypeInfo, object, sourceSubschema, context, info) {
+function mergeFields(mergedTypeInfo, object, sourceSubschema, context, info, fieldNodes = info.fieldNodes) {
   const delegationMaps = mergedTypeInfo.delegationPlanBuilder(
     info.schema,
     sourceSubschema,
     info.variableValues != null && Object.keys(info.variableValues).length > 0 ? info.variableValues : EMPTY_OBJECT,
     info.fragments != null && Object.keys(info.fragments).length > 0 ? info.fragments : EMPTY_OBJECT,
-    info.fieldNodes?.length ? info.fieldNodes.length === 1 && info.fieldNodes[0] ? getActualFieldNodes(info.fieldNodes[0]) : info.fieldNodes : EMPTY_ARRAY,
+    fieldNodes.length === 1 && fieldNodes[0] ? getActualFieldNodes(fieldNodes[0]) : fieldNodes,
     context,
     info
   );
@@ -2572,9 +2571,9 @@ function defaultMergedResolver(parent, args, context, info) {
       }
       const deferred = createDeferredPromise();
       missingDeferredFields.set(responseKey, deferred);
-      const stitchingInfo = info.schema.extensions?.["stitchingInfo"];
-      const parentTypeName = parent?.__typename || info.parentType.name;
-      const fieldNodesByType = stitchingInfo?.fieldNodesByField?.[parentTypeName]?.[info.fieldName];
+      const stitchingInfo2 = info.schema.extensions?.["stitchingInfo"];
+      const parentTypeName2 = parent?.__typename || info.parentType.name;
+      const fieldNodesByType = stitchingInfo2?.fieldNodesByField?.[parentTypeName2]?.[info.fieldName];
       if (fieldNodesByType?.every((fieldNode) => {
         const responseKey2 = fieldNode.alias?.value ?? fieldNode.name.value;
         return Object.prototype.hasOwnProperty.call(parent, responseKey2);
@@ -2588,6 +2587,29 @@ function defaultMergedResolver(parent, args, context, info) {
     if (Object.prototype.hasOwnProperty.call(parent, info.fieldName)) {
       return defaultFieldResolver(parent, args, context, info);
     }
+    const stitchingInfo = info.schema?.extensions?.["stitchingInfo"];
+    const parentTypeName = parent.__typename || info.parentType?.name;
+    const mergedTypeInfo = parentTypeName ? stitchingInfo?.mergedTypes[parentTypeName] : void 0;
+    const sourceSubschema = parent[OBJECT_SUBSCHEMA_SYMBOL];
+    if (mergedTypeInfo && sourceSubschema) {
+      const fieldNode = {
+        kind: Kind.FIELD,
+        name: info.fieldNodes[0]?.name ?? {
+          kind: Kind.NAME,
+          value: info.fieldName
+        },
+        selectionSet: {
+          kind: Kind.SELECTION_SET,
+          selections: info.fieldNodes
+        }
+      };
+      return handleMaybePromise(
+        () => mergeFields(mergedTypeInfo, parent, sourceSubschema, context, info, [
+          fieldNode
+        ]),
+        () => Object.prototype.hasOwnProperty.call(parent, responseKey) ? handleResult(parent, responseKey, context, info) : void 0
+      );
+    }
     return void 0;
   }
   return handleResult(parent, responseKey, context, info);
@@ -3486,4 +3508,4 @@ function subtractSelectionSets(selectionSetA, selectionSetB, fragments = {}) {
   };
 }
 
-export { EMPTY_ARRAY, EMPTY_OBJECT, FIELD_SUBSCHEMA_MAP_SYMBOL, OBJECT_SUBSCHEMA_SYMBOL, PLAN_LEFT_OVER, Subschema, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };
+export { EMPTY_OBJECT, FIELD_SUBSCHEMA_MAP_SYMBOL, OBJECT_SUBSCHEMA_SYMBOL, PLAN_LEFT_OVER, Subschema, Transformer, UNPATHED_ERRORS_SYMBOL, annotateExternalObject, applySchemaTransforms, cloneSubschemaConfig, createRequest, defaultMergedResolver, delegateRequest, delegateToSchema, extractUnavailableFields, extractUnavailableFieldsFromSelectionSet, getActualFieldNodes, getDelegatingOperation, getPlanLeftOverFromParent, getSubschema, getTypeInfo, getTypeInfoWithType, getUnpathedErrors, handleOverrideByDelegation, handleResolverResult, isExternalObject, isPrototypePollutingKey, isSubschema, isSubschemaConfig, leftOverByDelegationPlan, mergeFields, resolveExternalValue, subtractSelectionSets };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/delegate",
-  "version": "12.1.1",
+  "version": "12.1.2-alpha-a25a0e4521aff5261d06903efe4386cd565f2e57",
   "type": "module",
   "description": "A set of utils for faster development of GraphQL tools",
   "repository": {