@apollo/gateway 2.0.0-alpha.2 → 2.0.0-alpha.3

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

@@ -7,7 +7,9 @@ import {
   mockSdlQuerySuccess,
   mockSupergraphSdlRequestSuccess,
   mockApolloConfig,
-  mockCloudConfigUrl,
+  mockCloudConfigUrl1,
+  mockCloudConfigUrl2,
+  mockCloudConfigUrl3,
 } from './nockMocks';
 import { getTestingSupergraphSdl } from '../execution-utils';
 import { MockService } from './networkRequests.test';
@@ -111,7 +113,26 @@ describe('gateway configuration warnings', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+    });
+
+    await gateway.load(mockApolloConfig);
+
+    await gateway.stop();
+
+    expect(logger.warn).not.toHaveBeenCalledWith(
+      expect.stringMatching(
+        /A local gateway configuration is overriding a managed federation configuration/,
+      ),
+    );
+  });
+
+  it('deprecated conflicting configurations are not warned about when absent', async () => {
+    mockSupergraphSdlRequestSuccess();
+
+    gateway = new ApolloGateway({
+      logger,
+      schemaConfigDeliveryEndpoint: mockCloudConfigUrl1,
     });
 
     await gateway.load(mockApolloConfig);
@@ -301,6 +322,25 @@ describe('gateway config / env behavior', () => {
   });
 
   describe('schema config delivery endpoint configuration', () => {
+    it('A code config overrides the env variable', async () => {
+      cleanUp = mockedEnv({
+        APOLLO_SCHEMA_CONFIG_DELIVERY_ENDPOINT: 'env-config',
+      });
+
+      gateway = new ApolloGateway({
+        logger,
+        uplinkEndpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2, mockCloudConfigUrl3],
+      });
+
+      expect(gateway['uplinkEndpoints']).toEqual(
+        [mockCloudConfigUrl1, mockCloudConfigUrl2, mockCloudConfigUrl3],
+      );
+
+      gateway = null;
+    });
+  });
+
+  describe('deprecated schema config delivery endpoint configuration', () => {
     it('A code config overrides the env variable', async () => {
       cleanUp = mockedEnv({
         APOLLO_SCHEMA_CONFIG_DELIVERY_ENDPOINT: 'env-config',
@@ -311,8 +351,8 @@ describe('gateway config / env behavior', () => {
         schemaConfigDeliveryEndpoint: 'code-config',
       });
 
-      expect(gateway['schemaConfigDeliveryEndpoint']).toEqual(
-        'code-config',
+      expect(gateway['uplinkEndpoints']).toEqual(
+        ['code-config'],
       );
 
       gateway = null;

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,7 @@ import {
   mockSupergraphSdlRequestSuccess,
   mockSupergraphSdlRequest,
   mockApolloConfig,
-  mockCloudConfigUrl,
+  mockCloudConfigUrl1,
   mockSupergraphSdlRequestIfAfter,
   mockSupergraphSdlRequestSuccessIfAfter,
 } from './nockMocks';
@@ -26,6 +25,7 @@ import {
   reviews,
 } from 'apollo-federation-integration-testsuite';
 import { getTestingSupergraphSdl } from '../execution-utils';
+import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
 
 type GenericFunction = (...args: unknown[]) => unknown;
 export interface MockService {
@@ -63,7 +63,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();
@@ -79,9 +79,8 @@ beforeEach(() => {
 });
 
 afterEach(async () => {
-  expect(nock.isDone()).toBeTruthy();
-  nock.cleanAll();
-  nock.restore();
+  nockAfterEach();
+
   if (gateway) {
     await gateway.stop();
     gateway = null;
@@ -106,7 +105,7 @@ it('Fetches Supergraph SDL from remote storage', async () => {
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
 
   await gateway.load(mockApolloConfig);
@@ -116,7 +115,7 @@ it('Fetches Supergraph SDL from remote storage', async () => {
 
 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();
 
@@ -150,7 +149,7 @@ it('Updates Supergraph SDL from remote storage', async () => {
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
   // eslint-disable-next-line
   // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -170,7 +169,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
 
     await expect(
@@ -198,7 +198,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
 
     // eslint-disable-next-line
@@ -232,7 +233,8 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
+      uplinkMaxRetries: 0
     });
     // eslint-disable-next-line
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -270,7 +272,7 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
     });
     // eslint-disable-next-line
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -301,7 +303,7 @@ describe('Supergraph SDL update failures', () => {
 
     gateway = new ApolloGateway({
       logger,
-      schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+      uplinkEndpoints: [mockCloudConfigUrl1],
     });
     // eslint-disable-next-line
     // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -346,7 +348,7 @@ it('Rollsback to a previous schema when triggered', async () => {
 
   gateway = new ApolloGateway({
     logger,
-    schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+    uplinkEndpoints: [mockCloudConfigUrl1],
   });
   // eslint-disable-next-line
   // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -432,7 +434,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // eslint-disable-next-line
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -456,7 +458,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.
@@ -517,7 +519,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
@@ -561,7 +563,7 @@ describe('Downstream service health checks', () => {
       gateway = new ApolloGateway({
         serviceHealthCheck: true,
         logger,
-        schemaConfigDeliveryEndpoint: mockCloudConfigUrl,
+        uplinkEndpoints: [mockCloudConfigUrl1],
       });
       // eslint-disable-next-line
       // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here

package/src/__tests__/integration/nockMocks.ts

@@ -64,14 +64,20 @@ 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 mockSupergraphSdlRequestIfAfter(ifAfter: string | null) {
-  return gatewayNock(mockCloudConfigUrl).post('/', {
+export function mockSupergraphSdlRequestIfAfter(ifAfter: string | null, url: string = mockCloudConfigUrl1) {
+  return gatewayNock(url).post('/', {
     query: SUPERGRAPH_SDL_QUERY,
     variables: {
       ref: graphRef,
@@ -81,8 +87,8 @@ export function mockSupergraphSdlRequestIfAfter(ifAfter: string | null) {
   });
 }
 
-export function mockSupergraphSdlRequest(ifAfter: string | null = null) {
-  return mockSupergraphSdlRequestIfAfter(ifAfter);
+export function mockSupergraphSdlRequest(ifAfter: string | null = null, url: string = mockCloudConfigUrl1) {
+  return mockSupergraphSdlRequestIfAfter(ifAfter, url);
 }
 
 export function mockSupergraphSdlRequestSuccessIfAfter(