@apollo/gateway 0.43.1 → 2.0.0-alpha.1

package/src/__tests__/execution-utils.ts

@@ -5,23 +5,22 @@ import {
 } from 'apollo-graphql';
 import { GraphQLRequest, GraphQLExecutionResult, Logger } from 'apollo-server-types';
 import {
-  composeAndValidate,
   ServiceDefinition,
-  compositionHasErrors,
 } from '@apollo/federation';
 import { buildSubgraphSchema } from '@apollo/subgraph';
 import {
   executeQueryPlan,
   buildOperationContext,
 } from '@apollo/gateway';
-import { buildComposedSchema, QueryPlanner, QueryPlan } from '@apollo/query-planner';
+import { QueryPlan, QueryPlanner } from '@apollo/query-planner';
 import { LocalGraphQLDataSource } from '../datasources/LocalGraphQLDataSource';
 import { mergeDeep } from 'apollo-utilities';
 
 import { queryPlanSerializer, astSerializer } from 'apollo-federation-integration-testsuite';
 import gql from 'graphql-tag';
 import { fixtures } from 'apollo-federation-integration-testsuite';
-import { parse } from 'graphql';
+import { composeServices } from '@apollo/composition';
+import { buildSchema, operationFromDocument } from '@apollo/federation-internals';
 
 const prettyFormat = require('pretty-format');
 
@@ -56,13 +55,15 @@ export async function execute(
 
   const { schema, queryPlanner } = getFederatedTestingSchema(services);
 
+  const operationDocument = gql`${request.query}`;
+  const operation = operationFromDocument(schema, operationDocument);
+  const queryPlan = queryPlanner.buildQueryPlan(operation);
+
   const operationContext = buildOperationContext({
-    schema,
-    operationDocument: gql`${request.query}`,
+    schema: schema.toAPISchema().toGraphQLJSSchema(),
+    operationDocument,
   });
 
-  const queryPlan = queryPlanner.buildQueryPlan(operationContext);
-
   const result = await executeQueryPlan(
     queryPlan,
     serviceMap,
@@ -85,36 +86,29 @@ export function buildLocalService(modules: GraphQLSchemaModule[]) {
 }
 
 export function getFederatedTestingSchema(services: ServiceDefinitionModule[] = fixtures) {
+  const compositionResult = composeServices(services);
+  if (compositionResult.errors) {
+    throw new GraphQLSchemaValidationError(compositionResult.errors);
+  }
+
+  const queryPlanner = new QueryPlanner(compositionResult.schema);
+  const schema = buildSchema(compositionResult.supergraphSdl);
+
   const serviceMap = Object.fromEntries(
     services.map((service) => [
       service.name,
       buildLocalService([service]),
     ]),
   );
-
-  const compositionResult = composeAndValidate(services);
-
-  if (compositionHasErrors(compositionResult)) {
-    throw new GraphQLSchemaValidationError(compositionResult.errors);
-  }
-
-  const schema = buildComposedSchema(parse(compositionResult.supergraphSdl))
-
-  const queryPlanner = new QueryPlanner(schema);
-
   return { serviceMap, schema, queryPlanner };
 }
 
 export function getTestingSupergraphSdl(services: typeof fixtures = fixtures) {
-  const compositionResult = composeAndValidate(services);
-  if (!compositionHasErrors(compositionResult)) {
+  const compositionResult = composeServices(services);
+  if (!compositionResult.errors) {
     return compositionResult.supergraphSdl;
   }
-  throw new Error(
-    `Testing fixtures don't compose properly!\n${compositionResult.errors.join(
-      '\t\n',
-    )}`,
-  );
+  throw new Error(`Testing fixtures don't compose properly!\nCauses:\n${compositionResult.errors.join('\n\n')}`);
 }
 
 export function wait(ms: number) {

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

@@ -70,10 +70,32 @@ describe('lifecycle hooks', () => {
   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: [serviceDefinitions[0]],
+          serviceDefinitions: [s1, s2],
           compositionMetadata: {
             formatVersion: 1,
             id: 'abc',
@@ -88,12 +110,12 @@ describe('lifecycle hooks', () => {
       logger,
     });
 
-    await expect(gateway.load()).rejects.toThrowError();
+    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(1);
+    expect(callbackArgs.serviceList).toHaveLength(2);
     expect(callbackArgs.errors[0]).toMatchInlineSnapshot(
-      `[GraphQLError: [product] Book -> \`Book\` is an extension type, but \`Book\` is not defined in any service]`,
+      `[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();

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

@@ -444,13 +444,6 @@ describe('reporting', () => {
                                             "child": Array [
                                               Object {
                                                 "child": Array [
-                                                  Object {
-                                                    "endTime": "45678",
-                                                    "parentType": "Book",
-                                                    "responseName": "isbn",
-                                                    "startTime": "34567",
-                                                    "type": "String!",
-                                                  },
                                                   Object {
                                                     "endTime": "45678",
                                                     "parentType": "Book",
@@ -470,13 +463,6 @@ describe('reporting', () => {
                                               },
                                               Object {
                                                 "child": Array [
-                                                  Object {
-                                                    "endTime": "45678",
-                                                    "parentType": "Book",
-                                                    "responseName": "isbn",
-                                                    "startTime": "34567",
-                                                    "type": "String!",
-                                                  },
                                                   Object {
                                                     "endTime": "45678",
                                                     "parentType": "Book",

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

@@ -39,17 +39,15 @@ it('handles an abstract type from the base service', async () => {
           {
             product(upc: $upc) {
               __typename
+              upc
               ... on Book {
-                upc
                 __typename
                 isbn
-                price
               }
               ... on Furniture {
-                upc
                 name
-                price
               }
+              price
             }
           }
         },
@@ -63,8 +61,6 @@ it('handles an abstract type from the base service', async () => {
             } =>
             {
               ... on Book {
-                __typename
-                isbn
                 title
                 year
               }
@@ -76,9 +72,9 @@ it('handles an abstract type from the base service', async () => {
             {
               ... on Book {
                 __typename
-                isbn
                 title
                 year
+                isbn
               }
             } =>
             {
@@ -368,38 +364,38 @@ it('fetches interfaces returned from other services', async () => {
         },
         Parallel {
           Flatten(path: "me.reviews.@.product") {
-            Fetch(service: "product") {
+            Fetch(service: "books") {
               {
                 ... on Book {
                   __typename
                   isbn
                 }
-                ... on Furniture {
-                  __typename
-                  upc
-                }
               } =>
               {
                 ... on Book {
-                  price
-                }
-                ... on Furniture {
-                  price
+                  title
                 }
               }
             },
           },
           Flatten(path: "me.reviews.@.product") {
-            Fetch(service: "books") {
+            Fetch(service: "product") {
               {
                 ... on Book {
                   __typename
                   isbn
                 }
+                ... on Furniture {
+                  __typename
+                  upc
+                }
               } =>
               {
                 ... on Book {
-                  title
+                  price
+                }
+                ... on Furniture {
+                  price
                 }
               }
             },
@@ -515,8 +511,6 @@ it('fetches composite fields from a foreign type casted to an interface [@provid
                 } =>
                 {
                   ... on Book {
-                    __typename
-                    isbn
                     title
                     year
                   }
@@ -528,9 +522,9 @@ it('fetches composite fields from a foreign type casted to an interface [@provid
                 {
                   ... on Book {
                     __typename
-                    isbn
                     title
                     year
+                    isbn
                   }
                 } =>
                 {
@@ -943,30 +937,24 @@ describe("doesn't result in duplicate fetches", () => {
             {
               topProducts {
                 __typename
+                name
+                price
                 ... on Book {
-                  name
-                  price
                   __typename
                   isbn
                 }
+                ... on TV {
+                  __typename
+                  id
+                }
                 ... on Computer {
-                  name
-                  price
                   __typename
                   id
                 }
                 ... on Furniture {
-                  name
-                  price
                   __typename
                   sku
                 }
-                ... on TV {
-                  name
-                  price
-                  __typename
-                  id
-                }
               }
             }
           },
@@ -977,6 +965,10 @@ describe("doesn't result in duplicate fetches", () => {
                   __typename
                   isbn
                 }
+                ... on TV {
+                  __typename
+                  id
+                }
                 ... on Computer {
                   __typename
                   id
@@ -985,10 +977,6 @@ describe("doesn't result in duplicate fetches", () => {
                   __typename
                   sku
                 }
-                ... on TV {
-                  __typename
-                  id
-                }
               } =>
               {
                 ... on Book {
@@ -1002,7 +990,7 @@ describe("doesn't result in duplicate fetches", () => {
                     id
                   }
                 }
-                ... on Computer {
+                ... on TV {
                   reviews {
                     author {
                       __typename
@@ -1013,7 +1001,7 @@ describe("doesn't result in duplicate fetches", () => {
                     id
                   }
                 }
-                ... on Furniture {
+                ... on Computer {
                   reviews {
                     author {
                       __typename
@@ -1024,7 +1012,7 @@ describe("doesn't result in duplicate fetches", () => {
                     id
                   }
                 }
-                ... on TV {
+                ... on Furniture {
                   reviews {
                     author {
                       __typename
@@ -1186,16 +1174,16 @@ it("when including the same nested fields under different type conditions", asyn
               topProducts {
                 __typename
                 ... on Book {
-                  name
-                  price
                   __typename
                   isbn
-                }
-                ... on TV {
                   name
                   price
+                }
+                ... on TV {
                   __typename
                   id
+                  name
+                  price
                 }
               }
             }
@@ -1395,16 +1383,16 @@ it('when including multiple nested fields to the same service under different ty
               topProducts {
                 __typename
                 ... on Book {
-                  name
-                  price
                   __typename
                   isbn
-                }
-                ... on TV {
                   name
                   price
+                }
+                ... on TV {
                   __typename
                   id
+                  name
+                  price
                 }
               }
             }
@@ -1788,16 +1776,16 @@ it("when including the same nested fields under different type conditions that a
               topProducts {
                 __typename
                 ... on Book {
-                  name
-                  price
                   __typename
                   isbn
-                }
-                ... on TV {
                   name
                   price
+                }
+                ... on TV {
                   __typename
                   id
+                  name
+                  price
                 }
               }
             }

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

@@ -13,7 +13,9 @@ describe('@skip', () => {
         topReviews {
           body
           author @skip(if: true) {
-            name
+            name {
+              first
+            }
           }
         }
       }

package/src/__tests__/integration/complex-key.test.ts

@@ -123,6 +123,46 @@ it('works fetches data correctly with complex / nested @key fields', async () =>
     [userService, reviewService],
   );
 
+  expect(queryPlan).toMatchInlineSnapshot(`
+    QueryPlan {
+      Sequence {
+        Fetch(service: "review") {
+          {
+            reviews {
+              author {
+                __typename
+                id
+                organization {
+                  id
+                }
+              }
+            }
+          }
+        },
+        Flatten(path: "reviews.@.author") {
+          Fetch(service: "user") {
+            {
+              ... on User {
+                __typename
+                id
+                organization {
+                  id
+                }
+              }
+            } =>
+            {
+              ... on User {
+                name
+                organization {
+                  name
+                }
+              }
+            }
+          },
+        },
+      },
+    }
+  `);
   expect(data).toEqual({
     reviews: [
       {
@@ -159,59 +199,4 @@ it('works fetches data correctly with complex / nested @key fields', async () =>
       },
     ],
   });
-  expect(queryPlan).toMatchInlineSnapshot(`
-    QueryPlan {
-      Sequence {
-        Fetch(service: "review") {
-          {
-            reviews {
-              author {
-                __typename
-                id
-                organization {
-                  id
-                  __typename
-                }
-              }
-            }
-          }
-        },
-        Parallel {
-          Flatten(path: "reviews.@.author") {
-            Fetch(service: "user") {
-              {
-                ... on User {
-                  __typename
-                  id
-                  organization {
-                    id
-                  }
-                }
-              } =>
-              {
-                ... on User {
-                  name
-                }
-              }
-            },
-          },
-          Flatten(path: "reviews.@.author.organization") {
-            Fetch(service: "user") {
-              {
-                ... on Organization {
-                  __typename
-                  id
-                }
-              } =>
-              {
-                ... on Organization {
-                  name
-                }
-              }
-            },
-          },
-        },
-      },
-    }
-  `);
 });

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

@@ -182,11 +182,11 @@ describe('gateway startup errors', () => {
       err = e;
     }
 
-    expect(err.message).toMatchInlineSnapshot(`
-      "A valid schema couldn't be composed. The following composition errors were found:
-      	[accounts] Account -> A @key selects id, but Account.id could not be found
-      	[accounts] User -> A @key selects id, but User.id could not be found"
-    `);
+    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).'
+    expect(err.message).toBe(expected);
   });
 });
 

package/src/__tests__/integration/custom-directives.test.ts

@@ -97,7 +97,10 @@ describe('custom executable directives', () => {
     `);
   });
 
-  it("returns validation errors when directives aren't present across all services", async () => {
+  // With relaxed composition, instead of erroring out if a directive is not declared everywhere, we compose but don't
+  // include the directive in the supergraph and generate a hint. So the following test will complain that @stream 
+  // is unknown in the query. Not that the hints tests do test we properly raise an hint in that case.
+  it.skip("returns validation errors when directives aren't present across all services", async () => {
     const invalidService = {
       name: 'invalidService',
       typeDefs: gql`
@@ -129,7 +132,10 @@ describe('custom executable directives', () => {
     `);
   });
 
-  it("returns validation errors when directives aren't identical across all services", async () => {
+  // Same as previous: we don't of error out on inconsistent execution directives. Here, we instead look at the intersection of locations
+  // defined, and as that is empty, we don't include the directive in the supergraph (and raise a hint).
+  // So the following test will complain that @stream is unknown in the query. Not that the hints tests do test we properly raise an hint in that case.
+  it.skip("returns validation errors when directives aren't identical across all services", async () => {
     const invalidService = {
       name: 'invalid',
       typeDefs: gql`

package/src/__tests__/integration/multiple-key.test.ts

@@ -192,9 +192,8 @@ it('fetches data correctly with multiple @key fields', async () => {
             } =>
             {
               ... on User {
-                name
-                __typename
                 ssn
+                name
               }
             }
           },
@@ -283,40 +282,40 @@ it('fetches keys as needed to reduce round trip queries', async () => {
               {
                 users {
                   __typename
-                  ssn
                   id
+                  ssn
                 }
               }
             },
             Parallel {
               Flatten(path: "users.@") {
-                Fetch(service: "actuary") {
+                Fetch(service: "reviews") {
                   {
                     ... on User {
                       __typename
-                      ssn
+                      id
                     }
                   } =>
                   {
                     ... on User {
-                      risk
+                      reviews {
+                        body
+                      }
                     }
                   }
                 },
               },
               Flatten(path: "users.@") {
-                Fetch(service: "reviews") {
+                Fetch(service: "actuary") {
                   {
                     ... on User {
                       __typename
-                      id
+                      ssn
                     }
                   } =>
                   {
                     ... on User {
-                      reviews {
-                        body
-                      }
+                      risk
                     }
                   }
                 },

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

@@ -140,8 +140,8 @@ it('collapses nested requires', async () => {
               id
               preferences {
                 favorites {
-                  color
                   animal
+                  color
                 }
               }
             }
@@ -155,8 +155,8 @@ it('collapses nested requires', async () => {
                 id
                 preferences {
                   favorites {
-                    color
                     animal
+                    color
                   }
                 }
               }