mongoose 8.10.1 → 8.11.0

package/lib/cast/bigint.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const assert = require('assert');
 const { Long } = require('bson');
 
 /**
@@ -13,6 +12,10 @@ const { Long } = require('bson');
  * @api private
  */
 
+const MAX_BIGINT = 9223372036854775807n;
+const MIN_BIGINT = -9223372036854775808n;
+const ERROR_MESSAGE = `Mongoose only supports BigInts between ${MIN_BIGINT} and ${MAX_BIGINT} because MongoDB does not support arbitrary precision integers`;
+
 module.exports = function castBigInt(val) {
   if (val == null) {
     return val;
@@ -21,6 +24,9 @@ module.exports = function castBigInt(val) {
     return null;
   }
   if (typeof val === 'bigint') {
+    if (val > MAX_BIGINT || val < MIN_BIGINT) {
+      throw new Error(ERROR_MESSAGE);
+    }
     return val;
   }
 
@@ -29,8 +35,12 @@ module.exports = function castBigInt(val) {
   }
 
   if (typeof val === 'string' || typeof val === 'number') {
-    return BigInt(val);
+    val = BigInt(val);
+    if (val > MAX_BIGINT || val < MIN_BIGINT) {
+      throw new Error(ERROR_MESSAGE);
+    }
+    return val;
   }
 
-  assert.ok(false);
+  throw new Error(`Cannot convert value to BigInt: "${val}"`);
 };

package/lib/connection.js

@@ -23,6 +23,7 @@ const CreateCollectionsError = require('./error/createCollectionsError');
 const castBulkWrite = require('./helpers/model/castBulkWrite');
 const { modelSymbol } = require('./helpers/symbols');
 const isPromise = require('./helpers/isPromise');
+const decorateBulkWriteResult = require('./helpers/model/decorateBulkWriteResult');
 
 const arrayAtomicsSymbol = require('./helpers/symbols').arrayAtomicsSymbol;
 const sessionNewDocuments = require('./helpers/symbols').sessionNewDocuments;
@@ -559,7 +560,9 @@ Connection.prototype.bulkWrite = async function bulkWrite(ops, options) {
           'bulkWrite'
         );
       }
-      return getDefaultBulkwriteResult();
+      const BulkWriteResult = this.base.driver.get().BulkWriteResult;
+      const res = new BulkWriteResult(getDefaultBulkwriteResult(), false);
+      return decorateBulkWriteResult(res, validationErrors, results);
     }
 
     let error;
@@ -567,16 +570,17 @@ Connection.prototype.bulkWrite = async function bulkWrite(ops, options) {
       then(res => ([res, null])).
       catch(err => ([null, err]));
 
+    for (let i = 0; i < validOpIndexes.length; ++i) {
+      results[validOpIndexes[i]] = null;
+    }
     if (error) {
       if (validationErrors.length > 0) {
+        decorateBulkWriteResult(error, validationErrors, results);
         error.mongoose = error.mongoose || {};
         error.mongoose.validationErrors = validationErrors;
       }
     }
 
-    for (let i = 0; i < validOpIndexes.length; ++i) {
-      results[validOpIndexes[i]] = null;
-    }
     if (validationErrors.length > 0) {
       if (options.throwOnValidationError) {
         throw new MongooseBulkWriteError(
@@ -586,9 +590,7 @@ Connection.prototype.bulkWrite = async function bulkWrite(ops, options) {
           'bulkWrite'
         );
       } else {
-        res.mongoose = res.mongoose || {};
-        res.mongoose.validationErrors = validationErrors;
-        res.mongoose.results = results;
+        decorateBulkWriteResult(res, validationErrors, results);
       }
     }
   }

package/lib/document.js

@@ -3836,15 +3836,39 @@ Document.prototype.$toObject = function(options, json) {
   // Parent options should only bubble down for subdocuments, not populated docs
   options._parentOptions = this.$isSubdocument ? options : null;
 
-  // remember the root transform function
-  // to save it from being overwritten by sub-transform functions
-  // const originalTransform = options.transform;
+  const schemaFieldsOnly = options._calledWithOptions.schemaFieldsOnly
+    ?? options.schemaFieldsOnly
+    ?? defaultOptions.schemaFieldsOnly
+    ?? false;
 
   let ret;
   if (hasOnlyPrimitiveValues && !options.flattenObjectIds) {
     // Fast path: if we don't have any nested objects or arrays, we only need a
     // shallow clone.
-    ret = this.$__toObjectShallow();
+    ret = this.$__toObjectShallow(schemaFieldsOnly);
+  } else if (schemaFieldsOnly) {
+    ret = {};
+    for (const path of Object.keys(this.$__schema.paths)) {
+      const value = this.$__getValue(path);
+      if (value === undefined) {
+        continue;
+      }
+      let pathToSet = path;
+      let objToSet = ret;
+      if (path.indexOf('.') !== -1) {
+        const segments = path.split('.');
+        pathToSet = segments[segments.length - 1];
+        for (let i = 0; i < segments.length - 1; ++i) {
+          objToSet[segments[i]] = objToSet[segments[i]] ?? {};
+          objToSet = objToSet[segments[i]];
+        }
+      }
+      if (value === null) {
+        objToSet[pathToSet] = null;
+        continue;
+      }
+      objToSet[pathToSet] = clone(value, options);
+    }
   } else {
     ret = clone(this._doc, options) || {};
   }
@@ -3910,10 +3934,12 @@ Document.prototype.$toObject = function(options, json) {
  * Internal shallow clone alternative to `$toObject()`: much faster, no options processing
  */
 
-Document.prototype.$__toObjectShallow = function $__toObjectShallow() {
+Document.prototype.$__toObjectShallow = function $__toObjectShallow(schemaFieldsOnly) {
   const ret = {};
   if (this._doc != null) {
-    for (const key of Object.keys(this._doc)) {
+    const keys = schemaFieldsOnly ? Object.keys(this.$__schema.paths) : Object.keys(this._doc);
+    for (const key of keys) {
+      // Safe to do this even in the schemaFieldsOnly case because we assume there's no nested paths
       const value = this._doc[key];
       if (value instanceof Date) {
         ret[key] = new Date(value);
@@ -4066,6 +4092,7 @@ Document.prototype.$__toObjectShallow = function $__toObjectShallow() {
  * @param {Boolean} [options.flattenMaps=false] if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`.
  * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
  * @param {Boolean} [options.useProjection=false] - If true, omits fields that are excluded in this document's projection. Unless you specified a projection, this will omit any field that has `select: false` in the schema.
+ * @param {Boolean} [options.schemaFieldsOnly=false] - If true, the resulting object will only have fields that are defined in the document's schema. By default, `toObject()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema.
  * @return {Object} document as a plain old JavaScript object (POJO). This object may contain ObjectIds, Maps, Dates, mongodb.Binary, Buffers, and other non-POJO values.
  * @see mongodb.Binary https://mongodb.github.io/node-mongodb-native/4.9/classes/Binary.html
  * @api public
@@ -4336,6 +4363,7 @@ function omitDeselectedFields(self, json) {
  * @param {Object} options
  * @param {Boolean} [options.flattenMaps=true] if true, convert Maps to [POJOs](https://masteringjs.io/tutorials/fundamentals/pojo). Useful if you want to `JSON.stringify()` the result.
  * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
+ * @param {Boolean} [options.schemaFieldsOnly=false] - If true, the resulting object will only have fields that are defined in the document's schema. By default, `toJSON()` returns all fields in the underlying document from MongoDB, including ones that are not listed in the schema.
  * @return {Object}
  * @see Document#toObject https://mongoosejs.com/docs/api/document.html#Document.prototype.toObject()
  * @see JSON.stringify() in JavaScript https://thecodebarbarian.com/the-80-20-guide-to-json-stringify-in-javascript.html
@@ -4506,6 +4534,8 @@ Document.prototype.equals = function(doc) {
  * @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://www.mongodb.com/docs/manual/tutorial/query-documents/), or a function that returns a filter object.
  * @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
+ * @param {Boolean} [options.forceRepopulate=true] Set to `false` to prevent Mongoose from repopulating paths that are already populated
+ * @param {Boolean} [options.ordered=false] Set to `true` to execute any populate queries one at a time, as opposed to in parallel. We recommend setting this option to `true` if using transactions, especially if also populating multiple paths or paths with multiple models. MongoDB server does **not** support multiple operations in parallel on a single transaction.
  * @param {Function} [callback] Callback
  * @see population https://mongoosejs.com/docs/populate.html
  * @see Query#select https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
@@ -4532,6 +4562,7 @@ Document.prototype.populate = async function populate() {
   }
 
   const paths = utils.object.vals(pop);
+
   let topLevelModel = this.constructor;
   if (this.$__isNested) {
     topLevelModel = this.$__[scopeSymbol].constructor;

package/lib/drivers/browser/index.js

@@ -10,3 +10,4 @@ exports.Collection = function() {
 exports.Connection = function() {
   throw new Error('Cannot create a connection from browser library');
 };
+exports.BulkWriteResult = function() {};

package/lib/drivers/node-mongodb-native/bulkWriteResult.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const BulkWriteResult = require('mongodb/lib/bulk/common').BulkWriteResult;
+
+module.exports = BulkWriteResult;

package/lib/drivers/node-mongodb-native/collection.js

@@ -13,6 +13,8 @@ const internalToObjectOptions = require('../../options').internalToObjectOptions
 const stream = require('stream');
 const util = require('util');
 
+const formatToObjectOptions = Object.freeze({ ...internalToObjectOptions, copyTrustedSymbol: false });
+
 /**
  * A [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) collection implementation.
  *
@@ -384,7 +386,9 @@ function format(obj, sub, color, shell) {
   }
 
   const clone = require('../../helpers/clone');
-  let x = clone(obj, internalToObjectOptions);
+  // `sub` indicates `format()` was called recursively, so skip cloning because we already
+  // did a deep clone on the top-level object.
+  let x = sub ? obj : clone(obj, formatToObjectOptions);
   const constructorName = getConstructorName(x);
 
   if (constructorName === 'Binary') {

package/lib/drivers/node-mongodb-native/index.js

@@ -4,5 +4,6 @@
 
 'use strict';
 
+exports.BulkWriteResult = require('./bulkWriteResult');
 exports.Collection = require('./collection');
 exports.Connection = require('./connection');

package/lib/helpers/clone.js

@@ -147,7 +147,7 @@ function cloneObject(obj, options, isArrayChild) {
   } else if (seen) {
     seen.set(obj, ret);
   }
-  if (trustedSymbol in obj) {
+  if (trustedSymbol in obj && options?.copyTrustedSymbol !== false) {
     ret[trustedSymbol] = obj[trustedSymbol];
   }
 

package/lib/helpers/getDefaultBulkwriteResult.js

@@ -1,26 +1,17 @@
 'use strict';
+
 function getDefaultBulkwriteResult() {
   return {
-    result: {
-      ok: 1,
-      writeErrors: [],
-      writeConcernErrors: [],
-      insertedIds: [],
-      nInserted: 0,
-      nUpserted: 0,
-      nMatched: 0,
-      nModified: 0,
-      nRemoved: 0,
-      upserted: []
-    },
-    insertedCount: 0,
-    matchedCount: 0,
-    modifiedCount: 0,
-    deletedCount: 0,
-    upsertedCount: 0,
-    upsertedIds: {},
-    insertedIds: {},
-    n: 0
+    ok: 1,
+    nInserted: 0,
+    nUpserted: 0,
+    nMatched: 0,
+    nModified: 0,
+    nRemoved: 0,
+    upserted: [],
+    writeErrors: [],
+    insertedIds: [],
+    writeConcernErrors: []
   };
 }
 

package/lib/helpers/model/decorateBulkWriteResult.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = function decorateBulkWriteResult(resultOrError, validationErrors, results) {
+  resultOrError.mongoose = resultOrError.mongoose || {};
+  resultOrError.mongoose.validationErrors = validationErrors;
+  resultOrError.mongoose.results = results;
+  return resultOrError;
+};

package/lib/model.js

@@ -10,7 +10,6 @@ const Document = require('./document');
 const DocumentNotFoundError = require('./error/notFound');
 const EventEmitter = require('events').EventEmitter;
 const Kareem = require('kareem');
-const { MongoBulkWriteError } = require('mongodb');
 const MongooseBulkWriteError = require('./error/bulkWriteError');
 const MongooseError = require('./error/index');
 const ObjectParameterError = require('./error/objectParameter');
@@ -69,6 +68,7 @@ const utils = require('./utils');
 const minimize = require('./helpers/minimize');
 const MongooseBulkSaveIncompleteError = require('./error/bulkSaveIncompleteError');
 const ObjectExpectedError = require('./error/objectExpected');
+const decorateBulkWriteResult = require('./helpers/model/decorateBulkWriteResult');
 
 const modelCollectionSymbol = Symbol('mongoose#Model#collection');
 const modelDbSymbol = Symbol('mongoose#Model#db');
@@ -3104,11 +3104,9 @@ Model.$__insertMany = function(arr, options, callback) {
         const res = {
           acknowledged: true,
           insertedCount: 0,
-          insertedIds: {},
-          mongoose: {
-            validationErrors: validationErrors
-          }
+          insertedIds: {}
         };
+        decorateBulkWriteResult(res, validationErrors, validationErrors);
         return callback(null, res);
       }
       callback(null, []);
@@ -3161,10 +3159,7 @@ Model.$__insertMany = function(arr, options, callback) {
 
             // Decorate with mongoose validation errors in case of unordered,
             // because then still do `insertMany()`
-            res.mongoose = {
-              validationErrors: validationErrors,
-              results: results
-            };
+            decorateBulkWriteResult(res, validationErrors, results);
           }
           return callback(null, res);
         }
@@ -3198,10 +3193,7 @@ Model.$__insertMany = function(arr, options, callback) {
         if (error.writeErrors != null) {
           for (let i = 0; i < error.writeErrors.length; ++i) {
             const originalIndex = validDocIndexToOriginalIndex.get(error.writeErrors[i].index);
-            error.writeErrors[i] = {
-              ...error.writeErrors[i],
-              index: originalIndex
-            };
+            error.writeErrors[i] = { ...error.writeErrors[i], index: originalIndex };
             if (!ordered) {
               results[originalIndex] = error.writeErrors[i];
             }
@@ -3245,10 +3237,7 @@ Model.$__insertMany = function(arr, options, callback) {
           });
 
         if (rawResult && ordered === false) {
-          error.mongoose = {
-            validationErrors: validationErrors,
-            results: results
-          };
+          decorateBulkWriteResult(error, validationErrors, results);
         }
 
         callback(error, null);
@@ -3399,7 +3388,11 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
   const ordered = options.ordered == null ? true : options.ordered;
 
   if (ops.length === 0) {
-    return getDefaultBulkwriteResult();
+    const BulkWriteResult = this.base.driver.get().BulkWriteResult;
+    const bulkWriteResult = new BulkWriteResult(getDefaultBulkwriteResult(), false);
+    bulkWriteResult.n = 0;
+    decorateBulkWriteResult(bulkWriteResult, [], []);
+    return bulkWriteResult;
   }
 
   const validations = ops.map(op => castBulkWrite(this, op, options));
@@ -3470,7 +3463,11 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
           'bulkWrite'
         );
       }
-      return getDefaultBulkwriteResult();
+      const BulkWriteResult = this.base.driver.get().BulkWriteResult;
+      const bulkWriteResult = new BulkWriteResult(getDefaultBulkwriteResult(), false);
+      bulkWriteResult.result = getDefaultBulkwriteResult();
+      decorateBulkWriteResult(bulkWriteResult, validationErrors, results);
+      return bulkWriteResult;
     }
 
     let error;
@@ -3478,10 +3475,18 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
       then(res => ([res, null])).
       catch(error => ([null, error]));
 
+    const writeErrorsByIndex = {};
+    if (error?.writeErrors) {
+      for (const writeError of error.writeErrors) {
+        writeErrorsByIndex[writeError.err.index] = writeError;
+      }
+    }
+    for (let i = 0; i < validOpIndexes.length; ++i) {
+      results[validOpIndexes[i]] = writeErrorsByIndex[i] ?? null;
+    }
     if (error) {
       if (validationErrors.length > 0) {
-        error.mongoose = error.mongoose || {};
-        error.mongoose.validationErrors = validationErrors;
+        decorateBulkWriteResult(error, validationErrors, results);
       }
 
       await new Promise((resolve, reject) => {
@@ -3495,9 +3500,6 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
       });
     }
 
-    for (let i = 0; i < validOpIndexes.length; ++i) {
-      results[validOpIndexes[i]] = null;
-    }
     if (validationErrors.length > 0) {
       if (options.throwOnValidationError) {
         throw new MongooseBulkWriteError(
@@ -3507,9 +3509,7 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
           'bulkWrite'
         );
       } else {
-        res.mongoose = res.mongoose || {};
-        res.mongoose.validationErrors = validationErrors;
-        res.mongoose.results = results;
+        decorateBulkWriteResult(res, validationErrors, results);
       }
     }
   }
@@ -3575,7 +3575,7 @@ Model.bulkSave = async function bulkSave(documents, options) {
     (err) => ({ bulkWriteResult: null, bulkWriteError: err })
   );
   // If not a MongoBulkWriteError, treat this as all documents failed to save.
-  if (bulkWriteError != null && !(bulkWriteError instanceof MongoBulkWriteError)) {
+  if (bulkWriteError != null && bulkWriteError.name !== 'MongoBulkWriteError') {
     throw bulkWriteError;
   }
 
@@ -4381,6 +4381,7 @@ Model.validate = async function validate(obj, pathsOrOptions, context) {
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
  * @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
  * @param {Boolean} [options.forceRepopulate=true] Set to `false` to prevent Mongoose from repopulating paths that are already populated
+ * @param {Boolean} [options.ordered=false] Set to `true` to execute any populate queries one at a time, as opposed to in parallel. Set this option to `true` if populating multiple paths or paths with multiple models in transactions.
  * @return {Promise}
  * @api public
  */
@@ -4398,11 +4399,21 @@ Model.populate = async function populate(docs, paths) {
   }
 
   // each path has its own query options and must be executed separately
-  const promises = [];
-  for (const path of paths) {
-    promises.push(_populatePath(this, docs, path));
+  if (paths.find(p => p.ordered)) {
+    // Populate in series, primarily for transactions because MongoDB doesn't support multiple operations on
+    // one transaction in parallel.
+    // Note that if _any_ path has `ordered`, we make the top-level populate `ordered` as well.
+    for (const path of paths) {
+      await _populatePath(this, docs, path);
+    }
+  } else {
+    // By default, populate in parallel
+    const promises = [];
+    for (const path of paths) {
+      promises.push(_populatePath(this, docs, path));
+    }
+    await Promise.all(promises);
   }
-  await Promise.all(promises);
 
   return docs;
 };
@@ -4522,12 +4533,22 @@ async function _populatePath(model, docs, populateOptions) {
     return;
   }
 
-  const promises = [];
-  for (const arr of params) {
-    promises.push(_execPopulateQuery.apply(null, arr).then(valsFromDb => { vals = vals.concat(valsFromDb); }));
+  if (populateOptions.ordered) {
+    // Populate in series, primarily for transactions because MongoDB doesn't support multiple operations on
+    // one transaction in parallel.
+    for (const arr of params) {
+      await _execPopulateQuery.apply(null, arr).then(valsFromDb => { vals = vals.concat(valsFromDb); });
+    }
+  } else {
+    // By default, populate in parallel
+    const promises = [];
+    for (const arr of params) {
+      promises.push(_execPopulateQuery.apply(null, arr).then(valsFromDb => { vals = vals.concat(valsFromDb); }));
+    }
+
+    await Promise.all(promises);
   }
 
-  await Promise.all(promises);
 
   for (const arr of params) {
     const mod = arr[0];

package/lib/types/double.js

@@ -0,0 +1,13 @@
+/**
+ * Double type constructor
+ *
+ * #### Example:
+ *
+ *     const pi = new mongoose.Types.Double(3.1415);
+ *
+ * @constructor Double
+ */
+
+'use strict';
+
+module.exports = require('bson').Double;

package/lib/types/index.js

@@ -12,6 +12,7 @@ exports.Document = // @deprecate
 exports.Embedded = require('./arraySubdocument');
 
 exports.DocumentArray = require('./documentArray');
+exports.Double = require('./double');
 exports.Decimal128 = require('./decimal128');
 exports.ObjectId = require('./objectid');
 

package/lib/utils.js

@@ -551,8 +551,8 @@ exports.populate = function populate(path, select, model, match, options, subPop
     };
   }
 
-  if (typeof obj.path !== 'string') {
-    throw new TypeError('utils.populate: invalid path. Expected string. Got typeof `' + typeof path + '`');
+  if (typeof obj.path !== 'string' && !(Array.isArray(obj.path) && obj.path.every(el => typeof el === 'string'))) {
+    throw new TypeError('utils.populate: invalid path. Expected string or array of strings. Got typeof `' + typeof path + '`');
   }
 
   return _populateObj(obj);
@@ -600,7 +600,11 @@ function _populateObj(obj) {
   }
 
   const ret = [];
-  const paths = oneSpaceRE.test(obj.path) ? obj.path.split(manySpaceRE) : [obj.path];
+  const paths = oneSpaceRE.test(obj.path)
+    ? obj.path.split(manySpaceRE)
+    : Array.isArray(obj.path)
+      ? obj.path
+      : [obj.path];
   if (obj.options != null) {
     obj.options = clone(obj.options);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.10.1",
+  "version": "8.11.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",