Add maxTime option to all queries

[tomgrossman]

I would like to add the option for maxTime(ms) for all models queries (find, update, findOneAndUpdate, etc..).

for example:

A.findOneAndUpdate(id, updateObject, {maxTime: 1000}}, callback)

[vkarpov15]

Write a plugin, use query middleware

[tomgrossman]

Hi @vkarpov15 ,
After further investigation about this issue, it seems that this option exists, but not in the API.
I added maxTime: x to the options object in findOneAndUpdate function, and I saw that it is being converted to maxTimeMS option in the mquery.js file in this function:
Query.prototype.maxTime = function (v) (line 1359).

So it looks like this option is working, am I wrong?
it doesn't appear in the API in the available options.

[vkarpov15]

@tomgrossman yep should be working, just added it to the docs.

[tomgrossman]

@vkarpov15 So there is no need for a plugin, right? Should be closed.

[vkarpov15]

I think the original issue was "ability to set maxTimeMS for all queries" which is a task for a plugin. Adding the option to the docs is separate.

[tomgrossman]

@vkarpov15 sorry I don't understand. I said before that this option already exists but was only missing in the docs. So there is no need for a plugin. Am I wrong?

[vkarpov15]

The plugin is for setting max time ms for all queries at once, like mongoose.use(maxTimeMSPlugin(5000)) will make it so that all queries have maxTimeMS of 5000 by default. I thought that was the original use case, no?

[tomgrossman]

@vkarpov15 no, the original case was the option to add this timeout for every query. as an option.
but this is already available.

[vkarpov15]

Ok then we can close this issue :)

[santimendoza]

Hey just to know, find, findOne does not have the maxTime option? I can't see it in the documentation, neither seems to work.

[vkarpov15]

@santimendoza the option is maxTimeMS http://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#findOne we will add it to the mongoose docs

[freewil]

The plugin is for setting max time ms for all queries at once, like mongoose.use(maxTimeMSPlugin(5000)) will make it so that all queries have maxTimeMS of 5000 by default. I thought that was the original use case, no?

@vkarpov15 I was just looking to do this - would the plugin approach still be the best way to achieve global query timeouts in latest mongoose v5?

[freewil]

bump

@vkarpov15 I was just looking to do this - would the plugin approach still be the best way to achieve global query timeouts in latest mongoose v5?

[vkarpov15]

@freewil yes it would. I'm going to be writing a blog post on maxTimeMS next week that you should keep an eye out for. MaxTimeMS has some caveats

[natanavra]

@vkarpov15 Hi!
Seems docs are not updated, as Query.prototype.maxTimeMS errors with is not a function
Query.prototype.maxTime works as expected.

[vkarpov15]

@natanavra can you write a script that demonstrates this issue and clarify which version of Mongoose you're using? Here's the maxTimeMS() function in our code

[natanavra]

@vkarpov15 using Mongoose 5.0.16

Here's an example:

return await model
  .find(query, null)
  .sort(sort)
  .maxTime(constants.maxQueryMS) //maxTimeMS here does not work
  .hint(model.getHint())
  .limit(constants.maxEvents)
  .cache(10)
  .catch(err => {
     logger.warn({err}, 'events.find failed');
  });

[Fonger]

@natanavra You can't use that in mongoose 5.0.16. It was added in mongoose 5.2.6

I added maxTimeMS alias to maxTime in mquery v3.1.1, an underlying library of mongoose. This was introduced since [email protected], which used this version of mquery.

mongoosejs/mquery#105
mongoosejs/mquery@42499d3

For those who uses TypeScript, my PR for Query#maxTimeMS is awaiting to be merged DefinitelyTyped/DefinitelyTyped#35677 and will be released as @types/[email protected]

[natanavra]

@Fonger Ahh thanks for letting me know
There is not mention of it in the docs https://mongoosejs.com/docs/api.html#query_Query-maxTimeMS
And I never really accessed previous 5.x.x docs since it's usually the latest.

[GeniusBrother]

I can't find maxTimeMSPlugin, so is this just an example? @vkarpov15

[vkarpov15]

@GeniusBrother we added a global and connection level maxTimeMS option in 5.6.0.

mongoose.set('maxTimeMS', 3000);

Or:

const db = mongoose.createConnection(uri);

db.set('maxTimeMS', 3000);

[vkarpov15]

See Connection#set() and Mongoose#set()