feat: Expose document representation of sub-query request within GraphQLDataSourceProcessOptions so that it is available to RemoteGraphQLDataSource.process and RemoteGraphQLDataSource.willSendRequest

gateway-js/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 This CHANGELOG pertains only to Apollo Federation packages in the 2.x range. The Federation v0.x equivalent for this package can be found [here](https://github.com/apollographql/federation/blob/version-0.x/gateway-js/CHANGELOG.md) on the `version-0.x` branch of this repo.
 
+- Expose document representation of sub-query request within GraphQLDataSourceProcessOptions so that it is available to RemoteGraphQLDataSource.process and RemoteGraphQLDataSource.willSendRequest [PR#1878](https://github.com/apollographql/federation/pull/1878)
 - Fix issue when using a type condition on an inaccessible type in `@require` [#1873](https://github.com/apollographql/federation/pull/1873).
   - __BREAKING__: this fix required passing a new argument to the `executeQueryPlan` method, which is technically
     exported by the gateway. Most users of the gateway should _not_ call this method directly (which is exported mainly

gateway-js/src/__tests__/execution-utils.ts

@@ -92,7 +92,7 @@ export function getFederatedTestingSchema(services: ServiceDefinitionModule[] =
     throw new GraphQLSchemaValidationError(compositionResult.errors);
   }
 
-  const queryPlanner = new QueryPlanner(compositionResult.schema);
+  const queryPlanner = new QueryPlanner(compositionResult.schema, { exposeDocumentNodeInFetchNode: false} );
   const schema = buildSchema(compositionResult.supergraphSdl);
 
   const serviceMap = Object.fromEntries(

gateway-js/src/datasources/types.ts

@@ -39,6 +39,10 @@ export type GraphQLDataSourceProcessOptions<
        * checking `kind`).
        */
       context: GraphQLRequestContext<TContext>['context'];
+      /**
+       * The document representation of the request's query being sent to the subgraph, if available.
+       */
+      document?: GraphQLRequestContext<TContext>['document'];
     }
   | {
       kind:

gateway-js/src/executeQueryPlan.ts

@@ -15,6 +15,7 @@ import {
   isObjectType,
   isInterfaceType,
   GraphQLErrorOptions,
+  DocumentNode,
 } from 'graphql';
 import { Trace, google } from 'apollo-reporting-protobuf';
 import { GraphQLDataSource, GraphQLDataSourceRequestKind } from './datasources/types';
@@ -298,7 +299,8 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             variables,
-            fetch.operationName
+            fetch.operationName,
+            fetch.operationDocumentNode
         );
 
         for (const entity of entities) {
@@ -337,7 +339,8 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             {...variables, representations},
-            fetch.operationName
+            fetch.operationName,
+            fetch.operationDocumentNode
         );
 
         if (!dataReceivedFromService) {
@@ -379,7 +382,8 @@ async function executeFetch<TContext>(
     context: ExecutionContext<TContext>,
     source: string,
     variables: Record<string, any>,
-    operationName: string | undefined
+    operationName: string | undefined,
+    operationDocumentNode?: DocumentNode
   ): Promise<ResultMap | void | null> {
     // We declare this as 'any' because it is missing url and method, which
     // GraphQLRequest.http is supposed to have if it exists.
@@ -417,6 +421,7 @@ async function executeFetch<TContext>(
       },
       incomingRequestContext: context.requestContext,
       context: context.requestContext.context,
+      document: operationDocumentNode
     });
 
     if (response.errors) {

query-planner-js/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 This CHANGELOG pertains only to Apollo Federation packages in the 2.x range. The Federation v0.x equivalent for this package can be found [here](https://github.com/apollographql/federation/blob/version-0.x/query-planner-js/CHANGELOG.md) on the `version-0.x` branch of this repo.
 
+- Expose document representation of sub-query request within GraphQLDataSourceProcessOptions so that it is available to RemoteGraphQLDataSource.process and RemoteGraphQLDataSource.willSendRequest [PR#1878](https://github.com/apollographql/federation/pull/1878)
+
 ## 2.1.0-alpha.0
 
 - Expand support for Node.js v18 [PR #1884](https://github.com/apollographql/federation/pull/1884)

query-planner-js/src/QueryPlan.ts

@@ -2,6 +2,7 @@ import {
   Kind,
   SelectionNode as GraphQLJSSelectionNode,
   OperationTypeNode,
+  DocumentNode,
 } from 'graphql';
 import prettyFormat from 'pretty-format';
 import { queryPlanSerializer, astSerializer } from './snapshotSerializers';
@@ -33,6 +34,7 @@ export interface FetchNode {
   operation: string;
   operationName: string | undefined;
   operationKind: OperationTypeNode;
+  operationDocumentNode?: DocumentNode;
 }
 
 export interface FlattenNode {

query-planner-js/src/__tests__/allFeatures.test.ts

@@ -40,7 +40,8 @@ for (const directory of directories) {
       beforeAll(() => {
         const supergraphSdl = fs.readFileSync(schemaPath, 'utf8');
         schema = buildSchema(supergraphSdl);
-        queryPlanner = new QueryPlanner(schema);
+        const exposeDocumentNodeInFetchNode = feature.title.endsWith("(with ExposeDocumentNodeInFetchNode)");
+        queryPlanner = new QueryPlanner(schema, { exposeDocumentNodeInFetchNode: exposeDocumentNodeInFetchNode});
       });
 
       feature.scenarios.forEach((scenario) => {
@@ -65,7 +66,6 @@ for (const directory of directories) {
               queryPlan = queryPlanner.buildQueryPlan(operation);
 
               const expectedQueryPlan = JSON.parse(expectedQueryPlanString);
-
               expect(queryPlan).toMatchQueryPlan(expectedQueryPlan);
             });
           };