feat(resolvers): now resolvers have typechecks for args param (it checks names and presence of required arguments)

Author: nodkz

package.json

@@ -31,7 +31,7 @@
     "graphql-compose-pagination": "^7.0.0"
   },
   "peerDependencies": {
-    "graphql-compose": "^7.21.0",
+    "graphql-compose": "^7.21.1",
     "mongoose": "^5.0.0 || ^4.4.0"
   },
   "devDependencies": {
@@ -46,12 +46,12 @@
     "eslint-plugin-import": "2.22.0",
     "eslint-plugin-prettier": "3.1.4",
     "graphql": "15.3.0",
-    "graphql-compose": "7.21.0",
+    "graphql-compose": "7.21.1",
     "graphql-compose-connection": "^7.0.0",
     "graphql-compose-pagination": "^7.0.0",
     "jest": "26.4.2",
     "mongodb-memory-server": "6.7.4",
-    "mongoose": "5.10.4",
+    "mongoose": "5.10.5",
     "prettier": "2.1.1",
     "request": "2.88.2",
     "rimraf": "3.0.2",

src/composeMongoose.ts

@@ -4,7 +4,6 @@ import type { Model, Document } from 'mongoose';
 import { convertModelToGraphQL } from './fieldsConverter';
 import { allResolvers } from './resolvers';
 import MongoID from './types/MongoID';
-import { ArgsMap } from './resolvers/helpers';
 import {
   prepareFields,
   createInputType,
@@ -27,13 +26,18 @@ export type ComposeMongooseOpts<TContext> = {
 };
 
 export type GenerateResolverType<TDoc extends Document, TContext = any> = {
-  // get all available resolver generators, then leave only 3rd arg – opts
+  // Get all available resolver generators, then leave only 3rd arg – opts
   // because first two args will be attached via bind() method at runtime:
   //   count = count.bind(undefined, model, tc);
-  // TODO: explain infer
   [resolver in keyof typeof allResolvers]: <TSource = any>(
     opts?: Parameters<typeof allResolvers[resolver]>[2]
-  ) => typeof allResolvers[resolver] extends (...args: any) => Resolver<any, any, infer TArgs, any>
+  ) => // Also we should patch generics of the returned Resolver
+  //   attach TContext TDoc from the code which will bind at runtime
+  //   and allow user to attach TSource via generic at call
+  // For this case we are using `extends infer` construction
+  //   it helps to extract any Generic from existed method
+  //   and then construct new combined return type
+  typeof allResolvers[resolver] extends (...args: any) => Resolver<any, any, infer TArgs, any>
     ? Resolver<TSource, TContext, TArgs, TDoc>
     : any;
 };

src/resolvers/__tests__/createMany-test.ts

@@ -59,14 +59,22 @@ describe('createMany() ->', () => {
     });
 
     it('should rejected with Error if args.records is empty', async () => {
-      const result = createMany(UserModel, UserTC).resolve({ args: {} });
+      const result = createMany(UserModel, UserTC).resolve({
+        // @ts-expect-error
+        args: {},
+      });
       await expect(result).rejects.toThrow(
         'User.createMany resolver requires args.records to be an Array and must contain at least one record'
       );
     });
 
     it('should rejected with Error if args.records is not array', async () => {
-      const result = createMany(UserModel, UserTC).resolve({ args: { records: {} } });
+      const result = createMany(UserModel, UserTC).resolve({
+        args: {
+          // @ts-expect-error
+          records: {},
+        },
+      });
       await expect(result).rejects.toThrow(
         'ser.createMany resolver requires args.records to be an Array and must contain at least one record'
       );

src/resolvers/__tests__/createOne-test.ts

@@ -51,7 +51,10 @@ describe('createOne() ->', () => {
     });
 
     it('should rejected with Error if args.record is empty', async () => {
-      const result = createOne(UserModel, UserTC).resolve({ args: {} });
+      const result = createOne(UserModel, UserTC).resolve({
+        // @ts-expect-error
+        args: {},
+      });
       await expect(result).rejects.toThrow(
         'User.createOne resolver requires at least one value in args.record'
       );

src/resolvers/__tests__/dataLoaderMany-test.ts

@@ -62,7 +62,7 @@ describe('dataLoaderMany() ->', () => {
 
     it('should return Error if args.ids contains incorrect ObjectId', async () => {
       // For more info see https://github.com/graphql/dataloader#loadmanykeys
-      //   var [ a, b, c ] = await myLoader.loadMany([ 'a', 'b', 'badkey' ]);
+      //   var [ a, b, c ] = await myLoader.loadMany([ 'a', 'b', 'badKey' ]);
       //   // c instanceof Error
       const result = await dataLoaderMany(UserModel, UserTC).resolve({
         args: { _ids: [1] },

src/resolvers/__tests__/dataLoaderManyLean-test.ts

@@ -62,7 +62,7 @@ describe('dataLoaderManyLean() ->', () => {
 
     it('should return Error if args.ids contains incorrect ObjectId', async () => {
       // For more info see https://github.com/graphql/dataloader#loadmanykeys
-      //   var [ a, b, c ] = await myLoader.loadMany([ 'a', 'b', 'badkey' ]);
+      //   var [ a, b, c ] = await myLoader.loadMany([ 'a', 'b', 'badKey' ]);
       //   // c instanceof Error
       const result = await dataLoaderManyLean(UserModel, UserTC).resolve({
         args: { _ids: [1] },

src/resolvers/__tests__/findOne-test.ts

@@ -98,7 +98,7 @@ describe('findOne() ->', () => {
 
     it('should return document if provided existed id', async () => {
       const result = await findOne(UserModel, UserTC).resolve({
-        args: { id: user1._id },
+        args: { filter: { _id: user1._id } },
       });
       expect(result.name).toBe(user1.name);
     });
@@ -122,14 +122,14 @@ describe('findOne() ->', () => {
 
     it('should return mongoose document', async () => {
       const result = await findOne(UserModel, UserTC).resolve({
-        args: { _id: user1._id },
+        args: { filter: { _id: user1._id } },
       });
       expect(result).toBeInstanceOf(UserModel);
     });
 
     it('should call `beforeQuery` method with non-executed `query` as arg', async () => {
       const result = await findOne(UserModel, UserTC).resolve({
-        args: { _id: user1._id },
+        args: { filter: { _id: user1._id } },
         beforeQuery(query: any, rp: ExtendedResolveParams) {
           expect(rp.model).toBe(UserModel);
           expect(rp.query).toHaveProperty('exec');

src/resolvers/__tests__/findOneLean-test.ts

@@ -98,7 +98,7 @@ describe('findOneLean() ->', () => {
 
     it('should return document if provided existed id', async () => {
       const result = await findOneLean(UserModel, UserTC).resolve({
-        args: { id: user1._id },
+        args: { filter: { _id: user1._id } },
       });
       expect(result.name).toBe(user1.name);
     });
@@ -122,7 +122,7 @@ describe('findOneLean() ->', () => {
 
     it('should return mongoose document', async () => {
       const result = await findOneLean(UserModel, UserTC).resolve({
-        args: { _id: user1._id },
+        args: { filter: { _id: user1._id } },
       });
       expect(result).not.toBeInstanceOf(UserModel);
       // should translate aliases fields
@@ -131,7 +131,7 @@ describe('findOneLean() ->', () => {
 
     it('should call `beforeQuery` method with non-executed `query` as arg', async () => {
       const result = await findOneLean(UserModel, UserTC).resolve({
-        args: { _id: user1._id },
+        args: { filter: { _id: user1._id } },
         beforeQuery(query: any, rp: ExtendedResolveParams) {
           expect(rp.model).toBe(UserModel);
           expect(rp.query).toHaveProperty('lean');

src/resolvers/__tests__/removeById-test.ts

@@ -60,7 +60,10 @@ describe('removeById() ->', () => {
     });
 
     it('should rejected with Error if args._id is empty', async () => {
-      const result = removeById(UserModel, UserTC).resolve({ args: {} });
+      const result = removeById(UserModel, UserTC).resolve({
+        // @ts-expect-error
+        args: {},
+      });
       await expect(result).rejects.toThrow('User.removeById resolver requires args._id value');
     });
 

src/resolvers/__tests__/removeMany-test.ts

@@ -78,7 +78,10 @@ describe('removeMany() ->', () => {
     });
 
     it('should rejected with Error if args.filter is empty', async () => {
-      const result = removeMany(UserModel, UserTC).resolve({ args: {} });
+      const result = removeMany(UserModel, UserTC).resolve({
+        // @ts-expect-error
+        args: {},
+      });
       await expect(result).rejects.toThrow(
         'User.removeMany resolver requires at least one value in args.filter'
       );