feat(model): correctly handle hydrated documents in applyDefaults()

Re: #11945
Automattic · Jul 6, 2022 · dd49bc1 · dd49bc1
1 parent ae73d8b
commit dd49bc1
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 12 deletions.
diff --git a/lib/helpers/document/applyDefaults.js b/lib/helpers/document/applyDefaults.js
@@ -44,16 +44,18 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
           break;
         }
 
-        if (typeof type.defaultValue === 'function') {
-          if (!type.defaultValue.$runBeforeSetters && isBeforeSetters) {
-            break;
-          }
-          if (type.defaultValue.$runBeforeSetters && !isBeforeSetters) {
-            break;
+        if (isBeforeSetters != null) {
+          if (typeof type.defaultValue === 'function') {
+            if (!type.defaultValue.$runBeforeSetters && isBeforeSetters) {
+              break;
+            }
+            if (type.defaultValue.$runBeforeSetters && !isBeforeSetters) {
+              break;
+            }
+          } else if (!isBeforeSetters) {
+            // Non-function defaults should always run **before** setters
+            continue;
           }
-        } else if (!isBeforeSetters) {
-          // Non-function defaults should always run **before** setters
-          continue;
         }
 
         if (pathsToSkip && pathsToSkip[curPath]) {

diff --git a/lib/model.js b/lib/model.js
@@ -3695,7 +3695,13 @@ function handleSuccessfulWrite(document, resolve, reject) {
 
 Model.applyDefaults = function applyDefaults(doc) {
   if (doc.$__ != null) {
-    return applyDefaultsHelper(doc, doc.$__.fields, doc.$__.exclude);
+    applyDefaultsHelper(doc, doc.$__.fields, doc.$__.exclude);
+
+    for (const subdoc of doc.$getAllSubdocs()) {
+      applyDefaults(subdoc, subdoc.$__.fields, subdoc.$__.exclude);
+    }
+
+    return doc;
   }
 
   applyDefaultsToPOJO(doc, this.schema);

diff --git a/test/model.test.js b/test/model.test.js
@@ -8512,6 +8512,10 @@ describe('Model', function() {
           type: String,
           default: 'John Smith'
         },
+        age: {
+          type: Number,
+          default: 29
+        },
         nestedName: {
           first: {
             type: String,
@@ -8520,6 +8524,10 @@ describe('Model', function() {
           last: {
             type: String,
             default: 'Smith'
+          },
+          middle: {
+            type: String,
+            default: ''
           }
         },
         subdoc: {
@@ -8541,12 +8549,74 @@ describe('Model', function() {
         }]
       }));
 
-      const obj = { docArr: [{}] };
+      const obj = { age: 31, nestedName: { middle: 'James' }, docArr: [{}] };
       Test.applyDefaults(obj);
 
       assert.deepStrictEqual(obj, {
         name: 'John Smith',
-        nestedName: { first: 'John', last: 'Smith' },
+        age: 31,
+        nestedName: { first: 'John', last: 'Smith', middle: 'James' },
+        subdoc: {
+          test: 'subdoc default'
+        },
+        docArr: [{
+          test: 'doc array default'
+        }]
+      });
+    });
+
+    it('applies defaults to documents', function() {
+      const Test = db.model('Test', mongoose.Schema({
+        _id: false,
+        name: {
+          type: String,
+          default: 'John Smith'
+        },
+        age: {
+          type: Number,
+          default: 29
+        },
+        nestedName: {
+          first: {
+            type: String,
+            default: 'John'
+          },
+          last: {
+            type: String,
+            default: 'Smith'
+          },
+          middle: {
+            type: String,
+            default: ''
+          }
+        },
+        subdoc: {
+          type: mongoose.Schema({
+            _id: false,
+            test: {
+              type: String,
+              default: 'subdoc default'
+            }
+          }),
+          default: () => ({})
+        },
+        docArr: [{
+          _id: false,
+          test: {
+            type: String,
+            default: 'doc array default'
+          }
+        }]
+      }));
+
+      const obj = { age: 31, nestedName: { middle: 'James' }, docArr: [{}] };
+      const doc = new Test(obj, null, { defaults: false });
+      Test.applyDefaults(doc);
+
+      assert.deepStrictEqual(doc.toObject(), {
+        name: 'John Smith',
+        age: 31,
+        nestedName: { first: 'John', last: 'Smith', middle: 'James' },
         subdoc: {
           test: 'subdoc default'
         },