Merge pull request #13584 from Automattic/IslandRhythms/gh-13539

`includeResultMetadata` option
Automattic · Jul 7, 2023 · e191580 · e191580
2 parents 5f9593d + cec2ff4
commit e191580
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/lib/query.js b/lib/query.js
@@ -2435,7 +2435,7 @@ Query.prototype.collation = function(value) {
  */
 
 Query.prototype._completeOne = function(doc, res, callback) {
-  if (!doc && !this.options.rawResult) {
+  if (!doc && !this.options.rawResult && !this.options.includeResultMetadata) {
     return callback(null, null);
   }
 
@@ -3099,7 +3099,7 @@ Query.prototype._deleteMany = async function _deleteMany() {
  */
 
 function completeOne(model, doc, res, options, fields, userProvidedFields, pop, callback) {
-  if (options.rawResult && doc == null) {
+  if ((options.rawResult || options.includeResultMetadata) && doc == null) {
     _init(null);
     return null;
   }
@@ -3112,7 +3112,7 @@ function completeOne(model, doc, res, options, fields, userProvidedFields, pop,
     }
 
 
-    if (options.rawResult) {
+    if (options.rawResult || options.includeResultMetadata) {
       if (doc && casted) {
         if (options.session != null) {
           casted.$session(options.session);

diff --git a/test/model.findOneAndUpdate.test.js b/test/model.findOneAndUpdate.test.js
@@ -2143,4 +2143,19 @@ describe('model: findOneAndUpdate:', function() {
     assert.equal(doc.info['second.name'], 'Quiz');
     assert.equal(doc.info2['second.name'], 'Quiz');
   });
+  it('supports the `includeResultMetadata` option (gh-13539)', async function() {
+    const testSchema = new mongoose.Schema({
+      name: String
+    });
+    const Test = db.model('Test', testSchema);
+    await Test.create({
+      name: 'Test'
+    });
+    const doc = await Test.findOneAndUpdate({ name: 'Test' }, { name: 'Test Testerson' }, { new: true, upsert: true, includeResultMetadata: false });
+    assert.equal(doc.ok, undefined);
+    assert.equal(doc.name, 'Test Testerson');
+    const data = await Test.findOneAndUpdate({ name: 'Test Testerson' }, { name: 'Test' }, { new: true, upsert: true, includeResultMetadata: true });
+    assert(data.ok);
+    assert.equal(data.value.name, 'Test');
+  });
 });