@apollo/gateway 2.0.1 → 2.0.2-alpha.2

package/src/__tests__/gateway/opentelemetry.test.ts

@@ -1,7 +1,6 @@
 import gql from 'graphql-tag';
 import {ApolloGateway, LocalGraphQLDataSource} from '../../';
 import {fixtures, spanSerializer} from 'apollo-federation-integration-testsuite';
-import {fetch} from '../../__mocks__/apollo-server-env';
 import {InMemorySpanExporter, SimpleSpanProcessor} from '@opentelemetry/tracing'
 import {NodeTracerProvider} from '@opentelemetry/node';
 import { buildSubgraphSchema } from '@apollo/subgraph';
@@ -14,7 +13,6 @@ tracerProvider.addSpanProcessor(new SimpleSpanProcessor(inMemorySpans));
 tracerProvider.register();
 
 beforeEach(() => {
-  fetch.mockReset();
   inMemorySpans.reset();
 });
 
@@ -102,13 +100,11 @@ describe('opentelemetry', () => {
 
 
   it('receives spans on fetch failure', async () => {
-
-    fetch.mockImplementationOnce(async () => {
-      throw Error("Nooo");
-    });
-
     const gateway = new ApolloGateway({
       localServiceList: fixtures,
+      fetcher: () => {
+        throw Error('Nooo');
+      },
     });
 
     const { executor } = await gateway.load();

package/src/__tests__/gateway/reporting.test.ts

@@ -13,7 +13,7 @@ import { Plugin, Config, Refs } from 'pretty-format';
 import { Report, Trace } from 'apollo-reporting-protobuf';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
-import { GraphQLSchemaModule } from '../../schema-helper';
+import { GraphQLSchemaModule } from '@apollo/subgraph/src/schema-helper';
 import resolvable, { Resolvable } from '@josephg/resolvable';
 
 // Normalize specific fields that change often (eg timestamps) to static values,

package/src/__tests__/gateway/supergraphSdl.test.ts

@@ -4,15 +4,15 @@ import {
   SubgraphHealthCheckFunction,
   SupergraphSdlUpdateFunction,
 } from '@apollo/gateway';
-import { fixturesWithUpdate } from 'apollo-federation-integration-testsuite';
-import { createHash } from '../../utilities/createHash';
+import { accounts, fixturesWithUpdate } from 'apollo-federation-integration-testsuite';
+import { createHash } from '@apollo/utils.createhash';
 import { ApolloServer } from 'apollo-server';
 import type { Logger } from '@apollo/utils.logger';
-import { fetch } from '../../__mocks__/make-fetch-happen-fetcher';
 import { getTestingSupergraphSdl } from '../execution-utils';
 import { mockAllServicesHealthCheckSuccess } from '../integration/nockMocks';
 import resolvable from '@josephg/resolvable';
 import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
+import nock from 'nock';
 
 async function getSupergraphSdlGatewayServer() {
   const server = new ApolloServer({
@@ -21,7 +21,6 @@ async function getSupergraphSdlGatewayServer() {
       buildService({ url }) {
         return new RemoteGraphQLDataSource({
           url,
-          fetcher: fetch,
         });
       },
     }),
@@ -59,9 +58,10 @@ describe('Using supergraphSdl static configuration', () => {
   it('successfully starts and serves requests to the proper services', async () => {
     const server = await getSupergraphSdlGatewayServer();
 
-    fetch.mockJSONResponseOnce({
-      data: { me: { username: '@jbaxleyiii' } },
-    });
+    nock(accounts.url)
+      .post('/', { query: '{me{username}}', variables: {} })
+      .reply(200, { data: { me: { username: '@jbaxleyiii' } } });
+
 
     const result = await server.executeOperation({
       query: '{ me { username } }',
@@ -75,11 +75,6 @@ describe('Using supergraphSdl static configuration', () => {
       }
     `);
 
-    const [url, request] = fetch.mock.calls[0];
-    expect(url).toEqual('https://accounts.api.com.invalid');
-    expect(request?.body).toEqual(
-      JSON.stringify({ query: '{me{username}}', variables: {} }),
-    );
     await server.stop();
   });
 });

package/src/config.ts

@@ -1,6 +1,5 @@
 import { GraphQLError, GraphQLSchema } from 'graphql';
 import { HeadersInit } from 'node-fetch';
-import { fetch } from 'apollo-server-env';
 import { GraphQLRequestContextExecutionDidStart } from 'apollo-server-types';
 import type { Logger } from '@apollo/utils.logger';
 import { GraphQLDataSource } from './datasources/types';
@@ -8,6 +7,7 @@ import { QueryPlan } from '@apollo/query-planner';
 import { OperationContext } from './operationContext';
 import { ServiceMap } from './executeQueryPlan';
 import { ServiceDefinition } from "@apollo/federation-internals";
+import { Fetcher } from '@apollo/utils.fetcher';
 
 export type ServiceEndpointDefinition = Pick<ServiceDefinition, 'name' | 'url'>;
 
@@ -126,7 +126,7 @@ interface GatewayConfigBase {
   experimental_didUpdateSupergraph?: Experimental_DidUpdateSupergraphCallback;
   experimental_approximateQueryPlanStoreMiB?: number;
   experimental_autoFragmentization?: boolean;
-  fetcher?: typeof fetch;
+  fetcher?: Fetcher;
   serviceHealthCheck?: boolean;
 }
 

package/src/datasources/RemoteGraphQLDataSource.ts

@@ -12,17 +12,19 @@ import {
   AuthenticationError,
   ForbiddenError,
 } from 'apollo-server-errors';
-import { fetch, Request, Headers, Response } from 'apollo-server-env';
 import { isObject } from '../utilities/predicates';
 import { GraphQLDataSource, GraphQLDataSourceProcessOptions, GraphQLDataSourceRequestKind } from './types';
-import createSHA from 'apollo-server-core/dist/utils/createSHA';
+import { createHash } from '@apollo/utils.createhash';
 import { parseCacheControlHeader } from './parseCacheControlHeader';
 import fetcher from 'make-fetch-happen';
+import { Headers as NodeFetchHeaders, Request as NodeFetchRequest } from 'node-fetch';
+import { Fetcher, FetcherRequestInit, FetcherResponse } from '@apollo/utils.fetcher';
+
 export class RemoteGraphQLDataSource<
   TContext extends Record<string, any> = Record<string, any>,
 > implements GraphQLDataSource<TContext>
 {
-  fetcher: typeof fetch;
+  fetcher: Fetcher;
 
   constructor(
     config?: Partial<RemoteGraphQLDataSource<TContext>> &
@@ -30,6 +32,11 @@ export class RemoteGraphQLDataSource<
       ThisType<RemoteGraphQLDataSource<TContext>>,
   ) {
     this.fetcher = fetcher.defaults({
+      // Allow an arbitrary number of sockets per subgraph. This is the default
+      // behavior of Node's http.Agent as well as the npm package agentkeepalive
+      // which wraps it, but is not the default behavior of make-fetch-happen
+      // which wraps agentkeepalive (that package sets this to 15 by default).
+      maxSockets: Infinity,
       // although this is the default, we want to take extra care and be very
       // explicity to ensure that mutations cannot be retried. please leave this
       // intact.
@@ -82,7 +89,12 @@ export class RemoteGraphQLDataSource<
     const context = originalContext as TContext;
 
     // Respect incoming http headers (eg, apollo-federation-include-trace).
-    const headers = (request.http && request.http.headers) || new Headers();
+    const headers = new NodeFetchHeaders();
+    if (request.http?.headers) {
+      for (const [name, value] of request.http.headers) {
+        headers.append(name, value);
+      }
+    }
     headers.set('Content-Type', 'application/json');
 
     request.http = {
@@ -112,7 +124,7 @@ export class RemoteGraphQLDataSource<
         : null;
 
     if (this.apq) {
-      const apqHash = createSHA('sha256').update(request.query).digest('hex');
+      const apqHash = createHash('sha256').update(request.query).digest('hex');
 
       // Take the original extensions and extend them with
       // the necessary "extensions" for APQ handshaking.
@@ -177,20 +189,24 @@ export class RemoteGraphQLDataSource<
     // we're accessing (e.g. url) and what we access it with (e.g. headers).
     const { http, ...requestWithoutHttp } = request;
     const stringifiedRequestWithoutHttp = JSON.stringify(requestWithoutHttp);
-    const fetchRequest = new Request(http.url, {
-      ...http,
+    const requestInit: FetcherRequestInit = {
+      method: http.method,
+      headers: Object.fromEntries(http.headers),
       body: stringifiedRequestWithoutHttp,
-    });
+    };
+    // Note that we don't actually send this Request object to the fetcher; it
+    // is merely sent to methods on this object that might be overridden by users.
+    // We are careful to only send data to the overridable fetcher function that uses
+    // plain JS objects --- some fetch implementations don't know how to handle
+    // Request or Headers objects created by other fetch implementations.
+    const fetchRequest = new NodeFetchRequest(http.url, requestInit);
 
-    let fetchResponse: Response | undefined;
+    let fetchResponse: FetcherResponse | undefined;
 
     try {
       // Use our local `fetcher` to allow for fetch injection
       // Use the fetcher's `Request` implementation for compatibility
-      fetchResponse = await this.fetcher(http.url, {
-        ...http,
-        body: stringifiedRequestWithoutHttp,
-      });
+      fetchResponse = await this.fetcher(http.url, requestInit);
 
       if (!fetchResponse.ok) {
         throw await this.errorFromResponse(fetchResponse);
@@ -266,16 +282,16 @@ export class RemoteGraphQLDataSource<
 
   public didEncounterError(
     error: Error,
-    _fetchRequest: Request,
-    _fetchResponse?: Response,
+    _fetchRequest: NodeFetchRequest,
+    _fetchResponse?: FetcherResponse,
     _context?: TContext,
   ) {
     throw error;
   }
 
   public parseBody(
-    fetchResponse: Response,
-    _fetchRequest?: Request,
+    fetchResponse: FetcherResponse,
+    _fetchRequest?: NodeFetchRequest,
     _context?: TContext,
   ): Promise<object | string> {
     const contentType = fetchResponse.headers.get('Content-Type');
@@ -286,7 +302,7 @@ export class RemoteGraphQLDataSource<
     }
   }
 
-  public async errorFromResponse(response: Response) {
+  public async errorFromResponse(response: FetcherResponse) {
     const message = `${response.status}: ${response.statusText}`;
 
     let error: ApolloError;

package/src/datasources/__tests__/LocalGraphQLDataSource.test.ts

@@ -1,7 +1,7 @@
 import { LocalGraphQLDataSource } from '../LocalGraphQLDataSource';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import gql from 'graphql-tag';
-import { GraphQLResolverMap } from '../../schema-helper';
+import { GraphQLResolverMap } from '@apollo/subgraph/src/schema-helper';
 import { GraphQLRequestContext } from 'apollo-server-types';
 import { GraphQLDataSourceRequestKind } from '../types';