@depup/mongoose 9.1.3-depup.0

package/lib/helpers/populate/getSchemaTypes.js

@@ -0,0 +1,228 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+const Mixed = require('../../schema/mixed');
+const get = require('../get');
+const getDiscriminatorByValue = require('../discriminator/getDiscriminatorByValue');
+const leanPopulateMap = require('./leanPopulateMap');
+const mpath = require('mpath');
+
+const populateModelSymbol = require('../symbols').populateModelSymbol;
+
+/**
+ * Given a model and its schema, find all possible schema types for `path`,
+ * including searching through discriminators. If `doc` is specified, will
+ * use the doc's values for discriminator keys when searching, otherwise
+ * will search all discriminators.
+ *
+ * @param {Model} model
+ * @param {Schema} schema
+ * @param {Object} doc POJO
+ * @param {string} path
+ * @api private
+ */
+
+module.exports = function getSchemaTypes(model, schema, doc, path) {
+  const pathschema = schema.path(path);
+  const topLevelDoc = doc;
+  if (pathschema) {
+    return pathschema;
+  }
+
+  const discriminatorKey = schema.discriminatorMapping?.key;
+  if (discriminatorKey && model != null) {
+    if (doc?.[discriminatorKey] != null) {
+      const discriminator = getDiscriminatorByValue(model.discriminators, doc[discriminatorKey]);
+      schema = discriminator?.schema || schema;
+    } else if (model.discriminators != null) {
+      return Object.keys(model.discriminators).reduce((arr, name) => {
+        const disc = model.discriminators[name];
+        return arr.concat(getSchemaTypes(disc, disc.schema, null, path));
+      }, []);
+    }
+  }
+
+  function search(parts, schema, subdoc, nestedPath) {
+    let p = parts.length + 1;
+    let foundschema;
+    let trypath;
+
+    while (p--) {
+      trypath = parts.slice(0, p).join('.');
+      foundschema = schema.path(trypath);
+      if (foundschema == null) {
+        continue;
+      }
+
+      if (foundschema.embeddedSchemaType || foundschema.schema) {
+        // array of Mixed?
+        if (foundschema.embeddedSchemaType instanceof Mixed) {
+          return foundschema.embeddedSchemaType;
+        }
+
+        let schemas = null;
+        if (foundschema.schema?.discriminators != null) {
+          const discriminators = foundschema.schema.discriminators;
+          const discriminatorKeyPath = trypath + '.' +
+            foundschema.schema.options.discriminatorKey;
+          const keys = subdoc ? mpath.get(discriminatorKeyPath, subdoc) || [] : [];
+          schemas = Object.keys(discriminators).
+            reduce(function(cur, discriminator) {
+              const tiedValue = discriminators[discriminator].discriminatorMapping.value;
+              if (doc == null || keys.indexOf(discriminator) !== -1 || keys.indexOf(tiedValue) !== -1) {
+                cur.push(discriminators[discriminator]);
+              }
+              return cur;
+            }, []);
+        }
+
+        // Now that we found the array, we need to check if there
+        // are remaining document paths to look up for casting.
+        // Also we need to handle array.$.path since schema.path
+        // doesn't work for that.
+        // If there is no foundschema.schema we are dealing with
+        // a path like array.$
+        if (p !== parts.length && foundschema.schema) {
+          let ret;
+          if (parts[p] === '$') {
+            if (p + 1 === parts.length) {
+              // comments.$
+              return foundschema;
+            }
+            // comments.$.comments.$.title
+            ret = search(
+              parts.slice(p + 1),
+              schema,
+              subdoc ? mpath.get(trypath, subdoc) : null,
+              nestedPath.concat(parts.slice(0, p))
+            );
+            if (ret) {
+              ret.$parentSchemaDocArray = ret.$parentSchemaDocArray ||
+                (foundschema.schema.$isSingleNested ? null : foundschema);
+            }
+            return ret;
+          }
+
+          if (schemas != null && schemas.length > 0) {
+            ret = [];
+            for (const schema of schemas) {
+              const _ret = search(
+                parts.slice(p),
+                schema,
+                subdoc ? mpath.get(trypath, subdoc) : null,
+                nestedPath.concat(parts.slice(0, p))
+              );
+              if (_ret != null) {
+                _ret.$parentSchemaDocArray = _ret.$parentSchemaDocArray ||
+                  (foundschema.schema.$isSingleNested ? null : foundschema);
+                if (_ret.$parentSchemaDocArray) {
+                  ret.$parentSchemaDocArray = _ret.$parentSchemaDocArray;
+                }
+                ret.push(_ret);
+              }
+            }
+            return ret;
+          } else {
+            ret = search(
+              parts.slice(p),
+              foundschema.schema,
+              subdoc ? mpath.get(trypath, subdoc) : null,
+              nestedPath.concat(parts.slice(0, p))
+            );
+
+            if (ret) {
+              ret.$parentSchemaDocArray = ret.$parentSchemaDocArray ||
+                (foundschema.schema.$isSingleNested ? null : foundschema);
+            }
+            return ret;
+          }
+        } else if (p !== parts.length &&
+            foundschema.$isMongooseArray &&
+            foundschema.embeddedSchemaType.$isMongooseArray) {
+          // Nested arrays. Drill down to the bottom of the nested array.
+          let type = foundschema;
+          while (type.$isMongooseArray && !type.$isMongooseDocumentArray) {
+            type = type.embeddedSchemaType;
+          }
+
+          const ret = search(
+            parts.slice(p),
+            type.schema,
+            null,
+            nestedPath.concat(parts.slice(0, p))
+          );
+          if (ret != null) {
+            return ret;
+          }
+
+          if (type.schema.discriminators) {
+            const discriminatorPaths = [];
+            for (const discriminatorName of Object.keys(type.schema.discriminators)) {
+              const _schema = type.schema.discriminators[discriminatorName] || type.schema;
+              const ret = search(parts.slice(p), _schema, null, nestedPath.concat(parts.slice(0, p)));
+              if (ret != null) {
+                discriminatorPaths.push(ret);
+              }
+            }
+            if (discriminatorPaths.length > 0) {
+              return discriminatorPaths;
+            }
+          }
+        }
+      } else if (foundschema.$isSchemaMap && foundschema.$__schemaType instanceof Mixed) {
+        return foundschema.$__schemaType;
+      }
+
+      const fullPath = nestedPath.concat([trypath]).join('.');
+      if (topLevelDoc?.$__ && topLevelDoc.$populated(fullPath, true) && p < parts.length) {
+        const model = topLevelDoc.$populated(fullPath, true).options[populateModelSymbol];
+        if (model != null) {
+          const ret = search(
+            parts.slice(p),
+            model.schema,
+            subdoc ? mpath.get(trypath, subdoc) : null,
+            nestedPath.concat(parts.slice(0, p))
+          );
+
+          return ret;
+        }
+      }
+
+      const _val = get(topLevelDoc, trypath);
+      if (_val != null) {
+        const model = Array.isArray(_val) && _val.length > 0 ?
+          leanPopulateMap.get(_val[0]) :
+          leanPopulateMap.get(_val);
+        // Populated using lean, `leanPopulateMap` value is the foreign model
+        const schema = model?.schema ?? null;
+        if (schema != null) {
+          const ret = search(
+            parts.slice(p),
+            schema,
+            subdoc ? mpath.get(trypath, subdoc) : null,
+            nestedPath.concat(parts.slice(0, p))
+          );
+
+          if (ret != null) {
+            ret.$parentSchemaDocArray = ret.$parentSchemaDocArray ||
+              (schema.$isSingleNested ? null : schema);
+            return ret;
+          }
+        }
+      }
+      return foundschema;
+    }
+  }
+  // look for arrays
+  const parts = path.split('.');
+  for (let i = 0; i < parts.length; ++i) {
+    if (parts[i] === '$') {
+      // Re: gh-5628, because `schema.path()` doesn't take $ into account.
+      parts[i] = '0';
+    }
+  }
+  return search(parts, schema, doc, []);
+};

package/lib/helpers/populate/getVirtual.js

@@ -0,0 +1,103 @@
+'use strict';
+
+module.exports = getVirtual;
+
+/*!
+ * ignore
+ */
+
+function getVirtual(schema, name) {
+  if (schema.virtuals[name]) {
+    return { virtual: schema.virtuals[name], path: void 0 };
+  }
+
+  const parts = name.split('.');
+  let cur = '';
+  let nestedSchemaPath = '';
+  for (let i = 0; i < parts.length; ++i) {
+    cur += (cur.length > 0 ? '.' : '') + parts[i];
+    if (schema.virtuals[cur]) {
+      if (i === parts.length - 1) {
+        return { virtual: schema.virtuals[cur], path: nestedSchemaPath };
+      }
+      continue;
+    }
+
+    if (schema.nested[cur]) {
+      continue;
+    }
+
+    if (schema.paths[cur] && schema.paths[cur].schema) {
+      schema = schema.paths[cur].schema;
+      const rest = parts.slice(i + 1).join('.');
+
+      if (schema.virtuals[rest]) {
+        if (i === parts.length - 2) {
+          return {
+            virtual: schema.virtuals[rest],
+            nestedSchemaPath: [nestedSchemaPath, cur].filter(v => !!v).join('.')
+          };
+        }
+        continue;
+      }
+
+      if (i + 1 < parts.length && schema.discriminators) {
+        for (const key of Object.keys(schema.discriminators)) {
+          const res = getVirtual(schema.discriminators[key], rest);
+          if (res != null) {
+            const _path = [nestedSchemaPath, cur, res.nestedSchemaPath].
+              filter(v => !!v).join('.');
+            return {
+              virtual: res.virtual,
+              nestedSchemaPath: _path
+            };
+          }
+        }
+      }
+
+      nestedSchemaPath += (nestedSchemaPath.length > 0 ? '.' : '') + cur;
+      cur = '';
+      continue;
+    } else if (schema.paths[cur]?.$isSchemaMap && schema.paths[cur].$__schemaType?.schema) {
+      schema = schema.paths[cur].$__schemaType.schema;
+      ++i;
+      const rest = parts.slice(i + 1).join('.');
+
+      if (schema.virtuals[rest]) {
+        if (i === parts.length - 2) {
+          return {
+            virtual: schema.virtuals[rest],
+            nestedSchemaPath: [nestedSchemaPath, cur, '$*'].filter(v => !!v).join('.')
+          };
+        }
+        continue;
+      }
+
+      if (i + 1 < parts.length && schema.discriminators) {
+        for (const key of Object.keys(schema.discriminators)) {
+          const res = getVirtual(schema.discriminators[key], rest);
+          if (res != null) {
+            const _path = [nestedSchemaPath, cur, res.nestedSchemaPath, '$*'].
+              filter(v => !!v).join('.');
+            return {
+              virtual: res.virtual,
+              nestedSchemaPath: _path
+            };
+          }
+        }
+      }
+
+      nestedSchemaPath += (nestedSchemaPath.length > 0 ? '.' : '') + '$*' + cur;
+      cur = '';
+    }
+
+    if (schema.discriminators) {
+      for (const discriminatorKey of Object.keys(schema.discriminators)) {
+        const virtualFromDiscriminator = getVirtual(schema.discriminators[discriminatorKey], name);
+        if (virtualFromDiscriminator) return virtualFromDiscriminator;
+      }
+    }
+
+    return null;
+  }
+}

package/lib/helpers/populate/leanPopulateMap.js

@@ -0,0 +1,7 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+module.exports = new WeakMap();

package/lib/helpers/populate/lookupLocalFields.js

@@ -0,0 +1,40 @@
+'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) {
+    if (typeof cur !== 'object') {
+      return void 0;
+    }
+    if (val === void 0) {
+      return void 0;
+    }
+    if (cur instanceof Map) {
+      cur.set(path, val);
+    } else {
+      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]);
+  }
+
+  if (cur instanceof Map) {
+    return cur.get(path);
+  }
+
+  return cur[path];
+};

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const utils = require('../../utils');
+
+/**
+ * If populating a path within a document array, make sure each
+ * subdoc within the array knows its subpaths are populated.
+ *
+ * #### Example:
+ *
+ *     const doc = await Article.findOne().populate('comments.author');
+ *     doc.comments[0].populated('author'); // Should be set
+ *
+ * @param {Document} doc
+ * @param {Object} [populated]
+ * @api private
+ */
+
+module.exports = function markArraySubdocsPopulated(doc, populated) {
+  if (doc._doc._id == null || populated == null || populated.length === 0) {
+    return;
+  }
+
+  const id = String(doc._doc._id);
+  for (const item of populated) {
+    if (item.isVirtual) {
+      continue;
+    }
+    const path = item.path;
+    const pieces = path.split('.');
+    for (let i = 0; i < pieces.length - 1; ++i) {
+      const subpath = pieces.slice(0, i + 1).join('.');
+      const rest = pieces.slice(i + 1).join('.');
+      const val = doc.get(subpath);
+      if (val == null) {
+        continue;
+      }
+
+      if (utils.isMongooseDocumentArray(val)) {
+        for (let j = 0; j < val.length; ++j) {
+          if (val[j]) {
+            val[j].populated(rest, item._docs[id] == null ? void 0 : item._docs[id][j], item);
+          }
+        }
+        break;
+      }
+    }
+  }
+};

package/lib/helpers/populate/modelNamesFromRefPath.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const MongooseError = require('../../error/mongooseError');
+const isPathExcluded = require('../projection/isPathExcluded');
+const lookupLocalFields = require('./lookupLocalFields');
+const mpath = require('mpath');
+const util = require('util');
+const utils = require('../../utils');
+
+const hasNumericPropRE = /(\.\d+$|\.\d+\.)/g;
+
+module.exports = function modelNamesFromRefPath(refPath, doc, populatedPath, modelSchema, queryProjection) {
+  if (refPath == null) {
+    return [];
+  }
+
+  if (typeof refPath === 'string' && queryProjection != null && isPathExcluded(queryProjection, refPath)) {
+    throw new MongooseError('refPath `' + refPath + '` must not be excluded in projection, got ' +
+      util.inspect(queryProjection));
+  }
+
+  // If populated path has numerics, the end `refPath` should too. For example,
+  // if populating `a.0.b` instead of `a.b` and `b` has `refPath = a.c`, we
+  // should return `a.0.c` for the refPath.
+
+  if (hasNumericPropRE.test(populatedPath)) {
+    const chunks = populatedPath.split(hasNumericPropRE);
+
+    if (chunks[chunks.length - 1] === '') {
+      throw new Error('Can\'t populate individual element in an array');
+    }
+
+    let _refPath = '';
+    let _remaining = refPath;
+    // 2nd, 4th, etc. will be numeric props. For example: `[ 'a', '.0.', 'b' ]`
+    for (let i = 0; i < chunks.length; i += 2) {
+      const chunk = chunks[i];
+      if (_remaining.startsWith(chunk + '.')) {
+        _refPath += _remaining.substring(0, chunk.length) + chunks[i + 1];
+        _remaining = _remaining.substring(chunk.length + 1);
+      } else if (i === chunks.length - 1) {
+        _refPath += _remaining;
+        _remaining = '';
+        break;
+      } else {
+        throw new Error('Could not normalize ref path, chunk ' + chunk + ' not in populated path');
+      }
+    }
+
+    const refValue = mpath.get(_refPath, doc, lookupLocalFields);
+    let modelNames = Array.isArray(refValue) ? refValue : [refValue];
+    modelNames = utils.array.flatten(modelNames);
+    return modelNames;
+  }
+
+  const refValue = mpath.get(refPath, doc, lookupLocalFields);
+
+  let modelNames;
+  if (modelSchema != null && Object.hasOwn(modelSchema.virtuals, refPath)) {
+    modelNames = [modelSchema.virtuals[refPath].applyGetters(void 0, doc)];
+  } else {
+    modelNames = Array.isArray(refValue) ? refValue : [refValue];
+  }
+
+  return modelNames;
+};

package/lib/helpers/populate/removeDeselectedForeignField.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const get = require('../get');
+const mpath = require('mpath');
+const parseProjection = require('../projection/parseProjection');
+
+/*!
+ * ignore
+ */
+
+module.exports = function removeDeselectedForeignField(foreignFields, options, docs) {
+  const projection = parseProjection(get(options, 'select', null), true) ||
+    parseProjection(get(options, 'options.select', null), true);
+
+  if (projection == null) {
+    return;
+  }
+  for (const foreignField of foreignFields) {
+    if (!Object.hasOwn(projection, '-' + foreignField)) {
+      continue;
+    }
+
+    for (const val of docs) {
+      if (val.$__ != null) {
+        mpath.unset(foreignField, val._doc);
+      } else {
+        mpath.unset(foreignField, val);
+      }
+    }
+  }
+};

package/lib/helpers/populate/setPopulatedVirtualValue.js

@@ -0,0 +1,33 @@
+'use strict';
+
+/**
+ * Set a populated virtual value on a document's `$$populatedVirtuals` value
+ *
+ * @param {*} populatedVirtuals A document's `$$populatedVirtuals`
+ * @param {*} name The virtual name
+ * @param {*} v The result of the populate query
+ * @param {*} options The populate options. This function handles `justOne` and `count` options.
+ * @returns {Array<Document>|Document|Object|Array<Object>} the populated virtual value that was set
+ */
+
+module.exports = function setPopulatedVirtualValue(populatedVirtuals, name, v, options) {
+  if (options.justOne || options.count) {
+    populatedVirtuals[name] = Array.isArray(v) ?
+      v[0] :
+      v;
+
+    if (typeof populatedVirtuals[name] !== 'object') {
+      populatedVirtuals[name] = options.count ? v : null;
+    }
+  } else {
+    populatedVirtuals[name] = Array.isArray(v) ?
+      v :
+      v == null ? [] : [v];
+
+    populatedVirtuals[name] = populatedVirtuals[name].filter(function(doc) {
+      return doc && typeof doc === 'object';
+    });
+  }
+
+  return populatedVirtuals[name];
+};

package/lib/helpers/populate/skipPopulateValue.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = function SkipPopulateValue(val) {
+  if (!(this instanceof SkipPopulateValue)) {
+    return new SkipPopulateValue(val);
+  }
+
+  this.val = val;
+  return this;
+};

package/lib/helpers/populate/validateRef.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const MongooseError = require('../../error/mongooseError');
+const util = require('util');
+
+module.exports = validateRef;
+
+function validateRef(ref, path) {
+  if (typeof ref === 'string') {
+    return;
+  }
+
+  if (typeof ref === 'function') {
+    return;
+  }
+
+  throw new MongooseError('Invalid ref at path "' + path + '". Got ' +
+    util.inspect(ref, { depth: 0 }));
+}

package/lib/helpers/printJestWarning.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const utils = require('../utils');
+
+if (typeof jest !== 'undefined' && !process.env.SUPPRESS_JEST_WARNINGS) {
+  if (typeof window !== 'undefined') {
+    utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
+      'with Jest\'s default jsdom test environment. Please make sure you read ' +
+      'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
+      'https://mongoosejs.com/docs/jest.html. Set the SUPPRESS_JEST_WARNINGS to true ' +
+      'to hide this warning.');
+  }
+
+  if (typeof setTimeout.clock?.Date === 'function') {
+    utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
+      'with Jest\'s mock timers enabled. Please make sure you read ' +
+      'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
+      'https://mongoosejs.com/docs/jest.html. Set the SUPPRESS_JEST_WARNINGS to true ' +
+      'to hide this warning.');
+  }
+}

package/lib/helpers/processConnectionOptions.js

@@ -0,0 +1,65 @@
+'use strict';
+
+const clone = require('./clone');
+const MongooseError = require('../error/index');
+
+function processConnectionOptions(uri, options) {
+  const opts = options ? options : {};
+  const readPreference = opts.readPreference
+    ? opts.readPreference
+    : getUriReadPreference(uri);
+
+  const clonedOpts = clone(opts);
+  const resolvedOpts = (readPreference && readPreference !== 'primary' && readPreference !== 'primaryPreferred')
+    ? resolveOptsConflicts(readPreference, clonedOpts)
+    : clonedOpts;
+
+  return resolvedOpts;
+}
+
+function resolveOptsConflicts(pref, opts) {
+  // don't silently override user-provided indexing options
+  if (setsIndexOptions(opts) && setsSecondaryRead(pref)) {
+    throwReadPreferenceError();
+  }
+
+  // if user has not explicitly set any auto-indexing options,
+  // we can silently default them all to false
+  else {
+    return defaultIndexOptsToFalse(opts);
+  }
+}
+
+function setsIndexOptions(opts) {
+  const configIdx = opts.config?.autoIndex;
+  const { autoCreate, autoIndex } = opts;
+  return !!(configIdx || autoCreate || autoIndex);
+}
+
+function setsSecondaryRead(prefString) {
+  return !!(prefString === 'secondary' || prefString === 'secondaryPreferred');
+}
+
+function getUriReadPreference(connectionString) {
+  const exp = /(?:&|\?)readPreference=(\w+)(?:&|$)/;
+  const match = exp.exec(connectionString);
+  return match ? match[1] : null;
+}
+
+function defaultIndexOptsToFalse(opts) {
+  opts.config = { autoIndex: false };
+  opts.autoCreate = false;
+  opts.autoIndex = false;
+  return opts;
+}
+
+function throwReadPreferenceError() {
+  throw new MongooseError(
+    'MongoDB prohibits index creation on connections that read from ' +
+            'non-primary replicas.  Connections that set "readPreference" to "secondary" or ' +
+            '"secondaryPreferred" may not opt-in to the following connection options: ' +
+            'autoCreate, autoIndex'
+  );
+}
+
+module.exports = processConnectionOptions;