@depup/mongoose 9.1.3-depup.0

package/lib/helpers/document/compile.js

@@ -0,0 +1,238 @@
+'use strict';
+
+const clone = require('../../helpers/clone');
+const documentSchemaSymbol = require('../../helpers/symbols').documentSchemaSymbol;
+const internalToObjectOptions = require('../../options').internalToObjectOptions;
+const utils = require('../../utils');
+
+let Document;
+const getSymbol = require('../../helpers/symbols').getSymbol;
+const scopeSymbol = require('../../helpers/symbols').scopeSymbol;
+
+const isPOJO = utils.isPOJO;
+
+/*!
+ * exports
+ */
+
+exports.compile = compile;
+exports.defineKey = defineKey;
+
+const _isEmptyOptions = Object.freeze({
+  minimize: true,
+  virtuals: false,
+  getters: false,
+  transform: false
+});
+
+const noDottedPathGetOptions = Object.freeze({
+  noDottedPath: true
+});
+
+/**
+ * Compiles schemas.
+ * @param {Object} tree
+ * @param {Any} proto
+ * @param {String} prefix
+ * @param {Object} options
+ * @api private
+ */
+
+function compile(tree, proto, prefix, options) {
+  Document = Document || require('../../document');
+  const typeKey = options.typeKey;
+
+  for (const key of Object.keys(tree)) {
+    const limb = tree[key];
+
+    const hasSubprops = isPOJO(limb) &&
+      utils.hasOwnKeys(limb) &&
+      (!limb[typeKey] || (typeKey === 'type' && isPOJO(limb.type) && limb.type.type));
+    const subprops = hasSubprops ? limb : null;
+
+    defineKey({ prop: key, subprops: subprops, prototype: proto, prefix: prefix, options: options });
+  }
+}
+
+/**
+ * Defines the accessor named prop on the incoming prototype.
+ * @param {Object} options
+ * @param {String} options.prop
+ * @param {Boolean} options.subprops
+ * @param {Any} options.prototype
+ * @param {String} [options.prefix]
+ * @param {Object} options.options
+ * @api private
+ */
+
+function defineKey({ prop, subprops, prototype, prefix, options }) {
+  Document = Document || require('../../document');
+  const path = (prefix ? prefix + '.' : '') + prop;
+  prefix = prefix || '';
+  const useGetOptions = prefix ? Object.freeze({}) : noDottedPathGetOptions;
+
+  if (subprops) {
+    Object.defineProperty(prototype, prop, {
+      enumerable: true,
+      configurable: true,
+      get: function() {
+        const _this = this;
+        if (!this.$__.getters) {
+          this.$__.getters = {};
+        }
+
+        if (!this.$__.getters[path]) {
+          const nested = Object.create(Document.prototype, getOwnPropertyDescriptors(this));
+
+          // save scope for nested getters/setters
+          if (!prefix) {
+            nested.$__[scopeSymbol] = this;
+          }
+          nested.$__.nestedPath = path;
+
+          Object.defineProperty(nested, 'schema', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: prototype.schema
+          });
+
+          Object.defineProperty(nested, '$__schema', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: prototype.schema
+          });
+
+          Object.defineProperty(nested, documentSchemaSymbol, {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: prototype.schema
+          });
+
+          Object.defineProperty(nested, 'toObject', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: function() {
+              return clone(_this.get(path, null, {
+                virtuals: this &&
+                  this.schema &&
+                  this.schema.options &&
+                  this.schema.options.toObject &&
+                  this.schema.options.toObject.virtuals || null
+              }));
+            }
+          });
+
+          Object.defineProperty(nested, '$__get', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: function() {
+              return _this.get(path, null, {
+                virtuals: this?.schema?.options?.toObject?.virtuals || null
+              });
+            }
+          });
+
+          Object.defineProperty(nested, 'toJSON', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: function() {
+              return _this.get(path, null, {
+                virtuals: this?.schema?.options?.toJSON?.virtuals || null
+              });
+            }
+          });
+
+          Object.defineProperty(nested, '$__isNested', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: true
+          });
+
+          Object.defineProperty(nested, '$isEmpty', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: function() {
+              return Object.keys(this.get(path, null, _isEmptyOptions) || {}).length === 0;
+            }
+          });
+
+          Object.defineProperty(nested, '$__parent', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: this
+          });
+
+          compile(subprops, nested, path, options);
+          this.$__.getters[path] = nested;
+        }
+
+        return this.$__.getters[path];
+      },
+      set: function(v) {
+        if (v?.$__isNested) {
+          // Convert top-level to POJO, but leave subdocs hydrated so `$set`
+          // can handle them. See gh-9293.
+          v = v.$__get();
+        } else if (v instanceof Document && !v.$__isNested) {
+          v = v.$toObject(internalToObjectOptions);
+        }
+        const doc = this.$__[scopeSymbol] || this;
+        doc.$set(path, v);
+      }
+    });
+  } else {
+    Object.defineProperty(prototype, prop, {
+      enumerable: true,
+      configurable: true,
+      get: function() {
+        return this[getSymbol].call(
+          this.$__[scopeSymbol] || this,
+          path,
+          null,
+          useGetOptions
+        );
+      },
+      set: function(v) {
+        this.$set.call(this.$__[scopeSymbol] || this, path, v);
+      }
+    });
+  }
+}
+
+// gets descriptors for all properties of `object`
+// makes all properties non-enumerable to match previous behavior to #2211
+function getOwnPropertyDescriptors(object) {
+  const result = {};
+
+  Object.getOwnPropertyNames(object).forEach(function(key) {
+    const skip = [
+      'isNew',
+      '$__',
+      '$errors',
+      'errors',
+      '_doc',
+      '$locals',
+      '$op',
+      '__parentArray',
+      '__index',
+      '$isDocumentArrayElement'
+    ].indexOf(key) === -1;
+    if (skip) {
+      return;
+    }
+
+    result[key] = Object.getOwnPropertyDescriptor(object, key);
+    result[key].enumerable = false;
+  });
+
+  return result;
+}

package/lib/helpers/document/getDeepestSubdocumentForPath.js

@@ -0,0 +1,38 @@
+'use strict';
+
+/**
+ * Find the deepest subdocument along a given path to ensure setter functions run
+ * with the correct subdocument as `this`. If no subdocuments, returns the top-level
+ * document.
+ *
+ * @param {Document} doc
+ * @param {String[]} parts
+ * @param {Schema} schema
+ * @returns Document
+ */
+
+module.exports = function getDeepestSubdocumentForPath(doc, parts, schema) {
+  let curPath = parts[0];
+  let curSchema = schema;
+  let subdoc = doc;
+  for (let i = 0; i < parts.length - 1; ++i) {
+    const curSchemaType = curSchema.path(curPath);
+    if (curSchemaType?.schema) {
+      let newSubdoc = subdoc.get(curPath);
+      curSchema = curSchemaType.schema;
+      curPath = parts[i + 1];
+      if (Array.isArray(newSubdoc) && !isNaN(curPath)) {
+        newSubdoc = newSubdoc[curPath];
+        curPath = '';
+      }
+      if (newSubdoc == null) {
+        break;
+      }
+      subdoc = newSubdoc;
+    } else {
+      curPath += curPath.length ? '.' + parts[i + 1] : parts[i + 1];
+    }
+  }
+
+  return subdoc;
+};

package/lib/helpers/document/getEmbeddedDiscriminatorPath.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const get = require('../get');
+const getSchemaDiscriminatorByValue = require('../discriminator/getSchemaDiscriminatorByValue');
+
+/**
+ * Like `schema.path()`, except with a document, because impossible to
+ * determine path type without knowing the embedded discriminator key.
+ *
+ * @param {Document} doc
+ * @param {String|String[]} path
+ * @param {Object} [options]
+ * @api private
+ */
+
+module.exports = function getEmbeddedDiscriminatorPath(doc, path, options) {
+  options = options || {};
+  const typeOnly = options.typeOnly;
+  const parts = Array.isArray(path) ?
+    path :
+    (path.indexOf('.') === -1 ? [path] : path.split('.'));
+  let schemaType = null;
+  let type = 'adhocOrUndefined';
+
+  const schema = getSchemaDiscriminatorByValue(doc.schema, doc.get(doc.schema.options.discriminatorKey)) || doc.schema;
+
+  for (let i = 0; i < parts.length; ++i) {
+    const subpath = parts.slice(0, i + 1).join('.');
+    schemaType = schema.path(subpath);
+    if (schemaType == null) {
+      type = 'adhocOrUndefined';
+      continue;
+    }
+    if (schemaType.instance === 'Mixed') {
+      return typeOnly ? 'real' : schemaType;
+    }
+    type = schema.pathType(subpath);
+    if ((schemaType.$isSingleNested || schemaType.$isMongooseDocumentArrayElement) &&
+    schemaType.schema.discriminators != null) {
+      const discriminators = schemaType.schema.discriminators;
+      const discriminatorKey = doc.get(subpath + '.' +
+        get(schemaType, 'schema.options.discriminatorKey'));
+      if (discriminatorKey == null || discriminators[discriminatorKey] == null) {
+        continue;
+      }
+      const rest = parts.slice(i + 1).join('.');
+      return getEmbeddedDiscriminatorPath(doc.get(subpath), rest, options);
+    }
+  }
+
+  // Are we getting the whole schema or just the type, 'real', 'nested', etc.
+  return typeOnly ? type : schemaType;
+};

package/lib/helpers/document/handleSpreadDoc.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const utils = require('../../utils');
+
+const keysToSkip = new Set(['__index', '__parentArray', '_doc']);
+
+/**
+ * Using spread operator on a Mongoose document gives you a
+ * POJO that has a tendency to cause infinite recursion. So
+ * we use this function on `set()` to prevent that.
+ */
+
+module.exports = function handleSpreadDoc(v, includeExtraKeys) {
+  if (utils.isPOJO(v) && v.$__ != null && v._doc != null) {
+    if (includeExtraKeys) {
+      const extraKeys = {};
+      for (const key of Object.keys(v)) {
+        if (typeof key === 'symbol') {
+          continue;
+        }
+        if (key[0] === '$') {
+          continue;
+        }
+        if (keysToSkip.has(key)) {
+          continue;
+        }
+        extraKeys[key] = v[key];
+      }
+      return { ...v._doc, ...extraKeys };
+    }
+    return v._doc;
+  }
+
+  return v;
+};

package/lib/helpers/each.js

@@ -0,0 +1,25 @@
+'use strict';
+
+module.exports = function each(arr, cb, done) {
+  if (arr.length === 0) {
+    return done();
+  }
+
+  let remaining = arr.length;
+  let err = null;
+  for (const v of arr) {
+    cb(v, function(_err) {
+      if (err != null) {
+        return;
+      }
+      if (_err != null) {
+        err = _err;
+        return done(err);
+      }
+
+      if (--remaining <= 0) {
+        return done();
+      }
+    });
+  }
+};

package/lib/helpers/error/combinePathErrors.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+module.exports = function combinePathErrors(err) {
+  const keys = Object.keys(err.errors || {});
+  const len = keys.length;
+  const msgs = [];
+  let key;
+
+  for (let i = 0; i < len; ++i) {
+    key = keys[i];
+    if (err === err.errors[key]) {
+      continue;
+    }
+    msgs.push(key + ': ' + err.errors[key].message);
+  }
+
+  return msgs.join(', ');
+};

package/lib/helpers/firstKey.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = function firstKey(obj) {
+  if (obj == null) {
+    return null;
+  }
+  return Object.keys(obj)[0];
+};

package/lib/helpers/get.js

@@ -0,0 +1,65 @@
+'use strict';
+
+/**
+ * Simplified lodash.get to work around the annoying null quirk. See:
+ * https://github.com/lodash/lodash/issues/3659
+ * @api private
+ */
+
+module.exports = function get(obj, path, def) {
+  let parts;
+  let isPathArray = false;
+  if (typeof path === 'string') {
+    if (path.indexOf('.') === -1) {
+      const _v = getProperty(obj, path);
+      if (_v == null) {
+        return def;
+      }
+      return _v;
+    }
+
+    parts = path.split('.');
+  } else {
+    isPathArray = true;
+    parts = path;
+
+    if (parts.length === 1) {
+      const _v = getProperty(obj, parts[0]);
+      if (_v == null) {
+        return def;
+      }
+      return _v;
+    }
+  }
+  let rest = path;
+  let cur = obj;
+  for (const part of parts) {
+    if (cur == null) {
+      return def;
+    }
+
+    // `lib/cast.js` depends on being able to get dotted paths in updates,
+    // like `{ $set: { 'a.b': 42 } }`
+    if (!isPathArray && cur[rest] != null) {
+      return cur[rest];
+    }
+
+    cur = getProperty(cur, part);
+
+    if (!isPathArray) {
+      rest = rest.substr(part.length + 1);
+    }
+  }
+
+  return cur == null ? def : cur;
+};
+
+function getProperty(obj, prop) {
+  if (obj == null) {
+    return obj;
+  }
+  if (obj instanceof Map) {
+    return obj.get(prop);
+  }
+  return obj[prop];
+}

package/lib/helpers/getConstructorName.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * If `val` is an object, returns constructor name, if possible. Otherwise returns undefined.
+ * @api private
+ */
+
+module.exports = function getConstructorName(val) {
+  if (val == null) {
+    return void 0;
+  }
+  if (typeof val.constructor !== 'function') {
+    return void 0;
+  }
+  return val.constructor.name;
+};

package/lib/helpers/getDefaultBulkwriteResult.js

@@ -0,0 +1,18 @@
+'use strict';
+
+function getDefaultBulkwriteResult() {
+  return {
+    ok: 1,
+    nInserted: 0,
+    nUpserted: 0,
+    nMatched: 0,
+    nModified: 0,
+    nRemoved: 0,
+    upserted: [],
+    writeErrors: [],
+    insertedIds: [],
+    writeConcernErrors: []
+  };
+}
+
+module.exports = getDefaultBulkwriteResult;

package/lib/helpers/getFunctionName.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const functionNameRE = /^function\s*([^\s(]+)/;
+
+module.exports = function(fn) {
+  return (
+    fn.name ||
+    (fn.toString().trim().match(functionNameRE) || [])[1]
+  );
+};

package/lib/helpers/immediate.js

@@ -0,0 +1,16 @@
+/*!
+ * Centralize this so we can more easily work around issues with people
+ * stubbing out `process.nextTick()` in tests using sinon:
+ * https://github.com/sinonjs/lolex#automatically-incrementing-mocked-time
+ * See gh-6074
+ */
+
+'use strict';
+
+const nextTick = typeof process !== 'undefined' && typeof process.nextTick === 'function' ?
+  process.nextTick.bind(process) :
+  cb => setTimeout(cb, 0); // Fallback for browser build
+
+module.exports = function immediate(cb) {
+  return nextTick(cb);
+};

package/lib/helpers/indexes/applySchemaCollation.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const isTextIndex = require('./isTextIndex');
+
+module.exports = function applySchemaCollation(indexKeys, indexOptions, schemaOptions) {
+  if (isTextIndex(indexKeys)) {
+    return;
+  }
+
+  if (Object.hasOwn(schemaOptions, 'collation') && !Object.hasOwn(indexOptions, 'collation')) {
+    indexOptions.collation = schemaOptions.collation;
+  }
+};

package/lib/helpers/indexes/decorateDiscriminatorIndexOptions.js

@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = function decorateDiscriminatorIndexOptions(schema, indexOptions) {
+  // If the model is a discriminator and has an index, add a
+  // partialFilterExpression by default so the index will only apply
+  // to that discriminator.
+  const discriminatorName = schema.discriminatorMapping?.value;
+  if (discriminatorName && !('sparse' in indexOptions)) {
+    const discriminatorKey = schema.options.discriminatorKey;
+    indexOptions.partialFilterExpression = indexOptions.partialFilterExpression || {};
+    indexOptions.partialFilterExpression[discriminatorKey] = discriminatorName;
+  }
+  return indexOptions;
+};

package/lib/helpers/indexes/getRelatedIndexes.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const hasDollarKeys = require('../query/hasDollarKeys');
+
+function getRelatedSchemaIndexes(model, schemaIndexes) {
+  return getRelatedIndexes({
+    baseModelName: model.baseModelName,
+    discriminatorMapping: model.schema.discriminatorMapping,
+    indexes: schemaIndexes,
+    indexesType: 'schema'
+  });
+}
+
+function getRelatedDBIndexes(model, dbIndexes) {
+  return getRelatedIndexes({
+    baseModelName: model.baseModelName,
+    discriminatorMapping: model.schema.discriminatorMapping,
+    indexes: dbIndexes,
+    indexesType: 'db'
+  });
+}
+
+module.exports = {
+  getRelatedSchemaIndexes,
+  getRelatedDBIndexes
+};
+
+function getRelatedIndexes({
+  baseModelName,
+  discriminatorMapping,
+  indexes,
+  indexesType
+}) {
+  const discriminatorKey = discriminatorMapping?.key;
+  const discriminatorValue = discriminatorMapping?.value;
+
+  if (!discriminatorKey) {
+    return indexes;
+  }
+
+  const isChildDiscriminatorModel = Boolean(baseModelName);
+  if (isChildDiscriminatorModel) {
+    return indexes.filter(index => {
+      const partialFilterExpression = getPartialFilterExpression(index, indexesType);
+      return partialFilterExpression && partialFilterExpression[discriminatorKey] === discriminatorValue;
+    });
+  }
+
+  return indexes.filter(index => {
+    const partialFilterExpression = getPartialFilterExpression(index, indexesType);
+    return !partialFilterExpression
+      || !partialFilterExpression[discriminatorKey]
+      || (hasDollarKeys(partialFilterExpression[discriminatorKey]) && !('$eq' in partialFilterExpression[discriminatorKey]));
+  });
+}
+
+function getPartialFilterExpression(index, indexesType) {
+  if (indexesType === 'schema') {
+    const options = index[1];
+    return options?.partialFilterExpression;
+  }
+  return index.partialFilterExpression;
+}

package/lib/helpers/indexes/isDefaultIdIndex.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const get = require('../get');
+
+module.exports = function isDefaultIdIndex(index) {
+  if (Array.isArray(index)) {
+    // Mongoose syntax
+    const keys = Object.keys(index[0]);
+    return keys.length === 1 && keys[0] === '_id' && index[0]._id !== 'hashed';
+  }
+
+  if (typeof index !== 'object') {
+    return false;
+  }
+
+  const key = get(index, 'key', {});
+  return Object.keys(key).length === 1 && Object.hasOwn(key, '_id');
+};