@apollo/gateway 2.4.0-alpha.1 → 2.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/gateway",
-  "version": "2.4.0-alpha.1",
+  "version": "2.4.1",
   "description": "Apollo Gateway",
   "author": "Apollo <packages@apollographql.com>",
   "main": "dist/index.js",
@@ -25,9 +25,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@apollo/composition": "2.4.0-alpha.1",
-    "@apollo/federation-internals": "2.4.0-alpha.1",
-    "@apollo/query-planner": "2.4.0-alpha.1",
+    "@apollo/composition": "2.4.1",
+    "@apollo/federation-internals": "2.4.1",
+    "@apollo/query-planner": "2.4.1",
     "@apollo/server-gateway-interface": "^1.1.0",
     "@apollo/usage-reporting-protobuf": "^4.1.0",
     "@apollo/utils.createhash": "^2.0.0",

package/src/__generated__/graphqlTypes.ts

@@ -51,11 +51,11 @@ export type FetchError = {
 export enum FetchErrorCode {
   /** This token does not have access to fetch the schema for this ref. Do not retry. */
   AccessDenied = 'ACCESS_DENIED',
-  /** This token provided is not a valid graph token. Do not retry */
+  /** This token provided is not a valid graph token. Do not retry. */
   AuthenticationFailed = 'AUTHENTICATION_FAILED',
-  /** An internal server error occurred. Please retry with some backoff */
+  /** An internal server error occurred. Please retry with some backoff. */
   RetryLater = 'RETRY_LATER',
-  /** The graphRef passed is not a valid ref or no configuration for that ref is found. Do not retry */
+  /** The graphRef passed is not a valid ref or no configuration for that ref is found. Please retry with some backoff, eg in case of undeletion. */
   UnknownRef = 'UNKNOWN_REF'
 }
 
@@ -105,6 +105,7 @@ export type QueryRouterConfigArgs = {
 
 export type QueryRouterEntitlementsArgs = {
   apiKey: Scalars['String'];
+  ifAfterId?: InputMaybe<Scalars['ID']>;
   ref: Scalars['String'];
   unlessId?: InputMaybe<Scalars['ID']>;
 };

package/src/__tests__/buildQueryPlan.test.ts

@@ -465,7 +465,6 @@ describe('buildQueryPlan', () => {
       });
     });
 
-    // TODO: Ask martijn about the meaning of this test
     it(`should only add requirements once`, () => {
       const operationString = `#graphql
         query {

package/src/__tests__/executeQueryPlan.introspection.test.ts

@@ -0,0 +1,140 @@
+import gql from 'graphql-tag';
+import { getFederatedTestingSchema, ServiceDefinitionModule } from './execution-utils';
+import { Operation, parseOperation, Schema } from "@apollo/federation-internals";
+import { QueryPlan } from '@apollo/query-planner';
+import { LocalGraphQLDataSource } from '../datasources';
+import { GatewayExecutionResult, GatewayGraphQLRequestContext } from '@apollo/server-gateway-interface';
+import { buildOperationContext } from '../operationContext';
+import { executeQueryPlan } from '../executeQueryPlan';
+
+function buildRequestContext(variables: Record<string, any>): GatewayGraphQLRequestContext {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  return {
+    cache: undefined as any,
+    context: {},
+    request: {
+      variables,
+    },
+    metrics: {},
+  };
+}
+
+async function executePlan(
+  queryPlan: QueryPlan,
+  operation: Operation,
+  schema: Schema,
+  serviceMap: { [serviceName: string]: LocalGraphQLDataSource },
+  variables: Record<string, any> = {},
+): Promise<GatewayExecutionResult> {
+  const apiSchema = schema.toAPISchema();
+  const operationContext = buildOperationContext({
+    schema: apiSchema.toGraphQLJSSchema(),
+    operationDocument: gql`${operation.toString()}`,
+  });
+  return executeQueryPlan(
+    queryPlan,
+    serviceMap,
+    buildRequestContext(variables),
+    operationContext,
+    schema.toGraphQLJSSchema(),
+    apiSchema,
+  );
+}
+
+describe('handling of introspection queries', () => {
+  const typeDefs: ServiceDefinitionModule[] = [
+    {
+      name: 'S1',
+      typeDefs: gql`
+        type Query {
+          t: [T]
+        }
+
+        interface T {
+          id: ID!
+        }
+
+        type T1 implements T @key(fields: "id") {
+          id: ID!
+          a1: Int
+        }
+
+        type T2 implements T @key(fields: "id") {
+          id: ID!
+          a2: Int
+        }
+      `,
+    },
+  ];
+  const { serviceMap, schema, queryPlanner} = getFederatedTestingSchema(typeDefs);
+
+  it('it handles aliases on introspection fields', async () => {
+    const operation = parseOperation(schema, `
+      {
+        myAlias: __type(name: "T1") {
+          kind
+          name
+        }
+      }
+    `);
+
+    const queryPlan = queryPlanner.buildQueryPlan(operation);
+    const response = await executePlan(queryPlan, operation, schema, serviceMap);
+    expect(response.errors).toBeUndefined();
+    expect(response.data).toMatchInlineSnapshot(`
+      Object {
+        "myAlias": Object {
+          "kind": "OBJECT",
+          "name": "T1",
+        },
+      }
+    `);
+  });
+
+  it('it handles aliases inside introspection fields', async () => {
+    const operation = parseOperation(schema, `
+      {
+        __type(name: "T1") {
+          myKind: kind
+          name
+        }
+      }
+    `);
+
+    const queryPlan = queryPlanner.buildQueryPlan(operation);
+    const response = await executePlan(queryPlan, operation, schema, serviceMap);
+    expect(response.errors).toBeUndefined();
+    expect(response.data).toMatchInlineSnapshot(`
+      Object {
+        "__type": Object {
+          "myKind": "OBJECT",
+          "name": "T1",
+        },
+      }
+    `);
+  });
+
+  it('it handles variables passed to introspection fields', async () => {
+    const operation = parseOperation(schema, `
+      query ($name: String!) {
+        __type(name: $name) {
+          kind
+          name
+        }
+      }
+    `);
+
+    const queryPlan = queryPlanner.buildQueryPlan(operation);
+    const response = await executePlan(queryPlan, operation, schema, serviceMap, { name: "T1" });
+    expect(response.errors).toBeUndefined();
+    expect(response.data).toMatchInlineSnapshot(`
+      Object {
+        "__type": Object {
+          "kind": "OBJECT",
+          "name": "T1",
+        },
+      }
+    `);
+  });
+});

package/src/__tests__/executeQueryPlan.test.ts

@@ -3165,7 +3165,8 @@ describe('executeQueryPlan', () => {
                     data {
                       __typename
                       foo
-                      ... on Data {
+                      ... on Bar {
+                        __typename
                         bar
                       }
                     }
@@ -3829,7 +3830,7 @@ describe('executeQueryPlan', () => {
         name: 'S1',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
+            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
 
           type Query {
             iFromS1: I
@@ -3875,7 +3876,7 @@ describe('executeQueryPlan', () => {
         name: 'S2',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject"])
+            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key", "@interfaceObject"])
 
           type Query {
             iFromS2: I
@@ -4341,7 +4342,7 @@ describe('executeQueryPlan', () => {
         name: 'products',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
+            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
 
           type Query {
             products: [Product!]!
@@ -4390,7 +4391,7 @@ describe('executeQueryPlan', () => {
         name: 'reviews',
         typeDefs: gql`
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject"])
+            @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key", "@interfaceObject"])
 
           type Query {
             allReviewedProducts: [Product!]!
@@ -4599,6 +4600,269 @@ describe('executeQueryPlan', () => {
         }
       `);
     });
+
+    test('handles querying @interfaceObject from a specific implementation', async () => {
+      const s1 = {
+        name: 's1',
+        typeDefs: gql`
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
+
+          type Query {
+            ts: [T!]!
+          }
+
+          interface I {
+            id: ID!
+          }
+
+          type T implements I @key(fields: "id") {
+            id: ID!
+          }
+        `,
+        resolvers: {
+          Query: {
+            ts: () => [ { id: '2' }, { id: '4' }, { id: '1' } ]
+          },
+        }
+      }
+
+      const s2 = {
+        name: 's2',
+        typeDefs: gql`
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject", "@external", "@requires"])
+
+          type I @key(fields: "id") @interfaceObject {
+            id: ID!
+            v: String
+          }
+        `,
+        resolvers: {
+          I: {
+            __resolveReference(ref: any) {
+              return {
+                ...ref,
+                v: `id=${ref.id}`
+              };
+            },
+          }
+        }
+      }
+
+      const { serviceMap, schema, queryPlanner} = getFederatedTestingSchema([ s1, s2 ]);
+
+      let operation = parseOp(`
+        {
+          ts {
+            v
+          }
+        }
+        `, schema);
+
+      let queryPlan = buildPlan(operation, queryPlanner);
+      const expectedPlan = `
+        QueryPlan {
+          Sequence {
+            Fetch(service: "s1") {
+              {
+                ts {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "ts.@") {
+              Fetch(service: "s2") {
+                {
+                  ... on T {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on I {
+                    v
+                  }
+                }
+              },
+            },
+          },
+        }
+      `;
+      expect(queryPlan).toMatchInlineSnapshot(expectedPlan);
+
+      let response = await executePlan(queryPlan, operation, undefined, schema, serviceMap);
+      expect(response.data).toMatchInlineSnapshot(`
+        Object {
+          "ts": Array [
+            Object {
+              "v": "id=2",
+            },
+            Object {
+              "v": "id=4",
+            },
+            Object {
+              "v": "id=1",
+            },
+          ],
+        }
+      `);
+    });
+
+    test('handles querying @interfaceObject from a specific implementation (even when the subgraph does not have the corresponding interface)', async () => {
+      const s1 = {
+        name: 's1',
+        typeDefs: gql`
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key"])
+
+          type Query {
+            ts: [T!]!
+          }
+
+          type T @key(fields: "id", resolvable: false) {
+            id: ID!
+          }
+        `,
+        resolvers: {
+          Query: {
+            ts: () => [ { id: '2' }, { id: '4' }, { id: '1' } ]
+          },
+        }
+      }
+
+      const s2 = {
+        name: 's2',
+        typeDefs: gql`
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject"])
+
+          interface I @key(fields: "id") {
+            id: ID!
+            required: String
+          }
+
+          type T implements I @key(fields: "id") {
+            id: ID!
+            required: String
+          }
+
+        `,
+        resolvers: {
+          I: {
+            __resolveReference(ref: any) {
+              return [
+                { id: '1', __typename: "T", required: "r1" },
+                { id: '2', __typename: "T", required: "r2" },
+                { id: '3', __typename: "T", required: "r3" },
+                { id: '4', __typename: "T", required: "r4" },
+              ].find(({id}) => id === ref.id);
+            },
+          },
+        }
+      }
+
+      const s3 = {
+        name: 's3',
+        typeDefs: gql`
+          extend schema
+            @link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@interfaceObject", "@external", "@requires"])
+
+          type I @key(fields: "id") @interfaceObject {
+            id: ID!
+            required: String @external
+            v: String @requires(fields: "required")
+          }
+        `,
+        resolvers: {
+          I: {
+            __resolveReference(ref: any) {
+              return {
+                ...ref,
+                v: `req=${ref.required}`
+              };
+            },
+          }
+        }
+      }
+
+      const { serviceMap, schema, queryPlanner} = getFederatedTestingSchema([ s1, s2, s3 ]);
+
+      let operation = parseOp(`
+        {
+          ts {
+            v
+          }
+        }
+        `, schema);
+
+      let queryPlan = buildPlan(operation, queryPlanner);
+      const expectedPlan = `
+        QueryPlan {
+          Sequence {
+            Fetch(service: "s1") {
+              {
+                ts {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "ts.@") {
+              Fetch(service: "s2") {
+                {
+                  ... on I {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on I {
+                    __typename
+                    required
+                  }
+                }
+              },
+            },
+            Flatten(path: "ts.@") {
+              Fetch(service: "s3") {
+                {
+                  ... on I {
+                    __typename
+                    required
+                    id
+                  }
+                } =>
+                {
+                  ... on I {
+                    v
+                  }
+                }
+              },
+            },
+          },
+        }
+      `;
+      expect(queryPlan).toMatchInlineSnapshot(expectedPlan);
+
+      let response = await executePlan(queryPlan, operation, undefined, schema, serviceMap);
+      expect(response.data).toMatchInlineSnapshot(`
+        Object {
+          "ts": Array [
+            Object {
+              "v": "req=r2",
+            },
+            Object {
+              "v": "req=r4",
+            },
+            Object {
+              "v": "req=r1",
+            },
+          ],
+        }
+      `);
+    });
   });
 
   describe('fields with conflicting types needing aliasing', () => {

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

@@ -88,7 +88,7 @@ it('correctly passes the context from ApolloServer to datasources', async () =>
     .reply(
       200,
       {
-        data: { me: { username: '@jbaxleyiii' } },
+        data: { me: { username: '@apollo-user' } },
       },
       replyHeaders,
     );
@@ -107,7 +107,7 @@ it('correctly passes the context from ApolloServer to datasources', async () =>
   const { data, errors } = unwrapSingleResultKind(result);
   expect(errors).toBeUndefined();
   expect(data).toEqual({
-    me: { username: '@jbaxleyiii' },
+    me: { username: '@apollo-user' },
   });
 });
 

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

@@ -62,7 +62,7 @@ describe('Using supergraphSdl static configuration', () => {
 
     nock(accounts.url)
       .post('/', { query: '{me{username}}', variables: {} })
-      .reply(200, { data: { me: { username: '@jbaxleyiii' } } });
+      .reply(200, { data: { me: { username: '@apollo-user' } } });
 
 
     const result = await server.executeOperation({
@@ -72,7 +72,7 @@ describe('Using supergraphSdl static configuration', () => {
     expect(unwrapSingleResultKind(result).data).toMatchInlineSnapshot(`
       Object {
         "me": Object {
-          "username": "@jbaxleyiii",
+          "username": "@apollo-user",
         },
       }
     `);

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

@@ -6,8 +6,8 @@ expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
 
 const users = [
-  { id: '1', name: 'Trevor Scheer', organizationId: '1', __typename: 'User' },
-  { id: '1', name: 'Trevor Scheer', organizationId: '2', __typename: 'User' },
+  { id: '1', name: 'Trevor', organizationId: '1', __typename: 'User' },
+  { id: '1', name: 'Trevor', organizationId: '2', __typename: 'User' },
   { id: '2', name: 'James Baxley', organizationId: '1', __typename: 'User' },
   { id: '2', name: 'James Baxley', organizationId: '3', __typename: 'User' },
 ];
@@ -162,7 +162,7 @@ it('works fetches data correctly with complex / nested @key fields', async () =>
     reviews: [
       {
         author: {
-          name: 'Trevor Scheer',
+          name: 'Trevor',
           organization: {
             name: 'Apollo',
           },
@@ -170,7 +170,7 @@ it('works fetches data correctly with complex / nested @key fields', async () =>
       },
       {
         author: {
-          name: 'Trevor Scheer',
+          name: 'Trevor',
           organization: {
             name: 'Wayfair',
           },

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

@@ -6,7 +6,7 @@ expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
 
 const users = [
-  { id: ['1', '1'], name: 'Trevor Scheer', __typename: 'User' },
+  { id: ['1', '1'], name: 'Trevor', __typename: 'User' },
   { id: ['2', '2'], name: 'James Baxley', __typename: 'User' },
 ];
 
@@ -89,7 +89,7 @@ it('fetches data correctly list type @key fields', async () => {
 
   expect(data).toEqual({
     reviews: [
-      { body: 'Good', author: { name: 'Trevor Scheer' } },
+      { body: 'Good', author: { name: 'Trevor' } },
       { body: 'Bad', author: { name: 'James Baxley' } },
     ],
   });

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

@@ -7,7 +7,7 @@ expect.addSnapshotSerializer(queryPlanSerializer);
 
 const users = [
   { ssn: '111-11-1111', name: 'Trevor', id: '10', __typename: 'User' },
-  { ssn: '222-22-2222', name: 'Scheer', id: '20', __typename: 'User' },
+  { ssn: '222-22-2222', name: 'Joel', id: '20', __typename: 'User' },
   { ssn: '333-33-3333', name: 'James', id: '30', __typename: 'User' },
   { ssn: '444-44-4444', name: 'Baxley', id: '40', __typename: 'User' },
 ];
@@ -148,7 +148,7 @@ it('fetches data correctly with multiple @key fields', async () => {
         body: 'B',
         author: {
           risk: 0.2,
-          name: 'Scheer',
+          name: 'Joel',
         },
       },
       {

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

@@ -218,13 +218,13 @@ it('collapses nested requires with user-defined fragments', async () => {
           {
             user {
               __typename
-              id
               preferences {
                 favorites {
-                  animal
                   color
+                  animal
                 }
               }
+              id
             }
           }
         },

package/src/__tests__/integration/single-service.test.ts

@@ -18,7 +18,7 @@ const accounts = {
   `,
   resolvers: {
     Query: {
-      me: () => ({ id: 1, name: 'Martijn' }),
+      me: () => ({ id: 1, name: 'Me' }),
     },
   },
 };

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

@@ -98,14 +98,7 @@ describe('value types', () => {
                     reviews {
                       metadata {
                         __typename
-                        ... on KeyValue {
-                          key
-                          value
-                        }
-                        ... on Error {
-                          code
-                          message
-                        }
+                        ...Metadata
                       }
                     }
                   }
@@ -113,18 +106,22 @@ describe('value types', () => {
                     reviews {
                       metadata {
                         __typename
-                        ... on KeyValue {
-                          key
-                          value
-                        }
-                        ... on Error {
-                          code
-                          message
-                        }
+                        ...Metadata
                       }
                     }
                   }
                 }
+                
+                fragment Metadata on MetadataOrError {
+                  ... on KeyValue {
+                    key
+                    value
+                  }
+                  ... on Error {
+                    code
+                    message
+                  }
+                }
               },
             },
             Flatten(path: "topProducts.@") {