The MongoDB Node.js team is pleased to announce version 6.11.0 of the mongodb package!
Release Notes
Client Side Operations Timeout (CSOT)
We've been working hard to try to simplify how setting timeouts works in the driver and are excited to finally put Client Side Operation Timeouts (CSOT) in your hands! We're looking forward to hearing your feedback on this new feature during its trial period in the driver, so feel free to file Improvements, Questions or Bug reports on our Jira Project or leave comments on this community forum thread: Node.js Driver 6.11 Forum Discussion!
CSOT is the common drivers solution for timing out the execution of an operation at the different stages of an operation's lifetime. At its simplest, CSOT allows you to specify one option,timeoutMS that determines when the driver will interrupt an operation and return a timeout error.
For example, when executing a potentially long-running query, you would specify timeoutMS as follows:
await collection.find({}, {timeoutMS: 600_000}).toArray(); // Ensures that the find will throw a timeout error if all documents are not retrieved within 10 minutes
// Potential Stack trace if this were to time out:
// Uncaught MongoOperationTimeoutError: Timed out during socket read (600000ms)
// at Connection.readMany (mongodb/lib/cmap/connection.js:427:31)
// at async Connection.sendWire (mongodb/lib/cmap/connection.js:246:30)
// at async Connection.sendCommand (mongodb/lib/cmap/connection.js:281:24)
// at async Connection.command (mongodb/lib/cmap/connection.js:323:26)
// at async Server.command (mongodb/lib/sdam/server.js:170:29)
// at async GetMoreOperation.execute (mongodb/lib/operations/get_more.js:58:16)
// at async tryOperation (mongodb/lib/operations/execute_operation.js:203:20)
// at async executeOperation (mongodb/lib/operations/execute_operation.js:73:16)
// at async FindCursor.getMore (mongodb/lib/cursor/abstract_cursor.js:590:16)
[!WARNING]
This feature is experimental and subject to change at any time. We do not recommend using this feature in production applications until it is stable.
What's new?
timeoutMS
The main new option introduced with CSOT is the timeoutMS option. This option can be applied directly as a client option, as well as at the database, collection, session, transaction and operation layers, following the same inheritance behaviours as other driver options.
When the timeoutMS option is specified, it will always take precedence over the following options:
socketTimeoutMS
waitQueueTimeoutMS
wTimeoutMS
maxTimeMS
maxCommitTimeMS
Note, however that timeoutMSDOES NOT unconditionally override the serverSelectionTimeoutMS option.
When timeoutMS is specified, the duration of time allotted to the server selection and connection checkout portions of command execution is defined by min(serverSelectionTimeoutMS, timeoutMS) if both are >0. A zero value for either timeout value represents an infinite timeout. A finite timeout will always be used unless both timeouts are specified as 0. Note also that the driver has a default value for serverSelectionTimeoutMS of 30000.
After server selection and connection checkout are complete, the time remaining bounds the execution of the remainder of the operation.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps mongodb from 6.9.0 to 6.11.0.
Release notes
Sourced from mongodb's releases.
... (truncated)
Changelog
Sourced from mongodb's changelog.
... (truncated)
Commits
122421dchore(main): release 6.11.0 [skip-ci] (#4317)b9bba0fci(NODE-6557): Add Node.js 22 to support matrix (#4330)1673748chore(NODE-6565): add dependabot for github actions (#4331)a0431f0chore(NODE-6426): update saslprep dependency to 1.1.9 (#4327)adb15fefeat(NODE-6551): update bson to 6.10.0 (#4329)06a2e2cfix(NODE-6469): pool is cleared before connection checkin on error (#4296)aa986f8ci(NODE-6405): stop mongo orchestration in post task (#4328)1320ad8chore(NODE-6488): specify target=es2021 for ts compilation tests (#4303)691cbbbtest(NODE-5722): unpin on endSessions test (#4326)20564f7refactor(NODE-6524): consolidate socket timeout calculation (#4320)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show