@apollo/gateway 0.51.0 → 0.52.0

package/dist/supergraphManagers/IntrospectAndCompose/loadServicesFromRemoteEndpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadServicesFromRemoteEndpoint.js","sourceRoot":"","sources":["../../../src/supergraphManagers/IntrospectAndCompose/loadServicesFromRemoteEndpoint.ts"],"names":[],"mappings":";;;AACA,qCAAgC;AAChC,2CAAkD;AAClD,mDAA0F;AAC1F,6BAAiD;AAQ1C,KAAK,UAAU,8BAA8B,CAAC,EACnD,WAAW,EACX,8BAA8B,EAC9B,eAAe,GAOhB;IACC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;QACvC,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;KACH;IAED,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,MAAM,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE;QAC/E,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,KAAK,CACb,6BAA6B,IAAI,+BAA+B,CAAC,CAAC;SACrE;QAED,MAAM,OAAO,GAAmB;YAC9B,KAAK,EAAE,4BAAwB;YAC/B,IAAI,EAAE;gBACJ,GAAG;gBACH,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,oBAAO,CAAC,MAAM,8BAA8B,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;aAC1E;SACF,CAAC;QAEF,OAAO,UAAU;aACd,OAAO,CAAC;YACP,IAAI,EAAE,oCAA4B,CAAC,cAAc;YACjD,OAAO;YACP,OAAO,EAAE,EAAE;SACZ,CAAC;aACD,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAqB,EAAE;YAC5C,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;gBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAa,CAAC;gBAC7C,MAAM,kBAAkB,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAGrD,IAAI,kBAAkB,KAAK,QAAQ,EAAE;oBACnC,WAAW,GAAG,IAAI,CAAC;iBACpB;gBACD,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACpC,OAAO;oBACL,IAAI;oBACJ,GAAG;oBACH,QAAQ,EAAE,IAAA,eAAK,EAAC,QAAQ,CAAC;iBAC1B,CAAC;aACH;YAED,MAAM,IAAI,KAAK,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,YAAY,GAChB,0CAA0C,IAAI,QAAQ,GAAG,EAAE;gBAC3D,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAExD,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACnE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,CAAA;AAC5C,CAAC;AAtED,wEAsEC"}
+{"version":3,"file":"loadServicesFromRemoteEndpoint.js","sourceRoot":"","sources":["../../../src/supergraphManagers/IntrospectAndCompose/loadServicesFromRemoteEndpoint.ts"],"names":[],"mappings":";;;AAAA,qCAAgC;AAChC,2CAAkD;AAClD,mDAA0F;AAC1F,6BAAiD;AAS1C,KAAK,UAAU,8BAA8B,CAAC,EACnD,WAAW,EACX,8BAA8B,EAC9B,eAAe,GAOhB;IACC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;QACvC,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;KACH;IAED,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,MAAM,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE;QAC/E,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,KAAK,CACb,6BAA6B,IAAI,+BAA+B,CAAC,CAAC;SACrE;QAED,MAAM,OAAO,GAA0B;YACrC,KAAK,EAAE,4BAAwB;YAC/B,IAAI,EAAE;gBACJ,GAAG;gBACH,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,oBAAO,CAAC,MAAM,8BAA8B,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;aAC1E;SACF,CAAC;QAEF,OAAO,UAAU;aACd,OAAO,CAAC;YACP,IAAI,EAAE,oCAA4B,CAAC,cAAc;YACjD,OAAO;YACP,OAAO,EAAE,EAAE;SACZ,CAAC;aACD,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAqB,EAAE;YAC5C,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;gBACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAa,CAAC;gBAC7C,MAAM,kBAAkB,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAGrD,IAAI,kBAAkB,KAAK,QAAQ,EAAE;oBACnC,WAAW,GAAG,IAAI,CAAC;iBACpB;gBACD,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACpC,OAAO;oBACL,IAAI;oBACJ,GAAG;oBACH,QAAQ,EAAE,IAAA,eAAK,EAAC,QAAQ,CAAC;iBAC1B,CAAC;aACH;YAED,MAAM,IAAI,KAAK,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,YAAY,GAChB,0CAA0C,IAAI,QAAQ,GAAG,EAAE;gBAC3D,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAExD,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACnE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,CAAA;AAC5C,CAAC;AAtED,wEAsEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/gateway",
-  "version": "0.51.0",
+  "version": "0.52.0",
   "description": "Apollo Gateway",
   "author": "Apollo <packages@apollographql.com>",
   "main": "dist/index.js",
@@ -26,26 +26,24 @@
   },
   "dependencies": {
     "@apollo/core-schema": "^0.2.0",
-    "@apollo/federation": "^0.36.2",
-    "@apollo/query-planner": "^0.10.2",
+    "@apollo/federation": "^0.37.0",
+    "@apollo/query-planner": "^0.11.0",
+    "@apollo/server-gateway-interface": "^1.0.1",
     "@apollo/utils.createhash": "^1.0.0",
     "@apollo/utils.fetcher": "^1.0.0",
     "@apollo/utils.logger": "^1.0.0",
     "@josephg/resolvable": "^1.0.1",
     "@opentelemetry/api": "^1.0.1",
-    "@types/node-fetch": "2.6.1",
+    "@types/node-fetch": "2.6.2",
     "apollo-reporting-protobuf": "^0.8.0 || ^3.0.0",
-    "apollo-server-caching": "^0.7.0 || ^3.0.0",
-    "apollo-server-core": "^2.23.0 || ^3.0.0",
-    "apollo-server-errors": "^2.5.0 || ^3.0.0",
-    "apollo-server-types": "^0.9.0 || ^3.0.0",
     "async-retry": "^1.3.3",
     "loglevel": "^1.6.1",
+    "lru-cache": "^7.13.1",
     "make-fetch-happen": "^10.1.2",
-    "pretty-format": "^27.4.6"
+    "pretty-format": "^28.0.0"
   },
   "peerDependencies": {
     "graphql": "^15.8.0 || ^16.0.0"
   },
-  "gitHead": "bf11c7dbd65049d1cb0d91b148f181b89e51e157"
+  "gitHead": "302ecaeea4e20a4d594b92b94499d9e156f4cea6"
 }

package/src/__generated__/graphqlTypes.ts

@@ -10,7 +10,7 @@ export type Scalars = {
   Boolean: boolean;
   Int: number;
   Float: number;
-  /** ISO 8601, extended format with nanoseconds, Zulu (or '[+-]seconds' for times relative to now) */
+  /** ISO 8601, extended format with nanoseconds, Zulu (or "[+-]seconds" as a string or number relative to now) */
   Timestamp: any;
 };
 

package/src/__tests__/executeQueryPlan.test.ts

@@ -1,13 +1,12 @@
 import {
   buildClientSchema,
   getIntrospectionQuery,
+  GraphQLError,
   GraphQLObjectType,
   GraphQLSchema,
   print,
 } from 'graphql';
 import gql from 'graphql-tag';
-import { GraphQLRequestContext, VariableValues } from 'apollo-server-types';
-import { AuthenticationError } from 'apollo-server-core';
 import { buildOperationContext } from '../operationContext';
 import { executeQueryPlan } from '../executeQueryPlan';
 import { LocalGraphQLDataSource } from '../datasources/LocalGraphQLDataSource';
@@ -21,6 +20,7 @@ import { ApolloGateway } from '..';
 import { ApolloServerBase as ApolloServer } from 'apollo-server-core';
 import { getFederatedTestingSchema } from './execution-utils';
 import { addResolversToSchema, GraphQLResolverMap } from '@apollo/subgraph/src/schema-helper';
+import {GatewayGraphQLRequestContext} from '@apollo/server-gateway-interface';
 
 expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
@@ -53,8 +53,8 @@ describe('executeQueryPlan', () => {
   });
 
   function buildRequestContext(
-    variables: VariableValues = {},
-  ): GraphQLRequestContext {
+    variables: Record<string, any> = {},
+  ): GatewayGraphQLRequestContext {
     // @ts-ignore
     return {
       cache: undefined as any,
@@ -101,7 +101,16 @@ describe('executeQueryPlan', () => {
       overrideResolversInService('accounts', {
         RootQuery: {
           me() {
-            throw new AuthenticationError('Something went wrong');
+            // Must use old constructor for graphql@15 compat on v0.x branch.
+            throw new GraphQLError(
+              'Something went wrong',
+              undefined,
+              undefined,
+              undefined,
+              undefined,
+              undefined,
+              { code: 'UNAUTHENTICATED' },
+            );
           },
         },
       });

package/src/__tests__/execution-utils.ts

@@ -2,7 +2,6 @@ import {
   GraphQLSchemaModule,
   GraphQLResolverMap,
 } from '@apollo/subgraph/src/schema-helper';
-import { GraphQLRequest, GraphQLExecutionResult } from 'apollo-server-types';
 import type { Logger } from '@apollo/utils.logger';
 import {
   composeAndValidate,
@@ -22,6 +21,7 @@ import { queryPlanSerializer, astSerializer } from 'apollo-federation-integratio
 import gql from 'graphql-tag';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { parse } from 'graphql';
+import { GatewayExecutionResult, GatewayGraphQLRequest } from '@apollo/server-gateway-interface';
 
 const prettyFormat = require('pretty-format');
 
@@ -39,10 +39,10 @@ export function overrideResolversInService(
 }
 
 export async function execute(
-  request: GraphQLRequest,
+  request: GatewayGraphQLRequest,
   services: ServiceDefinitionModule[] = fixtures,
   logger: Logger = console,
-): Promise<GraphQLExecutionResult & { queryPlan: QueryPlan }> {
+): Promise<GatewayExecutionResult & { queryPlan: QueryPlan }> {
   const serviceMap = Object.fromEntries(
     services.map(({ name, typeDefs, resolvers }) => {
       return [

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

@@ -48,7 +48,7 @@ describe('ApolloGateway executor', () => {
         variables: { first: '3' },
       },
       queryHash: 'hashed',
-      context: null,
+      context: {},
       cache: {} as any,
       logger,
     });
@@ -83,7 +83,7 @@ describe('ApolloGateway executor', () => {
       document: gql(source),
       request: {},
       queryHash: 'hashed',
-      context: null,
+      context: {},
       cache: {} as any,
       logger,
     });

package/src/config.ts

@@ -1,6 +1,6 @@
 import { GraphQLError, GraphQLSchema } from 'graphql';
 import { HeadersInit } from 'node-fetch';
-import { GraphQLRequestContextExecutionDidStart } from 'apollo-server-types';
+import { GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
 import type { Logger } from '@apollo/utils.logger';
 import { ServiceDefinition } from '@apollo/federation';
 import { GraphQLDataSource } from './datasources/types';
@@ -20,9 +20,7 @@ export type Experimental_DidResolveQueryPlanCallback = ({
   readonly queryPlan: QueryPlan;
   readonly serviceMap: ServiceMap;
   readonly operationContext: OperationContext;
-  readonly requestContext: GraphQLRequestContextExecutionDidStart<
-    Record<string, any>
-  >;
+  readonly requestContext: GatewayGraphQLRequestContext;
 }) => void;
 
 interface ImplementingServiceLocation {

package/src/datasources/LocalGraphQLDataSource.ts

@@ -1,4 +1,4 @@
-import { GraphQLResponse } from 'apollo-server-types';
+import { GatewayGraphQLResponse } from '@apollo/server-gateway-interface';
 import {
   GraphQLSchema,
   graphql,
@@ -6,7 +6,6 @@ import {
   DocumentNode,
   parse,
 } from 'graphql';
-import { enablePluginsForSchemaResolvers } from 'apollo-server-core/dist/utils/schemaInstrumentation';
 import { GraphQLDataSource, GraphQLDataSourceProcessOptions } from './types';
 
 export class LocalGraphQLDataSource<
@@ -14,13 +13,12 @@ export class LocalGraphQLDataSource<
 > implements GraphQLDataSource<TContext>
 {
   constructor(public readonly schema: GraphQLSchema) {
-    enablePluginsForSchemaResolvers(schema);
   }
 
   async process({
     request,
     context,
-  }: GraphQLDataSourceProcessOptions<TContext>): Promise<GraphQLResponse> {
+  }: GraphQLDataSourceProcessOptions<TContext>): Promise<GatewayGraphQLResponse> {
     return graphql({
       schema: this.schema,
       source: request.query!,

package/src/datasources/RemoteGraphQLDataSource.ts

@@ -1,17 +1,3 @@
-import {
-  GraphQLRequestContext,
-  GraphQLResponse,
-  ValueOrPromise,
-  GraphQLRequest,
-  CacheHint,
-  CacheScope,
-  CachePolicy,
-} from 'apollo-server-types';
-import {
-  ApolloError,
-  AuthenticationError,
-  ForbiddenError,
-} from 'apollo-server-errors';
 import { isObject } from '../utilities/predicates';
 import { GraphQLDataSource, GraphQLDataSourceProcessOptions, GraphQLDataSourceRequestKind } from './types';
 import { createHash } from '@apollo/utils.createhash';
@@ -19,6 +5,8 @@ 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';
+import { GraphQLError, GraphQLErrorExtensions } from 'graphql';
+import { GatewayCacheHint, GatewayCachePolicy, GatewayGraphQLRequest, GatewayGraphQLRequestContext, GatewayGraphQLResponse } from '@apollo/server-gateway-interface';
 
 export class RemoteGraphQLDataSource<
   TContext extends Record<string, any> = Record<string, any>,
@@ -77,7 +65,7 @@ export class RemoteGraphQLDataSource<
 
   async process(
     options: GraphQLDataSourceProcessOptions<TContext>,
-  ): Promise<GraphQLResponse> {
+  ): Promise<GatewayGraphQLResponse> {
     const { request, context: originalContext } = options;
     // Deal with a bit of a hairy situation in typings: when doing health checks
     // and schema checks we always pass in `{}` as the context even though it's
@@ -161,7 +149,7 @@ export class RemoteGraphQLDataSource<
     // If APQ was enabled, we'll run the same request again, but add in the
     // previously omitted `query`.  If APQ was NOT enabled, this is the first
     // request (non-APQ, all the way).
-    const requestWithQuery: GraphQLRequest = {
+    const requestWithQuery: GatewayGraphQLRequest = {
       query,
       ...requestWithoutQuery,
     };
@@ -175,9 +163,9 @@ export class RemoteGraphQLDataSource<
   }
 
   private async sendRequest(
-    request: GraphQLRequest,
+    request: GatewayGraphQLRequest,
     context: TContext,
-  ): Promise<GraphQLResponse> {
+  ): Promise<GatewayGraphQLResponse> {
     // This would represent an internal programming error since this shouldn't
     // be possible in the way that this method is invoked right now.
     if (!request.http) {
@@ -230,7 +218,7 @@ export class RemoteGraphQLDataSource<
 
   public willSendRequest?(
     options: GraphQLDataSourceProcessOptions<TContext>,
-  ): ValueOrPromise<void>;
+  ): void | Promise<void>;
 
   private async respond({
     response,
@@ -238,11 +226,11 @@ export class RemoteGraphQLDataSource<
     context,
     overallCachePolicy,
   }: {
-    response: GraphQLResponse;
-    request: GraphQLRequest;
+    response: GatewayGraphQLResponse;
+    request: GatewayGraphQLRequest;
     context: TContext;
-    overallCachePolicy: CachePolicy | null;
-  }): Promise<GraphQLResponse> {
+    overallCachePolicy: GatewayCachePolicy | null;
+  }): Promise<GatewayGraphQLResponse> {
     const processedResponse =
       typeof this.didReceiveResponse === 'function'
         ? await this.didReceiveResponse({ response, request, context })
@@ -257,16 +245,16 @@ export class RemoteGraphQLDataSource<
       // thus the overall response) is uncacheable. (If you don't like this, you
       // can tweak the `cache-control` header in your `didReceiveResponse`
       // method.)
-      const hint: CacheHint = { maxAge: 0 };
+      const hint: GatewayCacheHint = { maxAge: 0 };
       const maxAge = parsed['max-age'];
       if (typeof maxAge === 'string' && maxAge.match(/^[0-9]+$/)) {
         hint.maxAge = +maxAge;
       }
       if (parsed['private'] === true) {
-        hint.scope = CacheScope.Private;
+        hint.scope = 'PRIVATE';
       }
       if (parsed['public'] === true) {
-        hint.scope = CacheScope.Public;
+        hint.scope = 'PUBLIC';
       }
       overallCachePolicy.restrict(hint);
     }
@@ -276,9 +264,9 @@ export class RemoteGraphQLDataSource<
 
   public didReceiveResponse?(
     requestContext: Required<
-      Pick<GraphQLRequestContext<TContext>, 'request' | 'response' | 'context'>
+      Pick<GatewayGraphQLRequestContext<TContext>, 'request' | 'response' | 'context'>
     >,
-  ): ValueOrPromise<GraphQLResponse>;
+  ): GatewayGraphQLResponse | Promise<GatewayGraphQLResponse>;
 
   public didEncounterError(
     error: Error,
@@ -303,28 +291,36 @@ export class RemoteGraphQLDataSource<
   }
 
   public async errorFromResponse(response: FetcherResponse) {
-    const message = `${response.status}: ${response.statusText}`;
-
-    let error: ApolloError;
-    if (response.status === 401) {
-      error = new AuthenticationError(message);
-    } else if (response.status === 403) {
-      error = new ForbiddenError(message);
-    } else {
-      error = new ApolloError(message);
-    }
-
     const body = await this.parseBody(response);
 
-    Object.assign(error.extensions, {
+    const extensions: GraphQLErrorExtensions = {
       response: {
         url: response.url,
         status: response.status,
         statusText: response.statusText,
         body,
       },
-    });
+    };
+
+    if (response.status === 401) {
+      extensions.code = 'UNAUTHENTICATED';
+    } else if (response.status === 403) {
+      extensions.code = 'FORBIDDEN';
+    }
 
-    return error;
+    // Note: gateway 0.x still supports graphql-js v15.8, which does
+    // not have the options-based GraphQLError constructor. Note that
+    // the constructor used here is dropped in graphql-js v17, so this
+    // will have to be adjusted if we try to make gateway 0.x support
+    // graphql-js v17.
+    return new GraphQLError(
+      `${response.status}: ${response.statusText}`,
+      null,
+      null,
+      null,
+      null,
+      null,
+      extensions,
+    );
   }
 }

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

@@ -2,8 +2,8 @@ import { LocalGraphQLDataSource } from '../LocalGraphQLDataSource';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import gql from 'graphql-tag';
 import { GraphQLResolverMap } from '@apollo/subgraph/src/schema-helper';
-import { GraphQLRequestContext } from 'apollo-server-types';
 import { GraphQLDataSourceRequestKind } from '../types';
+import { GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
 
 describe('constructing requests', () => {
   it('accepts context', async () => {
@@ -42,7 +42,7 @@ describe('constructing requests', () => {
       },
       incomingRequestContext: {
         context: { userId: 2 },
-      } as GraphQLRequestContext<{userId: number}>,
+      } as GatewayGraphQLRequestContext<{userId: number}>,
       context: { userId: 2 },
     });
 

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

@@ -1,15 +1,10 @@
-import {
-  ApolloError,
-  AuthenticationError,
-  ForbiddenError,
-} from 'apollo-server-errors';
-
 import { RemoteGraphQLDataSource } from '../RemoteGraphQLDataSource';
 import { Response, Headers } from 'node-fetch';
-import { GraphQLRequestContext } from 'apollo-server-types';
 import { GraphQLDataSourceRequestKind } from '../types';
 import { nockBeforeEach, nockAfterEach } from '../../__tests__/nockAssertions';
 import nock from 'nock';
+import { GraphQLError } from 'graphql';
+import { GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
 
 beforeEach(nockBeforeEach);
 afterEach(nockAfterEach);
@@ -322,7 +317,7 @@ describe('didReceiveResponse', () => {
         response,
       }: Required<
         Pick<
-          GraphQLRequestContext<MyContext>,
+          GatewayGraphQLRequestContext<MyContext>,
           'request' | 'response' | 'context'
         >
       >) {
@@ -367,7 +362,7 @@ describe('didReceiveResponse', () => {
         response,
       }: Required<
         Pick<
-          GraphQLRequestContext<MyContext>,
+          GatewayGraphQLRequestContext<MyContext>,
           'request' | 'response' | 'context'
         >
       >) {
@@ -403,7 +398,7 @@ describe('didReceiveResponse', () => {
         response,
       }: Required<
         Pick<
-          GraphQLRequestContext<MyContext>,
+          GatewayGraphQLRequestContext<MyContext>,
           'request' | 'response' | 'context'
         >
       >) {
@@ -457,11 +452,11 @@ describe('didEncounterError', () => {
       },
       incomingRequestContext: {
         context,
-      } as GraphQLRequestContext<MyContext>,
+      } as GatewayGraphQLRequestContext<MyContext>,
       context,
     });
 
-    await expect(result).rejects.toThrow(AuthenticationError);
+    await expect(result).rejects.toThrow(GraphQLError);
     expect(context).toMatchObject({
       timingData: [{ time: 1616446845234 }],
     });
@@ -469,7 +464,7 @@ describe('didEncounterError', () => {
 });
 
 describe('error handling', () => {
-  it('throws an AuthenticationError when the response status is 401', async () => {
+  it('throws error with code UNAUTHENTICATED when the response status is 401', async () => {
     const DataSource = new RemoteGraphQLDataSource({
       url: 'https://api.example.com/foo',
     });
@@ -480,7 +475,7 @@ describe('error handling', () => {
       ...defaultProcessOptions,
       request: { query: '{ me { name } }' },
     });
-    await expect(result).rejects.toThrow(AuthenticationError);
+    await expect(result).rejects.toThrow(GraphQLError);
     await expect(result).rejects.toMatchObject({
       extensions: {
         code: 'UNAUTHENTICATED',
@@ -492,7 +487,7 @@ describe('error handling', () => {
     });
   });
 
-  it('throws a ForbiddenError when the response status is 403', async () => {
+  it('throws an error with code FORBIDDEN when the response status is 403', async () => {
     const DataSource = new RemoteGraphQLDataSource({
       url: 'https://api.example.com/foo',
     });
@@ -503,7 +498,7 @@ describe('error handling', () => {
       ...defaultProcessOptions,
       request: { query: '{ me { name } }' },
     });
-    await expect(result).rejects.toThrow(ForbiddenError);
+    await expect(result).rejects.toThrow(GraphQLError);
     await expect(result).rejects.toMatchObject({
       extensions: {
         code: 'FORBIDDEN',
@@ -515,7 +510,7 @@ describe('error handling', () => {
     });
   });
 
-  it('throws an ApolloError when the response status is 500', async () => {
+  it('throws a GraphQLError when the response status is 500', async () => {
     const DataSource = new RemoteGraphQLDataSource({
       url: 'https://api.example.com/foo',
     });
@@ -526,7 +521,7 @@ describe('error handling', () => {
       ...defaultProcessOptions,
       request: { query: '{ me { name } }' },
     });
-    await expect(result).rejects.toThrow(ApolloError);
+    await expect(result).rejects.toThrow(GraphQLError);
     await expect(result).rejects.toMatchObject({
       extensions: {
         response: {
@@ -560,7 +555,7 @@ describe('error handling', () => {
       ...defaultProcessOptions,
       request: { query: '{ me { name } }' },
     });
-    await expect(result).rejects.toThrow(ApolloError);
+    await expect(result).rejects.toThrow(GraphQLError);
     await expect(result).rejects.toMatchObject({
       extensions: {
         response: {

package/src/datasources/types.ts

@@ -1,11 +1,11 @@
-import { GraphQLResponse, GraphQLRequestContext } from 'apollo-server-types';
+import { GatewayGraphQLResponse, GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
 
 export interface GraphQLDataSource<
   TContext extends Record<string, any> = Record<string, any>,
 > {
   process(
     options: GraphQLDataSourceProcessOptions<TContext>,
-  ): Promise<GraphQLResponse>;
+  ): Promise<GatewayGraphQLResponse>;
 }
 
 export enum GraphQLDataSourceRequestKind {
@@ -20,7 +20,7 @@ export type GraphQLDataSourceProcessOptions<
   /**
    * The request to send to the subgraph.
    */
-  request: GraphQLRequestContext<TContext>['request'];
+  request: GatewayGraphQLRequestContext<TContext>['request'];
 } & (
   | {
       kind: GraphQLDataSourceRequestKind.INCOMING_OPERATION;
@@ -28,8 +28,15 @@ export type GraphQLDataSourceProcessOptions<
        * The GraphQLRequestContext for the operation received by the gateway, or
        * one of the strings if this operation is generated by the gateway without an
        * incoming request.
+       *
+       * For backwards compatibility with Apollo Server 2, `overallCachePolicy` needs
+       * to be treated as optional.
        */
-      incomingRequestContext: GraphQLRequestContext<TContext>;
+      incomingRequestContext: Omit<
+        GatewayGraphQLRequestContext<TContext>,
+        'overallCachePolicy'
+      > &
+        Pick<Partial<GatewayGraphQLRequestContext<TContext>>, 'overallCachePolicy'>;
       /**
        * Equivalent to incomingRequestContext.context (provided here for
        * backwards compatibility): the object created by the Apollo Server
@@ -38,7 +45,7 @@ export type GraphQLDataSourceProcessOptions<
        * @deprecated Use `incomingRequestContext.context` instead (after
        * checking `kind`).
        */
-      context: GraphQLRequestContext<TContext>['context'];
+      context: GatewayGraphQLRequestContext<TContext>['context'];
     }
   | {
       kind:

package/src/executeQueryPlan.ts

@@ -1,8 +1,3 @@
-import {
-  GraphQLExecutionResult,
-  GraphQLRequestContext,
-  VariableValues,
-} from 'apollo-server-types';
 import { Headers } from 'node-fetch';
 import {
   execute,
@@ -34,6 +29,7 @@ import { deepMerge } from './utilities/deepMerge';
 import { isNotNullOrUndefined } from './utilities/array';
 import { SpanStatusCode } from "@opentelemetry/api";
 import { OpenTelemetrySpanNames, tracer } from "./utilities/opentelemetry";
+import { GatewayGraphQLRequestContext, GatewayExecutionResult } from '@apollo/server-gateway-interface';
 
 export type ServiceMap = {
   [serviceName: string]: GraphQLDataSource;
@@ -41,20 +37,20 @@ export type ServiceMap = {
 
 type ResultMap = Record<string, any>;
 
-interface ExecutionContext<TContext> {
+interface ExecutionContext {
   queryPlan: QueryPlan;
   operationContext: OperationContext;
   serviceMap: ServiceMap;
-  requestContext: GraphQLRequestContext<TContext>;
+  requestContext: GatewayGraphQLRequestContext;
   errors: GraphQLError[];
 }
 
-export async function executeQueryPlan<TContext>(
+export async function executeQueryPlan(
   queryPlan: QueryPlan,
   serviceMap: ServiceMap,
-  requestContext: GraphQLRequestContext<TContext>,
+  requestContext: GatewayGraphQLRequestContext,
   operationContext: OperationContext,
-): Promise<GraphQLExecutionResult> {
+): Promise<GatewayExecutionResult> {
 
   const logger = requestContext.logger || console;
 
@@ -62,7 +58,7 @@ export async function executeQueryPlan<TContext>(
     try {
       const errors: GraphQLError[] = [];
 
-      const context: ExecutionContext<TContext> = {
+      const context: ExecutionContext = {
         queryPlan,
         operationContext,
         serviceMap,
@@ -171,8 +167,8 @@ export async function executeQueryPlan<TContext>(
 // we're going to ignore it, because it makes the code much simpler and more
 // typesafe. However, it doesn't actually ask for traces from the backend
 // service unless we are capturing traces for Studio.
-async function executeNode<TContext>(
-  context: ExecutionContext<TContext>,
+async function executeNode(
+  context: ExecutionContext,
   node: PlanNode,
   results: ResultMap | ResultMap[],
   path: ResponsePath,
@@ -261,7 +257,7 @@ async function executeNode<TContext>(
 
 export function shouldSkipFetchNode(
   node: FetchNode,
-  variables: VariableValues = {},
+  variables: Record<string, any> = {},
 ) {
   if (!node.inclusionConditions) return false;
 
@@ -284,8 +280,8 @@ export function shouldSkipFetchNode(
   });
 }
 
-async function executeFetch<TContext>(
-  context: ExecutionContext<TContext>,
+async function executeFetch(
+  context: ExecutionContext,
   fetch: FetchNode,
   results: ResultMap | (ResultMap | null | undefined)[],
   _path: ResponsePath,
@@ -404,7 +400,7 @@ async function executeFetch<TContext>(
     }
   });
   async function sendOperation(
-    context: ExecutionContext<TContext>,
+    context: ExecutionContext,
     source: string,
     variables: Record<string, any>,
     operationName: string | undefined,