mongoose 8.1.2 → 8.2.0

package/lib/query.js

@@ -19,7 +19,6 @@ const castArrayFilters = require('./helpers/update/castArrayFilters');
 const castNumber = require('./cast/number');
 const castUpdate = require('./helpers/query/castUpdate');
 const clone = require('./helpers/clone');
-const completeMany = require('./helpers/query/completeMany');
 const getDiscriminatorByValue = require('./helpers/discriminator/getDiscriminatorByValue');
 const helpers = require('./queryHelpers');
 const immediate = require('./helpers/immediate');
@@ -40,7 +39,7 @@ const specialProperties = require('./helpers/specialProperties');
 const updateValidators = require('./helpers/updateValidators');
 const util = require('util');
 const utils = require('./utils');
-const validOps = require('./helpers/query/validOps');
+const queryMiddlewareFunctions = require('./constants').queryMiddlewareFunctions;
 
 const queryOptionMethods = new Set([
   'allowDiskUse',
@@ -457,7 +456,7 @@ Query.prototype.slice = function() {
  * ignore
  */
 
-const validOpsSet = new Set(validOps);
+const validOpsSet = new Set(queryMiddlewareFunctions);
 
 Query.prototype._validateOp = function() {
   if (this.op != null && !validOpsSet.has(this.op)) {
@@ -2233,8 +2232,8 @@ Query.prototype._find = async function _find() {
   const _this = this;
   const userProvidedFields = _this._userProvidedFields || {};
 
-  applyGlobalMaxTimeMS(this.options, this.model);
-  applyGlobalDiskUse(this.options, this.model);
+  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
@@ -2271,7 +2270,7 @@ Query.prototype._find = async function _find() {
     }
     return mongooseOptions.lean ?
       _completeManyLean(_this.model.schema, docs, null, completeManyOptions) :
-      completeMany(_this.model, docs, fields, userProvidedFields, completeManyOptions);
+      _this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
   }
   const pop = helpers.preparePopulationOptionsMQ(_this, mongooseOptions);
 
@@ -2279,7 +2278,7 @@ Query.prototype._find = async function _find() {
     return _this.model.populate(docs, pop);
   }
 
-  docs = await completeMany(_this.model, docs, fields, userProvidedFields, completeManyOptions);
+  docs = await _this._completeMany(docs, fields, userProvidedFields, completeManyOptions);
   await this.model.populate(docs, pop);
 
   return docs;
@@ -2473,6 +2472,36 @@ Query.prototype._completeOne = function(doc, res, callback) {
   });
 };
 
+/**
+ * Given a model and an array of docs, hydrates all the docs to be instances
+ * of the model. Used to initialize docs returned from the db from `find()`
+ *
+ * @param {Array} docs
+ * @param {Object} fields the projection used, including `select` from schemas
+ * @param {Object} userProvidedFields the user-specified projection
+ * @param {Object} [opts]
+ * @param {Array} [opts.populated]
+ * @param {ClientSession} [opts.session]
+ * @api private
+ */
+
+Query.prototype._completeMany = async function _completeMany(docs, fields, userProvidedFields, opts) {
+  const model = this.model;
+  return Promise.all(docs.map(doc => new Promise((resolve, reject) => {
+    const rawDoc = doc;
+    doc = helpers.createModel(model, doc, fields, userProvidedFields);
+    if (opts.session != null) {
+      doc.$session(opts.session);
+    }
+    doc.$init(rawDoc, opts, (err) => {
+      if (err != null) {
+        return reject(err);
+      }
+      resolve(doc);
+    });
+  })));
+};
+
 /**
  * Internal helper to execute a findOne() operation
  *
@@ -2488,8 +2517,8 @@ Query.prototype._findOne = async function _findOne() {
     throw err;
   }
 
-  applyGlobalMaxTimeMS(this.options, this.model);
-  applyGlobalDiskUse(this.options, this.model);
+  applyGlobalMaxTimeMS(this.options, this.model.db.options, this.model.base.options);
+  applyGlobalDiskUse(this.options, this.model.db.options, this.model.base.options);
 
   const options = this._optionsForExec();
 
@@ -2585,8 +2614,8 @@ Query.prototype._countDocuments = async function _countDocuments() {
     throw this.error();
   }
 
-  applyGlobalMaxTimeMS(this.options, this.model);
-  applyGlobalDiskUse(this.options, this.model);
+  applyGlobalMaxTimeMS(this.options, this.model.db.options, this.model.base.options);
+  applyGlobalDiskUse(this.options, this.model.db.options, this.model.base.options);
 
   const options = this._optionsForExec();
 
@@ -2754,8 +2783,8 @@ Query.prototype.__distinct = async function __distinct() {
     throw this.error();
   }
 
-  applyGlobalMaxTimeMS(this.options, this.model);
-  applyGlobalDiskUse(this.options, this.model);
+  applyGlobalMaxTimeMS(this.options, this.model.db.options, this.model.base.options);
+  applyGlobalDiskUse(this.options, this.model.db.options, this.model.base.options);
 
   const options = this._optionsForExec();
   this._applyTranslateAliases(options);
@@ -3247,8 +3276,8 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
     throw this.error();
   }
 
-  applyGlobalMaxTimeMS(this.options, this.model);
-  applyGlobalDiskUse(this.options, this.model);
+  applyGlobalMaxTimeMS(this.options, this.model.db.options, this.model.base.options);
+  applyGlobalDiskUse(this.options, this.model.db.options, this.model.base.options);
 
   if ('strict' in this.options) {
     this._mongooseOptions.strict = this.options.strict;

package/lib/schema.js

@@ -30,8 +30,7 @@ const hasNumericSubpathRegex = /\.\d+(\.|$)/;
 
 let MongooseTypes;
 
-const queryHooks = require('./helpers/query/applyQueryMiddleware').
-  middlewareFunctions;
+const queryHooks = require('./constants').queryMiddlewareFunctions;
 const documentHooks = require('./helpers/model/applyHooks').middlewareFunctions;
 const hookNames = queryHooks.concat(documentHooks).
   reduce((s, hook) => s.add(hook), new Set());

package/package.json

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

package/types/connection.d.ts

@@ -240,6 +240,8 @@ declare module 'mongoose' {
 
     /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model-watch). */
     watch<ResultType extends mongodb.Document = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
+
+    withSession<T = any>(executor: (session: ClientSession) => Promise<T>): T;
   }
 
 }

package/types/index.d.ts

@@ -373,8 +373,8 @@ declare module 'mongoose' {
     // method aggregate and insertMany with ErrorHandlingMiddlewareFunction
     post<T extends Aggregate<any>>(method: 'aggregate' | RegExp, fn: ErrorHandlingMiddlewareFunction<T, Array<any>>): this;
     post<T extends Aggregate<any>>(method: 'aggregate' | RegExp, options: SchemaPostOptions, fn: ErrorHandlingMiddlewareFunction<T, Array<any>>): this;
-    post<T = TModelType>(method: 'insertMany' | RegExp, fn: ErrorHandlingMiddlewareFunction<T>): this;
-    post<T = TModelType>(method: 'insertMany' | RegExp, options: SchemaPostOptions, fn: ErrorHandlingMiddlewareFunction<T>): this;
+    post<T = TModelType>(method: 'bulkWrite' | 'createCollection' | 'insertMany' | RegExp, fn: ErrorHandlingMiddlewareFunction<T>): this;
+    post<T = TModelType>(method: 'bulkWrite' | 'createCollection' | 'insertMany' | RegExp, options: SchemaPostOptions, fn: ErrorHandlingMiddlewareFunction<T>): this;
 
     /** Defines a pre hook for the model. */
     // this = never since it never happens
@@ -429,6 +429,44 @@ declare module 'mongoose' {
         options?: InsertManyOptions & { lean?: boolean }
       ) => void | Promise<void>
     ): this;
+    /* method bulkWrite */
+    pre<T = TModelType>(
+      method: 'bulkWrite' | RegExp,
+      fn: (
+        this: T,
+        next: (err?: CallbackError) => void,
+        ops: Array<mongodb.AnyBulkWriteOperation<any> & MongooseBulkWritePerWriteOptions>,
+        options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions
+      ) => void | Promise<void>
+    ): this;
+    pre<T = TModelType>(
+      method: 'bulkWrite' | RegExp,
+      options: SchemaPreOptions,
+      fn: (
+        this: T,
+        next: (err?: CallbackError) => void,
+        ops: Array<mongodb.AnyBulkWriteOperation<any> & MongooseBulkWritePerWriteOptions>,
+        options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions
+      ) => void | Promise<void>
+    ): this;
+    /* method createCollection */
+    pre<T = TModelType>(
+      method: 'createCollection' | RegExp,
+      fn: (
+        this: T,
+        next: (err?: CallbackError) => void,
+        options?: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'>
+      ) => void | Promise<void>
+    ): this;
+    pre<T = TModelType>(
+      method: 'createCollection' | RegExp,
+      options: SchemaPreOptions,
+      fn: (
+        this: T,
+        next: (err?: CallbackError) => void,
+        options?: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'>
+      ) => void | Promise<void>
+    ): this;
 
     /** Object of currently defined query helpers on this schema. */
     query: TQueryHelpers;

package/types/models.d.ts

@@ -37,6 +37,11 @@ declare module 'mongoose' {
     skipValidation?: boolean;
   }
 
+  interface HydrateOptions {
+    setters?: boolean;
+    hydratedPopulatedDocs?: boolean;
+  }
+
   interface InsertManyOptions extends
     PopulateOption,
     SessionOption {
@@ -371,7 +376,7 @@ declare module 'mongoose' {
      * Shortcut for creating a new Document from existing raw data, pre-saved in the DB.
      * The document returned has no paths marked as modified initially.
      */
-    hydrate(obj: any, projection?: AnyObject, options?: { setters?: boolean }): THydratedDocumentType;
+    hydrate(obj: any, projection?: AnyObject, options?: HydrateOptions): THydratedDocumentType;
 
     /**
      * This function is responsible for building [indexes](https://www.mongodb.com/docs/manual/indexes/),
@@ -728,6 +733,9 @@ declare module 'mongoose' {
       options?: (mongodb.ReplaceOptions & MongooseQueryOptions<TRawDocType>) | null
     ): QueryWithHelpers<UpdateWriteOpResult, ResultDoc, TQueryHelpers, TRawDocType, 'replaceOne'>;
 
+    /** Apply changes made to this model's schema after this model was compiled. */
+    recompileSchema(): void;
+
     /** Schema the model uses. */
     schema: Schema<TRawDocType>;
 

package/lib/helpers/query/applyQueryMiddleware.js

@@ -1,54 +0,0 @@
-'use strict';
-
-/*!
- * ignore
- */
-
-module.exports = applyQueryMiddleware;
-
-const validOps = require('./validOps');
-
-/*!
- * ignore
- */
-
-applyQueryMiddleware.middlewareFunctions = validOps.concat([
-  'validate'
-]);
-
-/**
- * Apply query middleware
- *
- * @param {Query} Query constructor
- * @param {Model} model
- * @api private
- */
-
-function applyQueryMiddleware(Query, model) {
-  const queryMiddleware = model.schema.s.hooks.filter(hook => {
-    const contexts = _getContexts(hook);
-    if (hook.name === 'validate') {
-      return !!contexts.query;
-    }
-    if (hook.name === 'deleteOne' || hook.name === 'updateOne') {
-      return !!contexts.query || Object.keys(contexts).length === 0;
-    }
-    if (hook.query != null || hook.document != null) {
-      return !!hook.query;
-    }
-    return true;
-  });
-
-  Query.prototype._queryMiddleware = queryMiddleware;
-}
-
-function _getContexts(hook) {
-  const ret = {};
-  if (hook.hasOwnProperty('query')) {
-    ret.query = hook.query;
-  }
-  if (hook.hasOwnProperty('document')) {
-    ret.document = hook.document;
-  }
-  return ret;
-}

package/lib/helpers/query/completeMany.js

@@ -1,36 +0,0 @@
-'use strict';
-
-const helpers = require('../../queryHelpers');
-
-module.exports = completeMany;
-
-/**
- * Given a model and an array of docs, hydrates all the docs to be instances
- * of the model. Used to initialize docs returned from the db from `find()`
- *
- * @param {Model} model
- * @param {Array} docs
- * @param {Object} fields the projection used, including `select` from schemas
- * @param {Object} userProvidedFields the user-specified projection
- * @param {Object} [opts]
- * @param {Array} [opts.populated]
- * @param {ClientSession} [opts.session]
- * @param {Function} callback
- * @api private
- */
-
-async function completeMany(model, docs, fields, userProvidedFields, opts) {
-  return Promise.all(docs.map(doc => new Promise((resolve, reject) => {
-    const rawDoc = doc;
-    doc = helpers.createModel(model, doc, fields, userProvidedFields);
-    if (opts.session != null) {
-      doc.$session(opts.session);
-    }
-    doc.$init(rawDoc, opts, (err) => {
-      if (err != null) {
-        return reject(err);
-      }
-      resolve(doc);
-    });
-  })));
-}