Switch to [email protected] (#373)

Author: IvanGoncharov

package-lock.json

@@ -40,7 +40,7 @@
     "build": "node resources/build.js"
   },
   "peerDependencies": {
-    "graphql": "^15.5.3"
+    "graphql": "^16.2.0"
   },
   "devDependencies": {
     "@babel/core": "7.15.5",
@@ -61,7 +61,7 @@
     "eslint-plugin-istanbul": "0.1.2",
     "eslint-plugin-node": "11.1.0",
     "flow-bin": "0.159.0",
-    "graphql": "15.8.0",
+    "graphql": "16.2.0",
     "mocha": "9.1.1",
     "nyc": "15.1.0",
     "prettier": "2.4.0",

package.json

@@ -116,7 +116,7 @@ const { nodeInterface, nodeField } = nodeDefinitions(
         return getShip(id);
     }
   },
-  (obj) => (obj.ships ? factionType : shipType),
+  (obj) => (obj.ships ? factionType.name : shipType.name),
 );
 
 /**

src/__tests__/starWarsSchema.ts

@@ -55,7 +55,6 @@ const userType = new GraphQLObjectType({
 
 const { connectionType: friendConnection } = connectionDefinitions({
   name: 'Friend',
-  // @ts-expect-error
   nodeType: new GraphQLNonNull(userType),
   resolveNode: (edge) => allUsers[edge.node],
   edgeFields: () => ({
@@ -73,7 +72,6 @@ const { connectionType: friendConnection } = connectionDefinitions({
 });
 
 const { connectionType: userConnection } = connectionDefinitions({
-  // @ts-expect-error
   nodeType: new GraphQLNonNull(userType),
   resolveNode: (edge) => allUsers[edge.node],
 });
@@ -184,8 +182,7 @@ describe('connectionDefinition()', () => {
   });
 
   it('generates correct types', () => {
-    // FIXME remove trimEnd after we update to `[email protected]`
-    expect(printSchema(schema).trimEnd()).to.deep.equal(dedent`
+    expect(printSchema(schema)).to.deep.equal(dedent`
       type Query {
         user: User
       }

src/connection/__tests__/connection-test.ts

@@ -6,14 +6,15 @@ import {
   GraphQLString,
   GraphQLBoolean,
   getNamedType,
+  resolveObjMapThunk,
 } from 'graphql';
 
 import type {
   GraphQLNamedOutputType,
   GraphQLFieldConfigArgumentMap,
-  GraphQLFieldConfigMap,
+  GraphQLFieldConfig,
   GraphQLFieldResolver,
-  Thunk,
+  ThunkObjMap,
 } from 'graphql';
 
 /**
@@ -79,22 +80,15 @@ export interface ConnectionConfig {
   nodeType: GraphQLNamedOutputType | GraphQLNonNull<GraphQLNamedOutputType>;
   resolveNode?: GraphQLFieldResolver<any, any>;
   resolveCursor?: GraphQLFieldResolver<any, any>;
-  edgeFields?: Thunk<GraphQLFieldConfigMap<any, any>>;
-  connectionFields?: Thunk<GraphQLFieldConfigMap<any, any>>;
+  edgeFields?: ThunkObjMap<GraphQLFieldConfig<any, any>>;
+  connectionFields?: ThunkObjMap<GraphQLFieldConfig<any, any>>;
 }
 
 export interface GraphQLConnectionDefinitions {
   edgeType: GraphQLObjectType;
   connectionType: GraphQLObjectType;
 }
 
-function resolveMaybeThunk<T>(thingOrThunk: Thunk<T>): T {
-  return typeof thingOrThunk === 'function'
-    ? // @ts-expect-error - if it's a function, we assume a thunk without arguments
-      thingOrThunk()
-    : thingOrThunk;
-}
-
 /**
  * Returns a GraphQLObjectType for a connection with the given name,
  * and whose nodes are of the specified type.
@@ -118,7 +112,7 @@ export function connectionDefinitions(
         resolve: config.resolveCursor,
         description: 'A cursor for use in pagination',
       },
-      ...resolveMaybeThunk(config.edgeFields ?? {}),
+      ...resolveObjMapThunk(config.edgeFields ?? {}),
     }),
   });
 
@@ -134,7 +128,7 @@ export function connectionDefinitions(
         type: new GraphQLList(edgeType),
         description: 'A list of edges.',
       },
-      ...resolveMaybeThunk(config.connectionFields ?? {}),
+      ...resolveObjMapThunk(config.connectionFields ?? {}),
     }),
   });
 

src/connection/connection.ts

@@ -8,6 +8,7 @@ import {
   GraphQLSchema,
   graphql,
   graphqlSync,
+  printType,
   printSchema,
 } from 'graphql';
 
@@ -48,24 +49,17 @@ describe('mutationWithClientMutationId()', () => {
       },
       mutateAndGetPayload: dummyResolve,
     });
-    const schema = wrapInSchema({ someMutation });
-    const source = `
-      mutation {
-        someMutation {
-          result
-        }
-      }
-    `;
 
-    expect(graphqlSync({ schema, source })).to.deep.equal({
-      errors: [
-        {
-          message:
-            'Field "someMutation" argument "input" of type "SomeMutationInput!" is required, but it was not provided.',
-          locations: [{ line: 3, column: 9 }],
-        },
-      ],
+    const wrapperType = new GraphQLObjectType({
+      name: 'WrapperType',
+      fields: { someMutation },
     });
+
+    expect(printType(wrapperType)).to.deep.equal(dedent`
+      type WrapperType {
+        someMutation(input: SomeMutationInput!): SomeMutationPayload
+      }
+    `);
   });
 
   it('returns the same client mutation ID', () => {
@@ -317,8 +311,7 @@ describe('mutationWithClientMutationId()', () => {
 
     const schema = wrapInSchema({ someMutation });
 
-    // FIXME remove trimEnd after we update to `[email protected]`
-    expect(printSchema(schema).trimEnd()).to.deep.equal(dedent`
+    expect(printSchema(schema)).to.deep.equal(dedent`
       type Query {
         dummy: Int
       }

src/mutation/__tests__/mutation-test.ts

@@ -3,26 +3,19 @@ import {
   GraphQLNonNull,
   GraphQLObjectType,
   GraphQLString,
+  resolveObjMapThunk,
 } from 'graphql';
 
 import type {
   GraphQLFieldConfig,
   GraphQLFieldExtensions,
-  GraphQLInputFieldConfigMap,
-  GraphQLFieldConfigMap,
+  GraphQLInputFieldConfig,
   GraphQLResolveInfo,
-  Thunk,
+  ThunkObjMap,
 } from 'graphql';
 
 type MutationFn = (object: any, ctx: any, info: GraphQLResolveInfo) => unknown;
 
-function resolveMaybeThunk<T>(thingOrThunk: Thunk<T>): T {
-  return typeof thingOrThunk === 'function'
-    ? // @ts-expect-error - if it's a function, we assume a thunk without arguments
-      thingOrThunk()
-    : thingOrThunk;
-}
-
 /**
  * A description of a mutation consumable by mutationWithClientMutationId
  * to create a GraphQLFieldConfig for that mutation.
@@ -42,8 +35,8 @@ interface MutationConfig {
   description?: string;
   deprecationReason?: string;
   extensions?: GraphQLFieldExtensions<any, any>;
-  inputFields: Thunk<GraphQLInputFieldConfigMap>;
-  outputFields: Thunk<GraphQLFieldConfigMap<any, any>>;
+  inputFields: ThunkObjMap<GraphQLInputFieldConfig>;
+  outputFields: ThunkObjMap<GraphQLFieldConfig<any, any>>;
   mutateAndGetPayload: MutationFn;
 }
 
@@ -56,13 +49,13 @@ export function mutationWithClientMutationId(
 ): GraphQLFieldConfig<unknown, unknown> {
   const { name, inputFields, outputFields, mutateAndGetPayload } = config;
   const augmentedInputFields = () => ({
-    ...resolveMaybeThunk(inputFields),
+    ...resolveObjMapThunk(inputFields),
     clientMutationId: {
       type: GraphQLString,
     },
   });
   const augmentedOutputFields = () => ({
-    ...resolveMaybeThunk(outputFields),
+    ...resolveObjMapThunk(outputFields),
     clientMutationId: {
       type: GraphQLString,
     },

src/mutation/mutation.ts

@@ -59,15 +59,15 @@ const { nodeField, nodeInterface } = nodeDefinitions(
   },
   (obj) => {
     if (obj.name) {
-      return userType;
+      return userType.name;
     }
     if (obj.photoId) {
-      return photoType;
+      return photoType.name;
     }
 
     // istanbul ignore else (Can't be reached)
     if (obj.text) {
-      return postType;
+      return postType.name;
     }
   },
 );

src/node/__tests__/global-test.ts

@@ -48,11 +48,11 @@ const { nodeField, nodesField, nodeInterface } = nodeDefinitions(
   },
   (obj) => {
     if (userData.includes(obj)) {
-      return userType;
+      return userType.name;
     }
     // istanbul ignore else (Can't be reached)
     if (photoData.includes(obj)) {
-      return photoType;
+      return photoType.name;
     }
   },
 );
@@ -315,8 +315,7 @@ describe('Node interface and fields', () => {
   });
 
   it('generates correct types', () => {
-    // FIXME remove trimEnd after we update to `[email protected]`
-    expect(printSchema(schema).trimEnd()).to.deep.equal(dedent`
+    expect(printSchema(schema)).to.deep.equal(dedent`
       """An object with an ID"""
       interface Node {
         """The id of the object."""

src/node/__tests__/node-test.ts

@@ -25,7 +25,7 @@ const userData = [
 
 const { nodeField, nodeInterface } = nodeDefinitions(
   (id) => userData.find((obj) => obj.id === id),
-  () => userType,
+  () => userType.name,
 );
 
 const userType: GraphQLObjectType = new GraphQLObjectType({