fix(array): avoid adding defaults to query filter when using pull()…

… on a doc array with no `_id` Fix #12294
Automattic · Sep 11, 2022 · 40b94c0 · 40b94c0
1 parent e8ac7d7
commit 40b94c0
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 2 deletions.
diff --git a/lib/types/array/methods/index.js b/lib/types/array/methods/index.js
@@ -341,8 +341,21 @@ const methods = {
       const pullOp = atomics['$pull'] || (atomics['$pull'] = {});
       if (val[0] instanceof ArraySubdocument) {
         selector = pullOp['$or'] || (pullOp['$or'] = []);
-        Array.prototype.push.apply(selector, val.map(function(v) {
-          return v.toObject({ transform: false, virtuals: false });
+        Array.prototype.push.apply(selector, val.map(v => {
+          return v.toObject({
+            transform: (doc, ret) => {
+              if (v == null || v.$__ == null) {
+                return ret;
+              }
+
+              Object.keys(v.$__.activePaths.getStatePaths('default')).forEach(path => {
+                delete ret[path];
+              });
+
+              return ret;
+            },
+            virtuals: false
+          });
         }));
       } else {
         selector = pullOp['_id'] || (pullOp['_id'] = { $in: [] });

diff --git a/test/types.array.test.js b/test/types.array.test.js
@@ -822,6 +822,30 @@ describe('types array', function() {
         });
       });
     });
+
+    it('avoids adding default paths to query filter (gh-12294)', async function() {
+      const catschema = new Schema({
+        name: String,
+        colors: [{
+          _id: false,
+          hex: { type: String, default: '#ffffff' },
+          name: String
+        }]
+      });
+      const Cat = db.model('Test', catschema);
+
+      const cat = new Cat({});
+      cat.init({
+        name: 'Garfield',
+        colors: [{ name: 'Orange' }]
+      });
+
+      cat.colors.pull({ name: 'Orange' });
+      assert.deepStrictEqual(cat.colors.$__getAtomics(), [[
+        '$pull',
+        { $or: [{ name: 'Orange' }] }
+      ]]);
+    });
   });
 
   describe('$pop()', function() {