mongoose 6.2.9 → 6.3.0

package/lib/cursor/ChangeStream.js

@@ -16,6 +16,7 @@ class ChangeStream extends EventEmitter {
 
     this.driverChangeStream = null;
     this.closed = false;
+    this.bindedEvents = false;
     this.pipeline = pipeline;
     this.options = options;
 
@@ -27,21 +28,60 @@ class ChangeStream extends EventEmitter {
       }
 
       this.driverChangeStream = driverChangeStream;
-      this._bindEvents();
       this.emit('ready');
     });
   }
 
   _bindEvents() {
+    if (this.bindedEvents) {
+      return;
+    }
+
+    this.bindedEvents = true;
+
+    if (this.driverChangeStream == null) {
+      this.once('ready', () => {
+        this.driverChangeStream.on('close', () => {
+          this.closed = true;
+        });
+
+        ['close', 'change', 'end', 'error'].forEach(ev => {
+          this.driverChangeStream.on(ev, data => this.emit(ev, data));
+        });
+      });
+
+      return;
+    }
+
     this.driverChangeStream.on('close', () => {
       this.closed = true;
     });
 
     ['close', 'change', 'end', 'error'].forEach(ev => {
-      this.driverChangeStream.on(ev, data => this.emit(ev, data));
+      this.driverChangeStream.on(ev, data => {
+        this.emit(ev, data);
+      });
     });
   }
 
+  hasNext(cb) {
+    return this.driverChangeStream.hasNext(cb);
+  }
+
+  next(cb) {
+    return this.driverChangeStream.next(cb);
+  }
+
+  on(event, handler) {
+    this._bindEvents();
+    return super.on(event, handler);
+  }
+
+  once(event, handler) {
+    this._bindEvents();
+    return super.once(event, handler);
+  }
+
   _queue(cb) {
     this.once('ready', () => cb());
   }

package/lib/cursor/QueryCursor.js

@@ -112,7 +112,7 @@ QueryCursor.prototype._read = function() {
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
  *
- * ####Example
+ * #### Example
  *
  *     // Map documents returned by `data` events
  *     Thing.
@@ -211,7 +211,7 @@ QueryCursor.prototype.next = function(callback) {
  * will wait for the promise to resolve before iterating on to the next one.
  * Returns a promise that resolves when done.
  *
- * ####Example
+ * #### Example
  *
  *     // Iterate over documents asynchronously
  *     Thing.
@@ -225,6 +225,8 @@ QueryCursor.prototype.next = function(callback) {
  * @param {Function} fn
  * @param {Object} [options]
  * @param {Number} [options.parallel] the number of promises to execute in parallel. Defaults to 1.
+ * @param {Number} [options.batchSize] if set, will call `fn()` with arrays of documents with length at most `batchSize`
+ * @param {Boolean} [options.continueOnError=false] if true, `eachAsync()` iterates through all docs even if `fn` throws an error. If false, `eachAsync()` throws an error immediately if the given function `fn()` throws an error.
  * @param {Function} [callback] executed when all docs have been processed
  * @return {Promise}
  * @api public
@@ -298,7 +300,7 @@ QueryCursor.prototype._transformForAsyncIterator = function() {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * ####Example
+ * #### Example
  *
  *     // Works without using `cursor()`
  *     for await (const doc of Model.find([{ $sort: { name: 1 } }])) {

package/lib/document.js

@@ -94,7 +94,7 @@ function Document(obj, fields, skipId, options) {
   this.$__ = new InternalCache();
   this.$isNew = 'isNew' in options ? options.isNew : true;
 
-  if ('priorDoc' in options) {
+  if (options.priorDoc != null) {
     this.$__.priorDoc = options.priorDoc;
   }
 
@@ -119,7 +119,7 @@ function Document(obj, fields, skipId, options) {
     fields = undefined;
   } else {
     this.$__.strictMode = schema.options.strict;
-    if (fields !== undefined) {
+    if (fields != null) {
       this.$__.selected = fields;
     }
   }
@@ -177,8 +177,6 @@ function Document(obj, fields, skipId, options) {
     $__applyDefaults(this, fields, exclude, hasIncludedChildren, false, options.skipDefaults);
   }
 
-  this.$__._id = this._id;
-
   if (!this.$__.strictMode && obj) {
     const _this = this;
     const keys = Object.keys(this._doc);
@@ -268,7 +266,7 @@ Document.prototype.schema;
  * is handy for passing data to middleware without conflicting with Mongoose
  * internals.
  *
- * ####Example:
+ * #### Example:
  *
  *     schema.pre('save', function() {
  *       // Mongoose will set `isNew` to `false` if `save()` succeeds
@@ -326,7 +324,7 @@ Document.prototype.isNew;
 /**
  * Set this property to add additional query filters when Mongoose saves this document and `isNew` is false.
  *
- * ####Example:
+ * #### Example:
  *
  *     // Make sure `save()` never updates a soft deleted document.
  *     schema.pre('save', function() {
@@ -348,7 +346,7 @@ Object.defineProperty(Document.prototype, '$where', {
 /**
  * The string version of this documents _id.
  *
- * ####Note:
+ * #### Note:
  *
  * This getter exists on all documents by default. The getter can be disabled by setting the `id` [option](/docs/guide.html#id) of its `Schema` to false at construction time.
  *
@@ -389,7 +387,7 @@ Document.prototype.errors;
  * A string containing the current operation that Mongoose is executing
  * on this document. May be `null`, `'save'`, `'validate'`, or `'remove'`.
  *
- * ####Example:
+ * #### Example:
  *
  *     const doc = new Model({ name: 'test' });
  *     doc.$op; // null
@@ -743,8 +741,6 @@ Document.prototype.$__init = function(doc, opts) {
   this.$emit('init', this);
   this.constructor.emit('init', this);
 
-  this.$__._id = this._id;
-
   const hasIncludedChildren = this.$__.exclude === false && this.$__.fields ?
     $__hasIncludedChildren(this.$__.fields) :
     null;
@@ -841,11 +837,11 @@ function init(self, obj, doc, opts, prefix) {
 /**
  * Sends an update command with this document `_id` as the query selector.
  *
- * ####Example:
+ * #### Example:
  *
  *     weirdCar.update({$inc: {wheels:1}}, { w: 1 }, callback);
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.update](#model_Model.update)
  *
@@ -876,11 +872,11 @@ Document.prototype.update = function update() {
 /**
  * Sends an updateOne command with this document `_id` as the query selector.
  *
- * ####Example:
+ * #### Example:
  *
  *     weirdCar.updateOne({$inc: {wheels:1}}, { w: 1 }, callback);
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.updateOne](#model_Model.updateOne)
  *
@@ -922,7 +918,7 @@ Document.prototype.updateOne = function updateOne(doc, options, callback) {
 /**
  * Sends a replaceOne command with this document `_id` as the query selector.
  *
- * ####Valid options:
+ * #### Valid options:
  *
  *  - same as in [Model.replaceOne](https://mongoosejs.com/docs/api/model.html#model_Model.replaceOne)
  *
@@ -947,7 +943,7 @@ Document.prototype.replaceOne = function replaceOne() {
  * automatically set `session` if you `save()` a doc that you got from a
  * query with an associated session.
  *
- * ####Example:
+ * #### Example:
  *
  *     const session = MyModel.startSession();
  *     const doc = await MyModel.findOne().session(session);
@@ -1514,7 +1510,7 @@ function _isManuallyPopulatedArray(val, ref) {
 /**
  * Sets the value of a path, or many paths.
  *
- * ####Example:
+ * #### Example:
  *
  *     // path, value
  *     doc.set(path, value)
@@ -1718,7 +1714,7 @@ Document.prototype.$__setValue = function(path, val) {
 /**
  * Returns the value of a path.
  *
- * ####Example
+ * #### Example
  *
  *     // path
  *     doc.get('age') // 47
@@ -1824,7 +1820,7 @@ Document.prototype.$__path = function(path) {
  *
  * _Very helpful when using [Mixed](https://mongoosejs.com/docs/schematypes.html#mixed) types._
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.mixed.type = 'changed';
  *     doc.markModified('mixed.type');
@@ -1847,7 +1843,7 @@ Document.prototype.markModified = function(path, scope) {
 /**
  * Clears the modified state on the specified path.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.foo = 'bar';
  *     doc.unmarkModified('foo');
@@ -1867,7 +1863,7 @@ Document.prototype.unmarkModified = function(path) {
 /**
  * Don't run validation on this path or persist changes to this path.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.foo = null;
  *     doc.$ignore('foo');
@@ -1892,7 +1888,7 @@ Document.prototype.$ignore = function(path) {
  * A path `a` may be in `modifiedPaths()` but not in `directModifiedPaths()`
  * because a child of `a` was directly modified.
  *
- * ####Example
+ * #### Example
  *     const schema = new Schema({ foo: String, nested: { bar: String } });
  *     const Model = mongoose.model('Test', schema);
  *     await Model.create({ foo: 'original', nested: { bar: 'original' } });
@@ -1915,7 +1911,7 @@ Document.prototype.directModifiedPaths = function() {
  * Useful for determining whether this subdoc will get stripped out by the
  * [minimize option](/docs/guide.html#minimize).
  *
- * ####Example:
+ * #### Example:
  *     const schema = new Schema({ nested: { foo: String } });
  *     const Model = mongoose.model('Test', schema);
  *     const doc = new Model({});
@@ -2048,7 +2044,7 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
  *
  * If `path` is given, checks if a path or any full path containing `path` as part of its path chain has been modified.
  *
- * ####Example
+ * #### Example
  *
  *     doc.set('documents.0.title', 'changed');
  *     doc.isModified()                      // true
@@ -2094,7 +2090,7 @@ Document.prototype[documentIsModified] = Document.prototype.isModified;
 /**
  * Checks if a path is set to its default.
  *
- * ####Example
+ * #### Example
  *
  *     MyModel = mongoose.model('test', { name: { type: String, default: 'Val '} });
  *     const m = new MyModel();
@@ -2128,7 +2124,7 @@ Document.prototype.$isDefault = function(path) {
 /**
  * Getter/setter, determines whether the document was removed or not.
  *
- * ####Example:
+ * #### Example:
  *     const product = await product.remove();
  *     product.$isDeleted(); // true
  *     product.remove(); // no-op, doesn't send anything to the db
@@ -2158,7 +2154,7 @@ Document.prototype.$isDeleted = function(val) {
 /**
  * Returns true if `path` was directly set and modified, else false.
  *
- * ####Example
+ * #### Example
  *
  *     doc.set('documents.0.title', 'changed');
  *     doc.isDirectModified('documents.0.title') // true
@@ -2214,7 +2210,7 @@ Document.prototype.isInit = function(path) {
 /**
  * Checks if `path` was selected in the source query which initialized this document.
  *
- * ####Example
+ * #### Example
  *
  *     const doc = await Thing.findOne().select('name');
  *     doc.isSelected('name') // true
@@ -2295,7 +2291,7 @@ Document.prototype.$__isSelected = Document.prototype.isSelected;
  * Checks if `path` was explicitly selected. If no projection, always returns
  * true.
  *
- * ####Example
+ * #### Example
  *
  *     Thing.findOne().select('nested.name').exec(function (err, doc) {
  *        doc.isDirectSelected('nested.name') // true
@@ -2357,11 +2353,11 @@ Document.prototype.isDirectSelected = function isDirectSelected(path) {
 /**
  * Executes registered validation rules for this document.
  *
- * ####Note:
+ * #### Note:
  *
  * This method is called `pre` save and if a validation rule is violated, [save](#model_Model-save) is aborted and the error is returned to your `callback`.
  *
- * ####Example:
+ * #### Example:
  *
  *     doc.validate(function (err) {
  *       if (err) handleError(err);
@@ -2485,10 +2481,7 @@ function _getPathsToValidate(doc) {
     if (subdoc.$basePath) {
       // Remove child paths for now, because we'll be validating the whole
       // subdoc
-      if (!subdoc.$__.fullPath) {
-        subdoc.ownerDocument();
-      }
-      const fullPathToSubdoc = subdoc.$__.fullPath;
+      const fullPathToSubdoc = subdoc.$__fullPathWithIndexes();
 
       for (const p of paths) {
         if (p === null || p.startsWith(fullPathToSubdoc + '.')) {
@@ -2826,11 +2819,11 @@ function _handlePathsToSkip(paths, pathsToSkip) {
 /**
  * Executes registered validation rules (skipping asynchronous validators) for this document.
  *
- * ####Note:
+ * #### Note:
  *
  * This method is useful if you need synchronous validation.
  *
- * ####Example:
+ * #### Example:
  *
  *     const err = doc.validateSync();
  *     if (err) {
@@ -3065,7 +3058,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * Saves this document by inserting a new document into the database if [document.isNew](/docs/api.html#document_Document-isNew) is `true`,
  * or sends an [updateOne](/docs/api.html#document_Document-updateOne) operation **only** with the modifications to the database, it does not replace the whole document in the latter case.
  *
- * ####Example:
+ * #### Example:
  *
  *     product.sold = Date.now();
  *     product = await product.save();
@@ -3073,7 +3066,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * If save is successful, the returned promise will fulfill with the document
  * saved.
  *
- * ####Example:
+ * #### Example:
  *
  *     const newProduct = await product.save();
  *     newProduct === product; // true
@@ -3601,7 +3594,7 @@ Document.prototype.$toObject = function(options, json) {
  *
  * Buffers are converted to instances of [mongodb.Binary](https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html) for proper storage.
  *
- * ####Options:
+ * #### Options:
  *
  * - `getters` apply all getters (path and virtual getters), defaults to false
  * - `aliases` apply all aliases if `virtuals=true`, defaults to true
@@ -3613,7 +3606,7 @@ Document.prototype.$toObject = function(options, json) {
  * - `flattenMaps` convert Maps to POJOs. Useful if you want to JSON.stringify() the result of toObject(), defaults to false
  * - `useProjection` set to `true` to omit 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.
  *
- * ####Getters/Virtuals
+ * #### Getters/Virtuals
  *
  * Example of only applying path getters
  *
@@ -3631,7 +3624,7 @@ Document.prototype.$toObject = function(options, json) {
  *
  *     schema.set('toObject', { virtuals: true })
  *
- * ####Transform
+ * #### Transform
  *
  * We may need to perform a transformation of the resulting object based on some criteria, say to remove some sensitive information or return a custom object. In this case we set the optional `transform` function.
  *
@@ -3643,7 +3636,7 @@ Document.prototype.$toObject = function(options, json) {
  * - `ret` The plain object representation which has been converted
  * - `options` The options in use (either schema options or the options passed inline)
  *
- * ####Example
+ * #### Example
  *
  *     // specify the transform schema option
  *     if (!schema.options.toObject) schema.options.toObject = {};
@@ -4137,7 +4130,7 @@ Document.prototype.equals = function(doc) {
 /**
  * Populates paths on an existing document.
  *
- * ####Example:
+ * #### Example:
  *
  *     await doc.populate([
  *       'stories',
@@ -4254,7 +4247,7 @@ Document.prototype.$getPopulatedDocs = function $getPopulatedDocs() {
 /**
  * Gets _id(s) used during population of the given `path`.
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.findOne().populate('author').exec(function (err, doc) {
  *       console.log(doc.author.name)         // Dr.Seuss
@@ -4316,7 +4309,7 @@ Document.prototype.$populated = Document.prototype.populated;
 /**
  * Takes a populated field and returns it to its unpopulated state.
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.findOne().populate('author').exec(function (err, doc) {
  *       console.log(doc.author.name); // Dr.Seuss

package/lib/error/eachAsyncMultiError.js

@@ -0,0 +1,41 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./');
+
+
+/**
+ * If `eachAsync()` is called with `continueOnError: true`, there can be
+ * multiple errors. This error class contains an `errors` property, which
+ * contains an array of all errors that occurred in `eachAsync()`.
+ *
+ * @api private
+ */
+
+class EachAsyncMultiError extends MongooseError {
+  /**
+   * @param {String} connectionString
+   */
+  constructor(errors) {
+    let preview = errors.map(e => e.message).join(', ');
+    if (preview.length > 50) {
+      preview = preview.slice(0, 50) + '...';
+    }
+    super(`eachAsync() finished with ${errors.length} errors: ${preview}`);
+
+    this.errors = errors;
+  }
+}
+
+Object.defineProperty(EachAsyncMultiError.prototype, 'name', {
+  value: 'EachAsyncMultiError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = EachAsyncMultiError;

package/lib/error/index.js

@@ -4,7 +4,7 @@
  * MongooseError constructor. MongooseError is the base class for all
  * Mongoose-specific errors.
  *
- * ####Example:
+ * #### Example:
  *     const Model = mongoose.model('Test', new Schema({ answer: Number }));
  *     const doc = new Model({ answer: 'not a number' });
  *     const err = doc.validateSync();
@@ -105,7 +105,7 @@ MongooseError.ValidationError = require('./validation');
  * A `ValidationError` has a hash of `errors` that contain individual
  * `ValidatorError` instances.
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = Schema({ name: { type: String, required: true } });
  *     const Model = mongoose.model('Test', schema);

package/lib/helpers/cursor/eachAsync.js

@@ -4,6 +4,7 @@
  * Module dependencies.
  */
 
+const EachAsyncMultiError = require('../../error/eachAsyncMultiError');
 const immediate = require('../immediate');
 const promiseOrCallback = require('../promiseOrCallback');
 
@@ -24,10 +25,11 @@ const promiseOrCallback = require('../promiseOrCallback');
 module.exports = function eachAsync(next, fn, options, callback) {
   const parallel = options.parallel || 1;
   const batchSize = options.batchSize;
+  const continueOnError = options.continueOnError;
+  const aggregatedErrors = [];
   const enqueue = asyncQueue();
 
   return promiseOrCallback(callback, cb => {
-
     if (batchSize != null) {
       if (typeof batchSize !== 'number') {
         throw new TypeError('batchSize must be a number');
@@ -62,14 +64,22 @@ module.exports = function eachAsync(next, fn, options, callback) {
           return done();
         }
         if (err != null) {
-          error = err;
-          finalCallback(err);
-          return done();
+          if (continueOnError) {
+            aggregatedErrors.push(err);
+          } else {
+            error = err;
+            finalCallback(err);
+            return done();
+          }
         }
         if (doc == null) {
           drained = true;
           if (handleResultsInProgress <= 0) {
-            finalCallback(null);
+            const finalErr = continueOnError ?
+              createEachAsyncMultiError(aggregatedErrors) :
+              error;
+
+            finalCallback(finalErr);
           } else if (batchSize && documentsBatch.length) {
             handleNextResult(documentsBatch, currentDocumentIndex++, handleNextResultCallBack);
           }
@@ -102,11 +112,18 @@ module.exports = function eachAsync(next, fn, options, callback) {
             --handleResultsInProgress;
           }
           if (err != null) {
-            error = err;
-            return finalCallback(err);
+            if (continueOnError) {
+              aggregatedErrors.push(err);
+            } else {
+              error = err;
+              return finalCallback(err);
+            }
           }
           if (drained && handleResultsInProgress <= 0) {
-            return finalCallback(null);
+            const finalErr = continueOnError ?
+              createEachAsyncMultiError(aggregatedErrors) :
+              error;
+            return finalCallback(finalErr);
           }
 
           immediate(() => enqueue(fetch));
@@ -118,11 +135,18 @@ module.exports = function eachAsync(next, fn, options, callback) {
   }
 
   function handleNextResult(doc, i, callback) {
-    const promise = fn(doc, i);
-    if (promise && typeof promise.then === 'function') {
-      promise.then(
+    let maybePromise;
+    try {
+      maybePromise = fn(doc, i);
+    } catch (err) {
+      return callback(err);
+    }
+    if (maybePromise && typeof maybePromise.then === 'function') {
+      maybePromise.then(
         function() { callback(null); },
-        function(error) { callback(error || new Error('`eachAsync()` promise rejected without error')); });
+        function(error) {
+          callback(error || new Error('`eachAsync()` promise rejected without error'));
+        });
     } else {
       callback(null);
     }
@@ -158,3 +182,11 @@ function asyncQueue() {
     }
   }
 }
+
+function createEachAsyncMultiError(aggregatedErrors) {
+  if (aggregatedErrors.length === 0) {
+    return null;
+  }
+
+  return new EachAsyncMultiError(aggregatedErrors);
+}

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 (schemaOptions.hasOwnProperty('collation') && !indexOptions.hasOwnProperty('collation')) {
+    indexOptions.collation = schemaOptions.collation;
+  }
+};

package/lib/helpers/indexes/isTextIndex.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * Returns `true` if the given index options have a `text` option.
+ */
+
+module.exports = function isTextIndex(indexKeys) {
+  let isTextIndex = false;
+  for (const key of Object.keys(indexKeys)) {
+    if (indexKeys[key] === 'text') {
+      isTextIndex = true;
+    }
+  }
+
+  return isTextIndex;
+};

package/lib/helpers/model/discriminator.js

@@ -17,7 +17,6 @@ const CUSTOMIZABLE_DISCRIMINATOR_OPTIONS = {
  */
 
 module.exports = function discriminator(model, name, schema, tiedValue, applyPlugins) {
-
   if (!(schema && schema.instanceOfSchema)) {
     throw new Error('You must pass a valid discriminator Schema');
   }
@@ -109,7 +108,7 @@ module.exports = function discriminator(model, name, schema, tiedValue, applyPlu
 
     utils.merge(schema, baseSchema, {
       isDiscriminatorSchemaMerge: true,
-      omit: { discriminators: true, base: true },
+      omit: { discriminators: true, base: true, _applyDiscriminators: true },
       omitNested: conflictingPaths.reduce((cur, path) => {
         cur['tree.' + path] = true;
         return cur;
@@ -141,7 +140,6 @@ module.exports = function discriminator(model, name, schema, tiedValue, applyPlu
     obj[key][schema.options.typeKey] = existingPath ? existingPath.options[schema.options.typeKey] : String;
     schema.add(obj);
 
-
     schema.discriminatorMapping = { key: key, value: value, isRoot: false };
 
     if (baseSchema.options.collection) {

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -6,7 +6,7 @@ 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:
+ * #### Example:
  *     const doc = await Article.findOne().populate('comments.author');
  *     doc.comments[0].populated('author'); // Should be set
  */

package/lib/helpers/projection/hasIncludedChildren.js

@@ -4,7 +4,7 @@
  * Creates an object that precomputes whether a given path has child fields in
  * the projection.
  *
- * ####Example:
+ * #### Example:
  *     const res = hasIncludedChildren({ 'a.b.c': 0 });
  *     res.a; // 1
  *     res['a.b']; // 1