@apollo/gateway 2.0.0-alpha.0 → 2.0.0-alpha.4

package/src/__tests__/execution-utils.ts

@@ -2,11 +2,8 @@ import {
   GraphQLSchemaValidationError,
   GraphQLSchemaModule,
   GraphQLResolverMap,
-} from 'apollo-graphql';
+} from '../schema-helper';
 import { GraphQLRequest, GraphQLExecutionResult, Logger } from 'apollo-server-types';
-import {
-  ServiceDefinition,
-} from '@apollo/federation';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import {
   executeQueryPlan,
@@ -20,7 +17,7 @@ import { queryPlanSerializer, astSerializer } from 'apollo-federation-integratio
 import gql from 'graphql-tag';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { composeServices } from '@apollo/composition';
-import { buildSchema, operationFromDocument } from '@apollo/federation-internals';
+import { buildSchema, operationFromDocument, ServiceDefinition } from '@apollo/federation-internals';
 
 const prettyFormat = require('pretty-format');
 
@@ -67,6 +64,7 @@ export async function execute(
   const result = await executeQueryPlan(
     queryPlan,
     serviceMap,
+     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
      // @ts-ignore
     {
       cache: undefined as any,
@@ -111,8 +109,8 @@ export function getTestingSupergraphSdl(services: typeof fixtures = fixtures) {
   throw new Error(`Testing fixtures don't compose properly!\nCauses:\n${compositionResult.errors.join('\n\n')}`);
 }
 
-export function wait(ms: number) {
-  return new Promise(r => setTimeout(r, ms));
+export function wait(ms: number, toResolveTo?: any) {
+  return new Promise((r) => setTimeout(() => r(toResolveTo), ms));
 }
 
 export function printPlan(queryPlan: QueryPlan): string {

package/src/__tests__/gateway/buildService.test.ts

@@ -1,4 +1,4 @@
-import { fetch } from '../../__mocks__/apollo-server-env';
+import { fetch } from '../../__mocks__/make-fetch-happen-fetcher';
 import { ApolloServerBase as ApolloServer } from 'apollo-server-core';
 
 import { RemoteGraphQLDataSource } from '../../datasources/RemoteGraphQLDataSource';
@@ -218,7 +218,7 @@ it('does not share service definition cache between gateways', async () => {
           url: 'https://api.example.com/repeat',
         },
       ],
-      experimental_didUpdateComposition: updateObserver,
+      experimental_didUpdateSupergraph: updateObserver,
     });
 
     await gateway.load();
@@ -237,7 +237,7 @@ it('does not share service definition cache between gateways', async () => {
           url: 'https://api.example.com/repeat',
         },
       ],
-      experimental_didUpdateComposition: updateObserver,
+      experimental_didUpdateSupergraph: updateObserver,
     });
 
     await gateway.load();

package/src/__tests__/gateway/endToEnd.test.ts

@@ -1,10 +1,10 @@
-import { GraphQLSchemaModule } from 'apollo-graphql';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import { ApolloServer } from 'apollo-server';
 import fetch from 'node-fetch';
 import { ApolloGateway } from '../..';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { ApolloServerPluginInlineTrace } from 'apollo-server-core';
+import { GraphQLSchemaModule } from '../../schema-helper';
 
 async function startFederatedServer(modules: GraphQLSchemaModule[]) {
   const schema = buildSubgraphSchema(modules);

package/src/__tests__/gateway/executor.test.ts

@@ -1,8 +1,8 @@
+import { fetch } from '../../__mocks__/make-fetch-happen-fetcher';
 import gql from 'graphql-tag';
 import { ApolloGateway } from '../../';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { Logger } from 'apollo-server-types';
-import { fetch } from '../../__mocks__/apollo-server-env';
 
 let logger: {
   warn: jest.MockedFunction<Logger['warn']>,
@@ -38,6 +38,7 @@ describe('ApolloGateway executor', () => {
       }
     `;
 
+     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
      // @ts-ignore
     const { errors } = await executor({
       source,
@@ -73,6 +74,7 @@ describe('ApolloGateway executor', () => {
       }
     `;
 
+     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
      // @ts-ignore
     const { errors, data } = await executor({
       source,

package/src/__tests__/gateway/lifecycle-hooks.test.ts

@@ -1,8 +1,10 @@
 import gql from 'graphql-tag';
 import { ApolloGateway } from '../..';
 import {
+  DynamicGatewayConfig,
   Experimental_DidResolveQueryPlanCallback,
   Experimental_UpdateServiceDefinitions,
+  ServiceDefinitionUpdate,
 } from '../../config';
 import {
   product,
@@ -11,8 +13,11 @@ import {
   accounts,
   books,
   documents,
+  fixtures,
+  fixturesWithUpdate,
 } from 'apollo-federation-integration-testsuite';
 import { Logger } from 'apollo-server-types';
+import resolvable from '@josephg/resolvable';
 
 // The order of this was specified to preserve existing test coverage. Typically
 // we would just import and use the `fixtures` array.
@@ -47,16 +52,14 @@ beforeEach(() => {
 
 describe('lifecycle hooks', () => {
   it('uses updateServiceDefinitions override', async () => {
-    const experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions = jest.fn(
-      async () => {
+    const experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions =
+      jest.fn(async () => {
         return { serviceDefinitions, isNewSchema: true };
-      },
-    );
+      });
 
     const gateway = new ApolloGateway({
       serviceList: serviceDefinitions,
       experimental_updateServiceDefinitions,
-      experimental_didUpdateComposition: jest.fn(),
       logger,
     });
 
@@ -67,61 +70,7 @@ describe('lifecycle hooks', () => {
     await gateway.stop();
   });
 
-  it('calls experimental_didFailComposition with a bad config', async () => {
-    const experimental_didFailComposition = jest.fn();
-
-    // Creating 2 subservices that clearly cannot composed.
-    const s1 = {
-      name: 'S1',
-      url: 'http://S1',
-      typeDefs: gql`
-        type T {
-          a: Int
-        }
-      `
-    };
-
-    const s2 = {
-      name: 'S2',
-      url: 'http://S2',
-      typeDefs: gql`
-        type T {
-          a: String
-        }
-      `
-    };
-
-
-    const gateway = new ApolloGateway({
-      async experimental_updateServiceDefinitions() {
-        return {
-          serviceDefinitions: [s1, s2],
-          compositionMetadata: {
-            formatVersion: 1,
-            id: 'abc',
-            implementingServiceLocations: [],
-            schemaHash: 'abc',
-          },
-          isNewSchema: true,
-        };
-      },
-      serviceList: [],
-      experimental_didFailComposition,
-      logger,
-    });
-
-    await expect(gateway.load()).rejects.toThrowError("A valid schema couldn't be composed");
-
-    const callbackArgs = experimental_didFailComposition.mock.calls[0][0];
-    expect(callbackArgs.serviceList).toHaveLength(2);
-    expect(callbackArgs.errors[0]).toMatchInlineSnapshot(
-      `[GraphQLError: Field "T.a" has incompatible types accross subgraphs: it has type "Int" in subgraph "S1" but type "String" in subgraph "S2"]`,
-    );
-    expect(callbackArgs.compositionMetadata.id).toEqual('abc');
-    expect(experimental_didFailComposition).toBeCalled();
-  });
-
-  it('calls experimental_didUpdateComposition on schema update', async () => {
+  it('calls experimental_didUpdateSupergraph on schema update', async () => {
     const compositionMetadata = {
       formatVersion: 1,
       id: 'abc',
@@ -129,81 +78,73 @@ describe('lifecycle hooks', () => {
       schemaHash: 'hash1',
     };
 
-    const update: Experimental_UpdateServiceDefinitions = async () => ({
-      serviceDefinitions,
-      isNewSchema: true,
-      compositionMetadata: {
-        ...compositionMetadata,
-        id: '123',
-        schemaHash: 'hash2',
-      },
-    });
-
-    // This is the simplest way I could find to achieve mocked functions that leverage our types
-    const mockUpdate = jest.fn(update);
-
-    // We want to return a different composition across two ticks, so we mock it
-    // slightly differenty
-    mockUpdate.mockImplementationOnce(async () => {
-      const services = serviceDefinitions.filter(s => s.name !== 'books');
-      return {
-        serviceDefinitions: [
-          ...services,
-          {
-            name: 'book',
-            typeDefs: books.typeDefs,
-            url: 'http://localhost:32542',
+    const mockUpdate = jest
+      .fn<Promise<ServiceDefinitionUpdate>, [config: DynamicGatewayConfig]>()
+      .mockImplementationOnce(async () => {
+        return {
+          serviceDefinitions: fixtures,
+          isNewSchema: true,
+          compositionMetadata: {
+            ...compositionMetadata,
+            id: '123',
+            schemaHash: 'hash2',
           },
-        ],
-        isNewSchema: true,
-        compositionMetadata,
-      };
-    });
+        };
+      })
+      // We want to return a different composition across two ticks, so we mock it
+      // slightly differently
+      .mockImplementationOnce(async () => {
+        return {
+          serviceDefinitions: fixturesWithUpdate,
+          isNewSchema: true,
+          compositionMetadata,
+        };
+      });
 
     const mockDidUpdate = jest.fn();
 
     const gateway = new ApolloGateway({
       experimental_updateServiceDefinitions: mockUpdate,
-      experimental_didUpdateComposition: mockDidUpdate,
+      experimental_didUpdateSupergraph: mockDidUpdate,
       logger,
     });
-    // @ts-ignore for testing purposes, a short pollInterval is ideal so we'll override here
-    gateway.experimental_pollInterval = 100;
+    // for testing purposes, a short pollInterval is ideal so we'll override here
+    gateway['pollIntervalInMs'] = 100;
 
-    let resolve1: Function;
-    let resolve2: Function;
-    const schemaChangeBlocker1 = new Promise(res => (resolve1 = res));
-    const schemaChangeBlocker2 = new Promise(res => (resolve2 = res));
+    const schemaChangeBlocker1 = resolvable();
+    const schemaChangeBlocker2 = resolvable();
 
-    gateway.onSchemaChange(
+    gateway.onSchemaLoadOrUpdate(
       jest
         .fn()
-        .mockImplementationOnce(() => resolve1())
-        .mockImplementationOnce(() => resolve2()),
+        .mockImplementationOnce(() => schemaChangeBlocker1.resolve())
+        .mockImplementationOnce(() => schemaChangeBlocker2.resolve()),
     );
 
     await gateway.load();
 
     await schemaChangeBlocker1;
+
     expect(mockUpdate).toBeCalledTimes(1);
     expect(mockDidUpdate).toBeCalledTimes(1);
 
     await schemaChangeBlocker2;
+
     expect(mockUpdate).toBeCalledTimes(2);
     expect(mockDidUpdate).toBeCalledTimes(2);
 
     const [firstCall, secondCall] = mockDidUpdate.mock.calls;
 
-    expect(firstCall[0]!.schema).toBeDefined();
-    expect(firstCall[0].compositionMetadata!.schemaHash).toEqual('hash1');
+    const expectedFirstId = 'd20cfb7a9c51179aa494ed9e98153f0042892bd225437af064bf1c1aa68eab86'
+    expect(firstCall[0]!.compositionId).toEqual(expectedFirstId);
     // first call should have no second "previous" argument
     expect(firstCall[1]).toBeUndefined();
 
-    expect(secondCall[0].schema).toBeDefined();
-    expect(secondCall[0].compositionMetadata!.schemaHash).toEqual('hash2');
+    expect(secondCall[0]!.compositionId).toEqual(
+      '7dad7ab8284165a86241b8973d71f0d6ac8cb142095c717dd23443522850c225',
+    );
     // second call should have previous info in the second arg
-    expect(secondCall[1]!.schema).toBeDefined();
-    expect(secondCall[1]!.compositionMetadata!.schemaHash).toEqual('hash1');
+    expect(secondCall[1]!.compositionId).toEqual(expectedFirstId);
 
     await gateway.stop();
   });
@@ -228,34 +169,31 @@ describe('lifecycle hooks', () => {
   it('warns when polling on the default fetcher', async () => {
     new ApolloGateway({
       serviceList: serviceDefinitions,
-      experimental_pollInterval: 10,
+      pollIntervalInMs: 10,
       logger,
     });
-    expect(logger.warn).toHaveBeenCalledTimes(1);
     expect(logger.warn).toHaveBeenCalledWith(
       'Polling running services is dangerous and not recommended in production. Polling should only be used against a registry. If you are polling running services, use with caution.',
     );
   });
 
   it('registers schema change callbacks when experimental_pollInterval is set for unmanaged configs', async () => {
-    const experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions = jest.fn(
-      async (_config) => {
+    const experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions =
+      jest.fn(async (_config) => {
         return { serviceDefinitions, isNewSchema: true };
-      },
-    );
+      });
 
     const gateway = new ApolloGateway({
       serviceList: [{ name: 'book', url: 'http://localhost:32542' }],
       experimental_updateServiceDefinitions,
-      experimental_pollInterval: 100,
+      pollIntervalInMs: 100,
       logger,
     });
 
-    let resolve: Function;
-    const schemaChangeBlocker = new Promise(res => (resolve = res));
-    const schemaChangeCallback = jest.fn(() => resolve());
+    const schemaChangeBlocker = resolvable();
+    const schemaChangeCallback = jest.fn(() => schemaChangeBlocker.resolve());
 
-    gateway.onSchemaChange(schemaChangeCallback);
+    gateway.onSchemaLoadOrUpdate(schemaChangeCallback);
     await gateway.load();
 
     await schemaChangeBlocker;
@@ -265,12 +203,11 @@ describe('lifecycle hooks', () => {
   });
 
   it('calls experimental_didResolveQueryPlan when executor is called', async () => {
-    const experimental_didResolveQueryPlan: Experimental_DidResolveQueryPlanCallback = jest.fn()
+    const experimental_didResolveQueryPlan: Experimental_DidResolveQueryPlanCallback =
+      jest.fn();
 
     const gateway = new ApolloGateway({
-      localServiceList: [
-        books
-      ],
+      localServiceList: [books],
       experimental_didResolveQueryPlan,
     });
 
@@ -280,7 +217,8 @@ describe('lifecycle hooks', () => {
       { book(isbn: "0262510871") { year } }
     `;
 
-     // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
     await executor({
       source,
       document: gql(source),

package/src/__tests__/gateway/opentelemetry.test.ts

@@ -36,11 +36,16 @@ describe('opentelemetry', () => {
   describe('with local data', () =>
   {
     async function gateway() {
+      const localDataSources = Object.fromEntries(
+        fixtures.map((f) => [
+          f.name,
+          new LocalGraphQLDataSource(buildSubgraphSchema(f)),
+        ]),
+      );
       const gateway = new ApolloGateway({
         localServiceList: fixtures,
-        buildService: service => {
-          // @ts-ignore
-          return new LocalGraphQLDataSource(buildSubgraphSchema([service]));
+        buildService(service) {
+          return localDataSources[service.name];
         },
       });
 

package/src/__tests__/gateway/queryPlanCache.test.ts

@@ -6,14 +6,20 @@ import { LocalGraphQLDataSource } from '../../datasources/LocalGraphQLDataSource
 import { ApolloGateway } from '../../';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { QueryPlanner } from '@apollo/query-planner';
+
 it('caches the query plan for a request', async () => {
   const buildQueryPlanSpy = jest.spyOn(QueryPlanner.prototype, 'buildQueryPlan');
 
+  const localDataSources = Object.fromEntries(
+    fixtures.map((f) => [
+      f.name,
+      new LocalGraphQLDataSource(buildSubgraphSchema(f)),
+    ]),
+  );
   const gateway = new ApolloGateway({
     localServiceList: fixtures,
-    buildService: service => {
-      // @ts-ignore
-      return new LocalGraphQLDataSource(buildSubgraphSchema([service]));
+    buildService(service) {
+      return localDataSources[service.name];
     },
   });
 
@@ -65,11 +71,17 @@ it('supports multiple operations and operationName', async () => {
     }
   `;
 
+  const localDataSources = Object.fromEntries(
+    fixtures.map((f) => [
+      f.name,
+      new LocalGraphQLDataSource(buildSubgraphSchema(f)),
+    ]),
+  );
+
   const gateway = new ApolloGateway({
     localServiceList: fixtures,
-    buildService: service => {
-      // @ts-ignore
-      return new LocalGraphQLDataSource(buildSubgraphSchema([service]));
+    buildService(service) {
+      return localDataSources[service.name];
     },
   });
 
@@ -170,11 +182,15 @@ it('does not corrupt cached queryplan data across requests', async () => {
     },
   };
 
+  const dataSources: Record<string, LocalGraphQLDataSource> = {
+    a: new LocalGraphQLDataSource(buildSubgraphSchema(serviceA)),
+    b: new LocalGraphQLDataSource(buildSubgraphSchema(serviceB)),
+  };
+
   const gateway = new ApolloGateway({
     localServiceList: [serviceA, serviceB],
-    buildService: service => {
-      // @ts-ignore
-      return new LocalGraphQLDataSource(buildSubgraphSchema([service]));
+    buildService(service) {
+      return dataSources[service.name];
     },
   });
 

package/src/__tests__/gateway/reporting.test.ts

@@ -1,17 +1,20 @@
 import { gunzipSync } from 'zlib';
 import nock from 'nock';
-import { GraphQLSchemaModule } from 'apollo-graphql';
 import gql from 'graphql-tag';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import { ApolloServer } from 'apollo-server';
 import { ApolloServerPluginUsageReporting } from 'apollo-server-core';
-import { execute, toPromise } from 'apollo-link';
-import { createHttpLink } from 'apollo-link-http';
+import { execute } from '@apollo/client/link/core';
+import { toPromise } from '@apollo/client/link/utils';
+import { createHttpLink } from '@apollo/client/link/http';
 import fetch from 'node-fetch';
 import { ApolloGateway } from '../..';
 import { Plugin, Config, Refs } from 'pretty-format';
 import { Report, Trace } from 'apollo-reporting-protobuf';
 import { fixtures } from 'apollo-federation-integration-testsuite';
+import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
+import { GraphQLSchemaModule } from '../../schema-helper';
+import resolvable, { Resolvable } from '@josephg/resolvable';
 
 // Normalize specific fields that change often (eg timestamps) to static values,
 // to make snapshot testing viable.  (If these helpers are more generally
@@ -88,19 +91,16 @@ describe('reporting', () => {
   let backendServers: ApolloServer[];
   let gatewayServer: ApolloServer;
   let gatewayUrl: string;
-  let reportPromise: Promise<any>;
-  let nockScope: nock.Scope;
+  let reportPromise: Resolvable<any>;
 
   beforeEach(async () => {
-    let reportResolver: (report: any) => void;
-    reportPromise = new Promise<any>((resolve) => {
-      reportResolver = resolve;
-    });
+    reportPromise = resolvable();
 
-    nockScope = nock('https://usage-reporting.api.apollographql.com')
+    nockBeforeEach();
+    nock('https://usage-reporting.api.apollographql.com')
       .post('/api/ingress/traces')
       .reply(200, (_: any, requestBody: string) => {
-        reportResolver(requestBody);
+        reportPromise.resolve(requestBody);
         return 'ok';
       });
 
@@ -137,7 +137,8 @@ describe('reporting', () => {
     if (gatewayServer) {
       await gatewayServer.stop();
     }
-    nockScope.done();
+
+    nockAfterEach();
   });
 
   it(`queries three services`, async () => {
@@ -231,6 +232,34 @@ describe('reporting', () => {
         "tracesPerQuery": Object {
           "# -
       {me{name{first last}}topProducts{name}}": Object {
+            "referencedFieldsByType": Object {
+              "Name": Object {
+                "fieldNames": Array [
+                  "first",
+                  "last",
+                ],
+                "isInterface": false,
+              },
+              "Product": Object {
+                "fieldNames": Array [
+                  "name",
+                ],
+                "isInterface": true,
+              },
+              "Query": Object {
+                "fieldNames": Array [
+                  "me",
+                  "topProducts",
+                ],
+                "isInterface": false,
+              },
+              "User": Object {
+                "fieldNames": Array [
+                  "name",
+                ],
+                "isInterface": false,
+              },
+            },
             "trace": Array [
               Object {
                 "cachePolicy": Object {
@@ -238,7 +267,6 @@ describe('reporting', () => {
                   "scope": "PRIVATE",
                 },
                 "clientName": "",
-                "clientReferenceId": "",
                 "clientVersion": "",
                 "details": Object {},
                 "durationNs": 12345,
@@ -246,6 +274,7 @@ describe('reporting', () => {
                   "nanos": 123000000,
                   "seconds": "1562203363",
                 },
+                "fieldExecutionWeight": 1,
                 "forbiddenOperation": false,
                 "fullQueryCacheHit": false,
                 "http": Object {