@apollo/gateway 2.1.0-alpha.0 → 2.1.0-alpha.3

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

@@ -49,7 +49,7 @@ describe('ApolloGateway executor', () => {
         variables: { first: '3' },
       },
       queryHash: 'hashed',
-      context: null,
+      context: {},
       cache: {} as any,
       logger,
     });
@@ -85,7 +85,7 @@ describe('ApolloGateway executor', () => {
       document: gql(source),
       request: {},
       queryHash: 'hashed',
-      context: null,
+      context: {},
       cache: {} as any,
       logger,
     });

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

@@ -147,7 +147,7 @@ describe('lifecycle hooks', () => {
     // the supergraph (even just formatting differences), this ID will change
     // and this test will have to updated.
     expect(secondCall[0]!.compositionId).toEqual(
-      '68b144680261e3b57be90f127f35c88d0ce6cb7aaadf04d0a5d60fedcc2500b3',
+      'cc95112b64179c4e549de788b051f44010a02877f568649a42caeeee6a135601',
     );
     // second call should have previous info in the second arg
     expect(secondCall[1]!.compositionId).toEqual(expectedFirstId);

package/src/__tests__/integration/abstract-types.test.ts

@@ -1626,14 +1626,16 @@ it('when exploding types through multiple levels', async () => {
             } =>
             {
               ... on Book {
-                reviews {
-                  body
-                }
+                ...ProductReviews
               }
               ... on Furniture {
-                reviews {
-                  body
-                }
+                ...ProductReviews
+              }
+            }
+            
+            fragment ProductReviews on Product {
+              reviews {
+                body
               }
             }
           },
@@ -1643,23 +1645,6 @@ it('when exploding types through multiple levels', async () => {
   `);
 });
 
-  // This test case describes a situation that isn't fixed by the deduplication
-  // workaround. It is here to remind us to look into this, but it doesn't
-  // actually test for the failing behavior so the test still succeeds.
-  //
-  // In cases where different possible types live in different
-  // services, you can't just merge the dependent fetches because they don't
-  // have the same parent. What you want here is to have these dependent fetches
-  // execute separately, but only take the objects fetched by its parent as input.
-  // The problem currently is that these fetches act on on the same path, so
-  // depending on the timing either one (or both) will end up fetching the same
-  // data just fetched by the other.
-  //
-  // To make this more concrete, in this case that means we'll fetch all of the
-  // reviews and authors twice.
-  //
-  // Solving this requires us to filter on the types of response objects as
-  // opposed to just collecting all objects in the path.
 it("when including the same nested fields under different type conditions that are split between services", async () => {
     const query = `#graphql
       query {
@@ -1829,63 +1814,46 @@ it("when including the same nested fields under different type conditions that a
                   }
                 },
               },
-              Flatten(path: "topProducts.@.reviews.@.author") {
-                Fetch(service: "accounts") {
-                  {
-                    ... on User {
-                      __typename
-                      id
-                    }
-                  } =>
-                  {
-                    ... on User {
-                      name
-                    }
-                  }
-                },
-              },
             },
-            Sequence {
-              Flatten(path: "topProducts.@") {
-                Fetch(service: "reviews") {
-                  {
-                    ... on TV {
-                      __typename
-                      id
-                    }
-                  } =>
-                  {
-                    ... on TV {
-                      reviews {
-                        author {
-                          __typename
-                          id
-                          username
-                        }
-                        body
+            Flatten(path: "topProducts.@") {
+              Fetch(service: "reviews") {
+                {
+                  ... on TV {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on TV {
+                    reviews {
+                      author {
+                        __typename
                         id
+                        username
                       }
-                    }
-                  }
-                },
-              },
-              Flatten(path: "topProducts.@.reviews.@.author") {
-                Fetch(service: "accounts") {
-                  {
-                    ... on User {
-                      __typename
+                      body
                       id
                     }
-                  } =>
-                  {
-                    ... on User {
-                      name
-                    }
                   }
-                },
+                }
               },
             },
           },
+          Flatten(path: "topProducts.@.reviews.@.author") {
+            Fetch(service: "accounts") {
+              {
+                ... on User {
+                  __typename
+                  id
+                }
+              } =>
+              {
+                ... on User {
+                  name
+                }
+              }
+            },
+          },
         },
       }
     `);

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

@@ -202,8 +202,8 @@ describe('gateway startup errors', () => {
 
     const expected =
       "A valid schema couldn't be composed. The following composition errors were found:\n"
-    + '	[accounts] On type "User", for @key(fields: "id"): Cannot query field "id" on type "User" (the field should be either be added to this subgraph or, if it should not be resolved by this subgraph, you need to add it to this subgraph with @external).\n'
-    + '	[accounts] On type "Account", for @key(fields: "id"): Cannot query field "id" on type "Account" (the field should be either be added to this subgraph or, if it should not be resolved by this subgraph, you need to add it to this subgraph with @external).'
+    + '	[accounts] On type "User", for @key(fields: "id"): Cannot query field "id" on type "User" (the field should either be added to this subgraph or, if it should not be resolved by this subgraph, you need to add it to this subgraph with @external).\n'
+    + '	[accounts] On type "Account", for @key(fields: "id"): Cannot query field "id" on type "Account" (the field should either be added to this subgraph or, if it should not be resolved by this subgraph, you need to add it to this subgraph with @external).'
     expect(err.message).toBe(expected);
   });
 });

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

@@ -1,4 +1,5 @@
 import mockedEnv from 'mocked-env';
+import fetcher from 'make-fetch-happen';
 
 import { ApolloGateway, UplinkSupergraphManager } from '@apollo/gateway';
 import { ApolloServer } from 'apollo-server';
@@ -22,8 +23,6 @@ beforeEach(() => {
 });
 
 afterEach(async () => {
-  nockAfterEach();
-
   if (server) {
     await server.stop();
     server = undefined;
@@ -34,6 +33,8 @@ afterEach(async () => {
     gateway = undefined;
   }
 
+  nockAfterEach();
+
   if (cleanUp) {
     cleanUp();
     cleanUp = undefined;
@@ -105,6 +106,30 @@ describe('minimal gateway', () => {
       schemaConfigDeliveryEndpoint,
     ]);
   });
+
+  it('supports a custom fetcher', async () => {
+    cleanUp = mockedEnv({
+      APOLLO_KEY: apiKey,
+      APOLLO_GRAPH_REF: graphRef,
+    });
+    mockSupergraphSdlRequestSuccess({ url: /.*?apollographql.com/ });
+
+    let calls = 0;
+    gateway = new ApolloGateway({
+      logger,
+      fetcher: (...args) => {
+        calls++;
+        return fetcher(...args);
+      },
+    });
+    server = new ApolloServer({
+      gateway,
+      plugins: [ApolloServerPluginUsageReportingDisabled()],
+    });
+    await server.listen({ port: 0 });
+
+    expect(calls).toEqual(1);
+  });
 });
 
 describe('Managed gateway with explicit UplinkSupergraphManager', () => {
@@ -134,7 +159,6 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
         graphRef,
         logger,
         maxRetries: 0,
-        fallbackPollIntervalInMs: 0,
         async onFailureToFetchSupergraphSdlDuringInit() {
           hasFired = true;
           return supergraphSchema;
@@ -155,25 +179,27 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
 
     const supergraphSchema = getTestingSupergraphSdl();
     let hasFired;
+    let uplinkManager = new UplinkSupergraphManager({
+      apiKey,
+      graphRef,
+      logger,
+      maxRetries: 0,
+      async onFailureToFetchSupergraphSdlAfterInit() {
+        hasFired = true;
+        return supergraphSchema;
+      },
+    });
+    // Set pollIntervalMs lower than the typically allowed value so we don't wait 10s between polling
+    uplinkManager['pollIntervalMs'] = 0;
+
     gateway = new ApolloGateway({
       logger,
-      supergraphSdl: new UplinkSupergraphManager({
-        apiKey,
-        graphRef,
-        logger,
-        maxRetries: 0,
-        fallbackPollIntervalInMs: 0,
-        async onFailureToFetchSupergraphSdlAfterInit() {
-          hasFired = true;
-          return supergraphSchema;
-        },
-      }),
+      supergraphSdl: uplinkManager,
     });
 
     await expect(gateway.load()).resolves.not.toThrow();
     expect(hasFired).toBeFalsy();
 
-    const uplinkManager = gateway.supergraphManager as UplinkSupergraphManager;
     await uplinkManager.nextFetch();
 
     expect(hasFired).toBeTruthy();
@@ -181,7 +207,7 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
 
   it.each([
     ['x', 'Syntax Error: Unexpected Name "x".'],
-    ['', 'Syntax Error: Unexpected <EOF>.'],
+    ['', 'Invalid supergraph schema supplied during initialization.'],
     [' ', 'Syntax Error: Unexpected <EOF>.'],
     ['type Query {hi: String}', 'Invalid supergraph: must be a core schema'],
   ])(
@@ -196,7 +222,6 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
           graphRef,
           logger,
           maxRetries: 0,
-          fallbackPollIntervalInMs: 0,
           async onFailureToFetchSupergraphSdlDuringInit() {
             return schemaText;
           },
@@ -220,26 +245,27 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
         .reply(500);
 
       let hasFired;
+      let uplinkManager = new UplinkSupergraphManager({
+        apiKey,
+        graphRef,
+        logger,
+        maxRetries: 0,
+        async onFailureToFetchSupergraphSdlAfterInit() {
+          hasFired = true;
+          return schemaText;
+        },
+      });
+      // Set pollIntervalMs lower than the typically allowed value so we don't wait 10s between polling
+      uplinkManager['pollIntervalMs'] = 0;
+
       gateway = new ApolloGateway({
         logger,
-        supergraphSdl: new UplinkSupergraphManager({
-          apiKey,
-          graphRef,
-          logger,
-          maxRetries: 0,
-          fallbackPollIntervalInMs: 0,
-          async onFailureToFetchSupergraphSdlAfterInit() {
-            hasFired = true;
-            return schemaText;
-          },
-        }),
+        supergraphSdl: uplinkManager
       });
 
       await expect(gateway.load()).resolves.not.toThrow();
       expect(hasFired).toBeFalsy();
 
-      const uplinkManager =
-        gateway.supergraphManager as UplinkSupergraphManager;
       await uplinkManager.nextFetch();
 
       expect(hasFired).toBeTruthy();
@@ -250,7 +276,7 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
   );
 
   it.each([null, ''])(
-    'uses existing supergraph schema is false-y value returned from callback after init: %p',
+    'uses existing supergraph schema if false-y value returned from callback after init: %p',
     async (schemaText) => {
       // This is kinda wonky to read: we're responding the first time with success, then the next fetch should fail
       mockSupergraphSdlRequestSuccess({ url: /.*?apollographql.com/ })
@@ -258,26 +284,28 @@ describe('Managed gateway with explicit UplinkSupergraphManager', () => {
         .reply(500);
 
       let hasFired;
+      let uplinkManager = new UplinkSupergraphManager({
+        apiKey,
+        graphRef,
+        logger,
+        maxRetries: 0,
+
+        async onFailureToFetchSupergraphSdlAfterInit() {
+          hasFired = true;
+          return schemaText;
+        },
+      });
+      // Set pollIntervalMs lower than the typically allowed value so we don't wait 10s between polling
+      uplinkManager['pollIntervalMs'] = 0;
+
       gateway = new ApolloGateway({
         logger,
-        supergraphSdl: new UplinkSupergraphManager({
-          apiKey,
-          graphRef,
-          logger,
-          maxRetries: 0,
-          fallbackPollIntervalInMs: 0,
-          async onFailureToFetchSupergraphSdlAfterInit() {
-            hasFired = true;
-            return schemaText;
-          },
-        }),
+        supergraphSdl: uplinkManager,
       });
 
       await expect(gateway.load()).resolves.not.toThrow();
       expect(hasFired).toBeFalsy();
 
-      const uplinkManager =
-        gateway.supergraphManager as UplinkSupergraphManager;
       await uplinkManager.nextFetch();
 
       expect(hasFired).toBeTruthy();

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

@@ -2,7 +2,7 @@ import gql from 'graphql-tag';
 import { GraphQLObjectType, GraphQLSchema } from 'graphql';
 import mockedEnv from 'mocked-env';
 import type { Logger } from '@apollo/utils.logger';
-import { ApolloGateway } from '../..';
+import { ApolloGateway, UplinkSupergraphManager } from '../..';
 import {
   mockSdlQuerySuccess,
   mockServiceHealthCheckSuccess,
@@ -56,8 +56,12 @@ function getRootQueryFields(schema?: GraphQLSchema): string[] {
 let logger: Logger;
 let gateway: ApolloGateway | null = null;
 let cleanUp: (() => void) | null = null;
+let originalMinPollInterval = UplinkSupergraphManager.MIN_POLL_INTERVAL_MS;
 
 beforeEach(() => {
+  // Set the min poll interval artificially low so we're not waiting during tests
+  // @ts-ignore
+  UplinkSupergraphManager['MIN_POLL_INTERVAL_MS'] = 100;
   nockBeforeEach();
 
   const warn = jest.fn();
@@ -74,13 +78,15 @@ beforeEach(() => {
 });
 
 afterEach(async () => {
-  nockAfterEach();
-
+  // @ts-ignore
+  UplinkSupergraphManager['MIN_POLL_INTERVAL_MS'] = originalMinPollInterval;
   if (gateway) {
     await gateway.stop();
     gateway = null;
   }
 
+  nockAfterEach();
+
   if (cleanUp) {
     cleanUp();
     cleanUp = null;
@@ -90,7 +96,7 @@ afterEach(async () => {
 it('Queries remote endpoints for their SDLs', async () => {
   mockSdlQuerySuccess(simpleService);
 
-  gateway = new ApolloGateway({ serviceList: [simpleService] });
+  gateway = new ApolloGateway({ serviceList: [simpleService], logger });
   await gateway.load();
   expect(gateway.schema!.getType('User')!.description).toBe('This is my User');
 });
@@ -139,8 +145,6 @@ it('Updates Supergraph SDL from remote storage', async () => {
     logger,
     uplinkEndpoints: [mockCloudConfigUrl1],
   });
-  // for testing purposes, a short pollInterval is ideal so we'll override here
-  gateway['pollIntervalInMs'] = 100;
 
   const schemas: GraphQLSchema[] = [];
   gateway.onSchemaLoadOrUpdate(({ apiSchema }) => {
@@ -199,9 +203,6 @@ describe('Supergraph SDL update failures', () => {
       uplinkMaxRetries: 0,
     });
 
-    // for testing purposes, a short pollInterval is ideal so we'll override here
-    gateway['pollIntervalInMs'] = 100;
-
     await gateway.load(mockApolloConfig);
     await errorLoggedPromise;
 
@@ -231,8 +232,6 @@ describe('Supergraph SDL update failures', () => {
       uplinkEndpoints: [mockCloudConfigUrl1],
       uplinkMaxRetries: 0,
     });
-    // for testing purposes, a short pollInterval is ideal so we'll override here
-    gateway['pollIntervalInMs'] = 100;
 
     await gateway.load(mockApolloConfig);
     await errorLoggedPromise;
@@ -265,8 +264,6 @@ describe('Supergraph SDL update failures', () => {
       logger,
       uplinkEndpoints: [mockCloudConfigUrl1],
     });
-    // for testing purposes, a short pollInterval is ideal so we'll override here
-    gateway['pollIntervalInMs'] = 100;
 
     await gateway.load(mockApolloConfig);
     await errorLoggedPromise;
@@ -295,8 +292,6 @@ describe('Supergraph SDL update failures', () => {
       logger,
       uplinkEndpoints: [mockCloudConfigUrl1],
     });
-    // for testing purposes, a short pollInterval is ideal so we'll override here
-    gateway['pollIntervalInMs'] = 100;
 
     await expect(
       gateway.load(mockApolloConfig),
@@ -332,8 +327,6 @@ it('Rollsback to a previous schema when triggered', async () => {
     logger,
     uplinkEndpoints: [mockCloudConfigUrl1],
   });
-  // for testing purposes, a short pollInterval is ideal so we'll override here
-  gateway['pollIntervalInMs'] = 100;
 
   gateway.onSchemaChange(onChange);
   await gateway.load(mockApolloConfig);
@@ -408,8 +401,6 @@ describe('Downstream service health checks', () => {
         logger,
         uplinkEndpoints: [mockCloudConfigUrl1],
       });
-      // for testing purposes, a short pollInterval is ideal so we'll override here
-      gateway['pollIntervalInMs'] = 100;
 
       await gateway.load(mockApolloConfig);
       await gateway.stop();
@@ -482,8 +473,6 @@ describe('Downstream service health checks', () => {
         logger,
         uplinkEndpoints: [mockCloudConfigUrl1],
       });
-      // for testing purposes, a short pollInterval is ideal so we'll override here
-      gateway['pollIntervalInMs'] = 100;
 
       gateway.onSchemaChange(onChange);
       await gateway.load(mockApolloConfig);
@@ -526,8 +515,6 @@ describe('Downstream service health checks', () => {
         logger,
         uplinkEndpoints: [mockCloudConfigUrl1],
       });
-      // for testing purposes, a short pollInterval is ideal so we'll override here
-      gateway['pollIntervalInMs'] = 100;
 
       const updateSpy = jest.fn();
       gateway.onSchemaLoadOrUpdate(() => updateSpy());

package/src/config.ts

@@ -1,9 +1,9 @@
 import { GraphQLError, GraphQLSchema } from 'graphql';
-import { HeadersInit } from 'node-fetch';
-import { GraphQLRequestContextExecutionDidStart } from 'apollo-server-types';
+import type { HeadersInit } from 'node-fetch';
+import { GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
 import type { Logger } from '@apollo/utils.logger';
 import { GraphQLDataSource } from './datasources/types';
-import { QueryPlan } from '@apollo/query-planner';
+import { QueryPlan, QueryPlannerConfig } from '@apollo/query-planner';
 import { OperationContext } from './operationContext';
 import { ServiceMap } from './executeQueryPlan';
 import { ServiceDefinition } from "@apollo/federation-internals";
@@ -21,9 +21,7 @@ export type Experimental_DidResolveQueryPlanCallback = ({
   readonly queryPlan: QueryPlan;
   readonly serviceMap: ServiceMap;
   readonly operationContext: OperationContext;
-  readonly requestContext: GraphQLRequestContextExecutionDidStart<
-    Record<string, any>
-  >;
+  readonly requestContext: GatewayGraphQLRequestContext;
 }) => void;
 
 interface ImplementingServiceLocation {
@@ -129,6 +127,8 @@ interface GatewayConfigBase {
   experimental_autoFragmentization?: boolean;
   fetcher?: Fetcher;
   serviceHealthCheck?: boolean;
+
+  queryPlannerConfig?: QueryPlannerConfig;
 }
 
 // TODO(trevor:removeServiceList)

package/src/datasources/LocalGraphQLDataSource.ts

@@ -1,4 +1,4 @@
-import { GraphQLResponse } from 'apollo-server-types';
+import { GatewayGraphQLResponse } from '@apollo/server-gateway-interface';
 import {
   GraphQLSchema,
   graphql,
@@ -6,7 +6,6 @@ import {
   DocumentNode,
   parse,
 } from 'graphql';
-import { enablePluginsForSchemaResolvers } from 'apollo-server-core/dist/utils/schemaInstrumentation';
 import { GraphQLDataSource, GraphQLDataSourceProcessOptions } from './types';
 
 export class LocalGraphQLDataSource<
@@ -14,13 +13,12 @@ export class LocalGraphQLDataSource<
 > implements GraphQLDataSource<TContext>
 {
   constructor(public readonly schema: GraphQLSchema) {
-    enablePluginsForSchemaResolvers(schema);
   }
 
   async process({
     request,
     context,
-  }: GraphQLDataSourceProcessOptions<TContext>): Promise<GraphQLResponse> {
+  }: GraphQLDataSourceProcessOptions<TContext>): Promise<GatewayGraphQLResponse> {
     return graphql({
       schema: this.schema,
       source: request.query!,