Merge pull request #13796 from Automattic/7.5

7.5

lib/document.js

@@ -4091,6 +4091,14 @@ function applyGetters(self, json, options) {
       if (ii === last) {
         const val = self.$get(path);
         branch[part] = clone(val, options);
+        if (Array.isArray(branch[part]) && schema.paths[path].$embeddedSchemaType) {
+          for (let i = 0; i < branch[part].length; ++i) {
+            branch[part][i] = schema.paths[path].$embeddedSchemaType.applyGetters(
+              branch[part][i],
+              self
+            );
+          }
+        }
       } else if (v == null) {
         if (part in cur) {
           branch[part] = v;

lib/helpers/query/castUpdate.js

@@ -14,6 +14,24 @@ const schemaMixedSymbol = require('../../schema/symbols').schemaMixedSymbol;
 const setDottedPath = require('../path/setDottedPath');
 const utils = require('../../utils');
 
+const mongodbUpdateOperators = new Set([
+  '$currentDate',
+  '$inc',
+  '$min',
+  '$max',
+  '$mul',
+  '$rename',
+  '$set',
+  '$setOnInsert',
+  '$unset',
+  '$addToSet',
+  '$pop',
+  '$pull',
+  '$push',
+  '$pullAll',
+  '$bit'
+]);
+
 /**
  * Casts an update op based on the given schema
  *
@@ -58,7 +76,7 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
   while (i--) {
     const op = ops[i];
     // if overwrite is set, don't do any of the special $set stuff
-    if (op[0] !== '$' && !overwrite) {
+    if (!mongodbUpdateOperators.has(op) && !overwrite) {
       // fix up $set sugar
       if (!ret.$set) {
         if (obj.$set) {
@@ -88,7 +106,7 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
     if (val &&
         typeof val === 'object' &&
         !Buffer.isBuffer(val) &&
-        (!overwrite || hasDollarKey)) {
+        (!overwrite || mongodbUpdateOperators.has(op))) {
       walkUpdatePath(schema, val, op, options, context, filter);
     } else if (overwrite && ret && typeof ret === 'object') {
       walkUpdatePath(schema, ret, '$set', options, context, filter);
@@ -540,7 +558,7 @@ function castUpdateVal(schema, val, op, $conditional, context, path) {
     return Boolean(val);
   }
 
-  if (/^\$/.test($conditional)) {
+  if (mongodbUpdateOperators.has($conditional)) {
     return schema.castForQuery(
       $conditional,
       val,

lib/model.js

@@ -4083,13 +4083,13 @@ Model.aggregate = function aggregate(pipeline, options) {
  *     }
  *
  * @param {Object} obj
- * @param {Array|String} pathsToValidate
+ * @param {Object|Array|String} pathsOrOptions
  * @param {Object} [context]
  * @return {Promise|undefined}
  * @api public
  */
 
-Model.validate = async function validate(obj, pathsToValidate, context) {
+Model.validate = async function validate(obj, pathsOrOptions, context) {
   if ((arguments.length < 3) || (arguments.length === 3 && typeof arguments[2] === 'function')) {
     // For convenience, if we're validating a document or an object, make `context` default to
     // the model so users don't have to always pass `context`, re: gh-10132, gh-10346
@@ -4106,9 +4106,20 @@ Model.validate = async function validate(obj, pathsToValidate, context) {
   }
   let paths = Object.keys(schema.paths);
 
-  if (pathsToValidate != null) {
-    const _pathsToValidate = typeof pathsToValidate === 'string' ? new Set(pathsToValidate.split(' ')) : new Set(pathsToValidate);
+  if (pathsOrOptions != null) {
+    const _pathsToValidate = typeof pathsOrOptions === 'string' ? new Set(pathsOrOptions.split(' ')) : Array.isArray(pathsOrOptions) ? new Set(pathsOrOptions) : new Set(paths);
     paths = paths.filter(p => {
+      if (pathsOrOptions.pathsToSkip) {
+        if (Array.isArray(pathsOrOptions.pathsToSkip)) {
+          if (pathsOrOptions.pathsToSkip.find(x => x == p)) {
+            return false;
+          }
+        } else if (typeof pathsOrOptions.pathsToSkip == 'string') {
+          if (pathsOrOptions.pathsToSkip.includes(p)) {
+            return false;
+          }
+        }
+      }
       const pieces = p.split('.');
       let cur = pieces[0];
 

lib/query.js

@@ -1683,6 +1683,15 @@ const printRawResultDeprecationWarning = util.deprecate(
   'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: false` as a replacement for `rawResult: true`.'
 );
 
+/*!
+ * ignore
+ */
+
+const printOverwriteDeprecationWarning = util.deprecate(
+  function printOverwriteDeprecationWarning() {},
+  'The `overwrite` option for `findOneAndUpdate()` is deprecated. use `findOneAndReplace()` instead.'
+);
+
 /**
  * Sets the [`explain` option](https://www.mongodb.com/docs/manual/reference/method/cursor.explain/),
  * which makes this query return detailed execution stats instead of the actual
@@ -3283,6 +3292,10 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
 
 Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   // For backwards compability with Mongoose 6 re: #13550
+
+  if (this._mongooseOptions.overwrite != null) {
+    printOverwriteDeprecationWarning();
+  }
   if (this._mongooseOptions.overwrite) {
     this.op = 'findOneAndReplace';
     return this._findOneAndReplace();
@@ -3587,9 +3600,6 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
   }
 
   if (replacement != null) {
-    if (hasDollarKeys(replacement)) {
-      throw new Error('The replacement document must not contain atomic operators.');
-    }
     this._mergeUpdate(replacement);
   }
 

lib/schema.js

@@ -2045,6 +2045,12 @@ Schema.prototype.index = function(fields, options) {
   if (options.expires) {
     utils.expires(options);
   }
+  for (const key in fields) {
+    if (this.aliases[key]) {
+      fields[this.aliases[key]] = fields[key];
+      delete fields[key];
+    }
+  }
 
   for (const field of Object.keys(fields)) {
     if (fields[field] === 'ascending' || fields[field] === 'asc') {

lib/schema/array.js

@@ -289,13 +289,6 @@ SchemaArray.prototype.applyGetters = function(value, scope) {
   }
 
   const ret = SchemaType.prototype.applyGetters.call(this, value, scope);
-  if (Array.isArray(ret)) {
-    const rawValue = utils.isMongooseArray(ret) ? ret.__array : ret;
-    const len = rawValue.length;
-    for (let i = 0; i < len; ++i) {
-      rawValue[i] = this.caster.applyGetters(rawValue[i], scope);
-    }
-  }
   return ret;
 };
 

lib/types/array/index.js

@@ -90,6 +90,9 @@ function MongooseArray(values, path, doc, schematype) {
       if (mongooseArrayMethods.hasOwnProperty(prop)) {
         return mongooseArrayMethods[prop];
       }
+      if (typeof prop === 'string' && numberRE.test(prop) && schematype?.$embeddedSchemaType != null) {
+        return schematype.$embeddedSchemaType.applyGetters(__array[prop], doc);
+      }
 
       return __array[prop];
     },

lib/utils.js

@@ -640,7 +640,10 @@ exports.getValue = function(path, obj, map) {
 const mapGetterOptions = Object.freeze({ getters: false });
 
 function getValueLookup(obj, part) {
-  const _from = obj?._doc || obj;
+  let _from = obj?._doc || obj;
+  if (_from != null && _from.isMongooseArrayProxy) {
+    _from = _from.__array;
+  }
   return _from instanceof Map ?
     _from.get(part, mapGetterOptions) :
     _from[part];

package.json

@@ -21,7 +21,7 @@
   "dependencies": {
     "bson": "^5.4.0",
     "kareem": "2.5.1",
-    "mongodb": "5.7.0",
+    "mongodb": "5.8.1",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",

test/document.test.js

@@ -5564,6 +5564,7 @@ describe('document', function() {
       const Test = db.model('Test', testSchema);
 
       const doc = new Test({ arr: [new mongoose.Types.ObjectId()] });
+      assert.equal(called, 0);
       assert.deepEqual(doc.toObject({ getters: true }).arr, [42]);
       assert.equal(called, 1);
     });
@@ -5582,7 +5583,6 @@ describe('document', function() {
 
       const Test = db.model('Test', testSchema);
 
-
       let doc = await Test.create({ arr: [new mongoose.Types.ObjectId()] });
       assert.equal(called, 1);
 
@@ -12343,6 +12343,55 @@ describe('document', function() {
     assert.strictEqual(Object.polluted, undefined);
   });
 
+  it('does not modify array when calling getters (gh-13748)', async function() {
+    // create simple setter to add a sufix
+    const addSufix = (name) => {
+      return name + '-sufix';
+    };
+
+    // create simple gettrer to remove last 6 letters (should be "-sufix")
+    const removeSufix = (name) => {
+      return ('' + name).slice(0, -6);
+    };
+
+    const userSchema = new mongoose.Schema(
+      {
+        name: String,
+        age: Number,
+        profession: {
+          type: String,
+          get: removeSufix,
+          set: addSufix
+        },
+        hobbies: [{ type: String, get: removeSufix, set: addSufix }]
+      },
+      {
+        toObject: { getters: true },
+        toJSON: { getters: true }
+      }
+    );
+    const User = db.model('User', userSchema);
+
+    const usr = await User.create({
+      name: 'John',
+      age: 18,
+      profession: 'teacher',
+      hobbies: ['swimming', 'football']
+    });
+
+    const oneUser = await User.findById(usr._id).orFail();
+    assert.equal(oneUser.profession, 'teacher');
+    assert.equal(oneUser.profession, 'teacher');
+    assert.equal(oneUser.profession, 'teacher');
+    assert.equal(oneUser.hobbies[0], 'swimming');
+    assert.equal(oneUser.hobbies[0], 'swimming');
+    assert.equal(oneUser.hobbies[0], 'swimming');
+
+    assert.equal(oneUser.get('hobbies.0'), 'swimming');
+    assert.equal(oneUser.get('hobbies.0'), 'swimming');
+    assert.equal(oneUser.get('hobbies.0'), 'swimming');
+  });
+
   it('sets defaults on subdocs with subdoc projection (gh-13720)', async function() {
     const subSchema = new mongoose.Schema({
       propertyA: { type: String, default: 'A' },

test/model.updateOne.test.js

@@ -3051,6 +3051,24 @@ describe('model: updateOne: ', function() {
       await Person.updateOne({ name: 'Anakin' }, { name: 'The Chosen One' }).orFail();
     }, { message: 'No document found for query "{ name: \'Anakin\' }" on model "gh-11620"' });
   });
+  it('updateOne with top level key that starts with $ (gh-13786)', async function() {
+    const [major] = await start.mongodVersion();
+    // Top-level dollar key support was added in MongoDB 5
+    if (major < 5) {
+      return this.skip();
+    }
+
+    const schema = new mongoose.Schema({
+      $myKey: String
+    });
+
+    const Test = db.model('Test', schema);
+
+    const _id = new mongoose.Types.ObjectId();
+    await Test.updateOne({ _id }, { $myKey: 'gh13786' }, { upsert: true });
+    const doc = await Test.findById(_id);
+    assert.equal(doc.$myKey, 'gh13786');
+  });
 });
 
 async function delay(ms) {

test/model.validate.test.js

@@ -144,4 +144,43 @@ describe('model: validate: ', function() {
     const err2 = await User.validate({ name: 'Sam' }).then(() => null, err => err);
     assert.ok(err2 === null);
   });
+  it('Model.validate(...) supports passing in an object, array or string (gh-10353)', async function() {
+    const testSchema = new Schema({
+      docs: {
+        type: String,
+        validate: () => false
+      },
+      name: {
+        type: String,
+        validate: () => false
+      },
+      obj: {
+        type: String,
+        validate: () => false
+      },
+      arr: {
+        type: String,
+        validate: () => false
+      }
+    });
+
+    const Test = mongoose.model('Test', testSchema);
+
+    let test = { obj: 1, docs: 'a doc' };
+    let pathsOrOptions = { pathsToSkip: ['obj'] };
+    await assert.rejects(async() => {
+      await Test.validate(test, pathsOrOptions);
+    }, { message: 'Validation failed: docs: Validator failed for path `docs` with value `a doc`' });
+    test = { arr: 1, docs: 'a doc' };
+    pathsOrOptions = ['arr'];
+    await assert.rejects(async() => {
+      await Test.validate(test, pathsOrOptions);
+    }, { message: 'Validation failed: arr: Validator failed for path `arr` with value `1`' });
+    test = { name: 1, docs: 'a doc' };
+    pathsOrOptions = 'name';
+    await assert.rejects(async() => {
+      await Test.validate(test, pathsOrOptions);
+    }, { message: 'Validation failed: name: Validator failed for path `name` with value `1`' });
+
+  });
 });

test/schema.alias.test.js

@@ -183,6 +183,18 @@ describe('schema alias option', function() {
     assert.ok(schema.virtuals['name1']);
     assert.ok(schema.virtuals['name2']);
   });
+  it('supports passing the alias name for an index (gh-13276)', function() {
+    const testSchema = new Schema({
+      fullName: {
+        type: String,
+        alias: 'short'
+      }
+    });
+    testSchema.index({ short: 1 });
+    const indexes = testSchema.indexes();
+    assert.equal(indexes[0][0].fullName, 1);
+  });
+
   it('should disable the id virtual entirely if there\'s a field with alias `id` gh-13650', async function() {
 
     const testSchema = new Schema({