@apollo/gateway 0.48.3 → 0.50.1

package/src/index.ts

@@ -2,9 +2,9 @@ import { deprecate } from 'util';
 import { GraphQLService, Unsubscriber } from 'apollo-server-core';
 import {
   GraphQLExecutionResult,
-  Logger,
   GraphQLRequestContextExecutionDidStart,
 } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 import { InMemoryLRUCache } from 'apollo-server-caching';
 import {
   isObjectType,
@@ -202,8 +202,12 @@ export class ApolloGateway implements GraphQLService {
     this.experimental_didUpdateSupergraph =
       config?.experimental_didUpdateSupergraph;
 
-    this.pollIntervalInMs =
-      config?.pollIntervalInMs ?? config?.experimental_pollInterval;
+    if (isManagedConfig(this.config)) {
+      this.pollIntervalInMs =
+        this.config.fallbackPollIntervalInMs ?? this.config.pollIntervalInMs;
+    } else if (isServiceListConfig(this.config)) {
+      this.pollIntervalInMs = this.config?.pollIntervalInMs;
+    }
 
     this.issueConfigurationWarningsIfApplicable();
 
@@ -254,7 +258,7 @@ export class ApolloGateway implements GraphQLService {
         '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 ' +
-          '`pollIntervalInMs` accordingly. If this is problematic for ' +
+          '`fallbackPollIntervalInMs` accordingly. If this is problematic for ' +
           'your team, please contact support.',
       );
     }
@@ -288,9 +292,11 @@ export class ApolloGateway implements GraphQLService {
       );
     }
 
-    if ('experimental_pollInterval' in this.config) {
+    if (isManagedConfig(this.config) && 'pollIntervalInMs' in this.config) {
       this.logger.warn(
-        'The `experimental_pollInterval` option is deprecated and will be removed in a future version of `@apollo/gateway`. Please migrate to the equivalent `pollIntervalInMs` configuration option.',
+        'The `pollIntervalInMs` option is deprecated and will be removed in a future version of `@apollo/gateway`. ' +
+        'Please migrate to the equivalent `fallbackPollIntervalInMs` configuration option. ' +
+        'The poll interval is now defined by Uplink, this option will only be used if it is greater than the value defined by Uplink or as a fallback.',
       );
     }
   }
@@ -404,7 +410,7 @@ export class ApolloGateway implements GraphQLService {
           subgraphHealthCheck: this.config.serviceHealthCheck,
           fetcher: this.fetcher,
           logger: this.logger,
-          pollIntervalInMs: this.pollIntervalInMs ?? 10000,
+          fallbackPollIntervalInMs: this.pollIntervalInMs ?? 10000,
         }),
       );
     }

package/src/schema-helper/index.ts

@@ -1,3 +1,2 @@
 export * from './resolverMap';
 export * from './addResolversToSchema';
-export * from './error';

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

@@ -9,7 +9,7 @@ import { IntrospectAndCompose } from '..';
 import { mockAllServicesSdlQuerySuccess } from '../../../__tests__/integration/nockMocks';
 import { getTestingSupergraphSdl, wait } from '../../../__tests__/execution-utils';
 import resolvable from '@josephg/resolvable';
-import { Logger } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 
 describe('IntrospectAndCompose', () => {
   beforeEach(nockBeforeEach);

package/src/supergraphManagers/IntrospectAndCompose/index.ts

@@ -3,7 +3,7 @@ import {
   compositionHasErrors,
   ServiceDefinition,
 } from '@apollo/federation';
-import { Logger } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 import { HeadersInit } from 'node-fetch';
 import resolvable from '@josephg/resolvable';
 import {

package/src/supergraphManagers/LegacyFetcher/index.ts

@@ -4,7 +4,7 @@
  * configuration options of the gateway and will be removed in a future release
  * along with those options.
  */
-import { Logger } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 import resolvable from '@josephg/resolvable';
 import {
   SupergraphManager,

package/src/supergraphManagers/LocalCompose/index.ts

@@ -1,5 +1,5 @@
 // TODO(trevor:removeServiceList) the whole file goes away
-import { Logger } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 import {
   composeAndValidate,
   compositionHasErrors,

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

@@ -65,6 +65,7 @@ describe('loadSupergraphSdlFromStorage', () => {
       compositionId: "originalId-1234",
       maxRetries: 1,
       roundRobinSeed: 0,
+      earliestFetchTime: null,
     });
 
     expect(result).toMatchObject({
@@ -88,6 +89,7 @@ describe('loadSupergraphSdlFromStorage', () => {
         compositionId: "originalId-1234",
         maxRetries: 1,
         roundRobinSeed: 0,
+        earliestFetchTime: null,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -388,10 +390,49 @@ describe("loadSupergraphSdlFromUplinks", () => {
       compositionId: "id-1234",
       maxRetries: 5,
       roundRobinSeed: 0,
+      earliestFetchTime: null,
     });
 
     expect(result).toBeNull();
     expect(fetcher).toHaveBeenCalledTimes(1);
   });
+
+  it("Waits the correct time before retrying", async () => {
+    const timeoutSpy = jest.spyOn(global, 'setTimeout');
+
+    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
+    mockSupergraphSdlRequestIfAfter('originalId-1234', mockCloudConfigUrl2).reply(
+      200,
+      JSON.stringify({
+        data: {
+          routerConfig: {
+            __typename: 'RouterConfigResult',
+            id: 'originalId-1234',
+            supergraphSdl: getTestingSupergraphSdl()
+          },
+        },
+      }),
+    );
+    const fetcher = getDefaultFetcher();
+
+    await loadSupergraphSdlFromUplinks({
+      graphRef,
+      apiKey,
+      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
+      errorReportingEndpoint: undefined,
+      fetcher: fetcher,
+      compositionId: "originalId-1234",
+      maxRetries: 1,
+      roundRobinSeed: 0,
+      earliestFetchTime: new Date(Date.now() + 1000),
+    });
+
+    // 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();
+  });
 });
 

package/src/supergraphManagers/UplinkFetcher/index.ts

@@ -1,12 +1,12 @@
 import { fetch } from 'apollo-server-env';
-import { Logger } from 'apollo-server-types';
+import type { Logger } from '@apollo/utils.logger';
 import resolvable from '@josephg/resolvable';
 import { SupergraphManager, SupergraphSdlHookOptions } from '../../config';
 import { SubgraphHealthCheckFunction, SupergraphSdlUpdateFunction } from '../..';
 import { loadSupergraphSdlFromUplinks } from './loadSupergraphSdlFromStorage';
 
 export interface UplinkFetcherOptions {
-  pollIntervalInMs: number;
+  fallbackPollIntervalInMs: number;
   subgraphHealthCheck?: boolean;
   graphRef: string;
   apiKey: string;
@@ -31,6 +31,8 @@ export class UplinkFetcher implements SupergraphManager {
     process.env.APOLLO_OUT_OF_BAND_REPORTER_ENDPOINT ?? undefined;
   private compositionId?: string;
   private fetchCount: number = 0;
+  private minDelayMs: number | null = null;
+  private earliestFetchTime: Date | null = null;
 
   constructor(options: UplinkFetcherOptions) {
     this.config = options;
@@ -46,7 +48,12 @@ export class UplinkFetcher implements SupergraphManager {
 
     let initialSupergraphSdl: string | null = null;
     try {
-      initialSupergraphSdl = await this.updateSupergraphSdl();
+      const result = await this.updateSupergraphSdl();
+      initialSupergraphSdl = result?.supergraphSdl || null;
+      if (result?.minDelaySeconds) {
+        this.minDelayMs = 1000 * result?.minDelaySeconds;
+        this.earliestFetchTime = new Date(Date.now() + this.minDelayMs);
+      }
     } catch (e) {
       this.logUpdateFailure(e);
       throw e;
@@ -83,6 +90,7 @@ export class UplinkFetcher implements SupergraphManager {
       compositionId: this.compositionId ?? null,
       maxRetries: this.config.maxRetries,
       roundRobinSeed: this.fetchCount++,
+      earliestFetchTime: this.earliestFetchTime,
     });
 
     if (!result) {
@@ -91,7 +99,8 @@ export class UplinkFetcher implements SupergraphManager {
       this.compositionId = result.id;
       // the healthCheck fn is only assigned if it's enabled in the config
       await this.healthCheck?.(result.supergraphSdl);
-      return result.supergraphSdl;
+      const { supergraphSdl, minDelaySeconds } = result;
+      return { supergraphSdl, minDelaySeconds };
     }
   }
 
@@ -101,24 +110,34 @@ export class UplinkFetcher implements SupergraphManager {
   }
 
   private poll() {
-    this.timerRef = setTimeout(async () => {
-      if (this.state.phase === 'polling') {
-        const pollingPromise = resolvable();
-
-        this.state.pollingPromise = pollingPromise;
-        try {
-          const maybeNewSupergraphSdl = await this.updateSupergraphSdl();
-          if (maybeNewSupergraphSdl) {
-            this.update?.(maybeNewSupergraphSdl);
+    this.timerRef = setTimeout(
+      async () => {
+        if (this.state.phase === 'polling') {
+          const pollingPromise = resolvable();
+
+          this.state.pollingPromise = pollingPromise;
+          try {
+            const result = await this.updateSupergraphSdl();
+            const maybeNewSupergraphSdl = result?.supergraphSdl || null;
+            if (result?.minDelaySeconds) {
+              this.minDelayMs = 1000 * result?.minDelaySeconds;
+              this.earliestFetchTime = new Date(Date.now() + this.minDelayMs);
+            }
+            if (maybeNewSupergraphSdl) {
+              this.update?.(maybeNewSupergraphSdl);
+            }
+          } catch (e) {
+            this.logUpdateFailure(e);
           }
-        } catch (e) {
-          this.logUpdateFailure(e);
+          pollingPromise.resolve();
         }
-        pollingPromise.resolve();
-      }
 
-      this.poll();
-    }, this.config.pollIntervalInMs);
+        this.poll();
+      },
+      this.minDelayMs
+        ? Math.max(this.minDelayMs, this.config.fallbackPollIntervalInMs)
+        : this.config.fallbackPollIntervalInMs,
+    );
   }
 
   private logUpdateFailure(e: any) {

package/src/supergraphManagers/UplinkFetcher/loadSupergraphSdlFromStorage.ts

@@ -13,6 +13,7 @@ export const SUPERGRAPH_SDL_QUERY = /* GraphQL */`#graphql
       ... on RouterConfigResult {
         id
         supergraphSdl: supergraphSDL
+        minDelaySeconds
       }
       ... on FetchError {
         code
@@ -56,6 +57,7 @@ export async function loadSupergraphSdlFromUplinks({
   compositionId,
   maxRetries,
   roundRobinSeed,
+  earliestFetchTime,
 }: {
   graphRef: string;
   apiKey: string;
@@ -65,6 +67,7 @@ export async function loadSupergraphSdlFromUplinks({
   compositionId: string | null;
   maxRetries: number,
   roundRobinSeed: number,
+  earliestFetchTime: Date | null
 }) : Promise<SupergraphSdlUpdate | null> {
   // This Promise resolves with either an updated supergraph or null if no change.
   // This Promise can reject in the case that none of the retries are successful,
@@ -81,6 +84,10 @@ export async function loadSupergraphSdlFromUplinks({
       }),
     {
       retries: maxRetries,
+      onRetry: async () => {
+        const delayMS = earliestFetchTime ? earliestFetchTime.getTime() - Date.now(): 0;
+        if (delayMS > 0) await new Promise(resolve => setTimeout(resolve, delayMS));
+      }
     },
   );
 
@@ -176,9 +183,10 @@ export async function loadSupergraphSdlFromStorage({
     const {
       id,
       supergraphSdl,
+      minDelaySeconds,
       // messages,
     } = routerConfig;
-    return { id, supergraphSdl: supergraphSdl! };
+    return { id, supergraphSdl: supergraphSdl!, minDelaySeconds };
   } else if (routerConfig.__typename === 'FetchError') {
     // FetchError case
     const { code, message } = routerConfig;

package/dist/schema-helper/error.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLError } from "graphql";
-export declare class GraphQLSchemaValidationError extends Error {
-    errors: ReadonlyArray<GraphQLError>;
-    constructor(errors: ReadonlyArray<GraphQLError>);
-}
-//# sourceMappingURL=error.d.ts.map

package/dist/schema-helper/error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/schema-helper/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,qBAAa,4BAA6B,SAAQ,KAAK;IAClC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC;gBAAnC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC;CAOvD"}

package/dist/schema-helper/error.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphQLSchemaValidationError = void 0;
-class GraphQLSchemaValidationError extends Error {
-    constructor(errors) {
-        super();
-        this.errors = errors;
-        this.name = this.constructor.name;
-        Error.captureStackTrace(this, this.constructor);
-        this.message = errors.map(error => error.message).join("\n\n");
-    }
-}
-exports.GraphQLSchemaValidationError = GraphQLSchemaValidationError;
-//# sourceMappingURL=error.js.map

package/dist/schema-helper/error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/schema-helper/error.ts"],"names":[],"mappings":";;;AAEA,MAAa,4BAA6B,SAAQ,KAAK;IACrD,YAAmB,MAAmC;QACpD,KAAK,EAAE,CAAC;QADS,WAAM,GAAN,MAAM,CAA6B;QAGpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;CACF;AARD,oEAQC"}

package/src/schema-helper/error.ts

@@ -1,11 +0,0 @@
-import { GraphQLError } from "graphql";
-
-export class GraphQLSchemaValidationError extends Error {
-  constructor(public errors: ReadonlyArray<GraphQLError>) {
-    super();
-
-    this.name = this.constructor.name;
-    Error.captureStackTrace(this, this.constructor);
-    this.message = errors.map(error => error.message).join("\n\n");
-  }
-}