mongoose 6.3.0 → 6.3.3

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/SubdocumentPath.js

@@ -60,25 +60,13 @@ function _createConstructor(schema, baseClass) {
   Subdocument || (Subdocument = require('../types/subdocument'));
 
   const _embedded = function SingleNested(value, path, parent) {
-    const _this = this;
-
     this.$__parent = parent;
     Subdocument.apply(this, arguments);
 
-    this.$session(this.ownerDocument().$session());
-
-    if (parent) {
-      parent.$on('save', function() {
-        _this.emit('save', _this);
-        _this.constructor.emit('save', _this);
-      });
-
-      parent.$on('isNew', function(val) {
-        _this.isNew = val;
-        _this.emit('isNew', val);
-        _this.constructor.emit('isNew', val);
-      });
+    if (parent == null) {
+      return;
     }
+    this.$session(parent.$session());
   };
 
   schema._preCompile();

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');
 
@@ -114,10 +113,12 @@ function _createConstructor(schema, options, baseClass) {
   Subdocument || (Subdocument = require('../types/ArraySubdocument'));
 
   // compile an embedded document for this schema
-  function EmbeddedDocument() {
+  function EmbeddedDocument(_value, parentArray) {
     Subdocument.apply(this, arguments);
-
-    this.$session(this.ownerDocument().$session());
+    if (parentArray == null || parentArray.getArrayParent() == null) {
+      return;
+    }
+    this.$session(parentArray.getArrayParent().$session());
   }
 
   schema._preCompile();
@@ -394,7 +395,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 +487,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/number.js

@@ -353,11 +353,7 @@ SchemaNumber.prototype.enum = function(values, message) {
  */
 
 SchemaNumber.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
-    if (typeof value === 'number') {
-      return value;
-    }
-
+  if (typeof value !== 'number' && SchemaType._isRef(this, value, doc, init)) {
     if (value == null || utils.isNonBuiltinObject(value)) {
       return this._castRef(value, doc, init);
     }

package/lib/schema/objectid.js

@@ -221,11 +221,9 @@ ObjectId.prototype.checkRequired = function checkRequired(value, doc) {
  */
 
 ObjectId.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
+  if (!(value instanceof oid) && SchemaType._isRef(this, value, doc, init)) {
     // wait! we may need to cast this to a document
-    if (value instanceof oid) {
-      return value;
-    } else if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
+    if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
       return new oid(value.toHexString());
     }
 

package/lib/schema/string.js

@@ -4,6 +4,7 @@
  * Module dependencies.
  */
 
+const { BSONRegExp } = require('bson');
 const SchemaType = require('../schematype');
 const MongooseError = require('../error/index');
 const SchemaStringOptions = require('../options/SchemaStringOptions');
@@ -580,11 +581,7 @@ SchemaString.prototype.checkRequired = function checkRequired(value, doc) {
  */
 
 SchemaString.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
-    if (typeof value === 'string') {
-      return value;
-    }
-
+  if (typeof value !== 'string' && SchemaType._isRef(this, value, doc, init)) {
     return this._castRef(value, doc, init);
   }
 
@@ -680,7 +677,7 @@ SchemaString.prototype.castForQuery = function($conditional, val) {
     return handler.call(this, val);
   }
   val = $conditional;
-  if (Object.prototype.toString.call(val) === '[object RegExp]') {
+  if (Object.prototype.toString.call(val) === '[object RegExp]' || val instanceof BSONRegExp) {
     return val;
   }
 

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

@@ -22,6 +22,14 @@ const methods = {
     return this.toObject(internalToObjectOptions);
   },
 
+  /*!
+   * ignore
+   */
+
+  getArrayParent() {
+    return this[arrayParentSymbol];
+  },
+
   /**
    * Overrides MongooseArray#cast
    *
@@ -311,8 +319,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/lib/utils.js

@@ -516,6 +516,10 @@ exports.populate = function populate(path, select, model, match, options, subPop
   let obj = null;
   if (arguments.length === 1) {
     if (path instanceof PopulateOptions) {
+      // If reusing old populate docs, avoid reusing `_docs` because that may
+      // lead to bugs and memory leaks. See gh-11641
+      path._docs = [];
+      path._childDocs = [];
       return [path];
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.0",
+  "version": "6.3.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,54 +19,72 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^4.2.2",
+    "bson": "^4.6.2",
     "kareem": "2.3.5",
     "mongodb": "4.5.0",
-    "mpath": "0.8.4",
+    "mpath": "0.9.0",
     "mquery": "4.0.2",
     "ms": "2.1.3",
     "sift": "16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.8",
-    "@babel/preset-env": "7.16.11",
-    "@typescript-eslint/eslint-plugin": "5.17.0",
-    "@typescript-eslint/parser": "5.17.0",
+    "@babel/core": "7.17.10",
+    "@babel/preset-env": "7.17.10",
+    "@typescript-eslint/eslint-plugin": "5.21.0",
+    "@typescript-eslint/parser": "5.21.0",
     "acquit": "1.2.1",
     "acquit-ignore": "0.2.0",
     "acquit-require": "0.1.1",
-    "assert-browserify": "npm:assert@^2.0.0",
-    "axios": "0.26.1",
-    "babel-loader": "8.2.4",
+    "assert-browserify": "2.0.0",
+    "axios": "0.27.2",
+    "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
+    "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.10",
     "crypto-browserify": "3.12.0",
     "dox": "0.3.1",
-    "eslint": "8.12.0",
+    "eslint": "8.14.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
-    "highlight.js": "11.5.0",
+    "highlight.js": "11.5.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "4.0.12",
-    "mocha": "9.2.2",
+    "marked": "4.0.14",
+    "mkdirp": "^1.0.4",
+    "mocha": "10.0.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.3.0",
+    "mongodb-memory-server": "8.5.2",
+    "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
     "serve-handler": "6.1.3",
-    "sinon": "13.0.0",
+    "sinon": "13.0.2",
     "stream-browserify": "3.0.0",
-    "tsd": "0.19.1",
-    "typescript": "4.6.3",
+    "tsd": "0.20.0",
+    "typescript": "4.6.4",
     "uuid": "8.3.2",
-    "webpack": "5.70.0"
+    "webpack": "5.72.0"
   },
   "directories": {
     "lib": "./lib/mongoose"
   },
   "scripts": {
+    "docs:clean": "npm run docs:clean:stable",
+    "docs:clean:stable": "rimraf index.html && rimraf -rf ./docs/*.html  && rimraf -rf ./docs/api && rimraf -rf ./docs/tutorials/*.html && rimraf -rf ./docs/typescript/*.html && rimraf -rf ./docs/*.html && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:clean:legacy": "rimraf index.html && rimraf -rf ./docs/5.x && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:copy:tmp": "mkdirp ./tmp/docs/css && mkdirp ./tmp/docs/js && mkdirp ./tmp/docs/images && mkdirp ./tmp/docs/tutorials && mkdirp ./tmp/docs/typescript && ncp ./docs/css ./tmp/docs/css --filter=.css$ && ncp ./docs/js ./tmp/docs/js --filter=.js$ && ncp ./docs/images ./tmp/docs/images && ncp ./docs/tutorials ./tmp/docs/tutorials && ncp ./docs/typescript ./tmp/docs/typescript && cp index.html ./tmp",
+    "docs:copy:tmp:legacy": "rimraf ./docs/5.x && ncp ./tmp ./docs/5.x",
+    "docs:checkout:gh-pages": "git checkout gh-pages",
+    "docs:checkout:legacy": "git checkout 5.x",
+    "docs:generate": "node website.js",
+    "docs:generate:search": "node docs/search.js",
+    "docs:merge:stable": "git merge master",
+    "docs:merge:legacy": "git merge 5.x",
+    "docs:test": "npm run docs:generate && npm run docs:generate:search",
+    "docs:view": "node website.js && node static.js",
+    "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && docs:merge:stable && npm run docs:clean:stable && npm run docs:generate && npm run docs:generate:search",
+    "docs:prepare:publish:legacy": "npm run docs:checkout:legacy && docs:merge:legacy && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && docs:checkout:gh-pages && docs:copy:tmp:legacy",
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js",
     "lint-ts": "eslint . --ext .ts",
@@ -76,6 +94,7 @@
     "release-legacy": "git pull origin 5.x && git push origin 5.x --tags && npm publish --tag legacy",
     "mongo": "node ./tools/repl.js",
     "test": "mocha --exit ./test/*.test.js",
+    "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
     "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
     "test-coverage": "nyc --reporter=html --reporter=text npm test"
@@ -119,6 +138,7 @@
       "allowSyntheticDefaultImports": true,
       "strictPropertyInitialization": false,
       "noImplicitAny": false,
+      "strictNullChecks": true,
       "module": "commonjs",
       "target": "ES2017"
     }

package/tsconfig.json

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

package/types/aggregate.d.ts

@@ -1,6 +1,5 @@
-import mongodb = require('mongodb');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
 
   interface AggregateOptions {
     /**

package/types/connection.d.ts

@@ -1,7 +1,6 @@
-import mongodb = require('mongodb');
-import events = require('events');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
+  import events = require('events');
 
   /**
      * Connection ready state
@@ -197,7 +196,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 +205,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/cursor.d.ts

@@ -1,6 +1,7 @@
-import stream = require('stream');
-
 declare module 'mongoose' {
+
+  import stream = require('stream');
+
   type CursorFlag = 'tailable' | 'oplogReplay' | 'noCursorTimeout' | 'awaitData' | 'partial';
 
   interface EachAsyncOptions {

package/types/document.d.ts

@@ -1,10 +1,15 @@
-import mongodb = require('mongodb');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
 
   /** A list of paths to skip. If set, Mongoose will validate every modified path that is not in this list. */
   type pathsToSkip = string[] | string;
 
+  /**
+   * Generic types for Document:
+   * *  T - the type of _id
+   * *  TQueryHelpers - Object with any helpers that should be mixed into the Query type
+   * *  DocType - the type of the actual Document created
+   */
   class Document<T = any, TQueryHelpers = any, DocType = any> {
     constructor(doc?: any);
 
@@ -49,6 +54,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 +177,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
@@ -186,10 +191,10 @@ declare module 'mongoose' {
     $parent(): Document | undefined;
 
     /** Populates document references. */
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, names: string, callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, names: string): Promise<this & Paths>;
     populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<this & Paths>;
+    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<unknown>, match?: AnyObject, options?: PopulateOptions): Promise<this & Paths>;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<unknown>, match?: AnyObject, options?: PopulateOptions, callback?: Callback<this & Paths>): void;
 
     /** Gets _id(s) used during population of the given `path`. If the path was not populated, returns `undefined`. */
     populated(path: string): any;
@@ -216,13 +221,11 @@ declare module 'mongoose' {
     set(value: any): this;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON(options: ToObjectOptions & { flattenMaps: false }): LeanDocument<this>;
-    toJSON(options?: ToObjectOptions): FlattenMaps<LeanDocument<this>>;
-    toJSON<T = FlattenMaps<DocType>>(options?: ToObjectOptions): T;
+    toJSON<T = LeanDocument<DocType>>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<T>;
+    toJSON<T = LeanDocument<DocType>>(options: ToObjectOptions & { flattenMaps: false }): T;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject(options?: ToObjectOptions): LeanDocument<this>;
-    toObject<T = DocType>(options?: ToObjectOptions): T;
+    toObject<T = LeanDocument<DocType>>(options?: ToObjectOptions): Require_id<T>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified(path: string): void;
@@ -242,6 +245,6 @@ declare module 'mongoose' {
 
     /** Executes registered validation rules (skipping asynchronous validators) for this document. */
     validateSync(options: { pathsToSkip?: pathsToSkip, [k: string]: any }): Error.ValidationError | null;
-    validateSync(pathsToValidate?: Array<string>, options?: AnyObject): Error.ValidationError | null;
+    validateSync(pathsToValidate?: pathsToValidate, options?: AnyObject): Error.ValidationError | null;
   }
-}
+}