fix(compatibility): fix mongoose 7 compatibility (#1040)

Author: romain-gilliotte

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 14.17.6
+          node-version: 14.20.1
       - uses: actions/cache@v2
         with:
           path: '**/node_modules'

package.json

@@ -59,7 +59,7 @@
     "jest": "26.6.3",
     "jest-extended": "0.11.5",
     "lint-staged": "12.3.7",
-    "mongoose": "5.13.15",
+    "mongoose": "7.2.2",
     "mongoose-fixture-loader": "1.0.2",
     "semantic-release": "19.0.3",
     "semantic-release-npm-deprecate-old-versions": "1.3.2",

src/services/filters-parser.js

@@ -22,8 +22,8 @@ function FiltersParser(model, timezone, options) {
     // automatically cast 'looking like' string value to ObjectId
     // CF Github Issue https://github.com/Automattic/mongoose/issues/1399
     const { ObjectId } = options.Mongoose.Types;
-    if (ObjectId.isValid(value) && ObjectId(value).toString() === value) {
-      return ObjectId(value);
+    if (ObjectId.isValid(value) && new ObjectId(value).toString() === value) {
+      return new ObjectId(value);
     }
 
     return value;
@@ -172,8 +172,8 @@ function FiltersParser(model, timezone, options) {
       throw new InvalidFiltersFormatError('Filters cannot be a raw array');
     }
     if (!_.isString(condition.field)
-        || !_.isString(condition.operator)
-        || _.isUndefined(condition.value)) {
+      || !_.isString(condition.operator)
+      || _.isUndefined(condition.value)) {
       throw new InvalidFiltersFormatError('Invalid condition format');
     }
 

src/services/has-many-getter.js

@@ -78,7 +78,7 @@ class HasManyGetter {
   async _getRecordsAndRecordIds() {
     let id = this._params.recordId;
     if (OBJECTID_REGEXP.test(this._params.recordId)) {
-      id = this._opts.Mongoose.Types.ObjectId(id);
+      id = new this._opts.Mongoose.Types.ObjectId(id);
     }
 
     const parentRecords = await this._parentModel
@@ -117,7 +117,7 @@ class HasManyGetter {
       // NOTICE: Convert values to strings, so ObjectIds could be easily searched and compared.
       const recordIdStrings = childRecordIds.map((recordId) => String(recordId));
       // NOTICE: indexOf could be improved by making a Map from record-ids to their index.
-          recordsSorted = _.sortBy(childRecords, record => recordIdStrings.indexOf(String(record._id))); // eslint-disable-line
+      recordsSorted = _.sortBy(childRecords, record => recordIdStrings.indexOf(String(record._id))); // eslint-disable-line
     }
 
     let sortedChildRecords = descending ? recordsSorted.reverse() : recordsSorted;

src/services/search-builder.js

@@ -21,17 +21,17 @@ function SearchBuilder(model, opts, params, searchFields) {
 
     _.each(model.schema.paths, (value, key) => {
       if ((searchFields && !searchFields.includes(value.path))
-      || value.path === model.schema.options.versionKey) {
+        || value.path === model.schema.options.versionKey) {
         return;
       }
 
       const condition = {};
       const searchValue = params.search.replace(/[-[\]{}()*+!<=:?./\\^$|#\s,]/g, '\\$&');
       const searchRegexp = new RegExp(`.*${searchValue}.*`, 'i');
 
-      if (value.instance === 'ObjectID') {
+      if (value.instance === 'ObjectID' || value.instance === 'ObjectId') {
         if (new RegExp('^[0-9a-fA-F]{24}$').test(params.search)) {
-          condition[key] = opts.Mongoose.Types.ObjectId(params.search);
+          condition[key] = new opts.Mongoose.Types.ObjectId(params.search);
           pushCondition(condition, key);
         }
       } else if (value.instance === 'Number') {

src/utils/field-analyser.js

@@ -148,7 +148,7 @@ class FieldAnalyser {
     if (fieldInfo.enumValues && fieldInfo.enumValues.length) {
       return 'Enum';
     }
-    if (fieldInfo.instance === 'ObjectID') {
+    if (fieldInfo.instance === 'ObjectID' || fieldInfo.instance === 'ObjectId') {
       // Deal with ObjectID
       return 'String';
     }

src/utils/schema.js

@@ -21,12 +21,14 @@ const getNestedFieldType = (mongooseSchema, nestedFieldPath) => {
 
   let nestedFieldDeclaration;
 
-  if (mongooseSchema.tree) {
+  if (mongooseSchema.tree?.[currentFieldName]) {
     nestedFieldDeclaration = mongooseSchema.tree[currentFieldName];
-  } else if (mongooseSchema.type) {
+  } else if (mongooseSchema.type?.[currentFieldName]) {
     nestedFieldDeclaration = mongooseSchema.type[currentFieldName];
-  } else {
+  } else if (mongooseSchema[currentFieldName]) {
     nestedFieldDeclaration = mongooseSchema[currentFieldName];
+  } else if (mongooseSchema.type?.tree?.[currentFieldName]) {
+    nestedFieldDeclaration = mongooseSchema.type?.tree?.[currentFieldName];
   }
 
   if (!nestedFieldDeclaration) return undefined;

test/tests/adapters/mongoose.test.js

@@ -7,11 +7,15 @@ const { Schema } = mongoose;
 describe('adapters > schema-adapter', () => {
   afterEach((done) => {
     delete mongoose.models.Foo;
-    delete mongoose.modelSchemas.Foo;
     delete mongoose.models.User;
-    delete mongoose.modelSchemas.User;
     delete mongoose.models.Bar;
-    delete mongoose.modelSchemas.Bar;
+
+    // For older mongoose versions
+    if (mongoose.modelSchemas) {
+      delete mongoose.modelSchemas.Foo;
+      delete mongoose.modelSchemas.User;
+      delete mongoose.modelSchemas.Bar;
+    }
     done();
   });
 

test/tests/services/filters-parser.test.js

@@ -155,7 +155,7 @@ describe('service > filters-parser', () => {
         const parser = defaultParser.getParserForType('ObjectId');
 
         expect(parser('53c2ae8528d75d572c06adbc')).toBeInstanceOf(mongoose.Types.ObjectId);
-        expect(parser(ObjectId('53c2ae8528d75d572c06adbc'))).toBeInstanceOf(mongoose.Types.ObjectId);
+        expect(parser(new ObjectId('53c2ae8528d75d572c06adbc'))).toBeInstanceOf(mongoose.Types.ObjectId);
         expect(parser('53c2ae8528d75d572c06adbcc')).not.toBeInstanceOf(mongoose.Types.ObjectId);
         expect(parser('star wars with the same ')).not.toBeInstanceOf(mongoose.Types.ObjectId);
       });

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

@@ -64,7 +64,7 @@ describe('service > resource-getter', () => {
     const getter = new ResourceGetter(ReviewModel, params, options, user);
     expect(await getter.perform()).toStrictEqual({
       __v: 0, // mongoose version
-      _id: mongoose.Types.ObjectId('507f1f77bcf86cd799439011'),
+      _id: new mongoose.Types.ObjectId('507f1f77bcf86cd799439011'),
       rating: 0,
     });
   });