@apollo/gateway 0.48.0 → 0.49.0

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

@@ -1,6 +1,7 @@
 import {
   loadSupergraphSdlFromStorage,
-  loadSupergraphSdlFromUplinks
+  loadSupergraphSdlFromUplinks,
+  UplinkFetcherError,
 } from '../loadSupergraphSdlFromStorage';
 import { getDefaultFetcher } from '../../..';
 import {
@@ -62,7 +63,9 @@ describe('loadSupergraphSdlFromStorage', () => {
       errorReportingEndpoint: undefined,
       fetcher,
       compositionId: "originalId-1234",
-      maxRetries: 1
+      maxRetries: 1,
+      roundRobinSeed: 0,
+      earliestFetchTime: null,
     });
 
     expect(result).toMatchObject({
@@ -84,10 +87,14 @@ describe('loadSupergraphSdlFromStorage', () => {
         errorReportingEndpoint: undefined,
         fetcher,
         compositionId: "originalId-1234",
-        maxRetries: 1
+        maxRetries: 1,
+        roundRobinSeed: 0,
+        earliestFetchTime: null,
       }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"An error occurred while fetching your schema from Apollo: 500 Internal Server Error"`,
+    ).rejects.toThrowError(
+      new UplinkFetcherError(
+        "An error occurred while fetching your schema from Apollo: 500 Internal Server Error",
+      )
     );
   })
 
@@ -105,8 +112,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 200 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected token I in JSON at position 0"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 200 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected token I in JSON at position 0"
+        )
       );
     });
 
@@ -129,7 +138,9 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowError(message);
+      ).rejects.toThrowError(
+        new UplinkFetcherError(`An error occurred while fetching your schema from Apollo: \n${message}`)
+      );
     });
 
     it("throws on non-OK status codes when `errors` isn't present in a JSON response", async () => {
@@ -146,8 +157,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 500 Internal Server Error"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 500 Internal Server Error"
+        )
       );
     });
 
@@ -166,8 +179,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input",
+        )
       );
     });
 
@@ -185,8 +200,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input",
+        )
       );
     });
 
@@ -204,8 +221,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 413 Payload Too Large"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 413 Payload Too Large",
+        )
       );
     });
 
@@ -223,8 +242,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 422 Unprocessable Entity"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 422 Unprocessable Entity",
+        )
       );
     });
 
@@ -242,8 +263,10 @@ describe('loadSupergraphSdlFromStorage', () => {
           fetcher,
           compositionId: null,
         }),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"An error occurred while fetching your schema from Apollo: 408 Request Timeout"`,
+      ).rejects.toThrowError(
+        new UplinkFetcherError(
+          "An error occurred while fetching your schema from Apollo: 408 Request Timeout",
+        )
       );
     });
   });
@@ -263,8 +286,10 @@ describe('loadSupergraphSdlFromStorage', () => {
         fetcher,
         compositionId: null,
       }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"An error occurred while fetching your schema from Apollo: 504 Gateway Timeout"`,
+    ).rejects.toThrowError(
+      new UplinkFetcherError(
+        "An error occurred while fetching your schema from Apollo: 504 Gateway Timeout",
+      )
     );
   });
 
@@ -282,8 +307,10 @@ describe('loadSupergraphSdlFromStorage', () => {
         fetcher,
         compositionId: null,
       }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"An error occurred while fetching your schema from Apollo: request to https://example1.cloud-config-url.com/cloudconfig/ failed, reason: no response"`,
+    ).rejects.toThrowError(
+      new UplinkFetcherError(
+        "An error occurred while fetching your schema from Apollo: request to https://example1.cloud-config-url.com/cloudconfig/ failed, reason: no response",
+      )
     );
   });
 
@@ -301,8 +328,10 @@ describe('loadSupergraphSdlFromStorage', () => {
         fetcher,
         compositionId: null,
       }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"An error occurred while fetching your schema from Apollo: 502 Bad Gateway"`,
+    ).rejects.toThrowError(
+      new UplinkFetcherError(
+        "An error occurred while fetching your schema from Apollo: 502 Bad Gateway",
+      )
     );
   });
 
@@ -320,8 +349,10 @@ describe('loadSupergraphSdlFromStorage', () => {
         fetcher,
         compositionId: null,
       }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"An error occurred while fetching your schema from Apollo: 503 Service Unavailable"`,
+    ).rejects.toThrowError(
+      new UplinkFetcherError(
+        "An error occurred while fetching your schema from Apollo: 503 Service Unavailable",
+      )
     );
   });
 
@@ -341,3 +372,67 @@ describe('loadSupergraphSdlFromStorage', () => {
   });
 });
 
+
+describe("loadSupergraphSdlFromUplinks", () => {
+  beforeEach(nockBeforeEach);
+  afterEach(nockAfterEach);
+
+  it("doesn't retry in the unchanged / null case", async () => {
+    mockSupergraphSdlRequestIfAfterUnchanged("id-1234", mockCloudConfigUrl1);
+
+    const fetcher = jest.fn(getDefaultFetcher());
+    const result = await loadSupergraphSdlFromUplinks({
+      graphRef,
+      apiKey,
+      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
+      errorReportingEndpoint: mockOutOfBandReporterUrl,
+      fetcher: fetcher as any,
+      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

@@ -6,7 +6,7 @@ import { SubgraphHealthCheckFunction, SupergraphSdlUpdateFunction } from '../..'
 import { loadSupergraphSdlFromUplinks } from './loadSupergraphSdlFromStorage';
 
 export interface UplinkFetcherOptions {
-  pollIntervalInMs: number;
+  fallbackPollIntervalInMs: number;
   subgraphHealthCheck?: boolean;
   graphRef: string;
   apiKey: string;
@@ -30,6 +30,9 @@ export class UplinkFetcher implements SupergraphManager {
   private errorReportingEndpoint: string | undefined =
     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;
@@ -45,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;
@@ -81,6 +89,8 @@ export class UplinkFetcher implements SupergraphManager {
       fetcher: this.config.fetcher,
       compositionId: this.compositionId ?? null,
       maxRetries: this.config.maxRetries,
+      roundRobinSeed: this.fetchCount++,
+      earliestFetchTime: this.earliestFetchTime,
     });
 
     if (!result) {
@@ -89,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 };
     }
   }
 
@@ -99,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

@@ -1,5 +1,6 @@
 import { fetch, Response, Request } from 'apollo-server-env';
 import { GraphQLError } from 'graphql';
+import retry from 'async-retry';
 import { SupergraphSdlUpdate } from '../../config';
 import { submitOutOfBandReportIfConfigured } from './outOfBandReporter';
 import { SupergraphSdlQuery } from '../../__generated__/graphqlTypes';
@@ -12,6 +13,7 @@ export const SUPERGRAPH_SDL_QUERY = /* GraphQL */`#graphql
       ... on RouterConfigResult {
         id
         supergraphSdl: supergraphSDL
+        minDelaySeconds
       }
       ... on FetchError {
         code
@@ -39,7 +41,12 @@ const { name, version } = require('../../../package.json');
 
 const fetchErrorMsg = "An error occurred while fetching your schema from Apollo: ";
 
-let fetchCounter = 0;
+export class UplinkFetcherError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'UplinkFetcherError';
+  }
+}
 
 export async function loadSupergraphSdlFromUplinks({
   graphRef,
@@ -49,6 +56,8 @@ export async function loadSupergraphSdlFromUplinks({
   fetcher,
   compositionId,
   maxRetries,
+  roundRobinSeed,
+  earliestFetchTime,
 }: {
   graphRef: string;
   apiKey: string;
@@ -56,29 +65,32 @@ export async function loadSupergraphSdlFromUplinks({
   errorReportingEndpoint: string | undefined,
   fetcher: typeof fetch;
   compositionId: string | null;
-  maxRetries: number
+  maxRetries: number,
+  roundRobinSeed: number,
+  earliestFetchTime: Date | null
 }) : Promise<SupergraphSdlUpdate | null> {
-  let retries = 0;
-  let lastException = null;
-  let result: SupergraphSdlUpdate | null = null;
-  while (retries++ <= maxRetries && result == null) {
-    try {
-      result = await loadSupergraphSdlFromStorage({
+  // 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,
+  // in which case it will reject with the most frequently encountered error.
+  return retry(
+    () =>
+      loadSupergraphSdlFromStorage({
         graphRef,
         apiKey,
-        endpoint: endpoints[fetchCounter++ % endpoints.length],
+        endpoint: endpoints[roundRobinSeed++ % endpoints.length],
         errorReportingEndpoint,
         fetcher,
-        compositionId
-      });
-    } catch (e) {
-      lastException = e;
-    }
-  }
-  if (result === null && lastException !== null) {
-    throw lastException;
-  }
-  return result;
+        compositionId,
+      }),
+    {
+      retries: maxRetries,
+      onRetry: async () => {
+        const delayMS = earliestFetchTime ? earliestFetchTime.getTime() - Date.now(): 0;
+        if (delayMS > 0) await new Promise(resolve => setTimeout(resolve, delayMS));
+      }
+    },
+  );
+
 }
 
 export async function loadSupergraphSdlFromStorage({
@@ -132,7 +144,7 @@ export async function loadSupergraphSdlFromStorage({
       fetcher,
     });
 
-    throw new Error(fetchErrorMsg + (e.message ?? e));
+    throw new UplinkFetcherError(fetchErrorMsg + (e.message ?? e));
   }
 
   const endTime = new Date();
@@ -143,11 +155,11 @@ export async function loadSupergraphSdlFromStorage({
       response = await result.json();
     } catch (e) {
       // Bad response
-      throw new Error(fetchErrorMsg + result.status + ' ' + e.message ?? e);
+      throw new UplinkFetcherError(fetchErrorMsg + result.status + ' ' + e.message ?? e);
     }
 
     if ('errors' in response) {
-      throw new Error(
+      throw new UplinkFetcherError(
         [fetchErrorMsg, ...response.errors.map((error) => error.message)].join(
           '\n',
         ),
@@ -155,7 +167,7 @@ export async function loadSupergraphSdlFromStorage({
     }
   } else {
     await submitOutOfBandReportIfConfigured({
-      error: new Error(fetchErrorMsg + result.status + ' ' + result.statusText),
+      error: new UplinkFetcherError(fetchErrorMsg + result.status + ' ' + result.statusText),
       request,
       endpoint: errorReportingEndpoint,
       response: result,
@@ -163,7 +175,7 @@ export async function loadSupergraphSdlFromStorage({
       endedAt: endTime,
       fetcher,
     });
-    throw new Error(fetchErrorMsg + result.status + ' ' + result.statusText);
+    throw new UplinkFetcherError(fetchErrorMsg + result.status + ' ' + result.statusText);
   }
 
   const { routerConfig } = response.data;
@@ -171,16 +183,17 @@ 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;
-    throw new Error(`${code}: ${message}`);
+    throw new UplinkFetcherError(`${code}: ${message}`);
   } else if (routerConfig.__typename === 'Unchanged') {
     return null;
   } else {
-    throw new Error('Programming error: unhandled response failure');
+    throw new UplinkFetcherError('Programming error: unhandled response failure');
   }
 }

package/src/supergraphManagers/index.ts

@@ -2,3 +2,4 @@ export { LocalCompose } from './LocalCompose';
 export { LegacyFetcher } from './LegacyFetcher';
 export { IntrospectAndCompose } from './IntrospectAndCompose';
 export { UplinkFetcher } from './UplinkFetcher';
+export { UplinkFetcherError } from './UplinkFetcher/loadSupergraphSdlFromStorage'