mongoose 6.3.4 → 6.3.5

package/lib/cast/objectid.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const isBsonType = require('../helpers/isBsonType');
 const ObjectId = require('../driver').get().ObjectId;
 
 module.exports = function castObjectId(value) {
@@ -7,12 +8,12 @@ module.exports = function castObjectId(value) {
     return value;
   }
 
-  if (value instanceof ObjectId) {
+  if (isBsonType(value, 'ObjectID')) {
     return value;
   }
 
   if (value._id) {
-    if (value._id instanceof ObjectId) {
+    if (isBsonType(value._id, 'ObjectID')) {
       return value._id;
     }
     if (value._id.toString instanceof Function) {

package/lib/connection.js

@@ -548,7 +548,7 @@ Connection.prototype.dropDatabase = _wrapConnHelper(function dropDatabase(cb) {
   // If `dropDatabase()` is called, this model's collection will not be
   // init-ed. It is sufficiently common to call `dropDatabase()` after
   // `mongoose.connect()` but before creating models that we want to
-  // support this. See gh-6967
+  // support this. See gh-6796
   for (const name of Object.keys(this.models)) {
     delete this.models[name].$init;
   }

package/lib/document.js

@@ -1378,7 +1378,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
     })();
 
     let didPopulate = false;
-    if (refMatches && val instanceof Document) {
+    if (refMatches && val instanceof Document && (!val.$__.wasPopulated || utils.deepEqual(val.$__.wasPopulated.value, val._id))) {
       const unpopulatedValue = (schema && schema.$isSingleNested) ? schema.cast(val, this) : val._id;
       this.$populated(path, unpopulatedValue, { [populateModelSymbol]: val.constructor });
       val.$__.wasPopulated = { value: unpopulatedValue };
@@ -3464,9 +3464,9 @@ Document.prototype.$toObject = function(options, json) {
 
   const path = json ? 'toJSON' : 'toObject';
   const baseOptions = this.constructor &&
-  this.constructor.base &&
-  this.constructor.base.options &&
-  get(this.constructor.base.options, path) || {};
+    this.constructor.base &&
+    this.constructor.base.options &&
+    get(this.constructor.base.options, path) || {};
   const schemaOptions = this.$__schema && this.$__schema.options || {};
   // merge base default options with Schema's set default options if available.
   // `clone` is necessary here because `utils.options` directly modifies the second input.
@@ -3503,7 +3503,8 @@ Document.prototype.$toObject = function(options, json) {
     _isNested: true,
     json: json,
     minimize: _minimize,
-    flattenMaps: flattenMaps
+    flattenMaps: flattenMaps,
+    _seen: (options && options._seen) || new Map()
   });
 
   if (utils.hasUserDefinedProperty(options, 'getters')) {

package/lib/error/index.js

@@ -5,11 +5,11 @@
  * Mongoose-specific errors.
  *
  * #### Example:
- *     const Model = mongoose.model('Test', new Schema({ answer: Number }));
+ *     const Model = mongoose.model('Test', new mongoose.Schema({ answer: Number }));
  *     const doc = new Model({ answer: 'not a number' });
  *     const err = doc.validateSync();
  *
- *     err instanceof mongoose.Error; // true
+ *     err instanceof mongoose.Error.ValidationError; // true
  *
  * @constructor Error
  * @param {String} msg Error message

package/lib/helpers/clone.js

@@ -77,7 +77,7 @@ function clone(obj, options, isArrayChild) {
     }
   }
 
-  if (obj instanceof ObjectId) {
+  if (isBsonType(obj, 'ObjectID')) {
     return new ObjectId(obj.id);
   }
 
@@ -119,9 +119,15 @@ module.exports = clone;
 function cloneObject(obj, options, isArrayChild) {
   const minimize = options && options.minimize;
   const omitUndefined = options && options.omitUndefined;
+  const seen = options && options._seen;
   const ret = {};
   let hasKeys;
 
+  if (seen && seen.has(obj)) {
+    return seen.get(obj);
+  } else if (seen) {
+    seen.set(obj, ret);
+  }
   if (trustedSymbol in obj) {
     ret[trustedSymbol] = obj[trustedSymbol];
   }

package/lib/helpers/common.js

@@ -5,8 +5,7 @@
  */
 
 const Binary = require('../driver').get().Binary;
-const Decimal128 = require('../types/decimal128');
-const ObjectId = require('../types/objectid');
+const isBsonType = require('./isBsonType');
 const isMongooseObject = require('./isMongooseObject');
 
 exports.flatten = flatten;
@@ -99,9 +98,9 @@ function shouldFlatten(val) {
   return val &&
     typeof val === 'object' &&
     !(val instanceof Date) &&
-    !(val instanceof ObjectId) &&
+    !isBsonType(val, 'ObjectID') &&
     (!Array.isArray(val) || val.length !== 0) &&
     !(val instanceof Buffer) &&
-    !(val instanceof Decimal128) &&
+    !isBsonType(val, 'Decimal128') &&
     !(val instanceof Binary);
 }

package/lib/helpers/discriminator/areDiscriminatorValuesEqual.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const ObjectId = require('../../types/objectid');
+const isBsonType = require('../isBsonType');
 
 module.exports = function areDiscriminatorValuesEqual(a, b) {
   if (typeof a === 'string' && typeof b === 'string') {
@@ -9,7 +9,7 @@ module.exports = function areDiscriminatorValuesEqual(a, b) {
   if (typeof a === 'number' && typeof b === 'number') {
     return a === b;
   }
-  if (a instanceof ObjectId && b instanceof ObjectId) {
+  if (isBsonType(a, 'ObjectID') && isBsonType(b, 'ObjectID')) {
     return a.toString() === b.toString();
   }
   return false;

package/lib/helpers/isBsonType.js

@@ -1,13 +1,15 @@
 'use strict';
 
-const get = require('./get');
-
 /*!
  * Get the bson type, if it exists
  */
 
 function isBsonType(obj, typename) {
-  return get(obj, '_bsontype', void 0) === typename;
+  return (
+    typeof obj === 'object' &&
+    obj !== null &&
+    obj._bsontype === typename
+  );
 }
 
 module.exports = isBsonType;

package/lib/helpers/path/setDottedPath.js

@@ -1,14 +1,25 @@
 'use strict';
 
+const specialProperties = require('../specialProperties');
+
+
 module.exports = function setDottedPath(obj, path, val) {
   if (path.indexOf('.') === -1) {
+    if (specialProperties.has(path)) {
+      return;
+    }
+
     obj[path] = val;
     return;
   }
   const parts = path.split('.');
+
   const last = parts.pop();
   let cur = obj;
   for (const part of parts) {
+    if (specialProperties.has(part)) {
+      continue;
+    }
     if (cur[part] == null) {
       cur[part] = {};
     }
@@ -16,5 +27,7 @@ module.exports = function setDottedPath(obj, path, val) {
     cur = cur[part];
   }
 
-  cur[last] = val;
+  if (!specialProperties.has(last)) {
+    cur[last] = val;
+  }
 };

package/lib/helpers/topology/isAtlas.js

@@ -8,6 +8,19 @@ module.exports = function isAtlas(topologyDescription) {
   }
 
   const hostnames = Array.from(topologyDescription.servers.keys());
-  return hostnames.length > 0 &&
-    hostnames.every(host => host.endsWith('.mongodb.net:27017'));
+
+  if (hostnames.length === 0) {
+    return false;
+  }
+
+  for (let i = 0, il = hostnames.length; i < il; ++i) {
+    const url = new URL(hostnames[i]);
+    if (
+      url.hostname.endsWith('.mongodb.net') === false ||
+      url.port !== '27017'
+    ) {
+      return false;
+    }
+  }
+  return true;
 };

package/lib/index.js

@@ -34,6 +34,7 @@ const PromiseProvider = require('./promise_provider');
 const shardingPlugin = require('./plugins/sharding');
 const trusted = require('./helpers/query/trusted').trusted;
 const sanitizeFilter = require('./helpers/query/sanitizeFilter');
+const isBsonType = require('./helpers/isBsonType');
 
 const defaultMongooseSymbol = Symbol.for('mongoose:default');
 
@@ -995,8 +996,7 @@ Mongoose.prototype.isValidObjectId = function(v) {
  */
 
 Mongoose.prototype.isObjectIdOrHexString = function(v) {
-  const _mongoose = this instanceof Mongoose ? this : mongoose;
-  return v instanceof _mongoose.Types.ObjectId || (typeof v === 'string' && objectIdHexRegexp.test(v));
+  return isBsonType(v, 'ObjectID') || (typeof v === 'string' && objectIdHexRegexp.test(v));
 };
 
 /**

package/lib/schema/decimal128.js

@@ -6,9 +6,9 @@
 
 const SchemaType = require('../schematype');
 const CastError = SchemaType.CastError;
-const Decimal128Type = require('../types/decimal128');
 const castDecimal128 = require('../cast/decimal128');
 const utils = require('../utils');
+const isBsonType = require('../helpers/isBsonType');
 
 /**
  * Decimal128 SchemaType constructor.
@@ -105,7 +105,7 @@ Decimal128.cast = function cast(caster) {
  */
 
 Decimal128._defaultCaster = v => {
-  if (v != null && !(v instanceof Decimal128Type)) {
+  if (v != null && !isBsonType(v, 'Decimal128')) {
     throw new Error();
   }
   return v;
@@ -115,7 +115,7 @@ Decimal128._defaultCaster = v => {
  * ignore
  */
 
-Decimal128._checkRequired = v => v instanceof Decimal128Type;
+Decimal128._checkRequired = v => isBsonType(v, 'Decimal128');
 
 /**
  * Override the function the required validator uses to check whether a string
@@ -164,7 +164,7 @@ Decimal128.prototype.checkRequired = function checkRequired(value, doc) {
 
 Decimal128.prototype.cast = function(value, doc, init) {
   if (SchemaType._isRef(this, value, doc, init)) {
-    if (value instanceof Decimal128Type) {
+    if (isBsonType(value, 'Decimal128')) {
       return value;
     }
 

package/lib/schema/string.js

@@ -4,12 +4,12 @@
  * Module dependencies.
  */
 
-const { BSONRegExp } = require('bson');
 const SchemaType = require('../schematype');
 const MongooseError = require('../error/index');
 const SchemaStringOptions = require('../options/SchemaStringOptions');
 const castString = require('../cast/string');
 const utils = require('../utils');
+const isBsonType = require('../helpers/isBsonType');
 
 const CastError = SchemaType.CastError;
 
@@ -677,7 +677,7 @@ SchemaString.prototype.castForQuery = function($conditional, val) {
     return handler.call(this, val);
   }
   val = $conditional;
-  if (Object.prototype.toString.call(val) === '[object RegExp]' || val instanceof BSONRegExp) {
+  if (Object.prototype.toString.call(val) === '[object RegExp]' || isBsonType(val, 'BSONRegExp')) {
     return val;
   }
 

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

@@ -2,11 +2,11 @@
 
 const ArrayMethods = require('../../array/methods');
 const Document = require('../../../document');
-const ObjectId = require('../../objectid');
 const castObjectId = require('../../../cast/objectid');
 const getDiscriminatorByValue = require('../../../helpers/discriminator/getDiscriminatorByValue');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
 const arrayPathSymbol = require('../../../helpers/symbols').arrayPathSymbol;
@@ -66,7 +66,7 @@ const methods = {
     // only objects are permitted so we can safely assume that
     // non-objects are to be interpreted as _id
     if (Buffer.isBuffer(value) ||
-        value instanceof ObjectId || !utils.isObject(value)) {
+        isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
       value = { _id: value };
     }
 
@@ -134,7 +134,7 @@ const methods = {
         if (sid == _id._id) {
           return val;
         }
-      } else if (!(id instanceof ObjectId) && !(_id instanceof ObjectId)) {
+      } else if (!isBsonType(id, 'ObjectID') && !isBsonType(_id, 'ObjectID')) {
         if (id == _id || utils.deepEqual(id, _id)) {
           return val;
         }

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

@@ -3,10 +3,10 @@
 const Document = require('../../../document');
 const ArraySubdocument = require('../../ArraySubdocument');
 const MongooseError = require('../../../error/mongooseError');
-const ObjectId = require('../../objectid');
 const cleanModifiedSubpaths = require('../../../helpers/document/cleanModifiedSubpaths');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayAtomicsSymbol = require('../../../helpers/symbols').arrayAtomicsSymbol;
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
@@ -227,7 +227,7 @@ const methods = {
       // only objects are permitted so we can safely assume that
       // non-objects are to be interpreted as _id
       if (Buffer.isBuffer(value) ||
-          value instanceof ObjectId || !utils.isObject(value)) {
+          isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
         value = { _id: value };
       }
 
@@ -469,7 +469,7 @@ const methods = {
    */
 
   indexOf(obj, fromIndex) {
-    if (obj instanceof ObjectId) {
+    if (isBsonType(obj, 'ObjectID')) {
       obj = obj.toString();
     }
 

package/lib/types/map.js

@@ -1,13 +1,13 @@
 'use strict';
 
 const Mixed = require('../schema/mixed');
-const ObjectId = require('./objectid');
 const clone = require('../helpers/clone');
 const deepEqual = require('../utils').deepEqual;
 const getConstructorName = require('../helpers/getConstructorName');
 const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const util = require('util');
 const specialProperties = require('../helpers/specialProperties');
+const isBsonType = require('../helpers/isBsonType');
 
 const populateModelSymbol = require('../helpers/symbols').populateModelSymbol;
 
@@ -43,7 +43,7 @@ class MongooseMap extends Map {
   }
 
   get(key, options) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -55,7 +55,7 @@ class MongooseMap extends Map {
   }
 
   set(key, value) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -117,7 +117,7 @@ class MongooseMap extends Map {
   }
 
   delete(key) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 

package/lib/utils.js

@@ -6,7 +6,6 @@
 
 const ms = require('ms');
 const mpath = require('mpath');
-const Decimal = require('./types/decimal128');
 const ObjectId = require('./types/objectid');
 const PopulateOptions = require('./options/PopulateOptions');
 const clone = require('./helpers/clone');
@@ -307,7 +306,7 @@ exports.merge = function merge(to, from, options, path) {
             to[key] = from[key].clone();
           }
           continue;
-        } else if (from[key] instanceof ObjectId) {
+        } else if (isBsonType(from[key], 'ObjectID')) {
           to[key] = new ObjectId(from[key]);
           continue;
         }
@@ -481,7 +480,7 @@ exports.tick = function tick(callback) {
  */
 
 exports.isMongooseType = function(v) {
-  return v instanceof ObjectId || v instanceof Decimal || v instanceof Buffer;
+  return isBsonType(v, 'ObjectID') || isBsonType(v, 'Decimal128') || v instanceof Buffer;
 };
 
 exports.isMongooseObject = isMongooseObject;
@@ -795,7 +794,7 @@ exports.array.unique = function(arr) {
       }
       ret.push(item);
       primitives.add(item);
-    } else if (item instanceof ObjectId) {
+    } else if (isBsonType(item, 'ObjectID')) {
       if (ids.has(item.toString())) {
         continue;
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.4",
+  "version": "6.3.5",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -61,6 +61,7 @@
     "serve-handler": "6.1.3",
     "sinon": "13.0.2",
     "stream-browserify": "3.0.0",
+    "ts-benchmark": "^1.0.2",
     "tsd": "0.20.0",
     "typescript": "4.6.4",
     "uuid": "8.3.2",
@@ -97,7 +98,9 @@
     "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"
+    "test-coverage": "nyc --reporter=html --reporter=text npm test",
+    "ts-benchmark": "ts-benchmark -p ./benchmarks/typescript/simple -f 17 18 29 32",
+    "ts-benchmark-watch": "ts-benchmark -p ./benchmarks/typescript/simple -w ./types -i -s -f 17 18 29 32 -b master"
   },
   "main": "./index.js",
   "types": "./types/index.d.ts",

package/types/aggregate.d.ts

@@ -1,7 +1,8 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  interface AggregateOptions {
+  interface AggregateOptions extends
+    SessionOption {
     /**
      * If true, the MongoDB server will use the hard drive to store data during this aggregation.
      */
@@ -56,8 +57,6 @@ declare module 'mongoose' {
      * The preferred read preference.
      */
     readPreference?: mongodb.ReadPreferenceLike;
-    /** The ClientSession for this aggregation */
-    session?: mongodb.ClientSession;
     /**
      * Specifies the write concern.
      */
@@ -65,7 +64,7 @@ declare module 'mongoose' {
     [key: string]: any;
   }
 
-  class Aggregate<R> {
+  class Aggregate<R> implements SessionOperation {
     /**
      * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
      * You do not need to call this function explicitly, the JavaScript runtime

package/types/callback.d.ts

@@ -0,0 +1,8 @@
+declare module 'mongoose' {
+  type CallbackError = NativeError | null;
+
+  type Callback<T = any> = (error: CallbackError, result: T) => void;
+
+  type CallbackWithoutResult = (error: CallbackError) => void;
+  type CallbackWithoutResultAndOptionalError = (error?: CallbackError) => void;
+}

package/types/collection.d.ts

@@ -0,0 +1,46 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /*
+   * section collection.js
+   * http://mongoosejs.com/docs/api.html#collection-js
+   */
+  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.
+     */
+    ensureIndex(...args: any[]): any;
+    findAndModify(...args: any[]): any;
+    getIndexes(...args: any[]): any;
+
+    /** The collection name */
+    collectionName: string;
+    /** The Connection instance */
+    conn: Connection;
+    /** The collection name */
+    name: string;
+  }
+
+  /*
+   * section drivers/node-mongodb-native/collection.js
+   * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-collection-js
+   */
+  interface Collection<T extends mongodb.Document = mongodb.Document> extends CollectionBase<T> {
+    /**
+     * Collection constructor
+     * @param name name of the collection
+     * @param conn A MongooseConnection instance
+     * @param opts optional collection options
+     */
+    // eslint-disable-next-line @typescript-eslint/no-misused-new
+    new(name: string, conn: Connection, opts?: any): Collection<T>;
+    /** Formatter for debug print args */
+    $format(arg: any, color?: boolean, shell?: boolean): string;
+    /** Debug print helper */
+    $print(name: string, i: string | number, args: any[], color?: boolean, shell?: boolean): void;
+    /** Retrieves information about this collections indexes. */
+    getIndexes(): ReturnType<mongodb.Collection<T>['indexInformation']>;
+  }
+  let Collection: Collection;
+}