mongoose 8.10.0 → 8.10.1

package/lib/connection.js

@@ -818,32 +818,41 @@ Connection.prototype.dropCollection = async function dropCollection(collection)
 /**
  * Waits for connection to be established, so the connection has a `client`
  *
+ * @param {Boolean} [noTimeout=false] if set, don't put a timeout on the operation. Used internally so `mongoose.model()` doesn't leave open handles.
  * @return Promise
  * @api private
  */
 
-Connection.prototype._waitForConnect = async function _waitForConnect() {
+Connection.prototype._waitForConnect = async function _waitForConnect(noTimeout) {
   if ((this.readyState === STATES.connecting || this.readyState === STATES.disconnected) && this._shouldBufferCommands()) {
     const bufferTimeoutMS = this._getBufferTimeoutMS();
     let timeout = null;
     let timedOut = false;
     // The element that this function pushes onto `_queue`, stored to make it easy to remove later
     const queueElement = {};
-    await Promise.race([
-      new Promise(resolve => {
-        queueElement.fn = resolve;
-        this._queue.push(queueElement);
-      }),
-      new Promise(resolve => {
-        timeout = setTimeout(
-          () => {
-            timedOut = true;
-            resolve();
-          },
-          bufferTimeoutMS
-        );
-      })
-    ]);
+
+    // Mongoose executes all elements in `_queue` when initial connection succeeds in `onOpen()`.
+    const waitForConnectPromise = new Promise(resolve => {
+      queueElement.fn = resolve;
+      this._queue.push(queueElement);
+    });
+
+    if (noTimeout) {
+      await waitForConnectPromise;
+    } else {
+      await Promise.race([
+        waitForConnectPromise,
+        new Promise(resolve => {
+          timeout = setTimeout(
+            () => {
+              timedOut = true;
+              resolve();
+            },
+            bufferTimeoutMS
+          );
+        })
+      ]);
+    }
 
     if (timedOut) {
       const index = this._queue.indexOf(queueElement);

package/lib/document.js

@@ -741,15 +741,10 @@ function init(self, obj, doc, opts, prefix) {
   let schemaType;
   let path;
   let i;
-  let index = 0;
   const strict = self.$__.strictMode;
   const docSchema = self.$__schema;
 
-  while (index < len) {
-    _init(index++);
-  }
-
-  function _init(index) {
+  for (let index = 0; index < len; ++index) {
     i = keys[index];
     // avoid prototype pollution
     if (i === '__proto__' || i === 'constructor') {
@@ -3558,8 +3553,10 @@ Document.prototype.$__undoReset = function $__undoReset() {
     }
   }
 
-  for (const subdoc of this.$getAllSubdocs()) {
-    subdoc.$__undoReset();
+  if (!this.$isSubdocument) {
+    for (const subdoc of this.$getAllSubdocs()) {
+      subdoc.$__undoReset();
+    }
   }
 };
 

package/lib/helpers/query/castUpdate.js

@@ -82,6 +82,16 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
     schema = schema.discriminators[discriminatorValue] ||
       (byValue && byValue.schema) ||
       schema;
+  } else if (schema != null &&
+      options.overwriteDiscriminatorKey &&
+      obj.$set != null &&
+      utils.hasUserDefinedProperty(obj.$set, schema.options.discriminatorKey) &&
+      schema.discriminators != null) {
+    const discriminatorValue = obj.$set[schema.options.discriminatorKey];
+    const byValue = getDiscriminatorByValue(context.model.discriminators, discriminatorValue);
+    schema = schema.discriminators[discriminatorValue] ||
+      (byValue && byValue.schema) ||
+      schema;
   }
 
   if (options.upsert) {

package/lib/model.js

@@ -1103,16 +1103,28 @@ Model.init = function init() {
     return results;
   };
   const _createCollection = async() => {
-    await conn._waitForConnect();
-    const autoCreate = utils.getOption(
+    let autoCreate = utils.getOption(
       'autoCreate',
       this.schema.options,
-      conn.config,
-      conn.base.options
+      conn.config
+      // No base.options here because we don't want to take the base value if the connection hasn't
+      // set it yet
     );
+    if (autoCreate == null) {
+      // `autoCreate` may later be set when the connection is opened, so wait for connect before checking
+      await conn._waitForConnect(true);
+      autoCreate = utils.getOption(
+        'autoCreate',
+        this.schema.options,
+        conn.config,
+        conn.base.options
+      );
+    }
+
     if (!autoCreate) {
       return;
     }
+
     return await this.createCollection();
   };
 

package/lib/query.js

@@ -65,6 +65,25 @@ const queryOptionMethods = new Set([
   'wtimeout'
 ]);
 
+// Map from operation name to the name of the function that executes the actual operation against MongoDB.
+// Called a thunk for legacy reasons, "thunk" means function that takes exactly 1 param, a callback.
+// Currently `_countDocuments()`, etc. are async functions that take no params.
+const opToThunk = new Map([
+  ['countDocuments', '_countDocuments'],
+  ['distinct', '__distinct'],
+  ['estimatedDocumentCount', '_estimatedDocumentCount'],
+  ['find', '_find'],
+  ['findOne', '_findOne'],
+  ['findOneAndReplace', '_findOneAndReplace'],
+  ['findOneAndUpdate', '_findOneAndUpdate'],
+  ['replaceOne', '_replaceOne'],
+  ['updateMany', '_updateMany'],
+  ['updateOne', '_updateOne'],
+  ['deleteMany', '_deleteMany'],
+  ['deleteOne', '_deleteOne'],
+  ['findOneAndDelete', '_findOneAndDelete']
+]);
+
 /**
  * Query constructor used for building queries. You do not need
  * to instantiate a `Query` directly. Instead use Model functions like
@@ -2337,18 +2356,17 @@ Query.prototype._find = async function _find() {
   }
 
   const mongooseOptions = this._mongooseOptions;
-  const _this = this;
-  const userProvidedFields = _this._userProvidedFields || {};
+  const userProvidedFields = this._userProvidedFields || {};
 
   applyGlobalMaxTimeMS(this.options, this.model.db.options, this.model.base.options);
   applyGlobalDiskUse(this.options, this.model.db.options, this.model.base.options);
 
   // Separate options to pass down to `completeMany()` in case we need to
   // set a session on the document
-  const completeManyOptions = Object.assign({}, {
+  const completeManyOptions = {
     session: this && this.options && this.options.session || null,
     lean: mongooseOptions.lean || null
-  });
+  };
 
   const options = this._optionsForExec();
 
@@ -2366,7 +2384,7 @@ Query.prototype._find = async function _find() {
   }
 
   if (!mongooseOptions.populate) {
-    const versionKey = _this.schema.options.versionKey;
+    const versionKey = this.schema.options.versionKey;
     if (mongooseOptions.lean && mongooseOptions.lean.versionKey === false && versionKey) {
       docs.forEach((doc) => {
         if (versionKey in doc) {
@@ -2375,17 +2393,17 @@ Query.prototype._find = async function _find() {
       });
     }
     return mongooseOptions.lean ?
-      _completeManyLean(_this.model.schema, docs, null, completeManyOptions) :
-      _this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
+      _completeManyLean(this.model.schema, docs, null, completeManyOptions) :
+      this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
   }
 
-  const pop = helpers.preparePopulationOptionsMQ(_this, mongooseOptions);
+  const pop = helpers.preparePopulationOptionsMQ(this, mongooseOptions);
 
   if (mongooseOptions.lean) {
-    return _this.model.populate(docs, pop);
+    return this.model.populate(docs, pop);
   }
 
-  docs = await _this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
+  docs = await this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
   await this.model.populate(docs, pop);
 
   return docs;
@@ -4397,22 +4415,14 @@ Query.prototype.exec = async function exec(op) {
   if (this.model == null) {
     throw new MongooseError('Query must have an associated model before executing');
   }
-  this._validateOp();
-
-  if (!this.op) {
-    return;
-  }
 
-  if (this.options && this.options.sort) {
-    const keys = Object.keys(this.options.sort);
-    if (keys.includes('')) {
-      throw new Error('Invalid field "" passed to sort()');
-    }
+  const thunk = opToThunk.get(this.op);
+  if (!thunk) {
+    throw new MongooseError('Query has invalid `op`: "' + this.op + '"');
   }
 
-  let thunk = '_' + this.op;
-  if (this.op === 'distinct') {
-    thunk = '__distinct';
+  if (this.options && this.options.sort && typeof this.options.sort === 'object' && this.options.sort.hasOwnProperty('')) {
+    throw new Error('Invalid field "" passed to sort()');
   }
 
   if (this._executionStack != null) {

package/lib/schema/map.js

@@ -91,14 +91,7 @@ class SchemaMap extends SchemaType {
 
     const isRequired = this.options.required && typeof this.options.required !== 'function';
     const result = createJSONSchemaTypeDefinition('object', 'object', useBsonType, isRequired);
-
-    if (embeddedSchemaType.schema) {
-      result.additionalProperties = useBsonType
-        ? { ...embeddedSchemaType.toJSONSchema(options) }
-        : { ...embeddedSchemaType.toJSONSchema(options) };
-    } else {
-      result.additionalProperties = embeddedSchemaType.toJSONSchema(options);
-    }
+    result.additionalProperties = embeddedSchemaType.toJSONSchema(options);
 
     return result;
   }

package/lib/schema.js

@@ -1118,6 +1118,9 @@ Schema.prototype.path = function(path, obj) {
   this.paths[path] = this.interpretAsType(path, obj, this.options);
   const schemaType = this.paths[path];
 
+  // If overwriting an existing path, make sure to clear the childSchemas
+  this.childSchemas = this.childSchemas.filter(childSchema => childSchema.path !== path);
+
   if (schemaType.$isSchemaMap) {
     // Maps can have arbitrary keys, so `$*` is internal shorthand for "any key"
     // The '$' is to imply this path should never be stored in MongoDB so we

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.10.0",
+  "version": "8.10.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",

package/types/index.d.ts

@@ -273,10 +273,10 @@ declare module 'mongoose' {
     /**
      * Create a new schema
      */
-    constructor(definition?: SchemaDefinition<SchemaDefinitionType<RawDocType>, RawDocType> | DocType, options?: SchemaOptions<FlatRecord<DocType>, TInstanceMethods, TQueryHelpers, TStaticMethods, TVirtuals, THydratedDocumentType> | ResolveSchemaOptions<TSchemaOptions>);
+    constructor(definition?: SchemaDefinition<SchemaDefinitionType<RawDocType>, RawDocType, THydratedDocumentType> | DocType, options?: SchemaOptions<FlatRecord<DocType>, TInstanceMethods, TQueryHelpers, TStaticMethods, TVirtuals, THydratedDocumentType> | ResolveSchemaOptions<TSchemaOptions>);
 
     /** Adds key path / schema type pairs to this schema. */
-    add(obj: SchemaDefinition<SchemaDefinitionType<RawDocType>> | Schema, prefix?: string): this;
+    add(obj: SchemaDefinition<SchemaDefinitionType<RawDocType>, RawDocType> | Schema, prefix?: string): this;
 
     /**
      * Add an alias for `path`. This means getting or setting the `alias`
@@ -297,7 +297,7 @@ declare module 'mongoose' {
     /** Returns a copy of this schema */
     clone<T = this>(): T;
 
-    discriminator<DisSchema = Schema>(name: string | number, schema: DisSchema): this;
+    discriminator<DisSchema = Schema>(name: string | number, schema: DisSchema, options?: DiscriminatorOptions): this;
 
     /** Returns a new schema that has the picked `paths` from this schema. */
     pick<T = this>(paths: string[], options?: SchemaOptions): T;
@@ -541,21 +541,21 @@ declare module 'mongoose' {
           ? DateSchemaDefinition
           : (Function | string);
 
-  export type SchemaDefinitionProperty<T = undefined, EnforcedDocType = any> = SchemaDefinitionWithBuiltInClass<T> |
-  SchemaTypeOptions<T extends undefined ? any : T, EnforcedDocType> |
-    typeof SchemaType |
-  Schema<any, any, any> |
-  Schema<any, any, any>[] |
-  SchemaTypeOptions<T extends undefined ? any : Unpacked<T>, EnforcedDocType>[] |
-  Function[] |
-  SchemaDefinition<T, EnforcedDocType> |
-  SchemaDefinition<Unpacked<T>, EnforcedDocType>[] |
-    typeof Schema.Types.Mixed |
-  MixedSchemaTypeOptions<EnforcedDocType>;
-
-  export type SchemaDefinition<T = undefined, EnforcedDocType = any> = T extends undefined
+  export type SchemaDefinitionProperty<T = undefined, EnforcedDocType = any, THydratedDocumentType = HydratedDocument<EnforcedDocType>> = SchemaDefinitionWithBuiltInClass<T>
+    | SchemaTypeOptions<T extends undefined ? any : T, EnforcedDocType, THydratedDocumentType>
+    | typeof SchemaType
+    | Schema<any, any, any>
+    | Schema<any, any, any>[]
+    | SchemaTypeOptions<T extends undefined ? any : Unpacked<T>, EnforcedDocType, THydratedDocumentType>[]
+    | Function[]
+    | SchemaDefinition<T, EnforcedDocType, THydratedDocumentType>
+    | SchemaDefinition<Unpacked<T>, EnforcedDocType, THydratedDocumentType>[]
+    | typeof Schema.Types.Mixed
+    | MixedSchemaTypeOptions<EnforcedDocType>;
+
+  export type SchemaDefinition<T = undefined, EnforcedDocType = any, THydratedDocumentType = HydratedDocument<EnforcedDocType>> = T extends undefined
     ? { [path: string]: SchemaDefinitionProperty; }
-    : { [path in keyof T]?: SchemaDefinitionProperty<T[path], EnforcedDocType>; };
+    : { [path in keyof T]?: SchemaDefinitionProperty<T[path], EnforcedDocType, THydratedDocumentType>; };
 
   export type AnyArray<T> = T[] | ReadonlyArray<T>;
   export type ExtractMongooseArray<T> = T extends Types.Array<any> ? AnyArray<Unpacked<T>> : T;

package/types/schematypes.d.ts

@@ -56,7 +56,7 @@ declare module 'mongoose' {
 
   type DefaultType<T> = T extends Schema.Types.Mixed ? any : Partial<ExtractMongooseArray<T>>;
 
-  class SchemaTypeOptions<T, EnforcedDocType = any> {
+  class SchemaTypeOptions<T, EnforcedDocType = any, THydratedDocumentType = HydratedDocument<EnforcedDocType>> {
     type?:
     T extends string ? StringSchemaDefinition :
       T extends number ? NumberSchemaDefinition :
@@ -65,19 +65,19 @@ declare module 'mongoose' {
             T extends Map<any, any> ? SchemaDefinition<typeof Map> :
               T extends Buffer ? SchemaDefinition<typeof Buffer> :
                 T extends Types.ObjectId ? ObjectIdSchemaDefinition :
-                  T extends Types.ObjectId[] ? AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId, EnforcedDocType>> :
-                    T extends object[] ? (AnyArray<Schema<any, any, any>> | AnyArray<SchemaDefinition<Unpacked<T>>> | AnyArray<SchemaTypeOptions<Unpacked<T>, EnforcedDocType>>) :
-                      T extends string[] ? AnyArray<StringSchemaDefinition> | AnyArray<SchemaTypeOptions<string, EnforcedDocType>> :
-                        T extends number[] ? AnyArray<NumberSchemaDefinition> | AnyArray<SchemaTypeOptions<number, EnforcedDocType>> :
-                          T extends boolean[] ? AnyArray<BooleanSchemaDefinition> | AnyArray<SchemaTypeOptions<boolean, EnforcedDocType>> :
-                            T extends Function[] ? AnyArray<Function | string> | AnyArray<SchemaTypeOptions<Unpacked<T>, EnforcedDocType>> :
+                  T extends Types.ObjectId[] ? AnyArray<ObjectIdSchemaDefinition> | AnyArray<SchemaTypeOptions<ObjectId, EnforcedDocType, THydratedDocumentType>> :
+                    T extends object[] ? (AnyArray<Schema<any, any, any>> | AnyArray<SchemaDefinition<Unpacked<T>>> | AnyArray<SchemaTypeOptions<Unpacked<T>, EnforcedDocType, THydratedDocumentType>>) :
+                      T extends string[] ? AnyArray<StringSchemaDefinition> | AnyArray<SchemaTypeOptions<string, EnforcedDocType, THydratedDocumentType>> :
+                        T extends number[] ? AnyArray<NumberSchemaDefinition> | AnyArray<SchemaTypeOptions<number, EnforcedDocType, THydratedDocumentType>> :
+                          T extends boolean[] ? AnyArray<BooleanSchemaDefinition> | AnyArray<SchemaTypeOptions<boolean, EnforcedDocType, THydratedDocumentType>> :
+                            T extends Function[] ? AnyArray<Function | string> | AnyArray<SchemaTypeOptions<Unpacked<T>, EnforcedDocType, THydratedDocumentType>> :
                               T | typeof SchemaType | Schema<any, any, any> | SchemaDefinition<T> | Function | AnyArray<Function>;
 
     /** Defines a virtual with the given name that gets/sets this path. */
     alias?: string | string[];
 
     /** Function or object describing how to validate this schematype. See [validation docs](https://mongoosejs.com/docs/validation.html). */
-    validate?: SchemaValidator<T, EnforcedDocType> | AnyArray<SchemaValidator<T, EnforcedDocType>>;
+    validate?: SchemaValidator<T, EnforcedDocType, THydratedDocumentType> | AnyArray<SchemaValidator<T, EnforcedDocType, THydratedDocumentType>>;
 
     /** Allows overriding casting logic for this individual path. If a string, the given string overwrites Mongoose's default cast error message. */
     cast?: string |
@@ -389,10 +389,10 @@ declare module 'mongoose' {
         expires(when: number | string): this;
 
         /** Sets a maximum date validator. */
-        max(value: NativeDate, message: string): this;
+        max(value: NativeDate, message?: string): this;
 
         /** Sets a minimum date validator. */
-        min(value: NativeDate, message: string): this;
+        min(value: NativeDate, message?: string): this;
 
         /** Default options for this SchemaType */
         defaultOptions: Record<string, any>;
@@ -457,10 +457,10 @@ declare module 'mongoose' {
         enum(vals: number[]): this;
 
         /** Sets a maximum number validator. */
-        max(value: number, message: string): this;
+        max(value: number, message?: string): this;
 
         /** Sets a minimum number validator. */
-        min(value: number, message: string): this;
+        min(value: number, message?: string): this;
 
         /** Default options for this SchemaType */
         defaultOptions: Record<string, any>;

package/types/validation.d.ts

@@ -1,6 +1,11 @@
 declare module 'mongoose' {
 
-  type SchemaValidator<T, EnforcedDocType> = RegExp | [RegExp, string] | Function | [Function, string] | ValidateOpts<T, EnforcedDocType> | ValidateOpts<T, EnforcedDocType>[];
+  type SchemaValidator<T, EnforcedDocType, THydratedDocumentType> = RegExp
+    | [RegExp, string]
+    | Function
+    | [Function, string]
+    | ValidateOpts<T, THydratedDocumentType>
+    | ValidateOpts<T, THydratedDocumentType>[];
 
   interface ValidatorProps {
     path: string;