mongoose 6.3.0 → 6.3.1

package/lib/collection.js

@@ -23,13 +23,6 @@ function Collection(name, conn, opts) {
   if (opts === void 0) {
     opts = {};
   }
-  if (opts.capped === void 0) {
-    opts.capped = {};
-  }
-
-  if (typeof opts.capped === 'number') {
-    opts.capped = { size: opts.capped };
-  }
 
   this.opts = opts;
   this.name = name;

package/lib/document.js

@@ -1048,7 +1048,6 @@ Document.prototype.$set = function $set(path, val, type, options) {
   const merge = options.merge;
   const adhoc = type && type !== true;
   const constructing = type === true;
-  const typeKey = this.$__schema.options.typeKey;
   let adhocs;
   let keys;
   let i = 0;
@@ -1150,14 +1149,15 @@ Document.prototype.$set = function $set(path, val, type, options) {
       }
     }
 
-    // Ensure all properties are in correct order by deleting and recreating every property.
-    for (const key of Object.keys(this.$__schema.tree)) {
-      if (this._doc.hasOwnProperty(key)) {
-        const val = this._doc[key];
-        delete this._doc[key];
-        this._doc[key] = val;
-      }
+    // Ensure all properties are in correct order
+    const orderedDoc = {};
+    const orderedKeys = Object.keys(this.$__schema.tree);
+    for (let i = 0, len = orderedKeys.length; i < len; ++i) {
+      (key = orderedKeys[i]) &&
+      (this._doc.hasOwnProperty(key)) &&
+      (orderedDoc[key] = undefined);
     }
+    this._doc = Object.assign(orderedDoc, this._doc);
 
     return this;
   }
@@ -1381,6 +1381,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
     }
 
     let popOpts;
+    const typeKey = this.$__schema.options.typeKey;
     if (schema.options &&
         Array.isArray(schema.options[typeKey]) &&
         schema.options[typeKey].length &&
@@ -1400,7 +1401,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
       // later in `$__set()` because we don't take `_doc` when we iterate through
       // a single nested doc. That's to make sure we get the correct context.
       // Otherwise we would double-call the setter, see gh-7196.
-      val = schema.applySetters(val, this, false, priorVal);
+      val = schema.applySetters(val, this, false, priorVal, options);
     }
 
     if (Array.isArray(val) &&

package/lib/error/cast.js

@@ -23,7 +23,7 @@ class CastError extends MongooseError {
       const stringValue = getStringValue(value);
       const valueType = getValueType(value);
       const messageFormat = getMessageFormat(schemaType);
-      const msg = formatMessage(null, type, stringValue, path, messageFormat, valueType);
+      const msg = formatMessage(null, type, stringValue, path, messageFormat, valueType, reason);
       super(msg);
       this.init(type, value, path, reason, schemaType);
     } else {
@@ -122,7 +122,7 @@ function getMessageFormat(schemaType) {
  * ignore
  */
 
-function formatMessage(model, kind, stringValue, path, messageFormat, valueType) {
+function formatMessage(model, kind, stringValue, path, messageFormat, valueType, reason) {
   if (messageFormat != null) {
     let ret = messageFormat.
       replace('{KIND}', kind).
@@ -140,6 +140,11 @@ function formatMessage(model, kind, stringValue, path, messageFormat, valueType)
     if (model != null) {
       ret += ' for model "' + model.modelName + '"';
     }
+    if (reason != null &&
+        typeof reason.constructor === 'function' &&
+        reason.constructor.name !== 'AssertionError') {
+      ret += ' because of "' + reason.constructor.name + '"';
+    }
     return ret;
   }
 }

package/lib/helpers/populate/getModelsMapForPopulate.js

@@ -76,17 +76,20 @@ module.exports = function getModelsMapForPopulate(model, docs, options) {
     let schemaOptions = null;
     let modelNamesInOrder = null;
 
-    if (schema != null && schema.instance === 'Embedded' && schema.options.ref) {
-      const data = {
-        localField: options.path + '._id',
-        foreignField: '_id',
-        justOne: true
-      };
-      const res = _getModelNames(doc, schema, modelNameFromQuery, model);
+    if (schema != null && schema.instance === 'Embedded') {
+      if (schema.options.ref) {
+        const data = {
+          localField: options.path + '._id',
+          foreignField: '_id',
+          justOne: true
+        };
+        const res = _getModelNames(doc, schema, modelNameFromQuery, model);
 
-      const unpopulatedValue = mpath.get(options.path, doc);
-      const id = mpath.get('_id', unpopulatedValue);
-      addModelNamesToMap(model, map, available, res.modelNames, options, data, id, doc, schemaOptions, unpopulatedValue);
+        const unpopulatedValue = mpath.get(options.path, doc);
+        const id = mpath.get('_id', unpopulatedValue);
+        addModelNamesToMap(model, map, available, res.modelNames, options, data, id, doc, schemaOptions, unpopulatedValue);
+      }
+      // No-op if no `ref` set. See gh-11538
       continue;
     }
 

package/lib/helpers/schematype/handleImmutable.js

@@ -19,13 +19,16 @@ module.exports = function(schematype) {
 };
 
 function createImmutableSetter(path, immutable) {
-  return function immutableSetter(v) {
+  return function immutableSetter(v, _priorVal, _doc, options) {
     if (this == null || this.$__ == null) {
       return v;
     }
     if (this.isNew) {
       return v;
     }
+    if (options && options.overwriteImmutable) {
+      return v;
+    }
 
     const _immutable = typeof immutable === 'function' ?
       immutable.call(this, this) :

package/lib/helpers/timestamps/setupTimestamps.js

@@ -48,8 +48,8 @@ module.exports = function setupTimestamps(schema, timestamps) {
       currentTime() :
       this.ownerDocument().constructor.base.now();
 
-    if (!skipCreatedAt && this.isNew && createdAt && !this.$__getValue(createdAt) && this.$__isSelected(createdAt)) {
-      this.$set(createdAt, defaultTimestamp);
+    if (!skipCreatedAt && (this.isNew || this.$isSubdocument) && createdAt && !this.$__getValue(createdAt) && this.$__isSelected(createdAt)) {
+      this.$set(createdAt, defaultTimestamp, undefined, { overwriteImmutable: true });
     }
 
     if (!skipUpdatedAt && updatedAt && (this.isNew || this.$isModified())) {

package/lib/index.js

@@ -267,7 +267,7 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
  * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
- * @return {Connection} the created Connection object. Connections are thenable, so you can do `await mongoose.createConnection()`
+ * @return {Connection} the created Connection object. Connections are not thenable, so you can not `await mongoose.createConnection()`. To await use mongoose.createConnection(uri).asPromise() instead.
  * @api public
  */
 

package/lib/model.js

@@ -1074,6 +1074,22 @@ Model.prototype.model = function model(name) {
   return this[modelDbSymbol].model(name);
 };
 
+/**
+ * Returns another Model instance.
+ *
+ * #### Example:
+ *
+ *     const doc = new Tank;
+ *     doc.model('User').findById(id, callback);
+ *
+ * @param {String} name model name
+ * @api public
+ */
+
+Model.prototype.$model = function $model(name) {
+  return this[modelDbSymbol].model(name);
+};
+
 /**
  * Returns a document with `_id` only if at least one document exists in the database that matches
  * the given `filter`, and `null` otherwise.
@@ -1362,23 +1378,27 @@ Model.createCollection = function createCollection(options, callback) {
   }
 
   const schemaCollation = this &&
-  this.schema &&
-  this.schema.options &&
-  this.schema.options.collation || null;
+    this.schema &&
+    this.schema.options &&
+    this.schema.options.collation;
   if (schemaCollation != null) {
     options = Object.assign({ collation: schemaCollation }, options);
   }
   const capped = this &&
-  this.schema &&
-  this.schema.options &&
-   this.schema.options.capped;
-  if (capped) {
-    options = Object.assign({ capped: true }, capped, options);
+    this.schema &&
+    this.schema.options &&
+    this.schema.options.capped;
+  if (capped != null) {
+    if (typeof capped === 'number') {
+      options = Object.assign({ capped: true, size: capped }, options);
+    } else if (typeof capped === 'object') {
+      options = Object.assign({ capped: true }, capped, options);
+    }
   }
   const timeseries = this &&
-  this.schema &&
-  this.schema.options &&
-  this.schema.options.timeseries;
+    this.schema &&
+    this.schema.options &&
+    this.schema.options.timeseries;
   if (timeseries != null) {
     options = Object.assign({ timeseries }, options);
     if (options.expireAfterSeconds != null) {
@@ -2148,14 +2168,7 @@ Model.find = function find(conditions, projection, options, callback) {
 
   const mq = new this.Query({}, {}, this, this.$__collection);
   mq.select(projection);
-
   mq.setOptions(options);
-  if (this.schema.discriminatorMapping &&
-      this.schema.discriminatorMapping.isRoot &&
-      mq.selectedInclusively()) {
-    // Need to select discriminator key because original schema doesn't have it
-    mq.select(this.schema.options.discriminatorKey);
-  }
 
   callback = this.$handleCallbackError(callback);
 
@@ -2261,11 +2274,6 @@ Model.findOne = function findOne(conditions, projection, options, callback) {
   const mq = new this.Query({}, {}, this, this.$__collection);
   mq.select(projection);
   mq.setOptions(options);
-  if (this.schema.discriminatorMapping &&
-      this.schema.discriminatorMapping.isRoot &&
-      mq.selectedInclusively()) {
-    mq.select(this.schema.options.discriminatorKey);
-  }
 
   callback = this.$handleCallbackError(callback);
   return mq.findOne(conditions, callback);

package/lib/queryhelpers.js

@@ -261,7 +261,17 @@ exports.applyPaths = function applyPaths(fields, schema) {
       delete fields[plusPath];
     }
 
-    if (typeof type.selected !== 'boolean') return;
+    if (typeof type.selected !== 'boolean') {
+      return;
+    }
+
+    // If set to 0, we're explicitly excluding the discriminator key. Can't do this for all fields,
+    // because we have tests that assert that using `-path` to exclude schema-level `select: true`
+    // fields counts as an exclusive projection. See gh-11546
+    if (exclude && type.selected && path === schema.options.discriminatorKey && fields[path] != null && !fields[path]) {
+      delete fields[path];
+      return;
+    }
 
     if (hasPlusPath) {
       // forced inclusion

package/lib/schema/documentarray.js

@@ -13,7 +13,6 @@ const SchemaType = require('../schematype');
 const discriminator = require('../helpers/model/discriminator');
 const handleIdOption = require('../helpers/schema/handleIdOption');
 const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
-const util = require('util');
 const utils = require('../utils');
 const getConstructor = require('../helpers/discriminator/getConstructor');
 
@@ -394,7 +393,7 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
 
   if (!Array.isArray(value)) {
     if (!init && !DocumentArrayPath.options.castNonArrays) {
-      throw new CastError('DocumentArray', util.inspect(value), this.path, null, this);
+      throw new CastError('DocumentArray', value, this.path, null, this);
     }
     // gh-2442 mark whole array as modified if we're initializing a doc from
     // the db and the path isn't an array in the document
@@ -486,8 +485,7 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
             // see gh-746
             rawArray[i] = subdoc;
           } catch (error) {
-            const valueInErrorMessage = util.inspect(rawArray[i]);
-            throw new CastError('embedded', valueInErrorMessage,
+            throw new CastError('embedded', rawArray[i],
               value[arrayPathSymbol], error, this);
           }
         }

package/lib/schema.js

@@ -54,7 +54,7 @@ let id = 0;
  * - [autoCreate](/docs/guide.html#autoCreate): bool - defaults to null (which means use the connection's autoCreate option)
  * - [bufferCommands](/docs/guide.html#bufferCommands): bool - defaults to true
  * - [bufferTimeoutMS](/docs/guide.html#bufferTimeoutMS): number - defaults to 10000 (10 seconds). If `bufferCommands` is enabled, the amount of time Mongoose will wait for connectivity to be restablished before erroring out.
- * - [capped](/docs/guide.html#capped): bool - defaults to false
+ * - [capped](/docs/guide.html#capped): bool | number | object - defaults to false
  * - [collection](/docs/guide.html#collection): string - no default
  * - [discriminatorKey](/docs/guide.html#discriminatorKey): string - defaults to `__t`
  * - [id](/docs/guide.html#id): bool - defaults to true

package/lib/schematype.js

@@ -1148,7 +1148,7 @@ SchemaType.prototype.getDefault = function(scope, init) {
  * @api private
  */
 
-SchemaType.prototype._applySetters = function(value, scope, init, priorVal) {
+SchemaType.prototype._applySetters = function(value, scope, init, priorVal, options) {
   let v = value;
   if (init) {
     return v;
@@ -1156,7 +1156,7 @@ SchemaType.prototype._applySetters = function(value, scope, init, priorVal) {
   const setters = this.setters;
 
   for (let i = setters.length - 1; i >= 0; i--) {
-    v = setters[i].call(scope, v, priorVal, this);
+    v = setters[i].call(scope, v, priorVal, this, options);
   }
 
   return v;

package/lib/types/DocumentArray/methods/index.js

@@ -311,8 +311,8 @@ const methods = {
       return this;
     }
     const value = methods._cast.call(this, val, i);
-    arr[i] = value;
     methods._markModified.call(this, i);
+    arr[i] = value;
     return this;
   },
 

package/lib/types/array/methods/index.js

@@ -414,9 +414,9 @@ const methods = {
       }
 
       if (!found) {
+        this._markModified();
         rawArray.push(v);
         this._registerAtomic('$addToSet', v);
-        this._markModified();
         [].push.call(added, v);
       }
     }, this);
@@ -510,9 +510,9 @@ const methods = {
 
   nonAtomicPush() {
     const values = [].map.call(arguments, this._mapCast, this);
+    this._markModified();
     const ret = [].push.apply(this, values);
     this._registerAtomic('$set', this);
-    this._markModified();
     return ret;
   },
 
@@ -530,9 +530,9 @@ const methods = {
    */
 
   pop() {
+    this._markModified();
     const ret = [].pop.call(this);
     this._registerAtomic('$set', this);
-    this._markModified();
     return ret;
   },
 
@@ -572,6 +572,7 @@ const methods = {
     const cur = this[arrayParentSymbol].get(this[arrayPathSymbol]);
     let i = cur.length;
     let mem;
+    this._markModified();
 
     while (i--) {
       mem = cur[i];
@@ -595,7 +596,6 @@ const methods = {
       this._registerAtomic('$pullAll', values);
     }
 
-    this._markModified();
 
     // Might have modified child paths and then pulled, like
     // `doc.children[1].name = 'test';` followed by
@@ -657,7 +657,7 @@ const methods = {
       undefined, { skipDocumentArrayCast: true });
     let ret;
     const atomics = this[arrayAtomicsSymbol];
-
+    this._markModified();
     if (isOverwrite) {
       atomic.$each = values;
 
@@ -684,7 +684,6 @@ const methods = {
     }
 
     this._registerAtomic('$push', atomic);
-    this._markModified();
     return ret;
   },
 
@@ -737,8 +736,8 @@ const methods = {
       return this;
     }
     const value = methods._cast.call(this, val, i);
-    arr[i] = value;
     methods._markModified.call(this, i);
+    arr[i] = value;
     return this;
   },
 
@@ -763,9 +762,9 @@ const methods = {
 
   shift() {
     const arr = utils.isMongooseArray(this) ? this.__array : this;
+    this._markModified();
     const ret = [].shift.call(arr);
     this._registerAtomic('$set', this);
-    this._markModified();
     return ret;
   },
 
@@ -890,9 +889,9 @@ const methods = {
     }
 
     const arr = utils.isMongooseArray(this) ? this.__array : this;
+    this._markModified();
     [].unshift.apply(arr, values);
     this._registerAtomic('$set', this);
-    this._markModified();
     return this.length;
   }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.0",
+  "version": "6.3.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,7 +19,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^4.2.2",
+    "bson": "^4.6.2",
     "kareem": "2.3.5",
     "mongodb": "4.5.0",
     "mpath": "0.8.4",

package/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
+    "strictNullChecks": true,
     "paths": {
       "mongoose" : ["./types/index.d.ts"]
     }
   },
-  "strictNullChecks": true
+  "include": ["types/*"]
 }

package/types/connection.d.ts

@@ -197,7 +197,7 @@ declare module 'mongoose' {
        * async function executes successfully and attempt to retry if
        * there was a retryable error.
        */
-    transaction<U = any>(fn: (session: mongodb.ClientSession) => Promise<U>): Promise<U>;
+    transaction(fn: (session: mongodb.ClientSession) => Promise<any>): Promise<void>;
 
     /** Switches to a different database using the same connection pool. */
     useDb(name: string, options?: { useCache?: boolean, noListener?: boolean }): Connection;
@@ -206,7 +206,7 @@ declare module 'mongoose' {
     readonly user: string;
 
     /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model.watch). */
-    watch<ResultType = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
+    watch<ResultType extends mongodb.Document = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
   }
 
 }

package/types/document.d.ts

@@ -49,6 +49,9 @@ declare module 'mongoose' {
     /** Marks a path as valid, removing existing validation errors. */
     $markValid(path: string): void;
 
+    /** Returns the model with the given name on this document's associated connection. */
+    $model<ModelType = Model<unknown>>(name: string): ModelType;
+
     /**
      * A string containing the current operation that Mongoose is executing
      * on this document. Can be `null`, `'save'`, `'validate'`, or `'remove'`.
@@ -169,9 +172,6 @@ declare module 'mongoose' {
     /** The name of the model */
     modelName: string;
 
-    /** Returns the model with the given name on this document's associated connection. */
-    model<ModelType = Model<unknown>>(name: string): ModelType;
-
     /**
      * Overwrite all values in this document with the values of `obj`, except
      * for immutable properties. Behaves similarly to `set()`, except for it

package/types/index.d.ts

@@ -183,7 +183,7 @@ declare module 'mongoose' {
    * section collection.js
    * http://mongoosejs.com/docs/api.html#collection-js
    */
-  interface CollectionBase<T> extends mongodb.Collection<T> {
+  interface CollectionBase<T extends mongodb.Document> extends mongodb.Collection<T> {
     /*
       * Abstract methods. Some of these are already defined on the
       * mongodb.Collection interface so they've been commented out.
@@ -205,7 +205,7 @@ declare module 'mongoose' {
    * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-collection-js
    */
   let Collection: Collection;
-  interface Collection<T = AnyObject> extends CollectionBase<T> {
+  interface Collection<T extends mongodb.Document = mongodb.Document> extends CollectionBase<T> {
     /**
      * Collection constructor
      * @param name name of the collection
@@ -317,8 +317,8 @@ declare module 'mongoose' {
      * mongoose will not create the collection for the model until any documents are
      * created. Use this method to create the collection explicitly.
      */
-    createCollection<T>(options?: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'>): Promise<mongodb.Collection<T>>;
-    createCollection<T>(options: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'> | null, callback: Callback<mongodb.Collection<T>>): void;
+    createCollection<T extends mongodb.Document>(options?: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'>): Promise<mongodb.Collection<T>>;
+    createCollection<T extends mongodb.Document>(options: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'> | null, callback: Callback<mongodb.Collection<T>>): void;
 
     /**
      * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#createIndex)
@@ -467,7 +467,7 @@ declare module 'mongoose' {
     validate(optional: any, pathsToValidate: string[], callback?: CallbackWithoutResult): Promise<void>;
 
     /** Watches the underlying collection for changes using [MongoDB change streams](https://docs.mongodb.com/manual/changeStreams/). */
-    watch<ResultType = any>(pipeline?: Array<Record<string, unknown>>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
+    watch<ResultType extends mongodb.Document = any>(pipeline?: Array<Record<string, unknown>>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
 
     /** Adds a `$where` clause to this query */
     $where(argument: string | Function): QueryWithHelpers<Array<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>, HydratedDocument<T, TMethodsAndOverrides, TVirtuals>, TQueryHelpers, T>;
@@ -789,6 +789,8 @@ declare module 'mongoose' {
     model?: string | Model<any>;
     /** optional query options like sort, limit, etc */
     options?: any;
+    /** correct limit on populated array */
+    perDocumentLimit?: number;
     /** optional boolean, set to `false` to allow populating paths that aren't in the schema */
     strictPopulate?: boolean;
     /** deep populate */
@@ -975,13 +977,13 @@ declare module 'mongoose' {
     virtual<T = HydratedDocument<DocType, TInstanceMethods>>(
       name: string,
       options?: VirtualTypeOptions<T, DocType>
-    ): VirtualType;
+    ): VirtualType<T>;
 
     /** Object of currently defined virtuals on this schema */
     virtuals: any;
 
     /** Returns the virtual type with the given `name`. */
-    virtualpath(name: string): VirtualType | null;
+    virtualpath<T = HydratedDocument<DocType, TInstanceMethods>>(name: string): VirtualType<T> | null;
   }
 
   type NumberSchemaDefinition = typeof Number | 'number' | 'Number' | typeof Schema.Types.Number;
@@ -1296,7 +1298,7 @@ declare module 'mongoose' {
     [extra: string]: any;
   }
 
-  class VirtualType {
+  class VirtualType<HydratedDocType> {
     /** Applies getters to `value`. */
     applyGetters(value: any, doc: Document): any;
 
@@ -1304,10 +1306,10 @@ declare module 'mongoose' {
     applySetters(value: any, doc: Document): any;
 
     /** Adds a custom getter to this virtual. */
-    get(fn: Function): this;
+    get<T = HydratedDocType>(fn: (this: T, value: any, virtualType: VirtualType<T>, doc: T) => any): this;
 
     /** Adds a custom setter to this virtual. */
-    set(fn: Function): this;
+    set<T = HydratedDocType>(fn: (this: T, value: any, virtualType: VirtualType<T>, doc: T) => void): this;
   }
 
   namespace Schema {