@apollo/gateway 2.1.0-alpha.2 → 2.1.0

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;
@@ -29,7 +29,7 @@ export type GraphQLDataSourceProcessOptions<
        * one of the strings if this operation is generated by the gateway without an
        * incoming request.
        */
-      incomingRequestContext: GraphQLRequestContext<TContext>;
+      incomingRequestContext: GatewayGraphQLRequestContext<TContext>;
       /**
        * Equivalent to incomingRequestContext.context (provided here for
        * backwards compatibility): the object created by the Apollo Server
@@ -38,11 +38,11 @@ export type GraphQLDataSourceProcessOptions<
        * @deprecated Use `incomingRequestContext.context` instead (after
        * checking `kind`).
        */
-      context: GraphQLRequestContext<TContext>['context'];
+      context: GatewayGraphQLRequestContext<TContext>['context'];
       /**
        * The document representation of the request's query being sent to the subgraph, if available.
        */
-      document?: GraphQLRequestContext<TContext>['document'];
+      document?: GatewayGraphQLRequestContext<TContext>['document'];
     }
   | {
       kind:

package/src/executeQueryPlan.ts

@@ -1,7 +1,3 @@
-import {
-  GraphQLExecutionResult,
-  GraphQLRequestContext,
-} from 'apollo-server-types';
 import { Headers } from 'node-fetch';
 import {
   execute,
@@ -33,7 +29,8 @@ import { deepMerge } from './utilities/deepMerge';
 import { isNotNullOrUndefined } from './utilities/array';
 import { SpanStatusCode } from "@opentelemetry/api";
 import { OpenTelemetrySpanNames, tracer } from "./utilities/opentelemetry";
-import { defaultRootName, errorCodeDef, ERRORS } from '@apollo/federation-internals';
+import { assert, defaultRootName, errorCodeDef, ERRORS } from '@apollo/federation-internals';
+import { GatewayGraphQLRequestContext, GatewayExecutionResult } from '@apollo/server-gateway-interface';
 
 export type ServiceMap = {
   [serviceName: string]: GraphQLDataSource;
@@ -41,22 +38,22 @@ export type ServiceMap = {
 
 type ResultMap = Record<string, any>;
 
-interface ExecutionContext<TContext> {
+interface ExecutionContext {
   queryPlan: QueryPlan;
   operationContext: OperationContext;
   serviceMap: ServiceMap;
-  requestContext: GraphQLRequestContext<TContext>;
+  requestContext: GatewayGraphQLRequestContext;
   supergraphSchema: GraphQLSchema;
   errors: GraphQLError[];
 }
 
-export async function executeQueryPlan<TContext>(
+export async function executeQueryPlan(
   queryPlan: QueryPlan,
   serviceMap: ServiceMap,
-  requestContext: GraphQLRequestContext<TContext>,
+  requestContext: GatewayGraphQLRequestContext,
   operationContext: OperationContext,
   supergraphSchema: GraphQLSchema,
-): Promise<GraphQLExecutionResult> {
+): Promise<GatewayExecutionResult> {
 
   const logger = requestContext.logger || console;
 
@@ -64,7 +61,7 @@ export async function executeQueryPlan<TContext>(
     try {
       const errors: GraphQLError[] = [];
 
-      const context: ExecutionContext<TContext> = {
+      const context: ExecutionContext = {
         queryPlan,
         operationContext,
         serviceMap,
@@ -170,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,
@@ -251,11 +248,17 @@ async function executeNode<TContext>(
       }
       return new Trace.QueryPlanNode({ fetch: traceNode });
     }
+    case 'Defer': {
+      assert(false, `@defer support is not available in the gateway`);
+    }
+    case 'Condition': {
+      assert(false, `Condition nodes are not available in the gateway`);
+    }
   }
 }
 
-async function executeFetch<TContext>(
-  context: ExecutionContext<TContext>,
+async function executeFetch(
+  context: ExecutionContext,
   fetch: FetchNode,
   results: ResultMap | (ResultMap | null | undefined)[],
   _path: ResponsePath,
@@ -379,7 +382,7 @@ async function executeFetch<TContext>(
     }
   });
   async function sendOperation(
-    context: ExecutionContext<TContext>,
+    context: ExecutionContext,
     source: string,
     variables: Record<string, any>,
     operationName: string | undefined,

package/src/index.ts

@@ -1,9 +1,4 @@
 import { deprecate } from 'util';
-import { GraphQLService, Unsubscriber } from 'apollo-server-core';
-import {
-  GraphQLExecutionResult,
-  GraphQLRequestContextExecutionDidStart,
-} from 'apollo-server-types';
 import { createHash } from '@apollo/utils.createhash';
 import type { Logger } from '@apollo/utils.logger';
 import LRUCache from 'lru-cache';
@@ -63,6 +58,7 @@ import {
   ServiceDefinition,
 } from '@apollo/federation-internals';
 import { getDefaultLogger } from './logger';
+import {GatewayInterface, GatewayUnsubscriber, GatewayGraphQLRequestContext, GatewayExecutionResult} from '@apollo/server-gateway-interface';
 
 type DataSourceMap = {
   [serviceName: string]: { url?: string; dataSource: GraphQLDataSource };
@@ -118,7 +114,7 @@ interface GraphQLServiceEngineConfig {
   graphVariant?: string;
 }
 
-export class ApolloGateway implements GraphQLService {
+export class ApolloGateway implements GatewayInterface {
   public schema?: GraphQLSchema;
   // Same as a `schema` but as a `Schema` to avoid reconverting when we need it.
   // TODO(sylvain): if we add caching in `Schema.toGraphQLJSSchema`, we could maybe only keep `apiSchema`
@@ -651,7 +647,7 @@ export class ApolloGateway implements GraphQLService {
    */
   public onSchemaChange(
     callback: (schema: GraphQLSchema) => void,
-  ): Unsubscriber {
+  ): GatewayUnsubscriber {
     this.onSchemaChangeListeners.add(callback);
 
     return () => {
@@ -664,7 +660,7 @@ export class ApolloGateway implements GraphQLService {
       apiSchema: GraphQLSchema;
       coreSupergraphSdl: string;
     }) => void,
-  ): Unsubscriber {
+  ): GatewayUnsubscriber {
     this.onSchemaLoadOrUpdateListeners.add(callback);
 
     return () => {
@@ -744,9 +740,9 @@ export class ApolloGateway implements GraphQLService {
   // ApolloServerPluginUsageReporting) assumes that. In fact, errors talking to backends
   // are unlikely to show up as GraphQLErrors. Do we need to use
   // formatApolloErrors or something?
-  public executor = async <TContext>(
-    requestContext: GraphQLRequestContextExecutionDidStart<TContext>,
-  ): Promise<GraphQLExecutionResult> => {
+  public executor = async (
+    requestContext: GatewayGraphQLRequestContext,
+  ): Promise<GatewayExecutionResult> => {
     const spanAttributes = requestContext.operationName
       ? { operationName: requestContext.operationName }
       : {};
@@ -824,7 +820,7 @@ export class ApolloGateway implements GraphQLService {
             });
           }
 
-          const response = await executeQueryPlan<TContext>(
+          const response = await executeQueryPlan(
             queryPlan,
             serviceMap,
             requestContext,
@@ -882,8 +878,8 @@ export class ApolloGateway implements GraphQLService {
     );
   };
 
-  private validateIncomingRequest<TContext>(
-    requestContext: GraphQLRequestContextExecutionDidStart<TContext>,
+  private validateIncomingRequest(
+    requestContext: GatewayGraphQLRequestContext,
     operationContext: OperationContext,
   ) {
     return tracer.startActiveSpan(OpenTelemetrySpanNames.VALIDATE, (span) => {

package/src/logger.ts

@@ -1,7 +1,7 @@
 import loglevel from 'loglevel';
 import type { Logger } from '@apollo/utils.logger';
 
-export function getDefaultLogger(debug: boolean = true): Logger {
+export function getDefaultLogger(debug: boolean = false): Logger {
   const logger = loglevel.getLogger('apollo-gateway');
 
   const level = debug === true ? loglevel.levels.DEBUG : loglevel.levels.WARN;

package/src/schema-helper/__tests__/addExtensions.test.ts

@@ -3,9 +3,63 @@ import { addExtensions } from '../addExtensions';
 const { version } = require('../../../package.json');
 
 describe('addExtensions', () => {
+
   it('adds gateway extensions to a schema', async () => {
     const schema = buildSchema('type Query { hello: String }');
     expect(schema.extensions).toEqual({});
     expect(addExtensions(schema).extensions).toEqual({ apollo: { gateway: { version: version } } });
   });
+
+  it('does not delete existing extensions', async () => {
+    const schema = buildSchema('type Query { hello: String }');
+    expect(schema.extensions).toEqual({});
+    schema.extensions = {
+      foo: 'bar',
+      apollo: {
+        gateway: {
+          version: 'hello'
+        }
+      }
+    };
+    expect(addExtensions(schema).extensions).toEqual({
+      foo: 'bar',
+      apollo: {
+        gateway: {
+          version: version
+        }
+      }
+    });
+  });
+
+  it('works with undefined apollo block', async () => {
+    const schema = buildSchema('type Query { hello: String }');
+    expect(schema.extensions).toEqual({});
+    schema.extensions = {
+      apollo: undefined
+    };
+    expect(addExtensions(schema).extensions).toEqual({
+      apollo: {
+        gateway: {
+          version: version
+        }
+      }
+    });
+  });
+
+  it('works with undefined gateway block', async () => {
+    const schema = buildSchema('type Query { hello: String }');
+    expect(schema.extensions).toEqual({});
+    schema.extensions = {
+      apollo: {
+        gateway: undefined
+      }
+    };
+    expect(addExtensions(schema).extensions).toEqual({
+      apollo: {
+        gateway: {
+          version: version
+        }
+      }
+    });
+  });
 });

package/src/schema-helper/addExtensions.ts

@@ -1,13 +1,19 @@
 import { GraphQLSchema } from 'graphql';
+import { GraphQLSchemaExtensions } from 'graphql/type/schema';
+
 const { version } = require('../../package.json');
 
 export function addExtensions(schema: GraphQLSchema): GraphQLSchema {
+  const schemaExtension = schema.extensions as GraphQLSchemaExtensions ?? {};
+  const apolloExtension = schemaExtension?.apollo ?? {};
+  const gatewayExtension = apolloExtension?.gateway ?? {};
+
   schema.extensions = {
     ...schema.extensions,
     apollo: {
-      ...schema.extensions.apollo,
+      ...apolloExtension,
       gateway: {
-        ...schema.extensions.apollo?.gateway,
+        ...gatewayExtension,
         version,
       }
     },

package/src/supergraphManagers/IntrospectAndCompose/loadServicesFromRemoteEndpoint.ts

@@ -1,10 +1,10 @@
-import { GraphQLRequest } from 'apollo-server-types';
 import { parse } from 'graphql';
 import { Headers, type HeadersInit } from 'node-fetch';
 import { ServiceDefinition } from '@apollo/federation-internals';
 import { GraphQLDataSource, GraphQLDataSourceRequestKind } from '../../datasources/types';
 import { SERVICE_DEFINITION_QUERY } from '../..';
 import { ServiceDefinitionUpdate, ServiceEndpointDefinition } from '../../config';
+import { GatewayGraphQLRequest } from '@apollo/server-gateway-interface';
 
 export type Service = ServiceEndpointDefinition & {
   dataSource: GraphQLDataSource;
@@ -35,7 +35,7 @@ export async function loadServicesFromRemoteEndpoint({
         `Tried to load schema for '${name}' but no 'url' was specified.`);
     }
 
-    const request: GraphQLRequest = {
+    const request: GatewayGraphQLRequest = {
       query: SERVICE_DEFINITION_QUERY,
       http: {
         url,

package/src/supergraphManagers/UplinkSupergraphManager/__tests__/loadSupergraphSdlFromStorage.test.ts

@@ -1,3 +1,4 @@
+import nock from 'nock';
 import {
   loadSupergraphSdlFromStorage,
   loadSupergraphSdlFromUplinks,
@@ -21,6 +22,7 @@ import {
   nockAfterEach,
   nockBeforeEach,
 } from '../../../__tests__/nockAssertions';
+import { FetcherRequestInit } from '@apollo/utils.fetcher';
 
 const logger = {
   warn: jest.fn(),
@@ -90,6 +92,48 @@ describe('loadSupergraphSdlFromStorage', () => {
     });
   });
 
+  it('Queries alternate Uplink URL if first one times out', async () => {
+    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).delay(120_000).reply(500);
+    mockSupergraphSdlRequestIfAfter(
+      'originalId-1234',
+      mockCloudConfigUrl2,
+    ).reply(
+      200,
+      JSON.stringify({
+        data: {
+          routerConfig: {
+            __typename: 'RouterConfigResult',
+            id: 'originalId-1234',
+            supergraphSdl: getTestingSupergraphSdl(),
+          },
+        },
+      }),
+    );
+
+    const result = await loadSupergraphSdlFromUplinks({
+      graphRef,
+      apiKey,
+      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
+      errorReportingEndpoint: undefined,
+      fetcher,
+      requestTimeoutMs,
+      compositionId: 'originalId-1234',
+      maxRetries: 1,
+      roundRobinSeed: 0,
+      logger,
+    });
+
+    expect(result).toMatchObject({
+      id: 'originalId-1234',
+      supergraphSdl: getTestingSupergraphSdl(),
+    });
+
+    // We're intentionally delaying the response above, so we need to make sure
+    // nock shuts down correctly, and isn't related to the underlying abort
+    // mechanism.
+    nock.abortPendingRequests();
+  });
+
   it('Throws error if all Uplink URLs fail', async () => {
     mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
     mockSupergraphSdlRequestIfAfter(
@@ -417,9 +461,9 @@ describe('loadSupergraphSdlFromUplinks', () => {
       apiKey,
       endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
       errorReportingEndpoint: mockOutOfBandReporterUrl,
-      fetcher: (...args) => {
+      fetcher: (url: string, init?: FetcherRequestInit) => {
         calls++;
-        return fetcher(...args);
+        return fetcher(url, init);
       },
       requestTimeoutMs,
       compositionId: 'id-1234',

package/src/supergraphManagers/UplinkSupergraphManager/index.ts

@@ -1,5 +1,6 @@
 import * as makeFetchHappen from 'make-fetch-happen';
 import type { Logger } from '@apollo/utils.logger';
+import type { Fetcher } from '@apollo/utils.fetcher';
 import resolvable, { Resolvable } from '@josephg/resolvable';
 import { SupergraphManager, SupergraphSdlHookOptions } from '../../config';
 import {
@@ -8,7 +9,6 @@ import {
 } from '../..';
 import { getDefaultLogger } from '../../logger';
 import { loadSupergraphSdlFromUplinks } from './loadSupergraphSdlFromStorage';
-import type { AbortableFetcher } from './types';
 
 export type FailureToFetchSupergraphSdlFunctionParams = {
   error: Error;
@@ -58,7 +58,7 @@ export class UplinkSupergraphManager implements SupergraphManager {
     UplinkSupergraphManager.getUplinkEndpoints();
   private apiKey: string;
   private graphRef: string;
-  private fetcher: AbortableFetcher = makeFetchHappen.defaults();
+  private fetcher: Fetcher = makeFetchHappen.defaults();
   private maxRetries: number;
   private requestTimeoutMs: number =
     UplinkSupergraphManager.DEFAULT_REQUEST_TIMEOUT_MS;
@@ -100,7 +100,7 @@ export class UplinkSupergraphManager implements SupergraphManager {
     fallbackPollIntervalInMs?: number;
     maxRetries?: number;
     initialMaxRetries?: number;
-    fetcher?: AbortableFetcher;
+    fetcher?: Fetcher;
     shouldRunSubgraphHealthcheck?: boolean;
     onFailureToFetchSupergraphSdlDuringInit?: FailureToFetchSupergraphSdlDuringInit;
     onFailureToFetchSupergraphSdlAfterInit?: FailureToFetchSupergraphSdlAfterInit;

package/src/supergraphManagers/UplinkSupergraphManager/loadSupergraphSdlFromStorage.ts

@@ -4,12 +4,12 @@ import { AbortController } from "node-abort-controller";
 import { SupergraphSdlUpdate } from '../../config';
 import { submitOutOfBandReportIfConfigured } from './outOfBandReporter';
 import { SupergraphSdlQuery } from '../../__generated__/graphqlTypes';
-import type { FetcherResponse } from '@apollo/utils.fetcher';
-import type { Logger } from '@apollo/utils.logger';
 import type {
-  AbortableFetcher as Fetcher,
-  AbortableFetcherRequestInit as FetcherRequestInit,
-} from './types';
+  FetcherResponse,
+  Fetcher,
+  FetcherRequestInit,
+} from '@apollo/utils.fetcher';
+import type { Logger } from '@apollo/utils.logger';
 
 // Magic /* GraphQL */ comment below is for codegen, do not remove
 export const SUPERGRAPH_SDL_QUERY = /* GraphQL */`#graphql

package/src/supergraphManagers/UplinkSupergraphManager/outOfBandReporter.ts

@@ -1,11 +1,10 @@
-import { FetcherResponse } from '@apollo/utils.fetcher';
+import { FetcherResponse, type Fetcher } from '@apollo/utils.fetcher';
 import { GraphQLError } from 'graphql';
 import {
   ErrorCode,
   OobReportMutation,
   OobReportMutationVariables,
 } from '../../__generated__/graphqlTypes';
-import { type AbortableFetcher as Fetcher } from './types';
 
 // Magic /* GraphQL */ comment below is for codegen, do not remove
 export const OUT_OF_BAND_REPORTER_QUERY = /* GraphQL */`#graphql

package/dist/supergraphManagers/UplinkSupergraphManager/types.d.ts

@@ -1,9 +0,0 @@
-import type { AbortSignal } from 'node-abort-controller';
-import type { Fetcher, FetcherRequestInit } from '@apollo/utils.fetcher';
-export interface AbortableFetcherRequestInit extends FetcherRequestInit {
-    signal?: AbortSignal | null | undefined;
-}
-export interface AbortableFetcher extends Fetcher {
-    init?: AbortableFetcherRequestInit;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/supergraphManagers/UplinkSupergraphManager/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/supergraphManagers/UplinkSupergraphManager/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEzE,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB;IACrE,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,WAAW,gBAAiB,SAAQ,OAAO;IAC/C,IAAI,CAAC,EAAE,2BAA2B,CAAC;CACpC"}

package/dist/supergraphManagers/UplinkSupergraphManager/types.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-;
-;
-//# sourceMappingURL=types.js.map

package/dist/supergraphManagers/UplinkSupergraphManager/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/supergraphManagers/UplinkSupergraphManager/types.ts"],"names":[],"mappings":";;AAKC,CAAC;AAID,CAAC"}

package/src/supergraphManagers/UplinkSupergraphManager/types.ts

@@ -1,10 +0,0 @@
-import type { AbortSignal } from 'node-abort-controller';
-import type { Fetcher, FetcherRequestInit } from '@apollo/utils.fetcher';
-
-export interface AbortableFetcherRequestInit extends FetcherRequestInit {
-  signal?: AbortSignal | null | undefined;
-};
-
-export interface AbortableFetcher extends Fetcher {
-  init?: AbortableFetcherRequestInit;
-};