fix(mongoose): smart has many relationships for mongoose major versions 6 and 7 (#1053)

Author: DayTF

src/services/has-many-getter.js

@@ -51,6 +51,7 @@ class HasManyGetter {
       if (field.reference) {
         query.populate({
           path: field.field,
+          strictPopulate: false,
         });
       }
     });

src/services/resource-getter.js

@@ -15,7 +15,7 @@ class ResourceGetter {
     const schema = Interface.Schemas.schemas[utils.getModelName(this._model)];
     _.each(schema.fields, (field) => {
       if (field.reference) {
-        query.populate(field.field);
+        query.populate({ path: field.field, strictPopulate: false });
       }
     });
   }

src/services/resource-updater.js

@@ -35,7 +35,7 @@ class ResourceUpdater {
     );
 
     _.each(schema.fields, (field) => {
-      if (field.reference) { query.populate(field.field); }
+      if (field.reference) { query.populate({ path: field.field, strictPopulate: false }); }
     });
 
     try {

test/tests/services/resource-getter.test.js

@@ -11,6 +11,7 @@ const options = { Mongoose: mongoose, connections: { mongoose } };
 
 describe('service > resource-getter', () => {
   let ReviewModel;
+  let UserModel;
   let scopeSpy;
 
   beforeAll(async () => {
@@ -24,16 +25,36 @@ describe('service > resource-getter', () => {
           fields: [
             { field: '_id', type: 'String' },
             { field: 'rating', type: 'Number' },
+            { field: 'reviewer', type: 'String', reference: 'User._id' },
+          ],
+        },
+        User: {
+          name: 'User',
+          idField: '_id',
+          primaryKeys: ['_id'],
+          isCompositePrimary: false,
+          searchFields: ['name'],
+          fields: [
+            { field: '_id', type: 'String' },
+            { field: 'name', type: 'String' },
           ],
         },
       },
     };
 
     await mongooseConnect();
 
-    ReviewModel = mongoose.model('ReviewsRGet', new mongoose.Schema({
+    const UserSchema = new mongoose.Schema({
+      _id: { type: 'ObjectId' },
+      name: { type: String },
+    });
+    UserModel = mongoose.model('User', UserSchema, 'users');
+
+    const ReviewSchema = new mongoose.Schema({
       rating: { type: Number },
-    }));
+      reviewer: { type: 'ObjectId', ref: 'User' },
+    });
+    ReviewModel = mongoose.model('ReviewsRGet', ReviewSchema);
   });
 
   afterAll(async () => {
@@ -43,6 +64,7 @@ describe('service > resource-getter', () => {
 
   beforeEach(async () => {
     await ReviewModel.deleteMany({});
+    await UserModel.deleteMany({});
   });
 
   it('should reject when the record does not exists', async () => {
@@ -68,4 +90,33 @@ describe('service > resource-getter', () => {
       rating: 0,
     });
   });
+
+  describe('when fetching with referenced field', () => {
+    it('should return the record properly', async () => {
+      expect.assertions(1);
+
+      await loadFixture(UserModel, [
+        { _id: '64fad8058f3de3f425abc85c', name: 'Bobby' },
+      ]);
+      await loadFixture(ReviewModel, [
+        { _id: '507f1f77bcf86cd799439011', rating: 5, reviewer: '64fad8058f3de3f425abc85c' },
+      ]);
+
+      const params = {
+        ...baseParams,
+        recordId: '507f1f77bcf86cd799439011',
+      };
+      const getter = new ResourceGetter(ReviewModel, params, options, user);
+      expect(await getter.perform()).toStrictEqual({
+        __v: 0, // mongoose version
+        _id: new mongoose.Types.ObjectId('507f1f77bcf86cd799439011'),
+        rating: 5,
+        reviewer: {
+          __v: 0, // mongoose version
+          _id: new mongoose.Types.ObjectId('64fad8058f3de3f425abc85c'),
+          name: 'Bobby',
+        },
+      });
+    });
+  });
 });