@apollo/gateway 0.43.0 → 0.45.0-alpha.0

package/src/__tests__/integration/networkRequests.test.ts

@@ -1,4 +1,3 @@
-import nock from 'nock';
 import gql from 'graphql-tag';
 import { DocumentNode, GraphQLObjectType, GraphQLSchema } from 'graphql';
 import mockedEnv from 'mocked-env';
@@ -12,7 +11,9 @@ import {
   mockSupergraphSdlRequestSuccess,
   mockSupergraphSdlRequest,
   mockApolloConfig,
-  mockCloudConfigUrl,
+  mockCloudConfigUrl1,
+  mockSupergraphSdlRequestIfAfter,
+  mockSupergraphSdlRequestSuccessIfAfter,
 } from './nockMocks';
 import {
   accounts,
@@ -24,6 +25,7 @@ import {
   reviews,
 } from 'apollo-federation-integration-testsuite';
 import { getTestingSupergraphSdl } from '../execution-utils';
+import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
 
 export interface MockService {
   name: string;
@@ -60,7 +62,7 @@ let gateway: ApolloGateway | null = null;
 let cleanUp: (() => void) | null = null;
 
 beforeEach(() => {
-  if (!nock.isActive()) nock.activate();
+  nockBeforeEach();
 
   const warn = jest.fn();
   const debug = jest.fn();
@@ -76,9 +78,8 @@ beforeEach(() => {
 });
 
 afterEach(async () => {
-  expect(nock.isDone()).toBeTruthy();
-  nock.cleanAll();
-  nock.restore();
+  nockAfterEach();
+
   if (gateway) {
     await gateway.stop();
     gateway = null;
@@ -98,13 +99,12 @@ it('Queries remote endpoints for their SDLs', async () => {
   expect(gateway.schema!.getType('User')!.description).toBe('This is my User');
 });
 
-// TODO(trevor:cloudconfig): Remove all usages of the experimental config option
 it('Fetches Supergraph SDL from remote storage', async () => {
   mockSupergraphSdlRequestSuccess();
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
 
   await gateway.load(mockApolloConfig);
@@ -112,10 +112,9 @@ it('Fetches Supergraph SDL from remote storage', async () => {
   expect(gateway.schema?.getType('User')).toBeTruthy();
 });
 
-// TODO(trevor:cloudconfig): This test should evolve to demonstrate overriding the default in the future
 it('Fetches Supergraph SDL from remote storage using a configured env variable', async () => {
   cleanUp = mockedEnv({
-    APOLLO_SCHEMA_CONFIG_DELIVERY_ENDPOINT: mockCloudConfigUrl,
+    APOLLO_SCHEMA_CONFIG_DELIVERY_ENDPOINT: mockCloudConfigUrl1,
   });
   mockSupergraphSdlRequestSuccess();
 
@@ -130,7 +129,11 @@ it('Fetches Supergraph SDL from remote storage using a configured env variable',
 
 it('Updates Supergraph SDL from remote storage', async () => {
   mockSupergraphSdlRequestSuccess();
-  mockSupergraphSdlRequestSuccess(getTestingSupergraphSdl(fixturesWithUpdate), 'updatedId-5678');
+  mockSupergraphSdlRequestSuccessIfAfter(
+    'originalId-1234',
+    'updatedId-5678',
+    getTestingSupergraphSdl(fixturesWithUpdate),
+  );
 
   // This test is only interested in the second time the gateway notifies of an
   // update, since the first happens on load.
@@ -145,11 +148,11 @@ it('Updates Supergraph SDL from remote storage', async () => {
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
   // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
   gateway.experimental_pollInterval = 100;
-  gateway.onSchemaChange(schemaChangeCallback);
+  gateway.onSchemaLoadOrUpdate(schemaChangeCallback);
 
   await gateway.load(mockApolloConfig);
   expect(gateway['compositionId']).toMatchInlineSnapshot(`"originalId-1234"`);
@@ -164,7 +167,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
 
     await expect(
@@ -183,7 +187,7 @@ describe('Supergraph SDL update failures', () => {
 
   it('Handles arbitrary fetch failures (non 200 response)', async () => {
     mockSupergraphSdlRequestSuccess();
-    mockSupergraphSdlRequest().reply(500);
+    mockSupergraphSdlRequestIfAfter('originalId-1234').reply(500);
 
     // Spy on logger.error so we can just await once it's been called
     let errorLogged: Function;
@@ -192,7 +196,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
 
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -208,7 +213,7 @@ describe('Supergraph SDL update failures', () => {
 
   it('Handles GraphQL errors', async () => {
     mockSupergraphSdlRequestSuccess();
-    mockSupergraphSdlRequest().reply(200, {
+    mockSupergraphSdlRequest('originalId-1234').reply(200, {
       errors: [
         {
           message: 'Cannot query field "fail" on type "Query".',
@@ -225,7 +230,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
     gateway.experimental_pollInterval = 100;
@@ -242,7 +248,7 @@ describe('Supergraph SDL update failures', () => {
 
   it("Doesn't update and logs on receiving unparseable Supergraph SDL", async () => {
     mockSupergraphSdlRequestSuccess();
-    mockSupergraphSdlRequest().reply(
+    mockSupergraphSdlRequestIfAfter('originalId-1234').reply(
       200,
       JSON.stringify({
         data: {
@@ -262,7 +268,7 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
     });
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
     gateway.experimental_pollInterval = 100;
@@ -292,7 +298,7 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
     });
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
     gateway.experimental_pollInterval = 100;
@@ -314,8 +320,12 @@ describe('Supergraph SDL update failures', () => {
 it('Rollsback to a previous schema when triggered', async () => {
   // Init
   mockSupergraphSdlRequestSuccess();
-  mockSupergraphSdlRequestSuccess(getTestingSupergraphSdl(fixturesWithUpdate), 'updatedId-5678');
-  mockSupergraphSdlRequestSuccess();
+  mockSupergraphSdlRequestSuccessIfAfter(
+    'originalId-1234',
+    'updatedId-5678',
+    getTestingSupergraphSdl(fixturesWithUpdate),
+  );
+  mockSupergraphSdlRequestSuccessIfAfter('updatedId-5678');
 
   let firstResolve: Function;
   let secondResolve: Function;
@@ -332,7 +342,7 @@ it('Rollsback to a previous schema when triggered', async () => {
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
   // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
   gateway.experimental_pollInterval = 100;
@@ -416,7 +426,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
       gateway.experimental_pollInterval = 100;
@@ -439,7 +449,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
 
       // This is the ideal, but our version of Jest has a bug with printing error snapshots.
@@ -480,9 +490,10 @@ describe('Downstream service health checks', () => {
       mockAllServicesHealthCheckSuccess();
 
       // Update
-      mockSupergraphSdlRequestSuccess(
-        getTestingSupergraphSdl(fixturesWithUpdate),
+      mockSupergraphSdlRequestSuccessIfAfter(
+        'originalId-1234',
         'updatedId-5678',
+        getTestingSupergraphSdl(fixturesWithUpdate),
       );
       mockAllServicesHealthCheckSuccess();
 
@@ -498,7 +509,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
       gateway.experimental_pollInterval = 100;
@@ -523,9 +534,10 @@ describe('Downstream service health checks', () => {
       mockAllServicesHealthCheckSuccess();
 
       // Update (with one health check failure)
-      mockSupergraphSdlRequestSuccess(
-        getTestingSupergraphSdl(fixturesWithUpdate),
+      mockSupergraphSdlRequestSuccessIfAfter(
+        'originalId-1234',
         'updatedId-5678',
+        getTestingSupergraphSdl(fixturesWithUpdate),
       );
       mockServiceHealthCheck(accounts).reply(500);
       mockServiceHealthCheckSuccess(books);
@@ -540,7 +552,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
       gateway.experimental_pollInterval = 100;

package/src/__tests__/integration/nockMocks.ts

@@ -64,27 +64,42 @@ function gatewayNock(url: Parameters<typeof nock>[0]): nock.Scope {
   });
 }
 
-export const mockCloudConfigUrl =
-  'https://example.cloud-config-url.com/cloudconfig/';
+export const mockCloudConfigUrl1 =
+  'https://example1.cloud-config-url.com/cloudconfig/';
+
+export const mockCloudConfigUrl2 =
+  'https://example2.cloud-config-url.com/cloudconfig/';
+
+export const mockCloudConfigUrl3 =
+  'https://example3.cloud-config-url.com/cloudconfig/';
 
 export const mockOutOfBandReporterUrl =
   'https://example.outofbandreporter.com/monitoring/';
 
-export function mockSupergraphSdlRequest() {
-  return gatewayNock(mockCloudConfigUrl).post('/', {
+export function mockSupergraphSdlRequestIfAfter(ifAfter: string | null, url: string = mockCloudConfigUrl1) {
+  return gatewayNock(url).post('/', {
     query: SUPERGRAPH_SDL_QUERY,
     variables: {
       ref: graphRef,
       apiKey: apiKey,
+      ifAfterId: ifAfter,
     },
   });
 }
 
-export function mockSupergraphSdlRequestSuccess(
-  supergraphSdl = getTestingSupergraphSdl(),
-  id = 'originalId-1234',
+export function mockSupergraphSdlRequest(ifAfter: string | null = null, url: string = mockCloudConfigUrl1) {
+  return mockSupergraphSdlRequestIfAfter(ifAfter, url);
+}
+
+export function mockSupergraphSdlRequestSuccessIfAfter(
+  ifAfter: string | null = null,
+  id: string = 'originalId-1234',
+  supergraphSdl: string = getTestingSupergraphSdl(),
 ) {
-  return mockSupergraphSdlRequest().reply(
+  if (supergraphSdl == null) {
+    supergraphSdl = getTestingSupergraphSdl();
+  }
+  return mockSupergraphSdlRequestIfAfter(ifAfter).reply(
     200,
     JSON.stringify({
       data: {
@@ -98,6 +113,25 @@ export function mockSupergraphSdlRequestSuccess(
   );
 }
 
+export function mockSupergraphSdlRequestIfAfterUnchanged(
+    ifAfter: string | null = null,
+) {
+  return mockSupergraphSdlRequestIfAfter(ifAfter).reply(
+      200,
+      JSON.stringify({
+        data: {
+          routerConfig: {
+            __typename: 'Unchanged',
+          },
+        },
+      }),
+  );
+}
+
+export function mockSupergraphSdlRequestSuccess() {
+  return mockSupergraphSdlRequestSuccessIfAfter(null);
+}
+
 export function mockOutOfBandReportRequest() {
   return gatewayNock(mockOutOfBandReporterUrl).post('/', () => true);
 }