Releases: mongodb/node-mongodb-native
v4.17.0
4.17.0 (2023-08-17)
The MongoDB Node.js team is pleased to announce version 4.17.0 of the mongodb package!
Release Notes
mongodb-js/saslprep is now installed by default
Until v6, the driver included the saslprep package as an optional dependency for SCRAM-SHA-256 authentication. saslprep breaks when bundled with webpack because it attempted to read a file relative to the package location and consequently the driver would throw errors when using SCRAM-SHA-256 if it were bundled.
The driver now depends on mongodb-js/saslprep, a fork of saslprep that can be bundled with webpack because it includes the necessary saslprep data in memory upon loading. This will be installed by default but will only be used if SCRAM-SHA-256 authentication is used.
Remove credential availability on ConnectionPoolCreatedEvent
In order to avoid mistakenly printing credentials the ConnectionPoolCreatedEvent will replace the credentials option with an empty object. The credentials are still accessble via MongoClient options: client.options.credentials.
Features
- NODE-5272: do not create or drop ecc collections (#3678) (d26ad61)
- NODE-5398: use mongodb-js/saslprep instead of saslprep (#3820) (5244711)
Bug Fixes
- NODE-5262: AWS Lambda metadata detection logic is too permissive (#3683) (c0c3d99)
- NODE-5311: construct error messages for AggregateErrors in Node16+ (#3683) (98b7bdf)
- NODE-5316: prevent parallel topology creation in MongoClient.connect (#3696) (e13038d)
- Thank you @clemclx for contributing this fix! 🎉
- NODE-5356: prevent scram auth from throwing TypeError if saslprep is not a function (#3732) (2d028af)
- NODE-5536: remove credentials from ConnectionPoolCreatedEvent options (#3812) (2910dca)
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
Contributors
Assets 2
v5.7.0
5.7.0 (2023-07-06)
The MongoDB Node.js team is pleased to announce version 5.7.0 of the mongodb package!
Release Notes
Write Concern legacy options deprecated
wtimeout, j, and fsync options have been deprecated, please use wtimeoutMS and journal instead.
Legacy SSL options deprecated
In an effort to simplify TLS setup and use with the driver we're paring down the number of custom options to the ones that are common to all drivers. This should reduce inadvertent misconfiguration due to conflicting options.
The legacy "ssl-" options have been deprecated, each has a corresponding "tls-" option listed in the table below (except for sslCRL, you may directly use the Node.js crl option instead). tlsCertificateFile has also been deprecated, please use tlsCertificateKeyFile or pass the cert directly to the MongoClient constructor.
In addition to the common driver options, the Node.js driver also passes through Node.js TLS options provided on the MongoClient to Node.js' tls.connect API, which may be convenient to reuse with other Node.js APIs.
| Node.js native option | MongoDB driver option name | legacy option name | driver option type |
|---|---|---|---|
ca |
tlsCAFile |
sslCA |
string |
crl |
N/A | sslCRL |
string |
cert |
tlsCertificateKeyFile |
sslCert |
string |
key |
tlsCertificateKeyFile |
sslKey |
string |
passphrase |
tlsCertificateKeyFilePassword |
sslPass |
string |
rejectUnauthorized |
tlsAllowInvalidCertificates |
sslValidate |
boolean |
New includeResultMetadata option for findOneAnd... family of methods.
This option defaults to true, which will return a ModifyResult type. When set to false, which will
become the default in the next major release, it will return the modified document or null if nothing matched.
This applies to findOneAndDelete, findOneAndUpdate, findOneAndReplace.
// With a document { _id: 1, a: 1 } in the collection
await collection.findOneAndDelete({ a: 1 }, { includeResultMetadata: false }); // returns { _id: 1, a: 1 }
await collection.findOneAndDelete({ a: 2 }, { includeResultMetadata: false }); // returns null
await collection.findOneAndDelete({ a: 1 }, { includeResultMetadata: true }); // returns { ok: 1, lastErrorObject: { n: 1 }, value: { _id: 1, a: 1 }}Support for change stream split events
When change stream documents exceed the max BSON size limit of 16MB, they can be split into multiple fragments in order to not error when sending events over the wire. In order to enable this functionality, the collection must be created with changeStreamPreAndPostImages enabled and the change stream itself must include an $changeStreamSplitLargeEvent aggregation stage. This feature requires a minimum server version of 7.0.0.
Example:
await db.createCollection('test', { changeStreamPreAndPostImages: { enabled: true }});
const collection = db.collection('test');
const changeStream = collection.watch([{ $changeStreamSplitLargeEvent: {} ], {
fullDocumentBeforeChange: 'required'
});
for await (const change of changeStream) {
console.log(change.splitEvent); // If changes over 16MB: { fragment: n, of: n }
}Programmatic management of search indexes
This PR adds support for managing search indexes (creating, updating, deleting and listing indexes). The new methods are available on the Collection class.
const indexes = await collection.listSearchIndexes().toArray(); // produces an array of search indexes
await collection.createSearchIndex({ name: 'my-index', definition: < index definition > } );
await collection.updateSearchIndex('my-index', < new definition >);
await collection.dropSearchIndex('my-index');BSON updated to v5.4.0
Take a look at the bson package's release notes!
Snappy loaded lazily
Unlike our other compression mechanisms snappy was loaded at the module level, meaning it would be optionally imported whether or not the driver was configured to use snappy compression. Snappy is now aligned with our other optional peer dependencies and is only loaded when enabled.
Zstd and Kerberos are now optional peer dependencies
This allows users who do not use these features to not have them installed. Users who do use these feature will now have them lazy loaded upon first use.
listDatabases nameOnly option bug fix
The listDatabases API exposes the nameOnly option which allows you to limit its output to only the names of the databases on a given mongoDB deployment:
db.admin().listDatabases({ nameOnly: true });
// [
// { name: 'local' },
// { name: 'movies' },
// ...
// ]Prior to this fix, the option was not being set properly on the command, so the output was always given in full.
Thanks to @redixhumayun for submitting this fix!
saslprep "is not a function" fix for bundled deployments
saslprep is an optional dependency used to perform Stringprep Profile for User Names and Passwords for SCRAM-SHA-256 authentication. The saslprep library breaks when it is bundled, causing the driver to throw TypeErrors.
This release includes a fix that prevents the driver throwing TypeErrors when attempting to use saslprep in bundled environments.
Cursor.map transform bug fixes
The cursor API provides the ability to apply a map function to each document in the cursor:
const cursor = collection.find({ name: 'john doe' }).map(({ name }) => name);
for await (const document of cursor) {
console.error(document); // only prints the `name` field from each document
}Cursor iteration properly catches errors thrown from the transform applied in Cursor.map
Starting in version 4.0 of the driver, if the transform function throws an error, there are certain scenarios where the driver does not correctly catch this error and an uncaught exception is thrown:
const cursor = collection.find({ name: 'john doe' }).map(() => {
throw new Error('oh no! error here'); //
});
await cursor.next(); // process crashes with uncaught errorThis release adds logic to ensure that whenever we transform a cursor document, we handle any errors properly. Any errors thrown from a transform function are caught and returned to the user.
Cursor.hasNext no longer transforms documents if a transform has been applied to the cursor
Version 4.0 introduced a bug that would apply a transform function to documents in the cursor when the cursor was iterated using Cursor.hasNext(). When combined with Cursor.next(), this would result in transforming documents multiple times.
const cursor = collection.find({ name: 'john doe' }).map((document) => document.name);
while (await cursor.hasNext()) { // this transforms the first document in the cursor once
const doc = await cursor.next(); // the second document in the cursor is transformed again
}This release removes the transform logic from Cursor.hasNext, preventing cursor documents from being transformed twice when iterated using hasNext.
Features
- NODE-5008: add zstd and kerberos to peer deps (#3691) (9561f32)
- NODE-5241: add option to return modified document (#3710) (d9c2600)
- NODE-5243: add change stream split event (#3745) (1c84f82)
- NODE-5274: deprecate write concern options (#3752) (1f880ea)
- NODE-5287: deprecate ssl options (#3743) (f9b5677)
- NODE-5319: mark search index api public (#3741) (c015e54)
- NODE-5407: update bson to 5.4.0 (#3754) (6a574cf)
Bug Fixes
- NODE-4977: load snappy lazily (#3726) ([865e658](865e658e7a341c8e9bd64...
Contributors
Assets 2
v3.7.4
c2b6da1
baileympearson
Bailey Pearson
The MongoDB Node.js team is pleased to announce version 3.7.4 of the mongodb package!
Release Highlights
This release fixes a bug that throws a type error when SCRAM-SHA-256 is used with saslprep in a webpacked environment.
3.7.4 (2023-06-21)
Bug Fixes
- NODE-3711: retry txn end on retryable write (#3047) (1595140)
- NODE-5355: prevent error when saslprep is not a function (#3733) (152425a)
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v5.6.0
The MongoDB Node.js team is pleased to announce version 5.6.0 of the mongodb package!
Release Highlights
Node 20 support
The MongoDB Node.js Driver now supports Node.js 20! 🎉
runCursorCommand API
We have added the Db#runCursorCommand method which can be used to execute generic cursor commands. This API complements the generic Db#command method.
TypeScript support for new time series options
The driver now has TypeScript support for the bucketMaxSpanSeconds and bucketRoundingSeconds options which will be available in MongoDB 7.0. You can read more about these options here.
Features
- NODE-5019: add runCursorCommand API (#3655) (4da926e)
- NODE-5071: support additional time series options (#3667) (ccf555d)
Bug Fixes
- NODE-5249: remove strict flag from create collection options (#3677) (be8faaf)
- NODE-5296: construct error messages for AggregateErrors in Node16+ (#3682) (e03178e)
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v5.5.0
ba3437d
baileympearson
Bailey Pearson
The MongoDB Node.js team is pleased to announce version 5.5.0 of the mongodb package!
Features
- NODE-4720: Add log messages to CMAP spec (#3645) (b27f385)
- NODE-5004: dont create or drop ecc collections (#3660) (2264fbb)
Bug Fixes
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v5.4.0
The MongoDB Node.js team is pleased to announce version 5.4.0 of the mongodb package!
Release Highlights
ChangeStream.tryNext Typescript fix
We have corrected the tryNext method on ChangeStream to use the TChange schema generic instead of the untyped Document interface. This may increase strictness for existing usages but aligns with the rest of the methods on the change stream class to accurately reflect the type returned from the driver.
Deprecations
The db.command() API has a number of options deprecated that were incorrectly included in the typescript interface the method reportedly accepts. A majority of the options relate to fields that must be attached to the command directly: readConcern, writeConcern, and comment.
Additionally, the collStats helper has been deprecated in favor of using database aggregations to get the same result: https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/
NOTE: This release includes some experimental features that are not yet ready for production use. As a reminder, anything marked experimental is not a part of the stable driver API and is subject to change without notice.
Features and Deprecations
- NODE-5166: bump max wire version for 7.0 (#3659) (561229b)
- NODE-4970: deprecate collStats collection helper (#3638) (325c4bc)
- NODE-5207: deprecate unsupported runCommand options and add spec tests (#3643) (d6d76b4)
Bug Fixes
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v5.3.0
The MongoDB Node.js team is pleased to announce version 5.3.0 of the mongodb package!
Features
- NODE-4696: add FaaS env information to client metadata (#3626) (0424080)
- NODE-4774: deprecate cursor forEach (#3622) (8d76a71)
- NODE-4791: deprecate duplicate bulk methods (#3623) (2839e95)
- NODE-4795: deprecate addUser helper (#3624) (53a0aae)
- NODE-5188: add alternative runtime detection to client metadata (#3636) (2a26de3)
- NODE-5189: deprecate tcp keepalive options (#3621) (cc7c75a)
Bug Fixes
- NODE-5042: relax SRV record validation to account for a dot suffix (#3633) (ad15881)
- NODE-5171: allow
upsertedIdto be null inUpdateResult(#3631) (4b5be21) - NODE-5201: prevent warning when default value for deprecation option is used (#3646) (e7f6e4e)
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v4.16.0
The MongoDB Node.js team is pleased to announce version 4.16.0 of the mongodb package!
Features
- NODE-5159: add FaaS env information to client metadata (#3639) (e0b20f1)
- NODE-5199: add alternative runtime detection to client metadata (#3647) (fba16ad)
Bug Fixes
- NODE-5161: metadata duplication in handshake (#3628) (b790142)
- NODE-5200: relax SRV record validation to account for a dot suffix (#3640) (4272c43)
Documentation
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
v5.2.0
The MongoDB Node.js team is pleased to announce version 5.2.0 of the mongodb package!
Release Highlights
This release includes driver support for automatically obtaining Azure credentials when using automatic client side encryption. You can find a tutorial for using Azure and automatic encryption here: Use Automatic Queryable Encryption with Azure
Additionally, we have a number of minor bug fixes listed below.
NOTE: This release includes some experimental features that are not yet ready for use. As a reminder, anything marked experimental is not a part of the stable driver API and is subject to change without notice.
Features
Bug Fixes
- NODE-3998: metadata duplication in handshake (#3615) (6d894d6)
- NODE-4518: error message with invalid authMechanism is provided (#3597) (1a16b7e)
- NODE-4854: set timeout on write and reset on message (#3582) (4a7b5ec)
- NODE-5106: prevent multiple mongo client connect()s from leaking topology (#3596) (eb836bb)
- Thank you @clemclx for contributing this fix! 🎉
- NODE-5126: find operations fail when passed an ObjectId as filter (#3604) (2647b61)
Documentation
- Reference: https://docs.mongodb.com/drivers/node/current/
- API: https://mongodb.github.io/node-mongodb-native/5.2/
- Changelog: HISTORY.md
We invite you to try the mongodb library immediately, and report any issues to the NODE project.
Contributors
Assets 2
v4.15.0
The MongoDB Node.js team is pleased to announce version 4.15.0 of the mongodb package!
Features
Bug Fixes
Documentation
- Reference: https://docs.mongodb.com/drivers/node/current/
- API: https://mongodb.github.io/node-mongodb-native/4.15/
- Changelog: HISTORY.md
We invite you to try the mongodb library immediately, and report any issues to the NODE project.