@apollo/gateway 2.1.2-alpha.0 → 2.1.2-alpha.2

package/dist/schema-helper/addExtensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"addExtensions.js","sourceRoot":"","sources":["../../src/schema-helper/addExtensions.ts"],"names":[],"mappings":";;;AAGA,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAElD,SAAgB,aAAa,CAAC,MAAqB;;IACjD,MAAM,eAAe,GAAG,MAAA,MAAM,CAAC,UAAqC,mCAAI,EAAE,CAAC;IAC3E,MAAM,eAAe,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,mCAAI,EAAE,CAAC;IACtD,MAAM,gBAAgB,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,mCAAI,EAAE,CAAC;IAExD,MAAM,CAAC,UAAU,GAAG;QAClB,GAAG,MAAM,CAAC,UAAU;QACpB,MAAM,EAAE;YACN,GAAG,eAAe;YAClB,OAAO,EAAE;gBACP,GAAG,gBAAgB;gBACnB,OAAO;aACR;SACF;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,sCAiBC"}
+{"version":3,"file":"addExtensions.js","sourceRoot":"","sources":["../../src/schema-helper/addExtensions.ts"],"names":[],"mappings":";;;AAGA,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAElD,SAAgB,aAAa,CAAC,MAAqB;;IACjD,MAAM,eAAe,GAAkC,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CAAC;IAC/E,MAAM,eAAe,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,mCAAI,EAAE,CAAC;IACtD,MAAM,gBAAgB,GAAG,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,mCAAI,EAAE,CAAC;IAExD,MAAM,CAAC,UAAU,GAAG;QAClB,GAAG,MAAM,CAAC,UAAU;QACpB,MAAM,EAAE;YACN,GAAG,eAAe;YAClB,OAAO,EAAE;gBACP,GAAG,gBAAgB;gBACnB,OAAO;aACR;SACF;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,sCAiBC"}

package/dist/typings/graphql.d.ts

@@ -1,34 +1,11 @@
-import { GraphQLResolveInfo } from 'graphql';
-declare type GraphQLReferenceResolver<TContext> = (reference: object, context: TContext, info: GraphQLResolveInfo) => any;
-interface ApolloSubgraphExtensions<TContext> {
-    resolveReference?: GraphQLReferenceResolver<TContext>;
-}
+import { GraphQLSchemaExtensions } from 'graphql';
 interface ApolloGatewayExtensions {
     version?: String;
 }
-declare module 'graphql/type/definition' {
-    interface GraphQLObjectTypeExtensions<_TSource = any, _TContext = any> {
-        apollo?: {
-            subgraph?: ApolloSubgraphExtensions<_TContext>;
-        };
-    }
-    interface GraphQLInterfaceTypeExtensions<_TSource = any, _TContext = any> {
-        apollo?: {
-            subgraph?: ApolloSubgraphExtensions<_TContext>;
-        };
-    }
-    interface GraphQLUnionTypeExtensions<_TSource = any, _TContext = any> {
-        apollo?: {
-            subgraph?: ApolloSubgraphExtensions<_TContext>;
-        };
-    }
-}
-declare module 'graphql/type/schema' {
-    interface GraphQLSchemaExtensions {
-        apollo?: {
-            gateway?: ApolloGatewayExtensions;
-        };
-    }
+export interface ApolloGraphQLSchemaExtensions extends GraphQLSchemaExtensions {
+    apollo?: {
+        gateway?: ApolloGatewayExtensions;
+    };
 }
 export {};
 //# sourceMappingURL=graphql.d.ts.map

package/dist/typings/graphql.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.d.ts","sourceRoot":"","sources":["../../src/typings/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C,aAAK,wBAAwB,CAAC,QAAQ,IAAI,CACxC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,QAAQ,EACjB,IAAI,EAAE,kBAAkB,KACrB,GAAG,CAAC;AAET,UAAU,wBAAwB,CAAC,QAAQ;IACzC,gBAAgB,CAAC,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;CACvD;AAED,UAAU,uBAAuB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,OAAO,QAAQ,yBAAyB,CAAC;IACvC,UAAU,2BAA2B,CAAC,QAAQ,GAAG,GAAG,EAAE,SAAS,GAAG,GAAG;QACnE,MAAM,CAAC,EAAE;YACP,QAAQ,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;SAChD,CAAA;KACF;IAED,UAAU,8BAA8B,CAAC,QAAQ,GAAG,GAAG,EAAE,SAAS,GAAG,GAAG;QACtE,MAAM,CAAC,EAAE;YACP,QAAQ,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;SAChD,CAAA;KACF;IAED,UAAU,0BAA0B,CAAC,QAAQ,GAAG,GAAG,EAAE,SAAS,GAAG,GAAG;QAClE,MAAM,CAAC,EAAE;YACP,QAAQ,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;SAChD,CAAA;KACF;CACF;AAED,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAU,uBAAuB;QAC/B,MAAM,CAAC,EAAE;YACP,OAAO,CAAC,EAAE,uBAAuB,CAAC;SACnC,CAAA;KACF;CACF"}
+{"version":3,"file":"graphql.d.ts","sourceRoot":"","sources":["../../src/typings/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD,UAAU,uBAAuB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,uBAAuB,CAAC;KACnC,CAAA;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/gateway",
-  "version": "2.1.2-alpha.0",
+  "version": "2.1.2-alpha.2",
   "description": "Apollo Gateway",
   "author": "Apollo <packages@apollographql.com>",
   "main": "dist/index.js",
@@ -25,9 +25,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@apollo/composition": "^2.1.2-alpha.0",
-    "@apollo/federation-internals": "^2.1.2-alpha.0",
-    "@apollo/query-planner": "^2.1.2-alpha.0",
+    "@apollo/composition": "^2.1.2-alpha.2",
+    "@apollo/federation-internals": "^2.1.2-alpha.2",
+    "@apollo/query-planner": "^2.1.2-alpha.2",
     "@apollo/server-gateway-interface": "^1.0.2",
     "@apollo/utils.createhash": "^1.1.0",
     "@apollo/utils.fetcher": "^1.1.0",
@@ -47,5 +47,5 @@
   "peerDependencies": {
     "graphql": "^16.5.0"
   },
-  "gitHead": "4ee2da1aaa93f08f1b9ff173b6ab9b895e3a53fc"
+  "gitHead": "c7bb87702c5913f5a0ecc5c2a28d2f7228e2988c"
 }

package/src/__tests__/executeQueryPlan.test.ts

@@ -3072,6 +3072,195 @@ describe('executeQueryPlan', () => {
         }
       `);
     });
+
+    test.each([
+      {
+        name: 'nullable argument, no default, no value passed',
+        argNullable: true,
+        defaultValue: undefined,
+        valuePassed: undefined,
+      },
+      {
+        name: 'nullable argument, no default, value passed',
+        argNullable: true,
+        defaultValue: undefined,
+        valuePassed: 42,
+      },
+      {
+        name: 'nullable argument, default, no value passed',
+        argNullable: true,
+        defaultValue: 24,
+        valuePassed: undefined,
+      },
+      {
+        name: 'nullable argument, default, value passed',
+        argNullable: true,
+        defaultValue: 24,
+        valuePassed: 42,
+      },
+      {
+        name: 'non-nullable argument, no default, no value passed',
+        argNullable: false,
+        defaultValue: undefined,
+        valuePassed: undefined,
+      },
+      {
+        name: 'non-nullable argument, no default, value passed',
+        argNullable: false,
+        defaultValue: undefined,
+        valuePassed: 42,
+      },
+      {
+        name: 'non-nullable argument, default, no value passed',
+        argNullable: false,
+        defaultValue: 24,
+        valuePassed: undefined,
+      },
+      {
+        name: 'non-nullable argument, default, value passed',
+        argNullable: false,
+        defaultValue: 24,
+        valuePassed: 42,
+      },
+    ])('requires on field with argument: $name', async ({
+      argNullable,
+      defaultValue,
+      valuePassed,
+    }: {
+      argNullable: boolean,
+      defaultValue?: number,
+      valuePassed?: number,
+    }) => {
+
+      const argType = `Int${argNullable ? '' : '!'}${defaultValue ? ` = ${defaultValue}` : ''}`;
+      const s1 = {
+        name: 'S1',
+        typeDefs: gql`
+          type T @key(fields: "id") {
+            id: Int!
+            x(opt: ${argType}): String!
+          }
+        `,
+        resolvers: {
+          T: {
+            __resolveReference(ref: { id: number}) {
+              return ref;
+            },
+            x(_: any, args: any) {
+              return `args: ${JSON.stringify(args)}`;
+            }
+          },
+        }
+      }
+
+      const s2 = {
+        name: 'S2',
+        typeDefs: gql`
+          type Query {
+            t: T
+          }
+
+          type T @key(fields: "id") {
+            id: Int!
+            x(opt: ${argType}): String! @external
+            y: String @requires(fields: "x${valuePassed ? `(opt: ${valuePassed})` : ''}")
+          }
+
+        `,
+        resolvers: {
+          Query: {
+            t() {
+              return {id: 0};
+            },
+          },
+          T: {
+            __resolveReference(ref: { id: number }) {
+              // the ref has already the id and f1 is a require is triggered, and we resolve f2 below
+              return ref;
+            },
+            y(parent: any) {
+              return `x: ${parent.x}`;
+            }
+          }
+        }
+      }
+
+      if (!argNullable && !defaultValue && !valuePassed) {
+        // We test all combination of `argNullable`, `defaultValue` set/unset and `valuePassed` set/unset, and all should be allowed
+        // except if the value is non-nullable and has neither a default nor a value passed. In that case, just ensure the error message
+        // is meaningful.
+        expect(() => getFederatedTestingSchema([ s1, s2 ])).toThrowError(
+          '[S2] On field "T.y", for @requires(fields: "x"): Missing mandatory value for argument "opt" of field "T.x" in selection "x"'
+        );
+        return;
+      }
+
+      const { serviceMap, schema, queryPlanner} = getFederatedTestingSchema([ s1, s2 ]);
+
+      const operation = parseOp(`
+        {
+          t {
+            y
+          }
+        }
+        `, schema);
+      const queryPlan = buildPlan(operation, queryPlanner);
+      expect(queryPlan).toMatchInlineSnapshot(`
+        QueryPlan {
+          Sequence {
+            Fetch(service: "S2") {
+              {
+                t {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "t") {
+              Fetch(service: "S1") {
+                {
+                  ... on T {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on T {
+                    x${valuePassed ? `(opt: ${valuePassed})` : ''}
+                  }
+                }
+              },
+            },
+            Flatten(path: "t") {
+              Fetch(service: "S2") {
+                {
+                  ... on T {
+                    __typename
+                    x
+                    id
+                  }
+                } =>
+                {
+                  ... on T {
+                    y
+                  }
+                }
+              },
+            },
+          },
+        }
+      `);
+
+      const response = await executePlan(queryPlan, operation, undefined, schema, serviceMap);
+      expect(response.errors).toBeUndefined();
+      expect(response.data).toMatchInlineSnapshot(`
+        Object {
+          "t": Object {
+            "y": "x: args: {${valuePassed ? `\\"opt\\":${valuePassed}` : (defaultValue ? `\\"opt\\":${defaultValue}` : '')}}",
+          },
+        }
+      `);
+    });
   });
 
   describe('@key', () => {

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(
-      'cc95112b64179c4e549de788b051f44010a02877f568649a42caeeee6a135601',
+      '55f11e687010f75c791b917d9a46745b967c5b19d20443463ed075e500bff6c8',
     );
     // second call should have previous info in the second arg
     expect(secondCall[1]!.compositionId).toEqual(expectedFirstId);

package/src/schema-helper/__tests__/addExtensions.test.ts

@@ -1,5 +1,6 @@
 import { buildSchema } from 'graphql';
 import { addExtensions } from '../addExtensions';
+import { ApolloGraphQLSchemaExtensions } from '../../typings/graphql';
 const { version } = require('../../../package.json');
 
 describe('addExtensions', () => {
@@ -7,7 +8,8 @@ describe('addExtensions', () => {
   it('adds gateway extensions to a schema', async () => {
     const schema = buildSchema('type Query { hello: String }');
     expect(schema.extensions).toEqual({});
-    expect(addExtensions(schema).extensions).toEqual({ apollo: { gateway: { version: version } } });
+    const actualExtensions: ApolloGraphQLSchemaExtensions = addExtensions(schema).extensions;
+    expect(actualExtensions).toEqual({ apollo: { gateway: { version: version } } });
   });
 
   it('does not delete existing extensions', async () => {
@@ -21,7 +23,8 @@ describe('addExtensions', () => {
         }
       }
     };
-    expect(addExtensions(schema).extensions).toEqual({
+    const actualExtensions: ApolloGraphQLSchemaExtensions = addExtensions(schema).extensions;
+    expect(actualExtensions).toEqual({
       foo: 'bar',
       apollo: {
         gateway: {
@@ -37,7 +40,8 @@ describe('addExtensions', () => {
     schema.extensions = {
       apollo: undefined
     };
-    expect(addExtensions(schema).extensions).toEqual({
+    const actualExtensions: ApolloGraphQLSchemaExtensions = addExtensions(schema).extensions;
+    expect(actualExtensions).toEqual({
       apollo: {
         gateway: {
           version: version
@@ -54,7 +58,8 @@ describe('addExtensions', () => {
         gateway: undefined
       }
     };
-    expect(addExtensions(schema).extensions).toEqual({
+    const actualExtensions: ApolloGraphQLSchemaExtensions = addExtensions(schema).extensions;
+    expect(actualExtensions).toEqual({
       apollo: {
         gateway: {
           version: version

package/src/schema-helper/addExtensions.ts

@@ -1,10 +1,10 @@
 import { GraphQLSchema } from 'graphql';
-import { GraphQLSchemaExtensions } from 'graphql/type/schema';
+import { ApolloGraphQLSchemaExtensions } from '../typings/graphql';
 
 const { version } = require('../../package.json');
 
 export function addExtensions(schema: GraphQLSchema): GraphQLSchema {
-  const schemaExtension = schema.extensions as GraphQLSchemaExtensions ?? {};
+  const schemaExtension: ApolloGraphQLSchemaExtensions = schema.extensions ?? {};
   const apolloExtension = schemaExtension?.apollo ?? {};
   const gatewayExtension = apolloExtension?.gateway ?? {};
 

package/src/typings/graphql.ts

@@ -1,43 +1,11 @@
-import { GraphQLResolveInfo } from 'graphql';
-
-type GraphQLReferenceResolver<TContext> = (
-  reference: object,
-  context: TContext,
-  info: GraphQLResolveInfo,
-) => any;
-
-interface ApolloSubgraphExtensions<TContext> {
-  resolveReference?: GraphQLReferenceResolver<TContext>;
-}
+import { GraphQLSchemaExtensions } from 'graphql';
 
 interface ApolloGatewayExtensions {
   version?: String;
 }
 
-declare module 'graphql/type/definition' {
-  interface GraphQLObjectTypeExtensions<_TSource = any, _TContext = any> {
-    apollo?: {
-      subgraph?: ApolloSubgraphExtensions<_TContext>;
-    }
-  }
-
-  interface GraphQLInterfaceTypeExtensions<_TSource = any, _TContext = any> {
-    apollo?: {
-      subgraph?: ApolloSubgraphExtensions<_TContext>;
-    }
-  }
-
-  interface GraphQLUnionTypeExtensions<_TSource = any, _TContext = any> {
-    apollo?: {
-      subgraph?: ApolloSubgraphExtensions<_TContext>;
-    }
-  }
-}
-
-declare module 'graphql/type/schema' {
-  interface GraphQLSchemaExtensions {
-    apollo?: {
-      gateway?: ApolloGatewayExtensions;
-    }
+export interface ApolloGraphQLSchemaExtensions extends GraphQLSchemaExtensions {
+  apollo?: {
+    gateway?: ApolloGatewayExtensions;
   }
 }