@depup/mongoose 9.1.3-depup.0

package/lib/helpers/aggregate/stringifyFunctionOperators.js

@@ -0,0 +1,50 @@
+'use strict';
+
+module.exports = function stringifyFunctionOperators(pipeline) {
+  if (!Array.isArray(pipeline)) {
+    return;
+  }
+
+  for (const stage of pipeline) {
+    if (stage == null) {
+      continue;
+    }
+
+    const canHaveAccumulator = stage.$group || stage.$bucket || stage.$bucketAuto;
+    if (canHaveAccumulator != null) {
+      for (const key of Object.keys(canHaveAccumulator)) {
+        handleAccumulator(canHaveAccumulator[key]);
+      }
+    }
+
+    const stageType = Object.keys(stage)[0];
+    if (stageType && typeof stage[stageType] === 'object') {
+      const stageOptions = stage[stageType];
+      for (const key of Object.keys(stageOptions)) {
+        if (stageOptions[key] != null &&
+            stageOptions[key].$function != null &&
+            typeof stageOptions[key].$function.body === 'function') {
+          stageOptions[key].$function.body = stageOptions[key].$function.body.toString();
+        }
+      }
+    }
+
+    if (stage.$facet != null) {
+      for (const key of Object.keys(stage.$facet)) {
+        stringifyFunctionOperators(stage.$facet[key]);
+      }
+    }
+  }
+};
+
+function handleAccumulator(operator) {
+  if (operator == null || operator.$accumulator == null) {
+    return;
+  }
+
+  for (const key of ['init', 'accumulate', 'merge', 'finalize']) {
+    if (typeof operator.$accumulator[key] === 'function') {
+      operator.$accumulator[key] = String(operator.$accumulator[key]);
+    }
+  }
+}

package/lib/helpers/arrayDepth.js

@@ -0,0 +1,33 @@
+'use strict';
+
+module.exports = arrayDepth;
+
+function arrayDepth(arr) {
+  if (!Array.isArray(arr)) {
+    return { min: 0, max: 0, containsNonArrayItem: true };
+  }
+  if (arr.length === 0) {
+    return { min: 1, max: 1, containsNonArrayItem: false };
+  }
+  if (arr.length === 1 && !Array.isArray(arr[0])) {
+    return { min: 1, max: 1, containsNonArrayItem: false };
+  }
+
+  const res = arrayDepth(arr[0]);
+
+  for (let i = 1; i < arr.length; ++i) {
+    const _res = arrayDepth(arr[i]);
+    if (_res.min < res.min) {
+      res.min = _res.min;
+    }
+    if (_res.max > res.max) {
+      res.max = _res.max;
+    }
+    res.containsNonArrayItem = res.containsNonArrayItem || _res.containsNonArrayItem;
+  }
+
+  res.min = res.min + 1;
+  res.max = res.max + 1;
+
+  return res;
+}

package/lib/helpers/clone.js

@@ -0,0 +1,204 @@
+'use strict';
+
+const Decimal = require('../types/decimal128');
+const ObjectId = require('../types/objectid');
+const specialProperties = require('./specialProperties');
+const isMongooseObject = require('./isMongooseObject');
+const getFunctionName = require('./getFunctionName');
+const isBsonType = require('./isBsonType');
+const isMongooseArray = require('../types/array/isMongooseArray').isMongooseArray;
+const isObject = require('./isObject');
+const isPOJO = require('./isPOJO');
+const symbols = require('./symbols');
+const trustedSymbol = require('./query/trusted').trustedSymbol;
+const BSON = require('mongodb/lib/bson');
+
+/**
+ * Object clone with Mongoose natives support.
+ *
+ * If options.minimize is true, creates a minimal data object. Empty objects and undefined values will not be cloned. This makes the data payload sent to MongoDB as small as possible.
+ *
+ * Functions and primitives are never cloned.
+ *
+ * @param {Object} obj the object to clone
+ * @param {Object} options
+ * @param {Boolean} isArrayChild true if cloning immediately underneath an array. Special case for minimize.
+ * @return {Object} the cloned object
+ * @api private
+ */
+
+function clone(obj, options, isArrayChild) {
+  if (obj == null) {
+    return obj;
+  }
+
+  if (isBsonType(obj, 'Double')) {
+    return new BSON.Double(obj.value);
+  }
+  if (typeof obj === 'number' || typeof obj === 'string' || typeof obj === 'boolean' || typeof obj === 'bigint') {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return cloneArray(obj, options);
+  }
+
+  if (isMongooseObject(obj)) {
+    if (options) {
+      if (options.retainDocuments && obj.$__ != null) {
+        const clonedDoc = obj.$clone();
+        if (obj.__index != null) {
+          clonedDoc.__index = obj.__index;
+        }
+        if (obj.__parentArray != null) {
+          clonedDoc.__parentArray = obj.__parentArray;
+        }
+        clonedDoc.$__setParent(options.parentDoc ?? obj.$__parent);
+        return clonedDoc;
+      }
+    }
+
+    if (isPOJO(obj) && obj.$__ != null && obj._doc != null) {
+      return obj._doc;
+    }
+
+    let ret;
+    if (options?.json && typeof obj.toJSON === 'function') {
+      ret = obj.toJSON(options);
+    } else {
+      ret = obj.toObject(options);
+    }
+
+    return ret;
+  }
+
+  const objConstructor = obj.constructor;
+
+  if (objConstructor) {
+    switch (getFunctionName(objConstructor)) {
+      case 'Object':
+        return cloneObject(obj, options, isArrayChild);
+      case 'Date':
+        return new objConstructor(+obj);
+      case 'RegExp':
+        return cloneRegExp(obj);
+      default:
+        // ignore
+        break;
+    }
+  }
+
+  if (isBsonType(obj, 'ObjectId')) {
+    if (options?.flattenObjectIds) {
+      return obj.toJSON();
+    }
+    return new ObjectId(obj.id);
+  }
+
+  if (isBsonType(obj, 'Decimal128')) {
+    if (options?.flattenDecimals) {
+      return obj.toJSON();
+    }
+    return Decimal.fromString(obj.toString());
+  }
+
+  // object created with Object.create(null)
+  if (!objConstructor && isObject(obj)) {
+    return cloneObject(obj, options, isArrayChild);
+  }
+
+  if (typeof obj === 'object' && obj[symbols.schemaTypeSymbol]) {
+    return obj.clone();
+  }
+
+  // If we're cloning this object to go into a MongoDB command,
+  // and there's a `toBSON()` function, assume this object will be
+  // stored as a primitive in MongoDB and doesn't need to be cloned.
+  if (options?.bson && typeof obj.toBSON === 'function') {
+    return obj;
+  }
+
+  if (typeof obj.valueOf === 'function') {
+    return obj.valueOf();
+  }
+
+  return cloneObject(obj, options, isArrayChild);
+}
+module.exports = clone;
+
+/*!
+ * ignore
+ */
+
+function cloneObject(obj, options, isArrayChild) {
+  const minimize = options?.minimize;
+  const omitUndefined = options?.omitUndefined;
+  const seen = options?._seen;
+  const ret = {};
+  let hasKeys;
+
+  if (seen && seen.has(obj)) {
+    return seen.get(obj);
+  } else if (seen) {
+    seen.set(obj, ret);
+  }
+  if (trustedSymbol in obj && options?.copyTrustedSymbol !== false) {
+    ret[trustedSymbol] = obj[trustedSymbol];
+  }
+
+  const keys = Object.keys(obj);
+  const len = keys.length;
+
+  for (let i = 0; i < len; ++i) {
+    const key = keys[i];
+    if (specialProperties.has(key)) {
+      continue;
+    }
+
+    // Don't pass `isArrayChild` down
+    const val = clone(obj[key], options, false);
+
+    if ((minimize === false || omitUndefined) && typeof val === 'undefined') {
+      delete ret[key];
+    } else if (minimize !== true || (typeof val !== 'undefined')) {
+      hasKeys || (hasKeys = true);
+      ret[key] = val;
+    }
+  }
+
+  return minimize && !isArrayChild ? hasKeys && ret : ret;
+}
+
+function cloneArray(arr, options) {
+  let i = 0;
+  const len = arr.length;
+
+  let ret = null;
+  if (options?.retainDocuments) {
+    if (arr.isMongooseDocumentArray) {
+      ret = new (arr.$schemaType().schema.base.Types.DocumentArray)([], arr.$path(), arr.$parent(), arr.$schemaType());
+    } else if (arr.isMongooseArray) {
+      ret = new (arr.$parent().schema.base.Types.Array)([], arr.$path(), arr.$parent(), arr.$schemaType());
+    } else {
+      ret = new Array(len);
+    }
+  } else {
+    ret = new Array(len);
+  }
+
+  arr = isMongooseArray(arr) ? arr.__array : arr;
+  for (i = 0; i < len; ++i) {
+    ret[i] = clone(arr[i], options, true);
+  }
+
+  return ret;
+}
+
+function cloneRegExp(regexp) {
+  const ret = new RegExp(regexp.source, regexp.flags);
+
+  if (ret.lastIndex !== regexp.lastIndex) {
+    ret.lastIndex = regexp.lastIndex;
+  }
+  return ret;
+}

package/lib/helpers/common.js

@@ -0,0 +1,127 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const Binary = require('mongodb/lib/bson').Binary;
+const isBsonType = require('./isBsonType');
+const isMongooseObject = require('./isMongooseObject');
+const MongooseError = require('../error');
+const util = require('util');
+
+exports.flatten = flatten;
+exports.modifiedPaths = modifiedPaths;
+
+/*!
+ * ignore
+ */
+
+function flatten(update, path, options, schema) {
+  let keys;
+  if (update && isMongooseObject(update) && !Buffer.isBuffer(update)) {
+    keys = Object.keys(update.toObject({ transform: false, virtuals: false }) || {});
+  } else {
+    keys = Object.keys(update || {});
+  }
+
+  const numKeys = keys.length;
+  const result = {};
+  path = path ? path + '.' : '';
+
+  for (let i = 0; i < numKeys; ++i) {
+    const key = keys[i];
+    const val = update[key];
+    result[path + key] = val;
+
+    // Avoid going into mixed paths if schema is specified
+    const keySchema = schema?.path?.(path + key);
+    const isNested = schema?.nested?.[path + key];
+    if (keySchema?.instance === 'Mixed') continue;
+
+    if (shouldFlatten(val)) {
+      if (options?.skipArrays && Array.isArray(val)) {
+        continue;
+      }
+      const flat = flatten(val, path + key, options, schema);
+      for (const k in flat) {
+        result[k] = flat[k];
+      }
+      if (Array.isArray(val)) {
+        result[path + key] = val;
+      }
+    }
+
+    if (isNested) {
+      const paths = Object.keys(schema.paths);
+      for (const p of paths) {
+        if (p.startsWith(path + key + '.') && !Object.hasOwn(result, p)) {
+          result[p] = void 0;
+        }
+      }
+    }
+  }
+
+  return result;
+}
+
+/*!
+ * ignore
+ */
+
+function modifiedPaths(update, path, result, recursion = null) {
+  if (update == null || typeof update !== 'object') {
+    return;
+  }
+
+  if (recursion == null) {
+    recursion = {
+      raw: { update, path },
+      trace: new WeakSet()
+    };
+  }
+
+  if (recursion.trace.has(update)) {
+    throw new MongooseError(`a circular reference in the update value, updateValue:
+${util.inspect(recursion.raw.update, { showHidden: false, depth: 1 })}
+updatePath: '${recursion.raw.path}'`);
+  }
+  recursion.trace.add(update);
+
+  const keys = Object.keys(update || {});
+  const numKeys = keys.length;
+  result = result || {};
+  path = path ? path + '.' : '';
+
+  for (let i = 0; i < numKeys; ++i) {
+    const key = keys[i];
+    let val = update[key];
+
+    const _path = path + key;
+    result[_path] = true;
+    if (!Buffer.isBuffer(val) && isMongooseObject(val)) {
+      val = val.toObject({ transform: false, virtuals: false });
+    }
+    if (shouldFlatten(val)) {
+      modifiedPaths(val, path + key, result, recursion);
+    }
+  }
+  recursion.trace.delete(update);
+
+  return result;
+}
+
+/*!
+ * ignore
+ */
+
+function shouldFlatten(val) {
+  return val &&
+      typeof val === 'object' &&
+      !(val instanceof Date) &&
+      !isBsonType(val, 'ObjectId') &&
+      (!Array.isArray(val) || val.length !== 0) &&
+      !(val instanceof Buffer) &&
+      !isBsonType(val, 'Decimal128') &&
+      !(val instanceof Binary);
+}

package/lib/helpers/createJSONSchemaTypeDefinition.js

@@ -0,0 +1,24 @@
+'use strict';
+
+/**
+ * Handles creating `{ type: 'object' }` vs `{ bsonType: 'object' }` vs `{ bsonType: ['object', 'null'] }`
+ *
+ * @param {String} type
+ * @param {String} bsonType
+ * @param {Boolean} useBsonType
+ * @param {Boolean} isRequired
+ */
+
+module.exports = function createJSONSchemaTypeArray(type, bsonType, useBsonType, isRequired) {
+  if (useBsonType) {
+    if (isRequired) {
+      return { bsonType };
+    }
+    return { bsonType: [bsonType, 'null'] };
+  } else {
+    if (isRequired) {
+      return { type };
+    }
+    return { type: [type, 'null'] };
+  }
+};

package/lib/helpers/cursor/eachAsync.js

@@ -0,0 +1,225 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const EachAsyncMultiError = require('../../error/eachAsyncMultiError');
+const immediate = require('../immediate');
+
+/**
+ * Execute `fn` for every document in the cursor. If `fn` returns a promise,
+ * will wait for the promise to resolve before iterating on to the next one.
+ * Returns a promise that resolves when done.
+ *
+ * @param {Function} next the thunk to call to get the next document
+ * @param {Function} fn
+ * @param {Object} options
+ * @param {Number} [options.batchSize=null] if set, Mongoose will call `fn` with an array of at most `batchSize` documents, instead of a single document
+ * @param {Number} [options.parallel=1] maximum number of `fn` calls that Mongoose will run in parallel
+ * @param {AbortSignal} [options.signal] allow cancelling this eachAsync(). Once the abort signal is fired, `eachAsync()` will immediately fulfill the returned promise (or call the callback) and not fetch any more documents.
+ * @return {Promise}
+ * @api public
+ * @method eachAsync
+ */
+
+module.exports = async function eachAsync(next, fn, options) {
+  const parallel = options.parallel || 1;
+  const batchSize = options.batchSize;
+  const signal = options.signal;
+  const continueOnError = options.continueOnError;
+  const aggregatedErrors = [];
+  const enqueue = asyncQueue();
+
+  let aborted = false;
+
+  return new Promise((resolve, reject) => {
+    if (signal != null) {
+      if (signal.aborted) {
+        return resolve(null);
+      }
+
+      signal.addEventListener('abort', () => {
+        aborted = true;
+        return resolve(null);
+      }, { once: true });
+    }
+
+    if (batchSize != null) {
+      if (typeof batchSize !== 'number') {
+        throw new TypeError('batchSize must be a number');
+      } else if (!Number.isInteger(batchSize)) {
+        throw new TypeError('batchSize must be an integer');
+      } else if (batchSize < 1) {
+        throw new TypeError('batchSize must be at least 1');
+      }
+    }
+
+    iterate((err, res) => {
+      if (err != null) {
+        return reject(err);
+      }
+      resolve(res);
+    });
+  });
+
+  function iterate(finalCallback) {
+    let handleResultsInProgress = 0;
+    let currentDocumentIndex = 0;
+
+    let error = null;
+    for (let i = 0; i < parallel; ++i) {
+      enqueue(createFetch());
+    }
+
+    function createFetch() {
+      let documentsBatch = [];
+      let drained = false;
+
+      return fetch;
+
+      function fetch(done) {
+        if (drained || aborted) {
+          return done();
+        } else if (error) {
+          return done();
+        }
+
+        next(function(err, doc) {
+          if (error != null) {
+            return done();
+          }
+          if (err != null) {
+            if (err.name === 'MongoCursorExhaustedError') {
+              // We may end up calling `next()` multiple times on an exhausted
+              // cursor, which leads to an error. In case cursor is exhausted,
+              // just treat it as if the cursor returned no document, which is
+              // how a cursor indicates it is exhausted.
+              doc = null;
+            } else if (continueOnError) {
+              aggregatedErrors.push(err);
+            } else {
+              error = err;
+              finalCallback(err);
+              return done();
+            }
+          }
+          if (doc == null) {
+            drained = true;
+            if (handleResultsInProgress <= 0) {
+              const finalErr = continueOnError ?
+                createEachAsyncMultiError(aggregatedErrors) :
+                error;
+
+              finalCallback(finalErr);
+            } else if (batchSize && documentsBatch.length) {
+              handleNextResult(documentsBatch, currentDocumentIndex++, handleNextResultCallBack);
+            }
+            return done();
+          }
+
+          ++handleResultsInProgress;
+
+          // Kick off the subsequent `next()` before handling the result, but
+          // make sure we know that we still have a result to handle re: #8422
+          immediate(() => done());
+
+          if (batchSize) {
+            documentsBatch.push(doc);
+          }
+
+          // If the current documents size is less than the provided batch size don't process the documents yet
+          if (batchSize && documentsBatch.length !== batchSize) {
+            immediate(() => enqueue(fetch));
+            return;
+          }
+
+          const docsToProcess = batchSize ? documentsBatch : doc;
+
+          function handleNextResultCallBack(err) {
+            if (batchSize) {
+              handleResultsInProgress -= documentsBatch.length;
+              documentsBatch = [];
+            } else {
+              --handleResultsInProgress;
+            }
+            if (err != null) {
+              if (continueOnError) {
+                aggregatedErrors.push(err);
+              } else {
+                error = err;
+                return finalCallback(err);
+              }
+            }
+            if ((drained || aborted) && handleResultsInProgress <= 0) {
+              const finalErr = continueOnError ?
+                createEachAsyncMultiError(aggregatedErrors) :
+                error;
+              return finalCallback(finalErr);
+            }
+
+            immediate(() => enqueue(fetch));
+          }
+
+          handleNextResult(docsToProcess, currentDocumentIndex++, handleNextResultCallBack);
+        });
+      }
+    }
+  }
+
+  function handleNextResult(doc, i, callback) {
+    let maybePromise;
+    try {
+      maybePromise = fn(doc, i);
+    } catch (err) {
+      return callback(err);
+    }
+    if (typeof maybePromise?.then === 'function') {
+      maybePromise.then(
+        function() { callback(null); },
+        function(error) {
+          callback(error || new Error('`eachAsync()` promise rejected without error'));
+        });
+    } else {
+      callback(null);
+    }
+  }
+};
+
+// `next()` can only execute one at a time, so make sure we always execute
+// `next()` in series, while still allowing multiple `fn()` instances to run
+// in parallel.
+function asyncQueue() {
+  const _queue = [];
+  let inProgress = null;
+  let id = 0;
+
+  return function enqueue(fn) {
+    if (
+      inProgress === null &&
+      _queue.length === 0
+    ) {
+      inProgress = id++;
+      return fn(_step);
+    }
+    _queue.push(fn);
+  };
+
+  function _step() {
+    if (_queue.length !== 0) {
+      inProgress = id++;
+      const fn = _queue.shift();
+      fn(_step);
+    } else {
+      inProgress = null;
+    }
+  }
+}
+
+function createEachAsyncMultiError(aggregatedErrors) {
+  if (aggregatedErrors.length === 0) {
+    return null;
+  }
+
+  return new EachAsyncMultiError(aggregatedErrors);
+}

package/lib/helpers/discriminator/applyEmbeddedDiscriminators.js

@@ -0,0 +1,36 @@
+'use strict';
+
+module.exports = applyEmbeddedDiscriminators;
+
+function applyEmbeddedDiscriminators(schema, seen = new WeakSet(), overwriteExisting = false) {
+  if (seen.has(schema)) {
+    return;
+  }
+  seen.add(schema);
+  for (const path of Object.keys(schema.paths)) {
+    const schemaType = schema.paths[path];
+    if (!schemaType.schema) {
+      continue;
+    }
+    applyEmbeddedDiscriminators(schemaType.schema, seen);
+    if (!schemaType.schema._applyDiscriminators) {
+      continue;
+    }
+    if (schemaType._appliedDiscriminators && !overwriteExisting) {
+      continue;
+    }
+    for (const discriminatorKey of schemaType.schema._applyDiscriminators.keys()) {
+      const {
+        schema: discriminatorSchema,
+        options
+      } = schemaType.schema._applyDiscriminators.get(discriminatorKey);
+      applyEmbeddedDiscriminators(discriminatorSchema, seen);
+      schemaType.discriminator(
+        discriminatorKey,
+        discriminatorSchema,
+        overwriteExisting ? { ...options, overwriteExisting: true } : options
+      );
+    }
+    schemaType._appliedDiscriminators = true;
+  }
+}