Merge pull request #9337 from FelixRe0/master

Fix: Retaining null value for populated documents when _id is suppressed

lib/helpers/populate/assignVals.js

@@ -243,7 +243,7 @@ function valueFilter(val, assignmentOpts, populateOptions) {
  */
 
 function maybeRemoveId(subdoc, assignmentOpts) {
-  if (assignmentOpts.excludeId) {
+  if (subdoc != null && assignmentOpts.excludeId) {
     if (typeof subdoc.$__setValue === 'function') {
       delete subdoc._doc._id;
     } else {

test/model.populate.test.js

@@ -1626,6 +1626,33 @@ describe('model: populate:', function() {
     });
   });
 
+  it('supports `retainNullValues` while supressing _id of subdocument', function() {
+    const BlogPost = db.model('BlogPost', blogPostSchema);
+    const User = db.model('User', userSchema);
+
+    return co(function*() {
+      const user = new User({ name: 'Victor Hugo' });
+      yield user.save();
+      const post = yield BlogPost.create({
+        title: 'Notre-Dame de Paris',
+        fans: []
+      });
+
+      yield BlogPost.collection.updateOne({ _id: post._id }, {
+        $set: { fans: [user.id] }
+      });
+
+      yield user.delete();
+
+      const returned = yield BlogPost.
+        findById(post._id).
+        populate({ path: 'fans', select: 'name -_id', options: { retainNullValues: true } });
+
+      assert.equal(returned.fans.length, 1);
+      assert.strictEqual(returned.fans[0], null);
+    });
+  });
+
   it('populating more than one array at a time', function(done) {
     const User = db.model('User', userSchema);
     const M = db.model('Test', new Schema({