BREAKING CHANGE: make MongooseArray#map() return a plain JavaScript…

… array rather than a headless Mongoose array Re: #8356
Automattic · May 10, 2020 · b99f6d3 · b99f6d3
1 parent 36552fa
commit b99f6d3
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/lib/plugins/idGetter.js b/lib/plugins/idGetter.js
@@ -11,10 +11,12 @@ module.exports = function addIdGetter(schema) {
     !schema.options.noVirtualId &&
     schema.options.id;
   if (!autoIdGetter) {
-    return;
+    return schema;
   }
 
   schema.virtual('id').get(idGetter);
+
+  return schema;
 };
 
 /*!

diff --git a/lib/types/documentarray.js b/lib/types/documentarray.js
@@ -39,12 +39,9 @@ class CoreDocumentArray extends CoreMongooseArray {
    */
 
   map() {
-    const ret = super.map.apply(this, arguments);
-    ret[arraySchemaSymbol] = null;
-    ret[arrayPathSymbol] = null;
-    ret[arrayParentSymbol] = null;
+    const copy = [].concat(this);
 
-    return ret;
+    return Array.prototype.map.apply(copy, arguments);
   }
 
   /**

diff --git a/test/types.documentarray.test.js b/test/types.documentarray.test.js
@@ -10,6 +10,7 @@ const DocumentArray = require('../lib/types/documentarray');
 const ArraySubdocument = require('../lib/types/ArraySubdocument');
 const assert = require('assert');
 const co = require('co');
+const idGetter = require('../lib/plugins/idGetter');
 const setValue = require('../lib/utils').setValue;
 
 const mongoose = require('./common').mongoose;
@@ -39,7 +40,7 @@ function TestDoc(schema) {
     title: { type: String }
   });
 
-  Subdocument.prototype.$__setSchema(schema || SubSchema);
+  Subdocument.prototype.$__setSchema(idGetter(schema || SubSchema));
 
   return Subdocument;
 }
@@ -575,7 +576,7 @@ describe('types.documentarray', function() {
       assert.equal(doc.docs.length, 2);
     });
 
-    it('map() works', function() {
+    it('map() works (gh-8317)', function() {
       const personSchema = new Schema({ friends: [{ name: { type: String } }] });
       mongoose.deleteModel(/Test/);
       const Person = mongoose.model('Test', personSchema);