fix(populate): allow populating paths underneath subdocument maps

Fix #9359

lib/helpers/populate/assignVals.js

@@ -5,6 +5,7 @@ const assignRawDocsToIdStructure = require('./assignRawDocsToIdStructure');
 const get = require('../get');
 const getVirtual = require('./getVirtual');
 const leanPopulateMap = require('./leanPopulateMap');
+const lookupLocalFields = require('./lookupLocalFields');
 const mpath = require('mpath');
 const sift = require('sift').default;
 const utils = require('../../utils');
@@ -68,7 +69,7 @@ module.exports = function assignVals(o) {
   }
 
   for (let i = 0; i < docs.length; ++i) {
-    const existingVal = utils.getValue(o.path, docs[i]);
+    const existingVal = mpath.get(o.path, docs[i], lookupLocalFields);
     if (existingVal == null && !getVirtual(o.originalModel.schema, o.path)) {
       continue;
     }
@@ -132,6 +133,10 @@ module.exports = function assignVals(o) {
         break;
       }
 
+      if (parts[j] === '$*') {
+        break;
+      }
+
       if (cur[parts[j]] == null) {
         // If nothing to set, avoid creating an unnecessary array. Otherwise
         // we'll end up with a single doc in the array with only defaults.
@@ -156,7 +161,7 @@ module.exports = function assignVals(o) {
     // If lean, need to check that each individual virtual respects
     // `justOne`, because you may have a populated virtual with `justOne`
     // underneath an array. See gh-6867
-    utils.setValue(o.path, valueToSet, docs[i], setValue, false);
+    mpath.set(o.path, valueToSet, docs[i], lookupLocalFields, setValue, false);
   }
 };
 

lib/helpers/populate/getModelsMapForPopulate.js

@@ -7,6 +7,8 @@ const getDiscriminatorByValue = require('../discriminator/getDiscriminatorByValu
 const isPathExcluded = require('../projection/isPathExcluded');
 const getSchemaTypes = require('./getSchemaTypes');
 const getVirtual = require('./getVirtual');
+const lookupLocalFields = require('./lookupLocalFields');
+const mpath = require('mpath');
 const normalizeRefPath = require('./normalizeRefPath');
 const util = require('util');
 const utils = require('../../utils');
@@ -203,16 +205,16 @@ module.exports = function getModelsMapForPopulate(model, docs, options) {
       options.isVirtual && get(virtual, 'options.getters', false);
     if (localFieldGetters.length > 0 && getters) {
       const hydratedDoc = (doc.$__ != null) ? doc : model.hydrate(doc);
-      const localFieldValue = utils.getValue(localField, doc);
+      const localFieldValue = mpath.get(localField, doc, lookupLocalFields);
       if (Array.isArray(localFieldValue)) {
-        const localFieldHydratedValue = utils.getValue(localField.split('.').slice(0, -1), hydratedDoc);
+        const localFieldHydratedValue = mpath.get(localField.split('.').slice(0, -1), hydratedDoc, lookupLocalFields);
         ret = localFieldValue.map((localFieldArrVal, localFieldArrIndex) =>
           localFieldPath.applyGetters(localFieldArrVal, localFieldHydratedValue[localFieldArrIndex]));
       } else {
         ret = localFieldPath.applyGetters(localFieldValue, hydratedDoc);
       }
     } else {
-      ret = convertTo_id(utils.getValue(localField, doc), schema);
+      ret = convertTo_id(mpath.get(localField, doc, lookupLocalFields), schema);
     }
 
     const id = String(utils.getValue(foreignField, doc));

lib/helpers/populate/lookupLocalFields.js

@@ -0,0 +1,26 @@
+'use strict';
+
+module.exports = function lookupLocalFields(cur, path, val) {
+  if (cur == null) {
+    return cur;
+  }
+
+  if (cur._doc != null) {
+    cur = cur._doc;
+  }
+
+  if (arguments.length >= 3) {
+    cur[path] = val;
+    return val;
+  }
+
+
+  // Support populating paths under maps using `map.$*.subpath`
+  if (path === '$*') {
+    return cur instanceof Map ?
+      Array.from(cur.values()) :
+      Object.keys(cur).map(key => cur[key]);
+  }
+
+  return cur[path];
+};