@apollo/gateway 2.1.0-alpha.0 → 2.1.0-alpha.1

package/src/datasources/RemoteGraphQLDataSource.ts

@@ -118,8 +118,7 @@ export class RemoteGraphQLDataSource<
     // there.
     const overallCachePolicy =
       this.honorSubgraphCacheControlHeader &&
-      options.kind === GraphQLDataSourceRequestKind.INCOMING_OPERATION &&
-      options.incomingRequestContext.overallCachePolicy?.restrict
+      options.kind === GraphQLDataSourceRequestKind.INCOMING_OPERATION
         ? options.incomingRequestContext.overallCachePolicy
         : null;
 

package/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:

package/src/executeQueryPlan.ts

@@ -14,6 +14,8 @@ import {
   GraphQLSchema,
   isObjectType,
   isInterfaceType,
+  GraphQLErrorOptions,
+  DocumentNode,
 } from 'graphql';
 import { Trace, google } from 'apollo-reporting-protobuf';
 import { GraphQLDataSource, GraphQLDataSourceRequestKind } from './datasources/types';
@@ -31,7 +33,7 @@ import { deepMerge } from './utilities/deepMerge';
 import { isNotNullOrUndefined } from './utilities/array';
 import { SpanStatusCode } from "@opentelemetry/api";
 import { OpenTelemetrySpanNames, tracer } from "./utilities/opentelemetry";
-import { defaultRootName } from '@apollo/federation-internals';
+import { defaultRootName, errorCodeDef, ERRORS } from '@apollo/federation-internals';
 
 export type ServiceMap = {
   [serviceName: string]: GraphQLDataSource;
@@ -44,6 +46,7 @@ interface ExecutionContext<TContext> {
   operationContext: OperationContext;
   serviceMap: ServiceMap;
   requestContext: GraphQLRequestContext<TContext>;
+  supergraphSchema: GraphQLSchema;
   errors: GraphQLError[];
 }
 
@@ -52,6 +55,7 @@ export async function executeQueryPlan<TContext>(
   serviceMap: ServiceMap,
   requestContext: GraphQLRequestContext<TContext>,
   operationContext: OperationContext,
+  supergraphSchema: GraphQLSchema,
 ): Promise<GraphQLExecutionResult> {
 
   const logger = requestContext.logger || console;
@@ -65,6 +69,7 @@ export async function executeQueryPlan<TContext>(
         operationContext,
         serviceMap,
         requestContext,
+        supergraphSchema,
         errors,
       };
 
@@ -118,11 +123,7 @@ export async function executeQueryPlan<TContext>(
               errors: [
                 new GraphQLError(
                   error.message,
-                  undefined,
-                  undefined,
-                  undefined,
-                  undefined,
-                  error as Error,
+                  { originalError: error },
                 )
               ]
             };
@@ -298,7 +299,8 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             variables,
-            fetch.operationName
+            fetch.operationName,
+            fetch.operationDocumentNode
         );
 
         for (const entity of entities) {
@@ -312,7 +314,10 @@ async function executeFetch<TContext>(
 
         entities.forEach((entity, index) => {
           const representation = executeSelectionSet(
-            context.operationContext,
+            // Note that `requires` may include references to inacessible elements, so we should "execute" it using the supergrah
+            // schema, _not_ the API schema (the one in `context.operationContext.schema`). And this is not a security risk since
+            // what we're extracting here is what is sent to subgraphs, and subgraphs knows `@inacessible` elements.
+            context.supergraphSchema,
             entity,
             requires,
           );
@@ -334,7 +339,8 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             {...variables, representations},
-            fetch.operationName
+            fetch.operationName,
+            fetch.operationDocumentNode
         );
 
         if (!dataReceivedFromService) {
@@ -376,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.
@@ -414,6 +421,7 @@ async function executeFetch<TContext>(
       },
       incomingRequestContext: context.requestContext,
       context: context.requestContext.context,
+      document: operationDocumentNode
     });
 
     if (response.errors) {
@@ -479,7 +487,7 @@ async function executeFetch<TContext>(
  * @param selectionSet
  */
 function executeSelectionSet(
-  operationContext: OperationContext,
+  schema: GraphQLSchema,
   source: Record<string, any> | null,
   selections: QueryPlanSelectionNode[],
 ): Record<string, any> | null {
@@ -514,12 +522,12 @@ function executeSelectionSet(
         if (Array.isArray(source[responseName])) {
           result[responseName] = source[responseName].map((value: any) =>
             selections
-              ? executeSelectionSet(operationContext, value, selections)
+              ? executeSelectionSet(schema, value, selections)
               : value,
           );
         } else if (selections) {
           result[responseName] = executeSelectionSet(
-            operationContext,
+            schema,
             source[responseName],
             selections,
           );
@@ -533,10 +541,10 @@ function executeSelectionSet(
         const typename = source && source['__typename'];
         if (!typename) continue;
 
-        if (doesTypeConditionMatch(operationContext.schema, selection.typeCondition, typename)) {
+        if (doesTypeConditionMatch(schema, selection.typeCondition, typename)) {
           deepMerge(
             result,
-            executeSelectionSet(operationContext, source, selection.selections),
+            executeSelectionSet(schema, source, selection.selections),
           );
         }
         break;
@@ -593,22 +601,25 @@ function downstreamServiceError(
   if (!message) {
     message = `Error while fetching subquery from service "${serviceName}"`;
   }
-  extensions = {
-    code: 'DOWNSTREAM_SERVICE_ERROR',
-    // XXX The presence of a serviceName in extensions is used to
-    // determine if this error should be captured for metrics reporting.
-    serviceName,
-    ...extensions,
+
+  const errorOptions: GraphQLErrorOptions = {
+    originalError: originalError as Error,
+    extensions: {
+      ...extensions,
+      // XXX The presence of a serviceName in extensions is used to
+      // determine if this error should be captured for metrics reporting.
+      serviceName,
+    }
   };
-  return new GraphQLError(
-    message,
-    undefined,
-    undefined,
-    undefined,
-    undefined,
-    originalError as Error,
-    extensions,
-  );
+
+  let codeDef = errorCodeDef(originalError);
+  // It's possible the orignal has a code, but not one we know about (one generated by the underlying `GraphQLDataSource`,
+  // which we don't control). In that case, we want to use that code (and have thus no `ErrorCodeDefinition` usable).
+  if (!codeDef && extensions?.code) {
+    return new GraphQLError(message, errorOptions);
+  }
+  // Otherwise, we either use the code we found and know, or default to a general downstream error code.
+  return (codeDef ?? ERRORS.DOWNSTREAM_SERVICE_ERROR).err(message, errorOptions);
 }
 
 export const defaultFieldResolverWithAliasSupport: GraphQLFieldResolver<

package/src/index.ts

@@ -142,6 +142,7 @@ export class ApolloGateway implements GraphQLService {
   private warnedStates: WarnedStates = Object.create(null);
   private queryPlanner?: QueryPlanner;
   private supergraphSdl?: string;
+  private supergraphSchema?: GraphQLSchema;
   private compositionId?: string;
   private state: GatewayState;
   private _supergraphManager?: SupergraphManager;
@@ -207,22 +208,6 @@ export class ApolloGateway implements GraphQLService {
   }
 
   private issueConfigurationWarningsIfApplicable() {
-    // Warn against a pollInterval of < 10s in managed mode and reset it to 10s
-    if (
-      isManagedConfig(this.config) &&
-      this.pollIntervalInMs &&
-      this.pollIntervalInMs < 10000
-    ) {
-      this.pollIntervalInMs = 10000;
-      this.logger.warn(
-        'Polling Apollo services at a frequency of less than once per 10 ' +
-          'seconds (10000) is disallowed. Instead, the minimum allowed ' +
-          'pollInterval of 10000 will be used. Please reconfigure your ' +
-          '`fallbackPollIntervalInMs` accordingly. If this is problematic for ' +
-          'your team, please contact support.',
-      );
-    }
-
     // Warn against using the pollInterval and a serviceList simultaneously
     // TODO(trevor:removeServiceList)
     if (this.pollIntervalInMs && isServiceListConfig(this.config)) {
@@ -522,7 +507,7 @@ export class ApolloGateway implements GraphQLService {
     // In the case that it throws, the gateway will:
     //   * on initial load, throw the error
     //   * on update, log the error and don't update
-    const { schema, supergraphSdl } = this.createSchemaFromSupergraphSdl(
+    const { supergraphSchema, supergraphSdl } = this.createSchemaFromSupergraphSdl(
       result.supergraphSdl,
     );
 
@@ -531,25 +516,26 @@ export class ApolloGateway implements GraphQLService {
     const previousCompositionId = this.compositionId;
 
     if (previousSchema) {
-      this.logger.info('Updated Supergraph SDL was found.');
+      this.logger.info(`Updated Supergraph SDL was found [Composition ID ${this.compositionId} => ${result.id}]`);
     }
 
     this.compositionId = result.id;
     this.supergraphSdl = supergraphSdl;
+    this.supergraphSchema = supergraphSchema.toGraphQLJSSchema();
 
     if (!supergraphSdl) {
       this.logger.error(
         "A valid schema couldn't be composed. Falling back to previous schema.",
       );
     } else {
-      this.updateWithSchemaAndNotify(schema, supergraphSdl);
+      this.updateWithSchemaAndNotify(supergraphSchema, supergraphSdl);
 
       if (this.experimental_didUpdateSupergraph) {
         this.experimental_didUpdateSupergraph(
           {
             compositionId: result.id,
             supergraphSdl,
-            schema: schema.toGraphQLJSSchema(),
+            schema: this.schema!,
           },
           previousCompositionId && previousSupergraphSdl && previousSchema
             ? {
@@ -654,7 +640,7 @@ export class ApolloGateway implements GraphQLService {
     this.createServices(serviceList);
 
     return {
-      schema,
+      supergraphSchema: schema,
       supergraphSdl,
     };
   }
@@ -859,6 +845,7 @@ export class ApolloGateway implements GraphQLService {
             serviceMap,
             requestContext,
             operationContext,
+            this.supergraphSchema!,
           );
 
           const shouldShowQueryPlan =
@@ -1076,5 +1063,4 @@ export {
   FailureToFetchSupergraphSdlAfterInit,
   FailureToFetchSupergraphSdlDuringInit,
   FailureToFetchSupergraphSdlFunctionParams,
-  DEFAULT_UPLINK_ENDPOINTS,
 } from './supergraphManagers';

package/src/operationContext.ts

@@ -1,7 +1,7 @@
+import { ERRORS } from '@apollo/federation-internals';
 import {
   DocumentNode,
   FragmentDefinitionNode,
-  GraphQLError,
   GraphQLSchema,
   Kind,
   OperationDefinitionNode,
@@ -37,7 +37,7 @@ export function buildOperationContext({
       case Kind.OPERATION_DEFINITION:
         operationCount++;
         if (!operationName && operationCount > 1) {
-          throw new GraphQLError(
+          throw ERRORS.INVALID_GRAPHQL.err(
             'Must provide operation name if query contains ' +
               'multiple operations.',
           );
@@ -55,11 +55,9 @@ export function buildOperationContext({
     }
   });
   if (!operation) {
-    if (operationName) {
-      throw new GraphQLError(`Unknown operation named "${operationName}".`);
-    } else {
-      throw new GraphQLError('Must provide an operation.');
-    }
+    throw ERRORS.INVALID_GRAPHQL.err(
+      operationName ? `Unknown operation named "${operationName}".` : 'Must provide an operation.'
+    );
   }
 
   return {

package/src/supergraphManagers/IntrospectAndCompose/index.ts

@@ -1,5 +1,5 @@
 import type { Logger } from '@apollo/utils.logger';
-import { HeadersInit } from 'node-fetch';
+import type { HeadersInit } from 'node-fetch';
 import resolvable from '@josephg/resolvable';
 import {
   ServiceEndpointDefinition,

package/src/supergraphManagers/IntrospectAndCompose/loadServicesFromRemoteEndpoint.ts

@@ -1,6 +1,6 @@
 import { GraphQLRequest } from 'apollo-server-types';
 import { parse } from 'graphql';
-import { Headers, HeadersInit } from 'node-fetch';
+import { Headers, type HeadersInit } from 'node-fetch';
 import { ServiceDefinition } from '@apollo/federation-internals';
 import { GraphQLDataSource, GraphQLDataSourceRequestKind } from '../../datasources/types';
 import { SERVICE_DEFINITION_QUERY } from '../..';

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

@@ -2,8 +2,6 @@ import mockedEnv from 'mocked-env';
 
 import { UplinkSupergraphManager } from '@apollo/gateway';
 
-import { DEFAULT_UPLINK_ENDPOINTS } from '..';
-
 let cleanUp: (() => void) | undefined;
 
 const logger = {
@@ -31,7 +29,7 @@ describe('UplinkSupergraphManager', () => {
     it('uses default uplink URLs', async () => {
       const manager = new UplinkSupergraphManager({ apiKey, graphRef, logger });
 
-      expect(manager.uplinkEndpoints).toEqual(DEFAULT_UPLINK_ENDPOINTS);
+      expect(manager.uplinkEndpoints).toEqual(UplinkSupergraphManager.DEFAULT_UPLINK_ENDPOINTS);
     });
 
     it('can set uplink URLs via config', async () => {

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

@@ -22,6 +22,15 @@ import {
   nockBeforeEach,
 } from '../../../__tests__/nockAssertions';
 
+const logger = {
+  warn: jest.fn(),
+  debug: jest.fn(),
+  error: jest.fn(),
+  info: jest.fn(),
+};
+
+const requestTimeoutMs = 100;
+
 describe('loadSupergraphSdlFromStorage', () => {
   beforeEach(nockBeforeEach);
   afterEach(nockAfterEach);
@@ -34,7 +43,9 @@ describe('loadSupergraphSdlFromStorage', () => {
       endpoint: mockCloudConfigUrl1,
       errorReportingEndpoint: undefined,
       fetcher,
+      requestTimeoutMs,
       compositionId: null,
+      logger,
     });
     expect(result).toMatchObject({
       id: 'originalId-1234',
@@ -66,10 +77,11 @@ describe('loadSupergraphSdlFromStorage', () => {
       endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
       errorReportingEndpoint: undefined,
       fetcher,
+      requestTimeoutMs,
       compositionId: 'originalId-1234',
       maxRetries: 1,
       roundRobinSeed: 0,
-      earliestFetchTime: null,
+      logger,
     });
 
     expect(result).toMatchObject({
@@ -92,10 +104,11 @@ describe('loadSupergraphSdlFromStorage', () => {
         endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
         errorReportingEndpoint: undefined,
         fetcher,
+        requestTimeoutMs,
         compositionId: 'originalId-1234',
         maxRetries: 1,
         roundRobinSeed: 0,
-        earliestFetchTime: null,
+        logger,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -115,7 +128,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -140,7 +155,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -160,7 +177,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -181,7 +200,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -200,7 +221,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -220,7 +243,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -240,7 +265,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -260,7 +287,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           endpoint: mockCloudConfigUrl1,
           errorReportingEndpoint: mockOutOfBandReporterUrl,
           fetcher,
+          requestTimeoutMs,
           compositionId: null,
+          logger,
         }),
       ).rejects.toThrowError(
         new UplinkFetcherError(
@@ -281,7 +310,9 @@ describe('loadSupergraphSdlFromStorage', () => {
         endpoint: mockCloudConfigUrl1,
         errorReportingEndpoint: mockOutOfBandReporterUrl,
         fetcher,
+        requestTimeoutMs,
         compositionId: null,
+        logger,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -301,7 +332,9 @@ describe('loadSupergraphSdlFromStorage', () => {
         endpoint: mockCloudConfigUrl1,
         errorReportingEndpoint: mockOutOfBandReporterUrl,
         fetcher,
+        requestTimeoutMs,
         compositionId: null,
+        logger,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -321,7 +354,9 @@ describe('loadSupergraphSdlFromStorage', () => {
         endpoint: mockCloudConfigUrl1,
         errorReportingEndpoint: mockOutOfBandReporterUrl,
         fetcher,
+        requestTimeoutMs,
         compositionId: null,
+        logger,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -341,7 +376,9 @@ describe('loadSupergraphSdlFromStorage', () => {
         endpoint: mockCloudConfigUrl1,
         errorReportingEndpoint: mockOutOfBandReporterUrl,
         fetcher,
+        requestTimeoutMs,
         compositionId: null,
+        logger,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -359,7 +396,9 @@ describe('loadSupergraphSdlFromStorage', () => {
       endpoint: mockCloudConfigUrl1,
       errorReportingEndpoint: mockOutOfBandReporterUrl,
       fetcher,
+      requestTimeoutMs,
       compositionId: 'id-1234',
+      logger,
     });
     expect(result).toBeNull();
   });
@@ -382,20 +421,20 @@ describe('loadSupergraphSdlFromUplinks', () => {
         calls++;
         return fetcher(...args);
       },
+      requestTimeoutMs,
       compositionId: 'id-1234',
       maxRetries: 5,
       roundRobinSeed: 0,
-      earliestFetchTime: null,
+      logger,
     });
 
     expect(result).toBeNull();
     expect(calls).toBe(1);
   });
 
-  it('Waits the correct time before retrying', async () => {
-    const timeoutSpy = jest.spyOn(global, 'setTimeout');
-
+  it('Retries on error', async () => {
     mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
+    const supergraphSdl = getTestingSupergraphSdl();
     mockSupergraphSdlRequestIfAfter(
       'originalId-1234',
       mockCloudConfigUrl2,
@@ -406,29 +445,25 @@ describe('loadSupergraphSdlFromUplinks', () => {
           routerConfig: {
             __typename: 'RouterConfigResult',
             id: 'originalId-1234',
-            supergraphSdl: getTestingSupergraphSdl(),
+            supergraphSdl,
           },
         },
       }),
     );
 
-    await loadSupergraphSdlFromUplinks({
+    const result = await loadSupergraphSdlFromUplinks({
       graphRef,
       apiKey,
       endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
       errorReportingEndpoint: undefined,
-      fetcher: fetcher,
+      fetcher,
+      requestTimeoutMs,
       compositionId: 'originalId-1234',
       maxRetries: 1,
       roundRobinSeed: 0,
-      earliestFetchTime: new Date(Date.now() + 1000),
+      logger,
     });
 
-    // test if setTimeout was called with a value in range to deal with time jitter
-    const setTimeoutCall = timeoutSpy.mock.calls[1][1];
-    expect(setTimeoutCall).toBeLessThanOrEqual(1000);
-    expect(setTimeoutCall).toBeGreaterThanOrEqual(900);
-
-    timeoutSpy.mockRestore();
+    expect(result?.supergraphSdl).toEqual(supergraphSdl);
   });
 });