@apollo/gateway 2.3.4 → 2.4.0-alpha.1

package/src/__tests__/executeQueryPlan.test.ts

@@ -16,7 +16,7 @@ import {
 } from 'apollo-federation-integration-testsuite';
 import { QueryPlan, QueryPlanner } from '@apollo/query-planner';
 import { ApolloGateway } from '..';
-import { ApolloServerBase as ApolloServer } from 'apollo-server-core';
+import { ApolloServer } from '@apollo/server';
 import { getFederatedTestingSchema } from './execution-utils';
 import { Schema, Operation, parseOperation, buildSchemaFromAST, arrayEquals } from '@apollo/federation-internals';
 import {
@@ -24,6 +24,7 @@ import {
   GraphQLResolverMap,
 } from '@apollo/subgraph/src/schema-helper';
 import {GatewayExecutionResult, GatewayGraphQLRequestContext} from '@apollo/server-gateway-interface';
+import { unwrapSingleResultKind } from './gateway/testUtils';
 
 expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
@@ -1325,13 +1326,12 @@ describe('executeQueryPlan', () => {
       // But note that this is only one possible initialization path for the
       // gateway, and with the current duplication of logic we'd actually need
       // to test other scenarios (like loading from supergraph SDL) separately.
-      const gateway = new ApolloGateway({
-        supergraphSdl: print(superGraphWithInaccessible),
+      const server = new ApolloServer({
+        gateway: new ApolloGateway({
+          supergraphSdl: print(superGraphWithInaccessible),
+        }),
       });
-
-      const { schema, executor } = await gateway.load();
-
-      const server = new ApolloServer({ schema, executor });
+      await server.start();
 
       const query = `#graphql
         query {
@@ -1349,10 +1349,22 @@ describe('executeQueryPlan', () => {
         query,
       });
 
-      expect(response.data).toBeUndefined();
-      expect(response.errors).toMatchInlineSnapshot(`
+      const { errors, data } = unwrapSingleResultKind(response);
+      expect(data).toBeUndefined();
+      expect(errors).toMatchInlineSnapshot(`
         Array [
-          [ValidationError: Cannot query field "ssn" on type "User".],
+          Object {
+            "extensions": Object {
+              "code": "GRAPHQL_VALIDATION_FAILED",
+            },
+            "locations": Array [
+              Object {
+                "column": 15,
+                "line": 7,
+              },
+            ],
+            "message": "Cannot query field \\"ssn\\" on type \\"User\\".",
+          },
         ]
       `);
     });
@@ -3817,7 +3829,7 @@ describe('executeQueryPlan', () => {
         name: 'S1',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
 
           type Query {
             iFromS1: I
@@ -3863,7 +3875,7 @@ describe('executeQueryPlan', () => {
         name: 'S2',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key", "@interfaceObject"])
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject"])
 
           type Query {
             iFromS2: I
@@ -4207,7 +4219,7 @@ describe('executeQueryPlan', () => {
       // any specific extra resolving.
       const tester = defineSchema({});
 
-      let { plan, response } = await tester(`
+      const { plan, response } = await tester(`
         query {
           iFromS2 {
             y
@@ -4242,7 +4254,7 @@ describe('executeQueryPlan', () => {
         s1: { iResolveReferenceExtra: (id: string) => ({ __typename: id === 'idA' ? 'A' : 'B' }), },
       });
 
-      let { plan, response } = await tester(`
+      const { plan, response } = await tester(`
         query {
           iFromS2 {
             ... on B {
@@ -4329,7 +4341,7 @@ describe('executeQueryPlan', () => {
         name: 'products',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
 
           type Query {
             products: [Product!]!
@@ -4378,7 +4390,7 @@ describe('executeQueryPlan', () => {
         name: 'reviews',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key", "@interfaceObject"])
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject"])
 
           type Query {
             allReviewedProducts: [Product!]!

package/src/__tests__/execution-utils.ts

@@ -17,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, ServiceDefinition } from '@apollo/federation-internals';
+import { buildSchema, Operation, operationFromDocument, ServiceDefinition } from '@apollo/federation-internals';
 import { GatewayExecutionResult, GatewayGraphQLRequest } from '@apollo/server-gateway-interface';
 
 const prettyFormat = require('pretty-format');
@@ -39,7 +39,7 @@ export async function execute(
   request: GatewayGraphQLRequest,
   services: ServiceDefinitionModule[] = fixtures,
   logger: Logger = console,
-): Promise<GatewayExecutionResult & { queryPlan: QueryPlan }> {
+): Promise<GatewayExecutionResult & { queryPlan: QueryPlan, operation: Operation }> {
   const serviceMap = Object.fromEntries(
     services.map(({ name, typeDefs, resolvers }) => {
       return [
@@ -79,7 +79,7 @@ export async function execute(
     apiSchema,
   );
 
-  return { ...result, queryPlan };
+  return { ...result, queryPlan, operation };
 }
 
 export function buildLocalService(modules: GraphQLSchemaModule[]) {

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

@@ -1,12 +1,13 @@
 import nock from 'nock';
 
-import { ApolloServerBase as ApolloServer } from 'apollo-server-core';
+import { ApolloServer } from '@apollo/server';
 
 import { RemoteGraphQLDataSource } from '../../datasources/RemoteGraphQLDataSource';
 import { ApolloGateway, SERVICE_DEFINITION_QUERY } from '../../';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { GraphQLDataSourceRequestKind } from '../../datasources/types';
 import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
+import { unwrapSingleResultKind } from '../gateway/testUtils';
 
 beforeEach(nockBeforeEach);
 afterEach(nockAfterEach);
@@ -62,15 +63,10 @@ it('correctly passes the context from ApolloServer to datasources', async () =>
     },
   });
 
-  const { schema, executor } = await gateway.load();
-
   const server = new ApolloServer({
-    schema,
-    executor,
-    context: () => ({
-      userId: '1234',
-    }),
+    gateway,
   });
+  await server.start();
 
   const query = `#graphql
     {
@@ -97,12 +93,20 @@ it('correctly passes the context from ApolloServer to datasources', async () =>
       replyHeaders,
     );
 
-  const result = await server.executeOperation({
-    query,
-  });
+  const result = await server.executeOperation(
+    {
+      query,
+    },
+    {
+      contextValue: {
+        userId: '1234',
+      },
+    },
+  );
 
-  expect(result.errors).toBeUndefined();
-  expect(result.data).toEqual({
+  const { data, errors } = unwrapSingleResultKind(result);
+  expect(errors).toBeUndefined();
+  expect(data).toEqual({
     me: { username: '@jbaxleyiii' },
   });
 });

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

@@ -1,68 +1,49 @@
-import { buildSubgraphSchema } from '@apollo/subgraph';
-import { ApolloServer } from 'apollo-server';
-import fetch, { Response } from 'node-fetch';
-import { ApolloGateway } from '../..';
 import { fixtures } from 'apollo-federation-integration-testsuite';
-import { ApolloServerPluginInlineTrace } from 'apollo-server-core';
-import { GraphQLSchemaModule } from '@apollo/subgraph/src/schema-helper';
-import { buildSchema, ObjectType, ServiceDefinition } from '@apollo/federation-internals';
+import { buildSchema, ObjectType } from '@apollo/federation-internals';
 import gql from 'graphql-tag';
 import { printSchema } from 'graphql';
+import { startSubgraphsAndGateway, Services } from './testUtils'
+import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache';
+import { QueryPlan } from '@apollo/query-planner';
+import { createHash } from '@apollo/utils.createhash';
 
-async function startFederatedServer(modules: GraphQLSchemaModule[]) {
-  const schema = buildSubgraphSchema(modules);
-  const server = new ApolloServer({
-    schema,
-    // Manually installing the inline trace plugin means it doesn't log a message.
-    plugins: [ApolloServerPluginInlineTrace()],
-  });
-  const { url } = await server.listen({ port: 0 });
-  return { url, server };
-}
-
-let backendServers: ApolloServer[];
-let gateway: ApolloGateway;
-let gatewayServer: ApolloServer;
-let gatewayUrl: string;
-
-async function startServicesAndGateway(servicesDefs: ServiceDefinition[]) {
-  backendServers = [];
-  const serviceList = [];
-  for (const serviceDef of servicesDefs) {
-    const { server, url } = await startFederatedServer([serviceDef]);
-    backendServers.push(server);
-    serviceList.push({ name: serviceDef.name, url });
-  }
-
-  gateway = new ApolloGateway({ serviceList });
-  gatewayServer = new ApolloServer({
-    gateway,
-  });
-  ({ url: gatewayUrl } = await gatewayServer.listen({ port: 0 }));
+function approximateObjectSize<T>(obj: T): number {
+  return Buffer.byteLength(JSON.stringify(obj), 'utf8');
 }
 
-async function queryGateway(query: string): Promise<Response> {
-  return fetch(gatewayUrl, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({ query }),
-  });
-}
+let services: Services;
 
 afterEach(async () => {
-  for (const server of backendServers) {
-    await server.stop();
-  }
-  if (gatewayServer) {
-    await gatewayServer.stop();
+  if (services) {
+    await services.stop();
   }
 });
 
+
 describe('caching', () => {
+  const cache = new InMemoryLRUCache<QueryPlan>({maxSize: Math.pow(2, 20) * (30), sizeCalculation: approximateObjectSize});
   beforeEach(async () => {
-    await startServicesAndGateway(fixtures);
+    services = await startSubgraphsAndGateway(fixtures, { gatewayConfig: { queryPlannerConfig: { cache } } });
+  });
+
+  it(`cached query plan`, async () => {
+    const query = `
+      query {
+        me {
+          name {
+            first
+            last
+          }
+        }
+        topProducts {
+          name
+        }
+      }
+    `;
+
+    await services.queryGateway(query);
+    const queryHash:string = createHash('sha256').update(query).digest('hex');
+    expect(await cache.get(queryHash)).toBeTruthy();
   });
 
   it(`cache control`, async () => {
@@ -80,7 +61,7 @@ describe('caching', () => {
       }
     `;
 
-    const response = await queryGateway(query);
+    const response = await services.queryGateway(query);
     const result = await response.json();
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -134,7 +115,7 @@ describe('caching', () => {
       }
     `;
 
-    const response = await queryGateway(query);
+    const response = await services.queryGateway(query);
     const result = await response.json();
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -167,7 +148,7 @@ describe('caching', () => {
         },
       }
     `);
-    expect(response.headers.get('cache-control')).toBe(null);
+    expect(response.headers.get('cache-control')).toBe('no-store');
   });
 });
 
@@ -185,8 +166,8 @@ describe('end-to-end features', () => {
       typeDefs: gql`
         extend schema
           @link(
-            url: "https://specs.apollo.dev/federation/v2.0",
-            import: [ "@key", { name: "@tag", as: "@federationTag"} ]
+            url: "https://specs.apollo.dev/federation/v2.0"
+            import: ["@key", { name: "@tag", as: "@federationTag" }]
           )
 
         type Query {
@@ -202,10 +183,10 @@ describe('end-to-end features', () => {
         Query: {
           t: () => ({
             k: 42,
-            x: 1
+            x: 1,
           }),
-        }
-      }
+        },
+      },
     };
 
     const subgraphB = {
@@ -214,8 +195,8 @@ describe('end-to-end features', () => {
       typeDefs: gql`
         extend schema
           @link(
-            url: "https://specs.apollo.dev/federation/v2.0",
-            import: [ "@key", { name: "@tag", as: "@federationTag"} ]
+            url: "https://specs.apollo.dev/federation/v2.0"
+            import: ["@key", { name: "@tag", as: "@federationTag" }]
           )
 
         type T @key(fields: "k") {
@@ -226,13 +207,13 @@ describe('end-to-end features', () => {
       resolvers: {
         T: {
           __resolveReference: ({ k }: { k: string }) => {
-            return k === '42' ? ({ y: 2 }) : undefined;
+            return k === '42' ? { y: 2 } : undefined;
           },
-        }
-      }
+        },
+      },
     };
 
-    await startServicesAndGateway([subgraphA, subgraphB]);
+    services = await startSubgraphsAndGateway([subgraphA, subgraphB]);
 
     const query = `
       {
@@ -243,7 +224,7 @@ describe('end-to-end features', () => {
       }
     `;
 
-    const response = await queryGateway(query);
+    const response = await services.queryGateway(query);
     const result = await response.json();
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -256,12 +237,16 @@ describe('end-to-end features', () => {
       }
     `);
 
-    const supergraphSdl = gateway.__testing().supergraphSdl;
+    const supergraphSdl = services.gateway.__testing().supergraphSdl;
     expect(supergraphSdl).toBeDefined();
     const supergraph = buildSchema(supergraphSdl!);
     const typeT = supergraph.type('T') as ObjectType;
-    expect(typeT.field('x')?.appliedDirectivesOf('federationTag').toString()).toStrictEqual('@federationTag(name: "Important")');
-    expect(typeT.field('y')?.appliedDirectivesOf('federationTag').toString()).toStrictEqual('@federationTag(name: "Less Important")');
+    expect(
+      typeT.field('x')?.appliedDirectivesOf('federationTag').toString(),
+    ).toStrictEqual('@federationTag(name: "Important")');
+    expect(
+      typeT.field('y')?.appliedDirectivesOf('federationTag').toString(),
+    ).toStrictEqual('@federationTag(name: "Less Important")');
   });
 
   it('handles fed1 schema', async () => {
@@ -282,10 +267,10 @@ describe('end-to-end features', () => {
         Query: {
           t: () => ({
             k: 42,
-            x: 1
+            x: 1,
           }),
-        }
-      }
+        },
+      },
     };
 
     const subgraphB = {
@@ -300,13 +285,13 @@ describe('end-to-end features', () => {
       resolvers: {
         T: {
           __resolveReference: ({ k }: { k: string }) => {
-            return k === '42' ? ({ y: 2 }) : undefined;
+            return k === '42' ? { y: 2 } : undefined;
           },
-        }
-      }
+        },
+      },
     };
 
-    await startServicesAndGateway([subgraphA, subgraphB]);
+    services = await startSubgraphsAndGateway([subgraphA, subgraphB]);
 
     const query = `
       {
@@ -317,7 +302,7 @@ describe('end-to-end features', () => {
       }
     `;
 
-    const response = await queryGateway(query);
+    const response = await services.queryGateway(query);
     const result = await response.json();
     expect(result).toMatchInlineSnapshot(`
       Object {
@@ -338,8 +323,8 @@ describe('end-to-end features', () => {
       typeDefs: gql`
         extend schema
           @link(
-            url: "https://specs.apollo.dev/federation/v2.0",
-            import: [ "@key", "@shareable", "@inaccessible"]
+            url: "https://specs.apollo.dev/federation/v2.0"
+            import: ["@key", "@shareable", "@inaccessible"]
           )
 
         type Query {
@@ -369,9 +354,9 @@ describe('end-to-end features', () => {
           }),
           f: (_: any, args: any) => {
             return args.e === 'FOO' ? 0 : 1;
-          }
-        }
-      }
+          },
+        },
+      },
     };
 
     const subgraphB = {
@@ -380,8 +365,8 @@ describe('end-to-end features', () => {
       typeDefs: gql`
         extend schema
           @link(
-            url: "https://specs.apollo.dev/federation/v2.0",
-            import: [ "@key", "@shareable", "@inaccessible" ]
+            url: "https://specs.apollo.dev/federation/v2.0"
+            import: ["@key", "@shareable", "@inaccessible"]
           )
 
         type T @key(fields: "k") {
@@ -393,13 +378,13 @@ describe('end-to-end features', () => {
       resolvers: {
         T: {
           __resolveReference: ({ k }: { k: string }) => {
-            return k === '42' ? ({ c: 'foo', d: 'bar' }) : undefined;
+            return k === '42' ? { c: 'foo', d: 'bar' } : undefined;
           },
-        }
-      }
+        },
+      },
     };
 
-    await startServicesAndGateway([subgraphA, subgraphB]);
+    services = await startSubgraphsAndGateway([subgraphA, subgraphB]);
 
     const q1 = `
       {
@@ -411,7 +396,7 @@ describe('end-to-end features', () => {
       }
     `;
 
-    const resp1 = await queryGateway(q1);
+    const resp1 = await services.queryGateway(q1);
     const res1 = await resp1.json();
     expect(res1).toMatchInlineSnapshot(`
       Object {
@@ -426,7 +411,7 @@ describe('end-to-end features', () => {
     `);
 
     // Make sure the exposed API doesn't have any @inaccessible elements.
-    expect(printSchema(gateway.schema!)).toMatchInlineSnapshot(`
+    expect(printSchema(services.gateway.schema!)).toMatchInlineSnapshot(`
       "enum E {
         FOO
       }
@@ -449,7 +434,7 @@ describe('end-to-end features', () => {
         f(e: BAR)
       }
     `;
-    const resp2 = await queryGateway(q2);
+    const resp2 = await services.queryGateway(q2);
     const res2 = await resp2.json();
     expect(res2).toMatchInlineSnapshot(`
       Object {
@@ -458,6 +443,12 @@ describe('end-to-end features', () => {
             "extensions": Object {
               "code": "GRAPHQL_VALIDATION_FAILED",
             },
+            "locations": Array [
+              Object {
+                "column": 14,
+                "line": 3,
+              },
+            ],
             "message": "Value \\"BAR\\" does not exist in \\"E\\" enum.",
           },
         ],
@@ -471,7 +462,7 @@ describe('end-to-end features', () => {
         }
       }
     `;
-    const resp3 = await queryGateway(q3);
+    const resp3 = await services.queryGateway(q3);
     const res3 = await resp3.json();
     expect(res3).toMatchInlineSnapshot(`
       Object {
@@ -480,10 +471,16 @@ describe('end-to-end features', () => {
             "extensions": Object {
               "code": "GRAPHQL_VALIDATION_FAILED",
             },
+            "locations": Array [
+              Object {
+                "column": 11,
+                "line": 4,
+              },
+            ],
             "message": "Cannot query field \\"a\\" on type \\"T\\". Did you mean \\"b\\", \\"d\\", or \\"k\\"?",
           },
         ],
       }
     `);
   });
-})
+});

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

@@ -1,11 +1,12 @@
 import gql from 'graphql-tag';
-import { ApolloServerBase as ApolloServer } from 'apollo-server-core';
+import { ApolloServer } from '@apollo/server';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 
 import { LocalGraphQLDataSource } from '../../datasources/LocalGraphQLDataSource';
 import { ApolloGateway } from '../../';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 import { QueryPlanner } from '@apollo/query-planner';
+import { unwrapSingleResultKind } from '../gateway/testUtils';
 
 it('caches the query plan for a request', async () => {
   const buildQueryPlanSpy = jest.spyOn(QueryPlanner.prototype, 'buildQueryPlan');
@@ -23,9 +24,8 @@ it('caches the query plan for a request', async () => {
     },
   });
 
-  const { schema, executor } = await gateway.load();
-
-  const server = new ApolloServer({ schema, executor });
+  const server = new ApolloServer({ gateway });
+  await server.start();
 
   const upc = '1';
 
@@ -42,7 +42,8 @@ it('caches the query plan for a request', async () => {
     variables: { upc },
   });
 
-  expect(result.data).toEqual({
+  const { data: result1Data } = unwrapSingleResultKind(result);
+  expect(result1Data).toEqual({
     product: {
       name: 'Table',
     },
@@ -53,7 +54,7 @@ it('caches the query plan for a request', async () => {
     variables: { upc },
   });
 
-  expect(result.data).toEqual(secondResult.data);
+  expect(unwrapSingleResultKind(secondResult).data).toEqual(result1Data);
   expect(buildQueryPlanSpy).toHaveBeenCalledTimes(1);
 });
 
@@ -85,24 +86,23 @@ it('supports multiple operations and operationName', async () => {
     },
   });
 
-  const { schema, executor } = await gateway.load();
-
-  const server = new ApolloServer({ schema, executor });
+  const server = new ApolloServer({ gateway });
+  await server.start();
 
-  const { data: userData } = await server.executeOperation({
+  const userResult = await server.executeOperation({
     query,
     operationName: 'GetUser',
   });
 
-  const { data: reviewsData } = await server.executeOperation({
+  const reviewsResult = await server.executeOperation({
     query,
     operationName: 'GetReviews',
   });
 
-  expect(userData).toEqual({
+  expect(unwrapSingleResultKind(userResult).data).toEqual({
     me: { username: '@ada' },
   });
-  expect(reviewsData).toEqual({
+  expect(unwrapSingleResultKind(reviewsResult).data).toEqual({
     topReviews: [
       { body: 'Love it!' },
       { body: 'Too expensive.' },
@@ -194,9 +194,8 @@ it('does not corrupt cached queryplan data across requests', async () => {
     },
   });
 
-  const { schema, executor } = await gateway.load();
-
-  const server = new ApolloServer({ schema, executor });
+  const server = new ApolloServer({ gateway });
+  await server.start();
 
   const query1 = `#graphql
     query UserFavoriteColor {
@@ -225,8 +224,8 @@ it('does not corrupt cached queryplan data across requests', async () => {
     query: query1,
   });
 
-  expect(result1.errors).toEqual(undefined);
-  expect(result2.errors).toEqual(undefined);
-  expect(result3.errors).toEqual(undefined);
+  expect(unwrapSingleResultKind(result1).errors).toEqual(undefined);
+  expect(unwrapSingleResultKind(result2).errors).toEqual(undefined);
+  expect(unwrapSingleResultKind(result3).errors).toEqual(undefined);
   expect(result1).toEqual(result3);
 });