mongoose 6.3.7 → 6.4.0

package/.eslintrc.json

@@ -4,43 +4,70 @@
   ],
   "ignorePatterns": [
     "docs",
+    "tools",
     "dist",
-    "test/files/*"
+    "website.js",
+    "test/files/*",
+    "benchmarks"
   ],
-  "overrides": [{
-    "files": [
-      "**/*.{ts,tsx}"
-    ],
-    "extends": [
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended"
-    ],
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "rules": {
-      "@typescript-eslint/triple-slash-reference": "off",
-      "spaced-comment": ["error", "always", {
-        "markers": ["/"]
-      }],
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/ban-types": "off",
-      "@typescript-eslint/no-unused-vars": "off",
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "@typescript-eslint/indent": ["error", 2, {
-        "SwitchCase": 1
-      }],
-      "@typescript-eslint/prefer-optional-chain": "error",
-      "@typescript-eslint/brace-style": "error",
-      "@typescript-eslint/no-dupe-class-members": "error",
-      "@typescript-eslint/no-redeclare": "error",
-      "@typescript-eslint/type-annotation-spacing": "error",
-      "@typescript-eslint/object-curly-spacing": ["error", "always"],
-      "@typescript-eslint/semi": "error",
-      "@typescript-eslint/space-before-function-paren": ["error", "never"],
-      "@typescript-eslint/space-infix-ops": "off"
+  "overrides": [
+    {
+      "files": [
+        "**/*.{ts,tsx}"
+      ],
+      "extends": [
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+      ],
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "rules": {
+        "@typescript-eslint/triple-slash-reference": "off",
+        "spaced-comment": [
+          "error",
+          "always",
+          {
+            "block": {
+              "markers": [
+                "!"
+              ],
+              "balanced": true
+            },
+            "markers": [
+              "/"
+            ]
+          }
+        ],
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/indent": [
+          "error",
+          2,
+          {
+            "SwitchCase": 1
+          }
+        ],
+        "@typescript-eslint/prefer-optional-chain": "error",
+        "@typescript-eslint/brace-style": "error",
+        "@typescript-eslint/no-dupe-class-members": "error",
+        "@typescript-eslint/no-redeclare": "error",
+        "@typescript-eslint/type-annotation-spacing": "error",
+        "@typescript-eslint/object-curly-spacing": [
+          "error",
+          "always"
+        ],
+        "@typescript-eslint/semi": "error",
+        "@typescript-eslint/space-before-function-paren": [
+          "error",
+          "never"
+        ],
+        "@typescript-eslint/space-infix-ops": "off"
+      }
     }
-  }],
+  ],
   "plugins": [
     "mocha-no-only"
   ],

package/lib/connection.js

@@ -9,6 +9,7 @@ const EventEmitter = require('events').EventEmitter;
 const Schema = require('./schema');
 const STATES = require('./connectionstate');
 const MongooseError = require('./error/index');
+const DisconnectedError = require('./error/disconnected');
 const SyncIndexesError = require('./error/syncIndexes');
 const PromiseProvider = require('./promise_provider');
 const ServerSelectionError = require('./error/serverSelection');
@@ -565,8 +566,7 @@ function _wrapConnHelper(fn) {
     const argsWithoutCb = typeof cb === 'function' ?
       Array.prototype.slice.call(arguments, 0, arguments.length - 1) :
       Array.prototype.slice.call(arguments);
-    const disconnectedError = new MongooseError('Connection ' + this.id +
-      ' was disconnected when calling `' + fn.name + '`');
+    const disconnectedError = new DisconnectedError(this.id, fn.name);
 
     return promiseOrCallback(cb, cb => {
       immediate(() => {
@@ -697,6 +697,18 @@ Connection.prototype.openUri = function(uri, options, callback) {
       typeof callback + '"');
   }
 
+  if (this._destroyCalled) {
+    const error = 'Connection has been closed and destroyed, and cannot be used for re-opening the connection. ' +
+    'Please create a new connection with `mongoose.createConnection()` or `mongoose.connect()`.';
+    if (typeof callback === 'function') {
+      callback(error);
+      return;
+    }
+    else {
+      throw new MongooseError(error);
+    }
+  }
+
   if (this.readyState === STATES.connecting || this.readyState === STATES.connected) {
     if (this._connectionString !== uri) {
       throw new MongooseError('Can\'t call `openUri()` on an active connection with ' +
@@ -901,6 +913,23 @@ function _setClient(conn, client, options, dbName) {
   }
 }
 
+Connection.prototype.destroy = function(force, callback) {
+  if (typeof force === 'function') {
+    callback = force;
+    force = false;
+  }
+
+  if (force != null && typeof force === 'object') {
+    this.$wasForceClosed = !!force.force;
+  } else {
+    this.$wasForceClosed = !!force;
+  }
+
+  return promiseOrCallback(callback, cb => {
+    this._close(force, true, cb);
+  });
+};
+
 /**
  * Closes the connection
  *
@@ -923,7 +952,7 @@ Connection.prototype.close = function(force, callback) {
   }
 
   return promiseOrCallback(callback, cb => {
-    this._close(force, cb);
+    this._close(force, false, cb);
   });
 };
 
@@ -931,19 +960,26 @@ Connection.prototype.close = function(force, callback) {
  * Handles closing the connection
  *
  * @param {Boolean} force
+ * @param {Boolean} destroy
  * @param {Function} callback
  * @api private
  */
-Connection.prototype._close = function(force, callback) {
+Connection.prototype._close = function(force, destroy, callback) {
   const _this = this;
   const closeCalled = this._closeCalled;
   this._closeCalled = true;
+  this._destroyCalled = destroy;
   if (this.client != null) {
     this.client._closeCalled = true;
+    this.client._destroyCalled = destroy;
   }
 
+  const conn = this;
   switch (this.readyState) {
     case STATES.disconnected:
+      if (destroy && this.base.connections.indexOf(conn) !== -1) {
+        this.base.connections.splice(this.base.connections.indexOf(conn), 1);
+      }
       if (closeCalled) {
         callback();
       } else {
@@ -963,6 +999,9 @@ Connection.prototype._close = function(force, callback) {
         if (err) {
           return callback(err);
         }
+        if (destroy && _this.base.connections.indexOf(conn) !== -1) {
+          _this.base.connections.splice(_this.base.connections.indexOf(conn), 1);
+        }
         _this.onClose(force);
         callback(null);
       });
@@ -970,12 +1009,15 @@ Connection.prototype._close = function(force, callback) {
       break;
     case STATES.connecting:
       this.once('open', function() {
-        _this.close(callback);
+        destroy ? _this.destroy(force, callback) : _this.close(force, callback);
       });
       break;
 
     case STATES.disconnecting:
       this.once('close', function() {
+        if (destroy && _this.base.connections.indexOf(conn) !== -1) {
+          _this.base.connections.splice(_this.base.connections.indexOf(conn), 1);
+        }
         callback();
       });
       break;
@@ -1004,7 +1046,7 @@ Connection.prototype.onClose = function(force) {
   this.emit('close', force);
 
   for (const db of this.otherDbs) {
-    db.close({ force: force, skipCloseClient: true });
+    this._destroyCalled ? db.destroy({ force: force, skipCloseClient: true }) : db.close({ force: force, skipCloseClient: true });
   }
 };
 
@@ -1026,7 +1068,7 @@ Connection.prototype.collection = function(name, options) {
   };
   options = Object.assign({}, defaultOptions, options ? utils.clone(options) : {});
   options.$wasForceClosed = this.$wasForceClosed;
-  const Collection = driver.get().Collection;
+  const Collection = this.base && this.base.__driver && this.base.__driver.Collection || driver.get().Collection;
   if (!(name in this.collections)) {
     this.collections[name] = new Collection(name, this, options);
   }
@@ -1260,8 +1302,7 @@ Connection.prototype.deleteModel = function(name) {
  */
 
 Connection.prototype.watch = function(pipeline, options) {
-  const disconnectedError = new MongooseError('Connection ' + this.id +
-    ' was disconnected when calling `watch()`');
+  const disconnectedError = new DisconnectedError(this.id, 'watch');
 
   const changeStreamThunk = cb => {
     immediate(() => {

package/lib/document.js

@@ -79,6 +79,7 @@ function Document(obj, fields, skipId, options) {
     options = skipId;
     skipId = options.skipId;
   }
+  options = Object.assign({}, options);
 
   // Support `browserDocument.js` syntax
   if (this.$__schema == null) {
@@ -92,9 +93,9 @@ function Document(obj, fields, skipId, options) {
   }
 
   this.$__ = new InternalCache();
-  this.$isNew = options && options.isNew != null ? options.isNew : true;
+  this.$isNew = 'isNew' in options ? options.isNew : true;
 
-  if (options && options.priorDoc != null) {
+  if (options.priorDoc != null) {
     this.$__.priorDoc = options.priorDoc;
   }
 
@@ -107,20 +108,18 @@ function Document(obj, fields, skipId, options) {
   }
 
   let defaults = true;
-  if (options && options.defaults !== undefined) {
+  if (options.defaults !== undefined) {
     this.$__.defaults = options.defaults;
     defaults = options.defaults;
   }
 
   const schema = this.$__schema;
 
-  let strict;
   if (typeof fields === 'boolean' || fields === 'throw') {
     this.$__.strictMode = fields;
-    strict = fields;
     fields = undefined;
   } else {
-    strict = schema.options.strict;
+    this.$__.strictMode = schema.options.strict;
     if (fields != null) {
       this.$__.selected = fields;
     }
@@ -170,15 +169,15 @@ function Document(obj, fields, skipId, options) {
   // Function defaults get applied **after** setting initial values so they
   // see the full doc rather than an empty one, unless they opt out.
   // Re: gh-3781, gh-6155
-  if (options && options.willInit && defaults) {
+  if (options.willInit && defaults) {
     if (options.skipDefaults) {
       this.$__.skipDefaults = options.skipDefaults;
     }
   } else if (defaults) {
-    $__applyDefaults(this, fields, exclude, hasIncludedChildren, false, options && options.skipDefaults);
+    $__applyDefaults(this, fields, exclude, hasIncludedChildren, false, options.skipDefaults);
   }
 
-  if (!strict && obj) {
+  if (!this.$__.strictMode && obj) {
     const _this = this;
     const keys = Object.keys(this._doc);
 
@@ -2487,7 +2486,7 @@ function _getPathsToValidate(doc) {
       const fullPathToSubdoc = subdoc.$__fullPathWithIndexes();
 
       for (const p of paths) {
-        if (p === null || p.startsWith(fullPathToSubdoc + '.')) {
+        if (p == null || p.startsWith(fullPathToSubdoc + '.')) {
           paths.delete(p);
         }
       }
@@ -2508,6 +2507,14 @@ function _getPathsToValidate(doc) {
       continue;
     }
 
+    if (_pathType.$isMongooseDocumentArray) {
+      for (const p of paths) {
+        if (p == null || p.startsWith(_pathType.path + '.')) {
+          paths.delete(p);
+        }
+      }
+    }
+
     // Optimization: if primitive path with no validators, or array of primitives
     // with no validators, skip validating this path entirely.
     if (!_pathType.caster && _pathType.validators.length === 0) {
@@ -3146,8 +3153,7 @@ Document.prototype.$__reset = function reset() {
       if (subdoc.$isDocumentArrayElement) {
         if (!resetArrays.has(subdoc.parentArray())) {
           const array = subdoc.parentArray();
-          // Mark path to array as init for gh-6818
-          this.$__.activePaths.init(fullPathWithIndexes.replace(/\.\d+$/, '').slice(-subdoc.$basePath - 1));
+          this.$__.activePaths.clearPath(fullPathWithIndexes.replace(/\.\d+$/, '').slice(-subdoc.$basePath - 1));
           array[arrayAtomicsBackupSymbol] = array[arrayAtomicsSymbol];
           array[arrayAtomicsSymbol] = {};
 
@@ -3155,7 +3161,7 @@ Document.prototype.$__reset = function reset() {
         }
       } else {
         if (subdoc.$parent() === this) {
-          this.$__.activePaths.init(subdoc.$basePath);
+          this.$__.activePaths.clearPath(subdoc.$basePath);
         } else if (subdoc.$parent() != null && subdoc.$parent().$isSubdocument) {
           // If map path underneath subdocument, may end up with a case where
           // map path is modified but parent still needs to be reset. See gh-10295
@@ -3389,7 +3395,7 @@ Document.prototype.$getAllSubdocs = function() {
       }, seed);
     } else if (val && !Array.isArray(val) && val.$isSingleNested) {
       seed = Object.keys(val._doc).reduce(function(seed, path) {
-        return docReducer(val._doc, seed, path);
+        return docReducer(val, seed, path);
       }, seed);
       seed.push(val);
     } else if (val && utils.isMongooseDocumentArray(val)) {
@@ -4263,10 +4269,10 @@ Document.prototype.$getPopulatedDocs = function $getPopulatedDocs() {
  *
  * #### Example:
  *
- *     Model.findOne().populate('author').exec(function (err, doc) {
- *       console.log(doc.author.name)         // Dr.Seuss
- *       console.log(doc.populated('author')) // '5144cf8050f071d979c118a7'
- *     })
+ *     const doc = await Model.findOne().populate('author');
+ *
+ *     console.log(doc.author.name); // Dr.Seuss
+ *     console.log(doc.populated('author')); // '5144cf8050f071d979c118a7'
  *
  * If the path was not populated, returns `undefined`.
  *
@@ -4320,6 +4326,37 @@ Document.prototype.populated = function(path, val, options) {
 
 Document.prototype.$populated = Document.prototype.populated;
 
+/**
+ * Throws an error if a given path is not populated
+ *
+ * #### Example:
+ *
+ *     const doc = await Model.findOne().populate('author');
+ *
+ *     doc.$assertPopulated('author'); // does not throw
+ *     doc.$assertPopulated('other path'); // throws an error
+ *
+ *
+ * @param {String | Array<String>} path
+ * @return {Document} this
+ * @memberOf Document
+ * @instance
+ * @api public
+ */
+
+Document.prototype.$assertPopulated = function $assertPopulated(paths) {
+  if (Array.isArray(paths)) {
+    paths.forEach(path => this.$assertPopulated(path));
+    return this;
+  }
+
+  if (!this.$populated(paths)) {
+    throw new MongooseError(`Expected path "${paths}" to be populated`);
+  }
+
+  return this;
+};
+
 /**
  * Takes a populated field and returns it to its unpopulated state.
  *

package/lib/error/disconnected.js

@@ -16,10 +16,9 @@ class DisconnectedError extends MongooseError {
   /**
    * @param {String} connectionString
    */
-  constructor(connectionString) {
-    super('Ran out of retries trying to reconnect to "' +
-      connectionString + '". Try setting `server.reconnectTries` and ' +
-      '`server.reconnectInterval` to something higher.');
+  constructor(id, fnName) {
+    super('Connection ' + id +
+    ' was disconnected when calling `' + fnName + '()`');
   }
 }
 

package/lib/helpers/schematype/handleImmutable.js

@@ -40,8 +40,7 @@ function createImmutableSetter(path, immutable) {
     const _value = this.$__.priorDoc != null ?
       this.$__.priorDoc.$__getValue(path) :
       this.$__getValue(path);
-    const strict = this.$__.strictMode == null ? this.$__schema.options.strict : this.$__.strictMode;
-    if (strict === 'throw' && v !== _value) {
+    if (this.$__.strictMode === 'throw' && v !== _value) {
       throw new StrictModeError(path, 'Path `' + path + '` is immutable ' +
         'and strict mode is set to throw.', true);
     }

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) {

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 {