@graphql-tools/federation 4.4.6 → 4.4.7-alpha-aa1e252176385f2fde9332a8073891f0188c53b7

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @graphql-tools/federation
 
+## 4.4.7-alpha-aa1e252176385f2fde9332a8073891f0188c53b7
+### Patch Changes
+
+
+
+- [#2351](https://github.com/graphql-hive/gateway/pull/2351) [`6bd3f3b`](https://github.com/graphql-hive/gateway/commit/6bd3f3b6acefed8bac80f889b80bf80c22042abd) Thanks [@ardatan](https://github.com/ardatan)! - Fix `@provides` so the gateway only requests the provided fields the client actually selected, and stops delegating to the owner subgraph when `@provides` already covers the request.
+  
+  Previously, when a subgraph declared `@provides(fields: "...")` on a field, the gateway would still:
+  
+  1. Forward **every** field listed in `@provides` to that subgraph, even when the client never asked for them.
+  2. After receiving the response, plan additional delegations to the owner subgraph for `@provides`-covered fields whenever the providing subgraph declared them as `@external`, even though the data was already returned.
+  
+  For example with:
+  
+  ```graphql
+  # subgraph B (provider)
+  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` *and* fetch `name` again from subgraph A (the owner of `Entity`).
+  
+  After this fix:
+  
+  - Only the `@provides` fields the client actually selected are forwarded to the providing subgraph (request side).
+  - The delegation planner now recognises `@provides` declarations at every nested level (e.g. `@provides(fields: "nested { nestedNested { name description } }")`) and `@provides` declarations made via inline fragments on union/interface members (e.g. `@provides(fields: "... on Book { title }")`), so the gateway no longer round-trips to the owner subgraph for fields that the providing subgraph has already returned.
+  - Fragment spreads in the client query are correctly handled when selecting `@provides`-covered fields. Previously, using a fragment spread (e.g. `...MyFrag`) to select nested `@external` fields would cause a parse error or an unnecessary delegation to the owner subgraph because the fragment body was stripped to empty by the subgraph schema filter. The gateway now inlines the provided fields directly and removes the dangling spread before forwarding the request.
+  
+  Aliases, fragments, fragment spreads, `@include`/`@skip` directives wrapping a `@provides` field, and nested `@provides` selections are preserved.
+- Updated dependencies [[`6bd3f3b`](https://github.com/graphql-hive/gateway/commit/6bd3f3b6acefed8bac80f889b80bf80c22042abd)]:
+  - @graphql-tools/delegate@12.0.18-alpha-aa1e252176385f2fde9332a8073891f0188c53b7
+  - @graphql-tools/stitch@10.1.23-alpha-aa1e252176385f2fde9332a8073891f0188c53b7
+  - @graphql-tools/wrap@11.1.17-alpha-aa1e252176385f2fde9332a8073891f0188c53b7
+
 ## 4.4.6
 ### Patch Changes
 

package/dist/index.cjs

@@ -713,7 +713,28 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                   (argumentNode) => argumentNode.name.value === "provides"
                 );
                 if (providedExtraField?.value?.kind === graphql.Kind.STRING) {
-                  let handleSelection2 = function(fieldNodeTypeName2, selection) {
+                  let registerProvidedSelectionForField2 = function(parentTypeName, fieldName, selectionSet) {
+                    let fieldMap = typeNameFieldProvidedSelectionMap.get(parentTypeName);
+                    if (!fieldMap) {
+                      fieldMap = /* @__PURE__ */ new Map();
+                      typeNameFieldProvidedSelectionMap.set(
+                        parentTypeName,
+                        fieldMap
+                      );
+                    }
+                    const existing = fieldMap.get(fieldName);
+                    if (existing) {
+                      fieldMap.set(fieldName, {
+                        kind: graphql.Kind.SELECTION_SET,
+                        selections: [
+                          ...existing.selections,
+                          ...selectionSet.selections
+                        ]
+                      });
+                    } else {
+                      fieldMap.set(fieldName, selectionSet);
+                    }
+                  }, handleSelection2 = function(fieldNodeTypeName2, selection) {
                     switch (selection.kind) {
                       case graphql.Kind.FIELD:
                         {
@@ -742,6 +763,11 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                             }
                             providedFields.add(selection.name.value);
                             if (selection.selectionSet) {
+                              registerProvidedSelectionForField2(
+                                fieldNodeTypeName2,
+                                selection.name.value,
+                                selection.selectionSet
+                              );
                               const extraFieldNodeNamedType = getNamedTypeNode(
                                 extraFieldNodeInType.type
                               );
@@ -780,15 +806,8 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                       typeNameFieldProvidedSelectionMap
                     );
                   }
-                  let fieldProvidedSelectionMap = typeNameFieldProvidedSelectionMap.get(typeNode.name.value);
-                  if (!fieldProvidedSelectionMap) {
-                    fieldProvidedSelectionMap = /* @__PURE__ */ new Map();
-                    typeNameFieldProvidedSelectionMap.set(
-                      typeNode.name.value,
-                      fieldProvidedSelectionMap
-                    );
-                  }
-                  fieldProvidedSelectionMap.set(
+                  registerProvidedSelectionForField2(
+                    typeNode.name.value,
                     fieldNode.name.value,
                     providesSelectionSet
                   );

package/dist/index.js

@@ -711,7 +711,28 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                   (argumentNode) => argumentNode.name.value === "provides"
                 );
                 if (providedExtraField?.value?.kind === Kind.STRING) {
-                  let handleSelection2 = function(fieldNodeTypeName2, selection) {
+                  let registerProvidedSelectionForField2 = function(parentTypeName, fieldName, selectionSet) {
+                    let fieldMap = typeNameFieldProvidedSelectionMap.get(parentTypeName);
+                    if (!fieldMap) {
+                      fieldMap = /* @__PURE__ */ new Map();
+                      typeNameFieldProvidedSelectionMap.set(
+                        parentTypeName,
+                        fieldMap
+                      );
+                    }
+                    const existing = fieldMap.get(fieldName);
+                    if (existing) {
+                      fieldMap.set(fieldName, {
+                        kind: Kind.SELECTION_SET,
+                        selections: [
+                          ...existing.selections,
+                          ...selectionSet.selections
+                        ]
+                      });
+                    } else {
+                      fieldMap.set(fieldName, selectionSet);
+                    }
+                  }, handleSelection2 = function(fieldNodeTypeName2, selection) {
                     switch (selection.kind) {
                       case Kind.FIELD:
                         {
@@ -740,6 +761,11 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                             }
                             providedFields.add(selection.name.value);
                             if (selection.selectionSet) {
+                              registerProvidedSelectionForField2(
+                                fieldNodeTypeName2,
+                                selection.name.value,
+                                selection.selectionSet
+                              );
                               const extraFieldNodeNamedType = getNamedTypeNode(
                                 extraFieldNodeInType.type
                               );
@@ -778,15 +804,8 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                       typeNameFieldProvidedSelectionMap
                     );
                   }
-                  let fieldProvidedSelectionMap = typeNameFieldProvidedSelectionMap.get(typeNode.name.value);
-                  if (!fieldProvidedSelectionMap) {
-                    fieldProvidedSelectionMap = /* @__PURE__ */ new Map();
-                    typeNameFieldProvidedSelectionMap.set(
-                      typeNode.name.value,
-                      fieldProvidedSelectionMap
-                    );
-                  }
-                  fieldProvidedSelectionMap.set(
+                  registerProvidedSelectionForField2(
+                    typeNode.name.value,
                     fieldNode.name.value,
                     providesSelectionSet
                   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/federation",
-  "version": "4.4.6",
+  "version": "4.4.7-alpha-aa1e252176385f2fde9332a8073891f0188c53b7",
   "type": "module",
   "description": "Useful tools to create and manipulate GraphQL schemas.",
   "repository": {
@@ -38,14 +38,14 @@
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
   },
   "dependencies": {
-    "@graphql-tools/delegate": "^12.0.17",
+    "@graphql-tools/delegate": "12.0.18-alpha-aa1e252176385f2fde9332a8073891f0188c53b7",
     "@graphql-tools/executor": "^1.4.13",
     "@graphql-tools/executor-http": "^3.3.0",
     "@graphql-tools/merge": "^9.1.5",
     "@graphql-tools/schema": "^10.0.29",
-    "@graphql-tools/stitch": "^10.1.22",
+    "@graphql-tools/stitch": "10.1.23-alpha-aa1e252176385f2fde9332a8073891f0188c53b7",
     "@graphql-tools/utils": "^11.0.0",
-    "@graphql-tools/wrap": "^11.1.16",
+    "@graphql-tools/wrap": "11.1.17-alpha-aa1e252176385f2fde9332a8073891f0188c53b7",
     "@graphql-yoga/typed-event-target": "^3.0.2",
     "@whatwg-node/disposablestack": "^0.0.6",
     "@whatwg-node/events": "^0.1.2",