mongoose 6.3.9 → 6.4.2

package/lib/helpers/query/wrapThunk.js

@@ -26,4 +26,4 @@ module.exports = function wrapThunk(fn) {
 
     fn.call(this, cb);
   };
-};
+};

package/lib/helpers/schema/addAutoId.js

@@ -4,4 +4,4 @@ module.exports = function addAutoId(schema) {
   const _obj = { _id: { auto: true } };
   _obj._id[schema.options.typeKey] = 'ObjectId';
   schema.add(_obj);
-};
+};

package/lib/helpers/schema/applyPlugins.js

@@ -52,4 +52,4 @@ module.exports = function applyPlugins(schema, plugins, options, cacheKey) {
     applyPlugins(discriminatorSchema, plugins,
       { skipTopLevel: !applyPluginsToDiscriminators }, cacheKey);
   }
-};
+};

package/lib/helpers/schema/cleanPositionalOperators.js

@@ -9,4 +9,4 @@ module.exports = function cleanPositionalOperators(path) {
   return path.
     replace(/\.\$(\[[^\]]*\])?(?=\.)/g, '.0').
     replace(/\.\$(\[[^\]]*\])?$/g, '.0');
-};
+};

package/lib/helpers/schema/getKeysInSchemaOrder.js

@@ -25,4 +25,4 @@ module.exports = function getKeysInSchemaOrder(schema, val, path) {
   }
 
   return keys;
-};
+};

package/lib/helpers/schema/getPath.js

@@ -34,4 +34,4 @@ module.exports = function getPath(schema, path) {
   }
 
   return schematype;
-};
+};

package/lib/helpers/schema/handleIdOption.js

@@ -17,4 +17,4 @@ module.exports = function handleIdOption(schema, options) {
   }
 
   return schema;
-};
+};

package/lib/helpers/schema/handleTimestampOption.js

@@ -21,4 +21,4 @@ function handleTimestampOption(arg, prop) {
     return prop;
   }
   return arg[prop];
-}
+}

package/lib/helpers/specialProperties.js

@@ -1,3 +1,3 @@
 'use strict';
 
-module.exports = new Set(['__proto__', 'constructor', 'prototype']);
+module.exports = new Set(['__proto__', 'constructor', 'prototype']);

package/lib/helpers/symbols.js

@@ -17,4 +17,4 @@ exports.populateModelSymbol = Symbol('mongoose.PopulateOptions#Model');
 exports.schemaTypeSymbol = Symbol('mongoose#schemaType');
 exports.sessionNewDocuments = Symbol('mongoose:ClientSession#newDocuments');
 exports.scopeSymbol = Symbol('mongoose#Document#scope');
-exports.validatorErrorSymbol = Symbol('mongoose:validatorError');
+exports.validatorErrorSymbol = Symbol('mongoose:validatorError');

package/lib/helpers/timers.js

@@ -1,3 +1,3 @@
 'use strict';
 
-exports.setTimeout = setTimeout;
+exports.setTimeout = setTimeout;

package/lib/helpers/timestamps/setupTimestamps.js

@@ -31,8 +31,11 @@ module.exports = function setupTimestamps(schema, timestamps) {
   }
 
   if (createdAt && !schema.paths[createdAt]) {
-    schemaAdditions[createdAt] = { [schema.options.typeKey || 'type']: Date, immutable: true };
+    const baseImmutableCreatedAt = schema.base.get('timestamps.createdAt.immutable');
+    const immutable = baseImmutableCreatedAt != null ? baseImmutableCreatedAt : true;
+    schemaAdditions[createdAt] = { [schema.options.typeKey || 'type']: Date, immutable };
   }
+
   schema.add(schemaAdditions);
 
   schema.pre('save', function(next) {
@@ -99,4 +102,4 @@ module.exports = function setupTimestamps(schema, timestamps) {
     applyTimestampsToChildren(now, this.getUpdate(), this.model.schema);
     next();
   }
-};
+};

package/lib/helpers/topology/allServersUnknown.js

@@ -9,4 +9,4 @@ module.exports = function allServersUnknown(topologyDescription) {
 
   const servers = Array.from(topologyDescription.servers.values());
   return servers.length > 0 && servers.every(server => server.type === 'Unknown');
-};
+};

package/lib/helpers/topology/isAtlas.js

@@ -23,4 +23,4 @@ module.exports = function isAtlas(topologyDescription) {
     }
   }
   return true;
-};
+};

package/lib/helpers/topology/isSSLError.js

@@ -13,4 +13,4 @@ module.exports = function isSSLError(topologyDescription) {
   const descriptions = Array.from(topologyDescription.servers.values());
   return descriptions.length > 0 &&
     descriptions.every(descr => descr.error && descr.error.message.indexOf(nonSSLMessage) !== -1);
-};
+};

package/lib/helpers/update/applyTimestampsToChildren.js

@@ -186,4 +186,4 @@ function applyTimestampsToUpdateKey(schema, key, update, now) {
       update[key][createdAt] = now;
     }
   }
-}
+}

package/lib/helpers/update/castArrayFilters.js

@@ -80,4 +80,4 @@ function _castArrayFilters(arrayFilters, schema, strictQuery, updatedPathsByFilt
       }
     }
   }
-}
+}

package/lib/helpers/update/moveImmutableProperties.js

@@ -50,4 +50,4 @@ function _walkUpdatePath(schema, op, path, update, ctx) {
   update.$setOnInsert = update.$setOnInsert || {};
   update.$setOnInsert[path] = op[path];
   delete op[path];
-}
+}

package/lib/helpers/update/removeUnusedArrayFilters.js

@@ -29,4 +29,4 @@ function _checkSingleFilterKey(arrayFilter, updateKeys) {
   const arrayFilterKey = firstDot === -1 ? firstKey : firstKey.slice(0, firstDot);
 
   return updateKeys.find(key => key.includes('$[' + arrayFilterKey + ']')) != null;
-}
+}

package/lib/helpers/update/updatedPathsByArrayFilter.js

@@ -24,4 +24,4 @@ module.exports = function updatedPathsByArrayFilter(update) {
     }
     return cur;
   }, {});
-};
+};

package/lib/helpers/updateValidators.js

@@ -125,26 +125,19 @@ module.exports = function(query, schema, castedDoc, options, callback) {
         validatorsToExecute.push(function(callback) {
           schemaPath.doValidate(v, function(err) {
             if (err) {
-              err.path = updates[i];
-              validationErrors.push(err);
-              return callback(null);
-            }
-
-            v.validate(function(err) {
-              if (err) {
-                if (err.errors) {
-                  for (const key of Object.keys(err.errors)) {
-                    const _err = err.errors[key];
-                    _err.path = updates[i] + '.' + key;
-                    validationErrors.push(_err);
-                  }
-                } else {
-                  err.path = updates[i];
-                  validationErrors.push(err);
+              if (err.errors) {
+                for (const key of Object.keys(err.errors)) {
+                  const _err = err.errors[key];
+                  _err.path = updates[i] + '.' + key;
+                  validationErrors.push(_err);
                 }
+              } else {
+                err.path = updates[i];
+                validationErrors.push(err);
               }
-              callback(null);
-            });
+            }
+
+            return callback(null);
           }, context, { updateValidator: true });
         });
       } else {

package/lib/index.js

@@ -8,6 +8,7 @@ require('./driver').set(require('./drivers/node-mongodb-native'));
 
 const Document = require('./document');
 const EventEmitter = require('events').EventEmitter;
+const Kareem = require('kareem');
 const Schema = require('./schema');
 const SchemaType = require('./schematype');
 const SchemaTypes = require('./schema/index');
@@ -35,6 +36,7 @@ const shardingPlugin = require('./plugins/sharding');
 const trusted = require('./helpers/query/trusted').trusted;
 const sanitizeFilter = require('./helpers/query/sanitizeFilter');
 const isBsonType = require('./helpers/isBsonType');
+const MongooseError = require('./error/mongooseError');
 
 const defaultMongooseSymbol = Symbol.for('mongoose:default');
 
@@ -62,6 +64,7 @@ function Mongoose(options) {
   this.connections = [];
   this.models = {};
   this.events = new EventEmitter();
+  this.__driver = driver.get();
   // default global options
   this.options = Object.assign({
     pluralization: true,
@@ -135,6 +138,7 @@ Mongoose.prototype.ConnectionStates = STATES;
  * uses to communicate with the database. A driver is a Mongoose-specific interface that defines functions
  * like `find()`.
  *
+ * @deprecated
  * @memberOf Mongoose
  * @property driver
  * @api public
@@ -142,6 +146,36 @@ Mongoose.prototype.ConnectionStates = STATES;
 
 Mongoose.prototype.driver = driver;
 
+/**
+ * Overwrites the current driver used by this Mongoose instance. A driver is a
+ * Mongoose-specific interface that defines functions like `find()`.
+ *
+ * @memberOf Mongoose
+ * @method setDriver
+ * @api public
+ */
+
+Mongoose.prototype.setDriver = function setDriver(driver) {
+  const _mongoose = this instanceof Mongoose ? this : mongoose;
+
+  if (_mongoose.__driver === driver) {
+    return _mongoose;
+  }
+
+  const openConnection = _mongoose.connections && _mongoose.connections.find(conn => conn.readyState !== STATES.disconnected);
+  if (openConnection) {
+    const msg = 'Cannot modify Mongoose driver if a connection is already open. ' +
+      'Call `mongoose.disconnect()` before modifying the driver';
+    throw new MongooseError(msg);
+  }
+  _mongoose.__driver = driver;
+
+  const Connection = driver.getConnection();
+  _mongoose.connections = [new Connection(_mongoose)];
+
+  return _mongoose;
+};
+
 /**
  * Sets mongoose options
  *
@@ -154,23 +188,26 @@ Mongoose.prototype.driver = driver;
  *     mongoose.set('debug', function(collectionName, methodName, ...methodArgs) {}); // use custom function to log collection methods + arguments
  *
  * Currently supported options are:
+ * - 'applyPluginsToChildSchemas': `true` by default. Set to false to skip applying global plugins to child schemas
+ * - 'applyPluginsToDiscriminators': `false` by default. Set to true to apply global plugins to discriminator schemas. This typically isn't necessary because plugins are applied to the base schema and discriminators copy all middleware, methods, statics, and properties from the base schema.
+ * - 'autoCreate': Set to `true` to make Mongoose call [`Model.createCollection()`](/docs/api/model.html#model_Model.createCollection) automatically when you create a model with `mongoose.model()` or `conn.model()`. This is useful for testing transactions, change streams, and other features that require the collection to exist.
+ * - 'autoIndex': `true` by default. Set to false to disable automatic index creation for all models associated with this Mongoose instance.
  * - 'debug': If `true`, prints the operations mongoose sends to MongoDB to the console. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arguments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
  * - 'returnOriginal': If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`, `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to setting the `new` option to `true` for `findOneAndX()` calls by default. Read our [`findOneAndUpdate()` tutorial](/docs/tutorials/findoneandupdate.html) for more information.
  * - 'bufferCommands': enable/disable mongoose's buffering mechanism for all connections and models
- * - 'cloneSchemas': false by default. Set to `true` to `clone()` all schemas before compiling into a model.
- * - 'applyPluginsToDiscriminators': false by default. Set to true to apply global plugins to discriminator schemas. This typically isn't necessary because plugins are applied to the base schema and discriminators copy all middleware, methods, statics, and properties from the base schema.
- * - 'applyPluginsToChildSchemas': true by default. Set to false to skip applying global plugins to child schemas
- * - 'objectIdGetter': true by default. Mongoose adds a getter to MongoDB ObjectId's called `_id` that returns `this` for convenience with populate. Set this to false to remove the getter.
- * - 'runValidators': false by default. Set to true to enable [update validators](/docs/validation.html#update-validators) for all validators by default.
- * - 'toObject': `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toObject()`](/docs/api.html#document_Document-toObject)
- * - 'toJSON': `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toJSON()`](/docs/api.html#document_Document-toJSON), for determining how Mongoose documents get serialized by `JSON.stringify()`
- * - 'strict': true by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
- * - 'strictQuery': same value as 'strict' by default (`true`), may be `false`, `true`, or `'throw'`. Sets the default [strictQuery](/docs/guide.html#strictQuery) mode for schemas.
- * - 'selectPopulatedPaths': true by default. Set to false to opt out of Mongoose adding all fields that you `populate()` to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
+ * - 'cloneSchemas': `false` by default. Set to `true` to `clone()` all schemas before compiling into a model.
+ * - 'debug': If `true`, prints the operations mongoose sends to MongoDB to the console. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arugments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
+ * - 'timestamps.createdAt.immutable': `true` by default. If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-immutable) which means you can update the `createdAt`
  * - 'maxTimeMS': If set, attaches [maxTimeMS](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/) to every query
- * - 'autoIndex': true by default. Set to false to disable automatic index creation for all models associated with this Mongoose instance.
- * - 'autoCreate': Set to `true` to make Mongoose call [`Model.createCollection()`](/docs/api/model.html#model_Model.createCollection) automatically when you create a model with `mongoose.model()` or `conn.model()`. This is useful for testing transactions, change streams, and other features that require the collection to exist.
+ * - 'objectIdGetter': `true` by default. Mongoose adds a getter to MongoDB ObjectId's called `_id` that returns `this` for convenience with populate. Set this to false to remove the getter.
  * - 'overwriteModels': Set to `true` to default to overwriting models with the same name when calling `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
+ * - 'returnOriginal': If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`, `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to setting the `new` option to `true` for `findOneAndX()` calls by default. Read our [`findOneAndUpdate()` tutorial](/docs/tutorials/findoneandupdate.html) for more information.
+ * - 'runValidators': `false` by default. Set to true to enable [update validators](/docs/validation.html#update-validators) for all validators by default.
+ * - 'selectPopulatedPaths': `true` by default. Set to false to opt out of Mongoose adding all fields that you `populate()` to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
+ * - 'strict': `true` by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
+ * - 'strictQuery': same value as 'strict' by default (`true`), may be `false`, `true`, or `'throw'`. Sets the default [strictQuery](/docs/guide.html#strictQuery) mode for schemas.
+ * - 'toJSON': `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toJSON()`](/docs/api.html#document_Document-toJSON), for determining how Mongoose documents get serialized by `JSON.stringify()`
+ * - 'toObject': `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toObject()`](/docs/api.html#document_Document-toObject)
  *
  * @param {String} key
  * @param {String|Function|Boolean} value
@@ -273,7 +310,7 @@ Mongoose.prototype.get = Mongoose.prototype.set;
 Mongoose.prototype.createConnection = function(uri, options, callback) {
   const _mongoose = this instanceof Mongoose ? this : mongoose;
 
-  const Connection = driver.get().getConnection();
+  const Connection = _mongoose.__driver.getConnection();
   const conn = new Connection(_mongoose);
   if (typeof options === 'function') {
     callback = options;
@@ -467,7 +504,6 @@ Mongoose.prototype.pluralize = function(fn) {
  */
 
 Mongoose.prototype.model = function(name, schema, collection, options) {
-
   const _mongoose = this instanceof Mongoose ? this : mongoose;
 
   if (typeof schema === 'string') {
@@ -684,7 +720,7 @@ Mongoose.prototype.__defineGetter__('connection', function() {
 });
 
 Mongoose.prototype.__defineSetter__('connection', function(v) {
-  if (v instanceof Connection) {
+  if (v instanceof this.__driver.getConnection()) {
     this.connections[0] = v;
     this.models = v.models;
   }
@@ -713,18 +749,6 @@ Mongoose.prototype.__defineSetter__('connection', function(v) {
 
 Mongoose.prototype.connections;
 
-/*!
- * Connection
- */
-
-const Connection = driver.get().getConnection();
-
-/*!
- * Collection
- */
-
-const Collection = driver.get().Collection;
-
 /**
  * The Mongoose Aggregate constructor
  *
@@ -741,7 +765,14 @@ Mongoose.prototype.Aggregate = Aggregate;
  * @api public
  */
 
-Mongoose.prototype.Collection = Collection;
+Object.defineProperty(Mongoose.prototype, 'Collection', {
+  get: function() {
+    return this.__driver.Collection;
+  },
+  set: function(Collection) {
+    this.__driver.Collection = Collection;
+  }
+});
 
 /**
  * The Mongoose [Connection](#connection_Connection) constructor
@@ -752,7 +783,18 @@ Mongoose.prototype.Collection = Collection;
  * @api public
  */
 
-Mongoose.prototype.Connection = Connection;
+Object.defineProperty(Mongoose.prototype, 'Connection', {
+  get: function() {
+    return this.__driver.getConnection();
+  },
+  set: function(Connection) {
+    if (Connection === this.__driver.getConnection()) {
+      return;
+    }
+
+    this.__driver.getConnection = () => Connection;
+  }
+});
 
 /**
  * The Mongoose version
@@ -1178,6 +1220,43 @@ Mongoose.prototype._promiseOrCallback = function(callback, fn, ee) {
   return promiseOrCallback(callback, fn, ee, this.Promise);
 };
 
+/**
+ * Use this function in `pre()` middleware to skip calling the wrapped function.
+ *
+ * #### Example:
+ *
+ *     schema.pre('save', function() {
+ *       // Will skip executing `save()`, but will execute post hooks as if
+ *       // `save()` had executed with the result `{ matchedCount: 0 }`
+ *       return mongoose.skipMiddlewareFunction({ matchedCount: 0 });
+ *     });
+ *
+ * @method skipMiddlewareFunction
+ * @param {any} result
+ * @api public
+ */
+
+Mongoose.prototype.skipMiddlewareFunction = Kareem.skipWrappedFunction;
+
+/**
+ * Use this function in `post()` middleware to replace the result
+ *
+ * #### Example:
+ *
+ *     schema.post('find', function(res) {
+ *       // Normally you have to modify `res` in place. But with
+ *       // `overwriteMiddlewarResult()`, you can make `find()` return a
+ *       // completely different value.
+ *       return mongoose.overwriteMiddlewareResult(res.filter(doc => !doc.isDeleted));
+ *     });
+ *
+ * @method overwriteMiddlewareResult
+ * @param {any} result
+ * @api public
+ */
+
+Mongoose.prototype.overwriteMiddlewareResult = Kareem.overwriteResult;
+
 /*!
  * The exports object is an instance of Mongoose.
  *

package/lib/model.js

@@ -4281,7 +4281,7 @@ Model.validate = function validate(obj, pathsToValidate, context, callback) {
 
     for (const path of paths) {
       const schemaType = schema.path(path);
-      if (!schemaType || !schemaType.$isMongooseArray) {
+      if (!schemaType || !schemaType.$isMongooseArray || schemaType.$isMongooseDocumentArray) {
         continue;
       }
 

package/lib/options/PopulateOptions.js

@@ -33,4 +33,4 @@ class PopulateOptions {
  * @api public
  */
 
-module.exports = PopulateOptions;
+module.exports = PopulateOptions;

package/lib/options/SchemaArrayOptions.js

@@ -56,4 +56,4 @@ Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
  * ignore
  */
 
-module.exports = SchemaArrayOptions;
+module.exports = SchemaArrayOptions;

package/lib/options/SchemaBufferOptions.js

@@ -35,4 +35,4 @@ Object.defineProperty(SchemaBufferOptions.prototype, 'subtype', opts);
  * ignore
  */
 
-module.exports = SchemaBufferOptions;
+module.exports = SchemaBufferOptions;

package/lib/options/SchemaDocumentArrayOptions.js

@@ -65,4 +65,4 @@ Object.defineProperty(SchemaDocumentArrayOptions.prototype, '_id', opts);
  * ignore
  */
 
-module.exports = SchemaDocumentArrayOptions;
+module.exports = SchemaDocumentArrayOptions;

package/lib/options/SchemaMapOptions.js

@@ -40,4 +40,4 @@ const opts = require('./propertyOptions');
 
 Object.defineProperty(SchemaMapOptions.prototype, 'of', opts);
 
-module.exports = SchemaMapOptions;
+module.exports = SchemaMapOptions;

package/lib/options/SchemaNumberOptions.js

@@ -96,4 +96,4 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'populate', opts);
  * ignore
  */
 
-module.exports = SchemaNumberOptions;
+module.exports = SchemaNumberOptions;

package/lib/options/SchemaObjectIdOptions.js

@@ -60,4 +60,4 @@ Object.defineProperty(SchemaObjectIdOptions.prototype, 'populate', opts);
  * ignore
  */
 
-module.exports = SchemaObjectIdOptions;
+module.exports = SchemaObjectIdOptions;

package/lib/options/SchemaSubdocumentOptions.js

@@ -39,4 +39,4 @@ const opts = require('./propertyOptions');
 
 Object.defineProperty(SchemaSubdocumentOptions.prototype, '_id', opts);
 
-module.exports = SchemaSubdocumentOptions;
+module.exports = SchemaSubdocumentOptions;

package/lib/options/SchemaTypeOptions.js

@@ -241,4 +241,4 @@ Object.defineProperty(SchemaTypeOptions.prototype, 'text', opts);
 
 Object.defineProperty(SchemaTypeOptions.prototype, 'transform', opts);
 
-module.exports = SchemaTypeOptions;
+module.exports = SchemaTypeOptions;

package/lib/options/VirtualOptions.js

@@ -161,4 +161,4 @@ Object.defineProperty(VirtualOptions.prototype, 'limit', opts);
 
 Object.defineProperty(VirtualOptions.prototype, 'perDocumentLimit', opts);
 
-module.exports = VirtualOptions;
+module.exports = VirtualOptions;

package/lib/options/propertyOptions.js

@@ -5,4 +5,4 @@ module.exports = Object.freeze({
   configurable: true,
   writable: true,
   value: void 0
-});
+});

package/lib/options/removeOptions.js

@@ -11,4 +11,4 @@ class RemoveOptions {
   }
 }
 
-module.exports = RemoveOptions;
+module.exports = RemoveOptions;

package/lib/options/saveOptions.js

@@ -11,4 +11,4 @@ class SaveOptions {
   }
 }
 
-module.exports = SaveOptions;
+module.exports = SaveOptions;

package/lib/plugins/trackTransaction.js

@@ -89,4 +89,4 @@ function mergeAtomics(destination, source) {
   }
 
   return destination;
-}
+}