@graphql-tools/delegate 12.0.16 → 12.0.17-alpha-96a4674a514e93d69c299c07916e06f49feed477

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @graphql-tools/delegate
 
+## 12.0.17-alpha-96a4674a514e93d69c299c07916e06f49feed477
+### Patch Changes
+
+
+
+- [#2351](https://github.com/graphql-hive/gateway/pull/2351) [`96a4674`](https://github.com/graphql-hive/gateway/commit/96a4674a514e93d69c299c07916e06f49feed477) Thanks [@ardatan](https://github.com/ardatan)! - Fix `@provides` so the gateway only requests the provided fields the client actually selected.
+  
+  Previously, when a subgraph declared `@provides(fields: "...")` on a query field, the gateway would forward **every** field listed in the `@provides` argument to that subgraph, even when the client never asked for those fields. For example with:
+  
+  ```graphql
+  # subgraph B
+  type Query {
+    entity: Entity @provides(fields: "name description")
+  }
+  
+  type Entity @key(fields: "id") {
+    id: ID!
+    name: String! @external
+    description: String! @external
+  }
+  ```
+  
+  a client query of `{ entity { id name } }` would still cause the gateway to ask subgraph B for `description`. After this fix the gateway only forwards `name` (because that is what the client asked for and what `@provides` allows the subgraph to resolve directly), bringing the behavior in line with Federation's `@provides` semantics where it acts as a hint that the providing subgraph **can** resolve those fields locally — not a directive to always fetch them.
+  
+  Aliases, fragments, fragment spreads, and nested `@provides` selections are preserved.
+
 ## 12.0.16
 ### Patch Changes
 

package/dist/index.cjs

@@ -590,7 +590,7 @@ const handleOverrideByDelegation = utils.memoize3(
   }
 );
 
-function finalizeGatewayDocument(targetSchema, fragments, operations, onOverlappingAliases, delegationContext) {
+function finalizeGatewayDocument(targetSchema, originalDocument, fragments, operations, onOverlappingAliases, delegationContext) {
   let usedVariables = [];
   let usedFragments = [];
   const newOperations = [];
@@ -688,37 +688,82 @@ function finalizeGatewayDocument(targetSchema, fragments, operations, onOverlapp
   };
   const stitchingInfo = delegationContext.info?.schema?.extensions?.["stitchingInfo"];
   if (stitchingInfo != null) {
+    const {
+      selectionSetsByPath: originalFieldSelectionSetsByPath,
+      fragments: originalFragmentsByName
+    } = collectFieldSelectionSetsByPath(originalDocument);
     const typeInfo = getTypeInfo(targetSchema);
+    const pathStack = [];
     newDocument = graphql.visit(
       newDocument,
       graphql.visitWithTypeInfo(typeInfo, {
-        [graphql.Kind.FIELD](fieldNode) {
-          const parentType = typeInfo.getParentType();
-          if (parentType) {
-            const parentTypeName = parentType.name;
-            const typeConfig = stitchingInfo?.mergedTypes?.[parentTypeName];
-            if (typeConfig) {
+        [graphql.Kind.OPERATION_DEFINITION]: {
+          enter(node) {
+            pathStack.push(`op:${node.operation}:${node.name?.value ?? ""}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [graphql.Kind.FRAGMENT_DEFINITION]: {
+          enter(node) {
+            pathStack.push(`frag:${node.name.value}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [graphql.Kind.INLINE_FRAGMENT]: {
+          enter(node) {
+            pathStack.push(`inline:${node.typeCondition?.name.value ?? ""}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [graphql.Kind.FIELD]: {
+          enter(fieldNode) {
+            pathStack.push(fieldNode.alias?.value ?? fieldNode.name.value);
+          },
+          leave(fieldNode) {
+            try {
+              const parentType = typeInfo.getParentType();
+              if (!parentType) {
+                return void 0;
+              }
+              const typeConfig = stitchingInfo?.mergedTypes?.[parentType.name];
               const providedSelectionsByField = typeConfig?.providedSelectionsByField?.get(
                 delegationContext.subschema
               );
-              if (providedSelectionsByField) {
-                const providedSelection = providedSelectionsByField[fieldNode.name.value];
-                if (providedSelection) {
-                  return {
-                    ...fieldNode,
-                    selectionSet: {
-                      kind: graphql.Kind.SELECTION_SET,
-                      selections: [
-                        ...providedSelection.selections,
-                        ...fieldNode.selectionSet?.selections ?? []
-                      ]
-                    }
-                  };
-                }
+              const providedSelection = providedSelectionsByField?.[fieldNode.name.value];
+              if (!providedSelection) {
+                return void 0;
+              }
+              const originalSelectionSet = originalFieldSelectionSetsByPath.get(
+                pathStack.join(">")
+              );
+              const requestedProvidedSelections = intersectProvidedSelections(
+                providedSelection.selections,
+                originalSelectionSet,
+                originalFragmentsByName
+              );
+              if (!requestedProvidedSelections.length) {
+                return void 0;
               }
+              return {
+                ...fieldNode,
+                selectionSet: {
+                  kind: graphql.Kind.SELECTION_SET,
+                  selections: [
+                    ...requestedProvidedSelections,
+                    ...fieldNode.selectionSet?.selections ?? []
+                  ]
+                }
+              };
+            } finally {
+              pathStack.pop();
             }
           }
-          return fieldNode;
         }
       })
     );
@@ -733,6 +778,7 @@ function finalizeGatewayRequest(originalRequest, delegationContext, onOverlappin
   const { targetSchema } = delegationContext;
   const { usedVariables, newDocument } = finalizeGatewayDocument(
     targetSchema,
+    originalRequest.document,
     fragments,
     operations,
     onOverlappingAliases,
@@ -761,6 +807,141 @@ function finalizeGatewayRequest(originalRequest, delegationContext, onOverlappin
 function isTypeNameField(selection) {
   return selection.kind === graphql.Kind.FIELD && !selection.alias && selection.name.value === "__typename";
 }
+function collectFieldSelectionSetsByPath(document) {
+  const selectionSetsByPath = /* @__PURE__ */ new Map();
+  const fragments = /* @__PURE__ */ new Map();
+  for (const def of document.definitions) {
+    if (def.kind === graphql.Kind.FRAGMENT_DEFINITION) {
+      fragments.set(def.name.value, def);
+    }
+  }
+  const pathStack = [];
+  graphql.visit(document, {
+    [graphql.Kind.OPERATION_DEFINITION]: {
+      enter(node) {
+        pathStack.push(`op:${node.operation}:${node.name?.value ?? ""}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [graphql.Kind.FRAGMENT_DEFINITION]: {
+      enter(node) {
+        pathStack.push(`frag:${node.name.value}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [graphql.Kind.INLINE_FRAGMENT]: {
+      enter(node) {
+        pathStack.push(`inline:${node.typeCondition?.name.value ?? ""}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [graphql.Kind.FIELD]: {
+      enter(node) {
+        pathStack.push(node.alias?.value ?? node.name.value);
+        if (node.selectionSet) {
+          selectionSetsByPath.set(pathStack.join(">"), node.selectionSet);
+        }
+      },
+      leave() {
+        pathStack.pop();
+      }
+    }
+  });
+  return { selectionSetsByPath, fragments };
+}
+function intersectProvidedSelections(providedSelections, originalSelectionSet, fragments) {
+  if (!originalSelectionSet) {
+    return [];
+  }
+  const providedFieldsByName = /* @__PURE__ */ new Map();
+  const otherProvided = [];
+  for (const provided of providedSelections) {
+    if (provided.kind === graphql.Kind.FIELD) {
+      providedFieldsByName.set(provided.name.value, provided);
+    } else {
+      otherProvided.push(provided);
+    }
+  }
+  const result = [];
+  const seenFieldNames = /* @__PURE__ */ new Set();
+  const seenFragmentNames = /* @__PURE__ */ new Set();
+  collectMatchingOriginalSelections(
+    originalSelectionSet,
+    providedFieldsByName,
+    fragments,
+    seenFieldNames,
+    seenFragmentNames,
+    result
+  );
+  return [...result, ...otherProvided];
+}
+function collectMatchingOriginalSelections(selectionSet, providedFieldsByName, fragments, seenFieldNames, seenFragmentNames, result) {
+  for (const sel of selectionSet.selections) {
+    if (sel.kind === graphql.Kind.FIELD) {
+      const provided = providedFieldsByName.get(sel.name.value);
+      if (!provided) {
+        continue;
+      }
+      const dedupKey = sel.alias?.value ?? sel.name.value;
+      if (seenFieldNames.has(dedupKey)) {
+        continue;
+      }
+      seenFieldNames.add(dedupKey);
+      if (provided.selectionSet && sel.selectionSet) {
+        const nested = intersectProvidedSelections(
+          provided.selectionSet.selections,
+          sel.selectionSet,
+          fragments
+        );
+        if (!nested.length) {
+          continue;
+        }
+        result.push({
+          ...sel,
+          selectionSet: {
+            kind: graphql.Kind.SELECTION_SET,
+            selections: nested
+          }
+        });
+      } else {
+        result.push(sel);
+      }
+    } else if (sel.kind === graphql.Kind.INLINE_FRAGMENT && sel.selectionSet) {
+      collectMatchingOriginalSelections(
+        sel.selectionSet,
+        providedFieldsByName,
+        fragments,
+        seenFieldNames,
+        seenFragmentNames,
+        result
+      );
+    } else if (sel.kind === graphql.Kind.FRAGMENT_SPREAD) {
+      const fragmentName = sel.name.value;
+      if (seenFragmentNames.has(fragmentName)) {
+        continue;
+      }
+      seenFragmentNames.add(fragmentName);
+      const fragmentDef = fragments.get(fragmentName);
+      if (!fragmentDef) {
+        continue;
+      }
+      collectMatchingOriginalSelections(
+        fragmentDef.selectionSet,
+        providedFieldsByName,
+        fragments,
+        seenFieldNames,
+        seenFragmentNames,
+        result
+      );
+    }
+  }
+}
 function filterTypenameFields(selections) {
   let hasTypeNameField = false;
   const filteredSelections = selections.filter((selection) => {

package/dist/index.js

@@ -590,7 +590,7 @@ const handleOverrideByDelegation = memoize3(
   }
 );
 
-function finalizeGatewayDocument(targetSchema, fragments, operations, onOverlappingAliases, delegationContext) {
+function finalizeGatewayDocument(targetSchema, originalDocument, fragments, operations, onOverlappingAliases, delegationContext) {
   let usedVariables = [];
   let usedFragments = [];
   const newOperations = [];
@@ -688,37 +688,82 @@ function finalizeGatewayDocument(targetSchema, fragments, operations, onOverlapp
   };
   const stitchingInfo = delegationContext.info?.schema?.extensions?.["stitchingInfo"];
   if (stitchingInfo != null) {
+    const {
+      selectionSetsByPath: originalFieldSelectionSetsByPath,
+      fragments: originalFragmentsByName
+    } = collectFieldSelectionSetsByPath(originalDocument);
     const typeInfo = getTypeInfo(targetSchema);
+    const pathStack = [];
     newDocument = visit(
       newDocument,
       visitWithTypeInfo(typeInfo, {
-        [Kind.FIELD](fieldNode) {
-          const parentType = typeInfo.getParentType();
-          if (parentType) {
-            const parentTypeName = parentType.name;
-            const typeConfig = stitchingInfo?.mergedTypes?.[parentTypeName];
-            if (typeConfig) {
+        [Kind.OPERATION_DEFINITION]: {
+          enter(node) {
+            pathStack.push(`op:${node.operation}:${node.name?.value ?? ""}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [Kind.FRAGMENT_DEFINITION]: {
+          enter(node) {
+            pathStack.push(`frag:${node.name.value}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [Kind.INLINE_FRAGMENT]: {
+          enter(node) {
+            pathStack.push(`inline:${node.typeCondition?.name.value ?? ""}`);
+          },
+          leave() {
+            pathStack.pop();
+          }
+        },
+        [Kind.FIELD]: {
+          enter(fieldNode) {
+            pathStack.push(fieldNode.alias?.value ?? fieldNode.name.value);
+          },
+          leave(fieldNode) {
+            try {
+              const parentType = typeInfo.getParentType();
+              if (!parentType) {
+                return void 0;
+              }
+              const typeConfig = stitchingInfo?.mergedTypes?.[parentType.name];
               const providedSelectionsByField = typeConfig?.providedSelectionsByField?.get(
                 delegationContext.subschema
               );
-              if (providedSelectionsByField) {
-                const providedSelection = providedSelectionsByField[fieldNode.name.value];
-                if (providedSelection) {
-                  return {
-                    ...fieldNode,
-                    selectionSet: {
-                      kind: Kind.SELECTION_SET,
-                      selections: [
-                        ...providedSelection.selections,
-                        ...fieldNode.selectionSet?.selections ?? []
-                      ]
-                    }
-                  };
-                }
+              const providedSelection = providedSelectionsByField?.[fieldNode.name.value];
+              if (!providedSelection) {
+                return void 0;
+              }
+              const originalSelectionSet = originalFieldSelectionSetsByPath.get(
+                pathStack.join(">")
+              );
+              const requestedProvidedSelections = intersectProvidedSelections(
+                providedSelection.selections,
+                originalSelectionSet,
+                originalFragmentsByName
+              );
+              if (!requestedProvidedSelections.length) {
+                return void 0;
               }
+              return {
+                ...fieldNode,
+                selectionSet: {
+                  kind: Kind.SELECTION_SET,
+                  selections: [
+                    ...requestedProvidedSelections,
+                    ...fieldNode.selectionSet?.selections ?? []
+                  ]
+                }
+              };
+            } finally {
+              pathStack.pop();
             }
           }
-          return fieldNode;
         }
       })
     );
@@ -733,6 +778,7 @@ function finalizeGatewayRequest(originalRequest, delegationContext, onOverlappin
   const { targetSchema } = delegationContext;
   const { usedVariables, newDocument } = finalizeGatewayDocument(
     targetSchema,
+    originalRequest.document,
     fragments,
     operations,
     onOverlappingAliases,
@@ -761,6 +807,141 @@ function finalizeGatewayRequest(originalRequest, delegationContext, onOverlappin
 function isTypeNameField(selection) {
   return selection.kind === Kind.FIELD && !selection.alias && selection.name.value === "__typename";
 }
+function collectFieldSelectionSetsByPath(document) {
+  const selectionSetsByPath = /* @__PURE__ */ new Map();
+  const fragments = /* @__PURE__ */ new Map();
+  for (const def of document.definitions) {
+    if (def.kind === Kind.FRAGMENT_DEFINITION) {
+      fragments.set(def.name.value, def);
+    }
+  }
+  const pathStack = [];
+  visit(document, {
+    [Kind.OPERATION_DEFINITION]: {
+      enter(node) {
+        pathStack.push(`op:${node.operation}:${node.name?.value ?? ""}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [Kind.FRAGMENT_DEFINITION]: {
+      enter(node) {
+        pathStack.push(`frag:${node.name.value}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [Kind.INLINE_FRAGMENT]: {
+      enter(node) {
+        pathStack.push(`inline:${node.typeCondition?.name.value ?? ""}`);
+      },
+      leave() {
+        pathStack.pop();
+      }
+    },
+    [Kind.FIELD]: {
+      enter(node) {
+        pathStack.push(node.alias?.value ?? node.name.value);
+        if (node.selectionSet) {
+          selectionSetsByPath.set(pathStack.join(">"), node.selectionSet);
+        }
+      },
+      leave() {
+        pathStack.pop();
+      }
+    }
+  });
+  return { selectionSetsByPath, fragments };
+}
+function intersectProvidedSelections(providedSelections, originalSelectionSet, fragments) {
+  if (!originalSelectionSet) {
+    return [];
+  }
+  const providedFieldsByName = /* @__PURE__ */ new Map();
+  const otherProvided = [];
+  for (const provided of providedSelections) {
+    if (provided.kind === Kind.FIELD) {
+      providedFieldsByName.set(provided.name.value, provided);
+    } else {
+      otherProvided.push(provided);
+    }
+  }
+  const result = [];
+  const seenFieldNames = /* @__PURE__ */ new Set();
+  const seenFragmentNames = /* @__PURE__ */ new Set();
+  collectMatchingOriginalSelections(
+    originalSelectionSet,
+    providedFieldsByName,
+    fragments,
+    seenFieldNames,
+    seenFragmentNames,
+    result
+  );
+  return [...result, ...otherProvided];
+}
+function collectMatchingOriginalSelections(selectionSet, providedFieldsByName, fragments, seenFieldNames, seenFragmentNames, result) {
+  for (const sel of selectionSet.selections) {
+    if (sel.kind === Kind.FIELD) {
+      const provided = providedFieldsByName.get(sel.name.value);
+      if (!provided) {
+        continue;
+      }
+      const dedupKey = sel.alias?.value ?? sel.name.value;
+      if (seenFieldNames.has(dedupKey)) {
+        continue;
+      }
+      seenFieldNames.add(dedupKey);
+      if (provided.selectionSet && sel.selectionSet) {
+        const nested = intersectProvidedSelections(
+          provided.selectionSet.selections,
+          sel.selectionSet,
+          fragments
+        );
+        if (!nested.length) {
+          continue;
+        }
+        result.push({
+          ...sel,
+          selectionSet: {
+            kind: Kind.SELECTION_SET,
+            selections: nested
+          }
+        });
+      } else {
+        result.push(sel);
+      }
+    } else if (sel.kind === Kind.INLINE_FRAGMENT && sel.selectionSet) {
+      collectMatchingOriginalSelections(
+        sel.selectionSet,
+        providedFieldsByName,
+        fragments,
+        seenFieldNames,
+        seenFragmentNames,
+        result
+      );
+    } else if (sel.kind === Kind.FRAGMENT_SPREAD) {
+      const fragmentName = sel.name.value;
+      if (seenFragmentNames.has(fragmentName)) {
+        continue;
+      }
+      seenFragmentNames.add(fragmentName);
+      const fragmentDef = fragments.get(fragmentName);
+      if (!fragmentDef) {
+        continue;
+      }
+      collectMatchingOriginalSelections(
+        fragmentDef.selectionSet,
+        providedFieldsByName,
+        fragments,
+        seenFieldNames,
+        seenFragmentNames,
+        result
+      );
+    }
+  }
+}
 function filterTypenameFields(selections) {
   let hasTypeNameField = false;
   const filteredSelections = selections.filter((selection) => {

package/package.json

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