fix(array): avoid using default _id when using pull()

Fix #12294
Automattic · Sep 11, 2022 · b97d410 · b97d410
1 parent 40b94c0
commit b97d410
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/lib/types/array/methods/index.js b/lib/types/array/methods/index.js
@@ -603,7 +603,11 @@ const methods = {
 
     if (values[0] instanceof ArraySubdocument) {
       this._registerAtomic('$pullDocs', values.map(function(v) {
-        return v.$__getValue('_id') || v;
+        const _id = v.$__getValue('_id');
+        if (_id === undefined || v.$isDefault('_id')) {
+          return v;
+        }
+        return _id;
       }));
     } else {
       this._registerAtomic('$pullAll', values);

diff --git a/test/types.array.test.js b/test/types.array.test.js
@@ -846,6 +846,29 @@ describe('types array', function() {
         { $or: [{ name: 'Orange' }] }
       ]]);
     });
+
+    it('avoids adding default paths to query filter with _id (gh-12294)', async function() {
+      const catschema = new Schema({
+        name: String,
+        colors: [{
+          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() {