feat: required fields from mongoose schema became required in GraphQL

closes #224
graphql-compose · Jul 2, 2020 · d3d28da · d3d28da
1 parent df6afdb
commit d3d28da
Show file tree

Hide file tree

Showing 18 changed files with 88 additions and 13 deletions.
diff --git a/src/__mocks__/userModel.js b/src/__mocks__/userModel.js
@@ -28,12 +28,17 @@ const UserSchema: SchemaType<any> = new Schema(
 
     name: {
       type: String,
+      required: true,
       description: 'Person name',
     },
 
     age: {
       type: Number,
       description: 'Full years',
+      required() {
+        // in graphql this field should be Nullable
+        return this.name === 'Something special';
+      },
     },
 
     gender: {
@@ -120,7 +125,7 @@ UserSchema.set('autoIndex', false);
 UserSchema.index({ name: 1, age: -1 });
 
 // eslint-disable-next-line
-UserSchema.virtual('nameVirtual').get(function() {
+UserSchema.virtual('nameVirtual').get(function () {
   return `VirtualFieldValue${this._id}`;
 });
 

diff --git a/src/__tests__/composeWithMongoose-test.js b/src/__tests__/composeWithMongoose-test.js
@@ -208,8 +208,13 @@ describe('composeWithMongoose ->', () => {
           },
         },
       });
-      const filterArgInFindOne = typeComposer.getResolver('findOne').getArgITC('filter');
-      expect(filterArgInFindOne.isFieldNonNull('age')).toBe(true);
+
+      const ac = typeComposer.getResolver('createOne').getArgITC('record');
+      expect(ac.isFieldNonNull('age')).toBe(true);
+
+      // but should be nullable in filters
+      const ac2 = typeComposer.getResolver('findOne').getArgITC('filter');
+      expect(ac2.isFieldNonNull('age')).toBe(false);
     });
 
     it('should use cached type to avoid maximum call stack size exceeded', () => {

diff --git a/src/__tests__/composeWithMongooseDiscriminators-test.js b/src/__tests__/composeWithMongooseDiscriminators-test.js
@@ -39,9 +39,8 @@ describe('composeWithMongooseDiscriminators ->', () => {
           },
         },
       });
-      const filterArgInFindOne: any = typeComposer.getResolver('findOne').getArg('filter');
-      const inputComposer = schemaComposer.createInputTC(filterArgInFindOne.type);
-      expect(inputComposer.isFieldNonNull('kind')).toBe(true);
+      const ac: any = typeComposer.getResolver('createOne').getArgTC('record');
+      expect(ac.isFieldNonNull('kind')).toBe(true);
     });
 
     it('should proceed customizationOptions.inputType.fields.required', () => {

diff --git a/src/__tests__/fieldConverter-test.js b/src/__tests__/fieldConverter-test.js
@@ -275,7 +275,7 @@ describe('fieldConverter', () => {
     const tc = convertModelToGraphQL(UserModel, 'User', sc);
 
     it('should work with String', () => {
-      expect(tc.getFieldTypeName('name')).toBe('String');
+      expect(tc.getFieldTypeName('name')).toBe('String!');
       expect(tc.getFieldTypeName('skills')).toBe('[String]');
     });
 

diff --git a/src/fieldsConverter.js b/src/fieldsConverter.js
@@ -140,10 +140,19 @@ export function convertModelToGraphQL<TSource, TContext>(
 
   const mongooseFields = getFieldsFromModel(model);
   const graphqlFields = {};
+  const requiredFields = [];
 
   Object.keys(mongooseFields).forEach((fieldName) => {
     const mongooseField: MongooseFieldT = mongooseFields[fieldName];
 
+    if (
+      (mongooseField: any).isRequired &&
+      // conditional required field in mongoose cannot be NonNulable in GraphQL
+      typeof (mongooseField: any).originalRequiredValue !== 'function'
+    ) {
+      requiredFields.push(fieldName);
+    }
+
     graphqlFields[fieldName] = {
       type: convertFieldToGraphQL(mongooseField, typeName, sc),
       description: _getFieldDescription(mongooseField),
@@ -165,6 +174,7 @@ export function convertModelToGraphQL<TSource, TContext>(
   });
 
   typeComposer.addFields(graphqlFields);
+  typeComposer.makeFieldNonNull(requiredFields);
   return typeComposer;
 }
 

diff --git a/src/resolvers/__tests__/createMany-test.js b/src/resolvers/__tests__/createMany-test.js
@@ -187,8 +187,10 @@ describe('createMany() ->', () => {
 
   describe('Resolver.getType()', () => {
     it('should have correct output type name', () => {
-      const outputType: any = createMany(UserModel, UserTC).getType();
-      expect(outputType.name).toBe(`CreateMany${UserTC.getTypeName()}Payload`);
+      const resolver: any = createMany(UserModel, UserTC);
+      expect(resolver.getTypeName()).toBe(`CreateMany${UserTC.getTypeName()}Payload`);
+      expect(resolver.getArgITC('records').getFieldTypeName('name')).toBe('String!');
+      expect(resolver.getArgITC('records').getFieldTypeName('age')).toBe('Float');
     });
 
     it('should have recordIds field, NonNull List', () => {

diff --git a/src/resolvers/__tests__/createOne-test.js b/src/resolvers/__tests__/createOne-test.js
@@ -114,8 +114,10 @@ describe('createOne() ->', () => {
 
   describe('Resolver.getType()', () => {
     it('should have correct output type name', () => {
-      const outputType: any = createOne(UserModel, UserTC).getType();
-      expect(outputType.name).toBe(`CreateOne${UserTC.getTypeName()}Payload`);
+      const resolver = createOne(UserModel, UserTC);
+      expect(resolver.getTypeName()).toBe(`CreateOne${UserTC.getTypeName()}Payload`);
+      expect(resolver.getArgITC('record').getFieldTypeName('name')).toBe('String!');
+      expect(resolver.getArgITC('record').getFieldTypeName('age')).toBe('Float');
     });
 
     it('should have recordId field', () => {

diff --git a/src/resolvers/__tests__/findMany-test.js b/src/resolvers/__tests__/findMany-test.js
@@ -124,4 +124,12 @@ describe('findMany() ->', () => {
       expect(result).toEqual([{ overridden: true }]);
     });
   });
+
+  describe('Resolver.getType()', () => {
+    it('should have all fields optional in filter', () => {
+      const resolver = findMany(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+    });
+  });
 });
diff --git a/src/resolvers/__tests__/findOne-test.js b/src/resolvers/__tests__/findOne-test.js
@@ -138,5 +138,11 @@ describe('findOne() ->', () => {
       const outputType = findOne(UserModel, UserTC).getType();
       expect(outputType).toBe(UserTC.getType());
     });
+
+    it('should have all fields optional in filter', () => {
+      const resolver = findOne(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+    });
   });
 });
diff --git a/src/resolvers/__tests__/removeMany-test.js b/src/resolvers/__tests__/removeMany-test.js
@@ -142,5 +142,11 @@ describe('removeMany() ->', () => {
       const outputType = removeMany(UserModel, UserTC).getType();
       expect(outputType).toBe(existedType.getType());
     });
+
+    it('should have all fields optional in filter', () => {
+      const resolver = removeMany(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+    });
   });
 });
diff --git a/src/resolvers/__tests__/removeOne-test.js b/src/resolvers/__tests__/removeOne-test.js
@@ -235,5 +235,11 @@ describe('removeOne() ->', () => {
       const outputType = removeOne(UserModel, UserTC).getType();
       expect(outputType).toBe(existedType.getType());
     });
+
+    it('should have all fields optional in filter', () => {
+      const resolver = removeOne(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+    });
   });
 });
diff --git a/src/resolvers/__tests__/updateMany-test.js b/src/resolvers/__tests__/updateMany-test.js
@@ -151,5 +151,13 @@ describe('updateMany() ->', () => {
       const outputType = updateMany(UserModel, UserTC).getType();
       expect(outputType).toBe(existedType.getType());
     });
+
+    it('should have all fields optional in filter', () => {
+      const resolver = updateMany(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+      expect(resolver.getArgITC('record').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('record').getFieldTypeName('age')).toBe('Float');
+    });
   });
 });
diff --git a/src/resolvers/__tests__/updateOne-test.js b/src/resolvers/__tests__/updateOne-test.js
@@ -257,5 +257,13 @@ describe('updateOne() ->', () => {
       const outputType = updateOne(UserModel, UserTC).getType();
       expect(outputType).toBe(existedType.getType());
     });
+
+    it('should have all fields optional in filter', () => {
+      const resolver = updateOne(UserModel, UserTC);
+      expect(resolver.getArgITC('filter').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
+      expect(resolver.getArgITC('record').getFieldTypeName('name')).toBe('String');
+      expect(resolver.getArgITC('record').getFieldTypeName('age')).toBe('Float');
+    });
   });
 });
diff --git a/src/resolvers/helpers/filter.js b/src/resolvers/helpers/filter.js
@@ -72,7 +72,7 @@ export const filterHelperArgs = (
   const filterTypeName: string = opts.filterTypeName;
   const itc = typeComposer.getInputTypeComposer().clone(filterTypeName);
 
-  itc.makeFieldNullable('_id');
+  itc.makeFieldNullable(itc.getFieldNames());
 
   itc.addFields({
     _ids: [GraphQLMongoID],

diff --git a/src/resolvers/helpers/record.d.ts b/src/resolvers/helpers/record.d.ts
@@ -5,6 +5,8 @@ export type RecordHelperArgsOpts = {
   isRequired?: boolean;
   removeFields?: string[];
   requiredFields?: string[];
+  /** Make all fields nullable by default. May be overridden by `requiredFields` property */
+  allFieldsNullable?: boolean;
 };
 
 export function getRecordHelperArgsOptsMap(): Partial<
@@ -16,5 +18,5 @@ export type RecordsHelperArgs<TSource> = { records: TSource[] };
 
 export function recordHelperArgs(
   tc: ObjectTypeComposer<any>,
-  opts?: RecordHelperArgsOpts,
+  opts?: RecordHelperArgsOpts
 ): ObjectTypeComposerArgumentConfigMapDefinition;
diff --git a/src/resolvers/helpers/record.js b/src/resolvers/helpers/record.js
@@ -11,6 +11,8 @@ export type RecordHelperArgsOpts = {
   isRequired?: boolean,
   removeFields?: string[],
   requiredFields?: string[],
+  /** Make all fields nullable by default. May be overridden by `requiredFields` property */
+  allFieldsNullable?: boolean,
 };
 
 // for merging, discriminators merge-able only
@@ -42,6 +44,10 @@ export const recordHelperArgs = (
     recordITC = tc.getInputTypeComposer().clone(recordTypeName);
   }
 
+  if (opts && opts.allFieldsNullable) {
+    recordITC.makeFieldNullable(recordITC.getFieldNames());
+  }
+
   if (opts && opts.removeFields) {
     recordITC.removeField(opts.removeFields);
   }

diff --git a/src/resolvers/updateMany.js b/src/resolvers/updateMany.js
@@ -55,6 +55,7 @@ export default function updateMany<TSource: MongooseDocument, TContext>(
         recordTypeName: `UpdateMany${tc.getTypeName()}Input`,
         removeFields: ['id', '_id'],
         isRequired: true,
+        allFieldsNullable: true,
         ...(opts && opts.record),
       }),
       ...filterHelperArgs(tc, model, {

diff --git a/src/resolvers/updateOne.js b/src/resolvers/updateOne.js
@@ -52,6 +52,7 @@ export default function updateOne<TSource: MongooseDocument, TContext>(
         recordTypeName: `UpdateOne${tc.getTypeName()}Input`,
         removeFields: ['id', '_id'],
         isRequired: true,
+        allFieldsNullable: true,
         ...(opts && opts.record),
       }),
       ...filterHelperArgs(tc, model, {