feat(index+connection): support setting global and connection-level `…

…maxTimeMS`

Fix #4066

lib/aggregate.js

@@ -6,6 +6,7 @@
 
 const AggregationCursor = require('./cursor/AggregationCursor');
 const Query = require('./query');
+const applyGlobalMaxTimeMS = require('./helpers/query/applyGlobalMaxTimeMS');
 const util = require('util');
 const utils = require('./utils');
 const read = Query.prototype.read;
@@ -932,6 +933,8 @@ Aggregate.prototype.exec = function(callback) {
   const pipeline = this._pipeline;
   const collection = this._model.collection;
 
+  applyGlobalMaxTimeMS(this.options, model);
+
   if (this.options && this.options.cursor) {
     return new AggregationCursor(this);
   }

lib/connection.js

@@ -119,6 +119,48 @@ Object.defineProperty(Connection.prototype, 'readyState', {
   }
 });
 
+/**
+ * Gets the value of the option `key`. Equivalent to `conn.options[key]`
+ *
+ * ####Example:
+ *
+ *     conn.get('test'); // returns the 'test' value
+ *
+ * @param {String} key
+ * @method get
+ * @api public
+ */
+
+Connection.prototype.get = function(key) {
+  return get(this.options, key);
+};
+
+/**
+ * Sets the value of the option `key`. Equivalent to `conn.options[key] = val`
+ *
+ * Supported options include:
+ *
+ * - `maxTimeMS`: Set [`maxTimeMS`](/docs/api.html#query_Query-maxTimeMS) for all queries on this connection.
+ * - `useFindAndModify`: Set to `false` to work around the [`findAndModify()` deprecation warning](/docs/deprecations.html#-findandmodify-)
+ *
+ * ####Example:
+ *
+ *     conn.set('test', 'foo');
+ *     conn.get('test'); // 'foo'
+ *     conn.options.test; // 'foo'
+ *
+ * @param {String} key
+ * @param {Any} val
+ * @method set
+ * @api public
+ */
+
+Connection.prototype.set = function(key, val) {
+  this.options = this.options || {};
+  this.options[key] = val;
+  return val;
+};
+
 /**
  * A hash of the collections associated with this connection
  *

lib/helpers/query/applyGlobalMaxTimeMS.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const utils = require('../../utils');
+
+module.exports = function applyGlobalMaxTimeMS(options, model) {
+  if (utils.hasUserDefinedProperty(options, 'maxTimeMS')) {
+    return;
+  }
+
+  if (utils.hasUserDefinedProperty(model.db.options, 'maxTimeMS')) {
+    options.maxTimeMS = model.db.options.maxTimeMS;
+  } else if (utils.hasUserDefinedProperty(model.base.options, 'maxTimeMS')) {
+    options.maxTimeMS = model.base.options.maxTimeMS;
+  }
+};

lib/query.js

@@ -11,6 +11,7 @@ const MongooseError = require('./error/mongooseError');
 const ObjectParameterError = require('./error/objectParameter');
 const QueryCursor = require('./cursor/QueryCursor');
 const ReadPreference = require('./driver').get().ReadPreference;
+const applyGlobalMaxTimeMS = require('./helpers/query/applyGlobalMaxTimeMS');
 const applyWriteConcern = require('./helpers/schema/applyWriteConcern');
 const cast = require('./cast');
 const castArrayFilters = require('./helpers/update/castArrayFilters');
@@ -1823,6 +1824,8 @@ Query.prototype._find = wrapThunk(function(callback) {
   const _this = this;
   const userProvidedFields = _this._userProvidedFields || {};
 
+  applyGlobalMaxTimeMS(this.options, this.model);
+
   // Separate options to pass down to `completeMany()` in case we need to
   // set a session on the document
   const completeManyOptions = Object.assign({}, {
@@ -2042,6 +2045,8 @@ Query.prototype._findOne = wrapThunk(function(callback) {
   this._applyPaths();
   this._fields = this._castFields(this._fields);
 
+  applyGlobalMaxTimeMS(this.options, this.model);
+
   // don't pass in the conditions because we already merged them in
   Query.base.findOne.call(this, {}, (err, doc) => {
     if (err) {

test/query.test.js

@@ -3396,6 +3396,38 @@ describe('Query', function() {
     });
   });
 
+  it('connection-level maxTimeMS() (gh-4066)', function() {
+    db.options = db.options || {};
+    db.options.maxTimeMS = 10;
+    const Model = db.model('gh4066_conn', new Schema({}));
+
+    return co(function*() {
+      yield Model.create({});
+
+      const res = yield Model.find({ $where: 'sleep(250) || true' }).
+        then(() => null, err => err);
+      assert.ok(res);
+      assert.ok(res.message.indexOf('time limit') !== -1, res.message);
+      delete db.options.maxTimeMS;
+    });
+  });
+
+  it('mongoose-level maxTimeMS() (gh-4066)', function() {
+    db.base.options = db.base.options || {};
+    db.base.options.maxTimeMS = 10;
+    const Model = db.model('gh4066_global', new Schema({}));
+
+    return co(function*() {
+      yield Model.create({});
+
+      const res = yield Model.find({ $where: 'sleep(250) || true' }).
+        then(() => null, err => err);
+      assert.ok(res);
+      assert.ok(res.message.indexOf('time limit') !== -1, res.message);
+      delete db.options.maxTimeMS;
+    });
+  });
+
   it('throws error with updateOne() and overwrite (gh-7475)', function() {
     const Model = db.model('gh7475', new Schema({ name: String }));