Merge pull request #14833 from Automattic/vkarpov15/gh-14827

vkarpov15 · web-flow · commit 05055f0a6fa9 · 2024-08-28T10:05:55.000-04:00
fix(populate): fix a couple of other places where we get the document's _id with getters
diff --git a/lib/document.js b/lib/document.js
@@ -842,7 +842,7 @@ function init(self, obj, doc, opts, prefix) {
  */
 
 Document.prototype.updateOne = function updateOne(doc, options, callback) {
-  const query = this.constructor.updateOne({ _id: this._id }, doc, options);
+  const query = this.constructor.updateOne({ _id: this._doc._id }, doc, options);
   const self = this;
   query.pre(function queryPreUpdateOne(cb) {
     self.constructor._middleware.execPre('updateOne', self, [self], cb);
@@ -883,7 +883,7 @@ Document.prototype.updateOne = function updateOne(doc, options, callback) {
 
 Document.prototype.replaceOne = function replaceOne() {
   const args = [...arguments];
-  args.unshift({ _id: this._id });
+  args.unshift({ _id: this._doc._id });
   return this.constructor.replaceOne.apply(this.constructor, args);
 };
 
@@ -3050,7 +3050,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
       } else if (val != null && val.$__ != null && val.$__.wasPopulated) {
         // Array paths, like `somearray.1`, do not show up as populated with `$populated()`,
         // so in that case pull out the document's id
-        val = val._id;
+        val = val._doc._id;
       }
       const scope = _this.$__.pathsToScopes != null && path in _this.$__.pathsToScopes ?
         _this.$__.pathsToScopes[path] :
diff --git a/lib/error/parallelSave.js b/lib/error/parallelSave.js
@@ -15,7 +15,7 @@ class ParallelSaveError extends MongooseError {
    */
   constructor(doc) {
     const msg = 'Can\'t save() the same doc multiple times in parallel. Document: ';
-    super(msg + doc._id);
+    super(msg + doc._doc._id);
   }
 }
 
diff --git a/lib/error/parallelValidate.js b/lib/error/parallelValidate.js
@@ -16,7 +16,7 @@ class ParallelValidateError extends MongooseError {
    */
   constructor(doc) {
     const msg = 'Can\'t validate() the same doc multiple times in parallel. Document: ';
-    super(msg + doc._id);
+    super(msg + doc._doc._id);
   }
 }
 
diff --git a/lib/error/version.js b/lib/error/version.js
@@ -17,7 +17,7 @@ class VersionError extends MongooseError {
    */
   constructor(doc, currentVersion, modifiedPaths) {
     const modifiedPathsStr = modifiedPaths.join(', ');
-    super('No matching document found for id "' + doc._id +
+    super('No matching document found for id "' + doc._doc._id +
       '" version ' + currentVersion + ' modifiedPaths "' + modifiedPathsStr + '"');
     this.version = currentVersion;
     this.modifiedPaths = modifiedPaths;
diff --git a/lib/helpers/model/discriminator.js b/lib/helpers/model/discriminator.js
@@ -115,6 +115,9 @@ module.exports = function discriminator(model, name, schema, tiedValue, applyPlu
       }
     }
 
+    // Shallow clone `obj` so we can add additional properties without modifying original
+    // schema. `Schema.prototype.clone()` copies `obj` by reference, no cloning.
+    schema.obj = { ...schema.obj };
     mergeDiscriminatorSchema(schema, baseSchema);
 
     // Clean up conflicting paths _after_ merging re: gh-6076
diff --git a/lib/helpers/populate/getModelsMapForPopulate.js b/lib/helpers/populate/getModelsMapForPopulate.js
@@ -626,7 +626,7 @@ function _getLocalFieldValues(doc, localField, model, options, virtual, schema)
 
 function convertTo_id(val, schema) {
   if (val != null && val.$__ != null) {
-    return val._id;
+    return val._doc._id;
   }
   if (val != null && val._id != null && (schema == null || !schema.$isSchemaMap)) {
     return val._id;
@@ -636,7 +636,7 @@ function convertTo_id(val, schema) {
     const rawVal = val.__array != null ? val.__array : val;
     for (let i = 0; i < rawVal.length; ++i) {
       if (rawVal[i] != null && rawVal[i].$__ != null) {
-        rawVal[i] = rawVal[i]._id;
+        rawVal[i] = rawVal[i]._doc._id;
       }
     }
     if (utils.isMongooseArray(val) && val.$schema()) {
diff --git a/lib/helpers/populate/markArraySubdocsPopulated.js b/lib/helpers/populate/markArraySubdocsPopulated.js
@@ -17,11 +17,11 @@ const utils = require('../../utils');
  */
 
 module.exports = function markArraySubdocsPopulated(doc, populated) {
-  if (doc._id == null || populated == null || populated.length === 0) {
+  if (doc._doc._id == null || populated == null || populated.length === 0) {
     return;
   }
 
-  const id = String(doc._id);
+  const id = String(doc._doc._id);
   for (const item of populated) {
     if (item.isVirtual) {
       continue;
diff --git a/lib/model.js b/lib/model.js
@@ -2345,7 +2345,7 @@ Model.findByIdAndUpdate = function(id, update, options) {
 
   // if a model is passed in instead of an id
   if (id instanceof Document) {
-    id = id._id;
+    id = id._doc._id;
   }
 
   return this.findOneAndUpdate.call(this, { _id: id }, update, options);
@@ -3408,7 +3408,7 @@ Model.bulkSave = async function bulkSave(documents, options) {
     documents.map(async(document) => {
       const documentError = bulkWriteError && bulkWriteError.writeErrors.find(writeError => {
         const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
-        return writeErrorDocumentId.toString() === document._id.toString();
+        return writeErrorDocumentId.toString() === document._doc._id.toString();
       });
 
       if (documentError == null) {
@@ -4436,7 +4436,7 @@ function _assign(model, vals, mod, assignmentOpts) {
 
         for (let __val of _val) {
           if (__val instanceof Document) {
-            __val = __val._id;
+            __val = __val._doc._id;
           }
           key = String(__val);
           if (rawDocs[key]) {
diff --git a/lib/query.js b/lib/query.js
@@ -3380,9 +3380,9 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   if (!this._update || Object.keys(this._update).length === 0) {
     if (options.upsert) {
       // still need to do the upsert to empty doc
-      const doc = clone(this._update);
-      delete doc._id;
-      this._update = { $set: doc };
+      const $set = clone(this._update);
+      delete $set._id;
+      this._update = { $set };
     } else {
       this._executionStack = null;
       const res = await this._findOne();
diff --git a/test/model.discriminator.test.js b/test/model.discriminator.test.js
@@ -620,6 +620,23 @@ describe('model', function() {
         Person.discriminator('Parent2', parentSchema.clone());
       });
 
+      it('clone() does not modify original schema `obj` (gh-14821)', function() {
+        const personSchema = new Schema({
+          name: String
+        }, { discriminatorKey: 'kind' });
+
+        const parentSchema = new Schema({
+          child: String
+        });
+
+        const Person = db.model('Person', personSchema);
+        const Parent = Person.discriminator('Parent', parentSchema.clone());
+
+        assert.ok(!Person.schema.obj.child);
+        assert.ok(!personSchema.obj.child);
+        assert.ok(Parent.schema.obj.child);
+      });
+
       it('clone() allows reusing with different models (gh-5721)', async function() {
         const schema = new mongoose.Schema({
           name: String
diff --git a/test/model.populate.test.js b/test/model.populate.test.js
@@ -11049,6 +11049,41 @@ describe('model: populate:', function() {
     assert.equal(pet2.owner.name, 'Alice');
   });
 
+  it('avoids populating manually populated doc as getter value (gh-14827)', async function() {
+    const ownerSchema = new mongoose.Schema({
+      _id: {
+        type: 'ObjectId',
+        get(value) {
+          return value == null ? value : value.toString();
+        }
+      },
+      name: 'String'
+    });
+    const petSchema = new mongoose.Schema({
+      name: 'String',
+      owner: { type: 'ObjectId', ref: 'Owner' }
+    });
+
+    const Owner = db.model('Owner', ownerSchema);
+    const Pet = db.model('Pet', petSchema);
+
+    const _id = new mongoose.Types.ObjectId();
+    const owner = new Owner({ _id, name: 'Alice' });
+    const pet = new Pet({ name: 'Kitty', owner: owner });
+
+    await owner.save();
+
+    assert.equal(typeof pet._doc.owner.$__.wasPopulated.value, 'object');
+    await pet.populate('owner');
+    assert.equal(typeof pet._doc.owner.$__.wasPopulated.value, 'object');
+
+    await pet.save();
+
+
+    const fromDb = await Pet.findOne({ owner: _id }).lean().orFail();
+    assert.ok(fromDb.owner instanceof mongoose.Types.ObjectId);
+  });
+
   it('makes sure that populate works correctly with duplicate foreignField with lean(); (gh-14794)', async function() {
     const authorSchema = new mongoose.Schema({
       group: String,

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class ParallelSaveError extends MongooseError {`
`15`	`15`	`*/`
`16`	`16`	`constructor(doc) {`
`17`	`17`	`const msg = 'Can\'t save() the same doc multiple times in parallel. Document: ';`
`18`		`- super(msg + doc._id);`
	`18`	`+ super(msg + doc._doc._id);`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class ParallelValidateError extends MongooseError {`
`16`	`16`	`*/`
`17`	`17`	`constructor(doc) {`
`18`	`18`	`const msg = 'Can\'t validate() the same doc multiple times in parallel. Document: ';`
`19`		`- super(msg + doc._id);`
	`19`	`+ super(msg + doc._doc._id);`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,9 @@ module.exports = function discriminator(model, name, schema, tiedValue, applyPlu`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`
	`118`	+ // Shallow clone `obj` so we can add additional properties without modifying original
	`119`	+ // schema. `Schema.prototype.clone()` copies `obj` by reference, no cloning.
	`120`	`+ schema.obj = { ...schema.obj };`
`118`	`121`	`mergeDiscriminatorSchema(schema, baseSchema);`
`119`	`122`
`120`	`123`	`// Clean up conflicting paths _after_ merging re: gh-6076`
Original file line number	Diff line number	Diff line change
`@@ -626,7 +626,7 @@ function _getLocalFieldValues(doc, localField, model, options, virtual, schema)`
`626`	`626`
`627`	`627`	`function convertTo_id(val, schema) {`
`628`	`628`	`if (val != null && val.$__ != null) {`
`629`		`- return val._id;`
	`629`	`+ return val._doc._id;`
`630`	`630`	`}`
`631`	`631`	`if (val != null && val._id != null && (schema == null \|\| !schema.$isSchemaMap)) {`
`632`	`632`	`return val._id;`
`@@ -636,7 +636,7 @@ function convertTo_id(val, schema) {`
`636`	`636`	`const rawVal = val.__array != null ? val.__array : val;`
`637`	`637`	`for (let i = 0; i < rawVal.length; ++i) {`
`638`	`638`	`if (rawVal[i] != null && rawVal[i].$__ != null) {`
`639`		`- rawVal[i] = rawVal[i]._id;`
	`639`	`+ rawVal[i] = rawVal[i]._doc._id;`
`640`	`640`	`}`
`641`	`641`	`}`
`642`	`642`	`if (utils.isMongooseArray(val) && val.$schema()) {`