Releases · mongodb/node-mongodb-native

14 Sep 17:43

nbbeeken

v4.1.2

78df6b9

v4.1.2

The MongoDB Node.js team is pleased to announce version 4.1.2 of the mongodb package!

Release Highlights

This release addresses a number of bug fixes, please peruse the list below for more information on each fix.

Bug Fixes

NODE-3434: errInfo should be exposed on bulk write (#2977) (6b3c161)
NODE-3467: allow object type for aggregate out helper (#2971) (cd603e8)
NODE-3487: check for nullish aws mechanism property (#2951) (78ec0dd)
NODE-3559: incorrect GridFS stream type (#2981) (3915ea8)
NODE-3567: correct typing on aggregation out helper (#2967) (a299a0b)
NODE-3574: reintroduce ObjectID export (#2965) (2291119)
NODE-3585: MongoClientOptions#compressors has incorrect type (#2976) (f1b896d)
NODE-3591: tlsCertificateKeyFile option does not default cert (#2979) (6d42267)
NODE-3599: incorrect indexes return type (#2980) (122b9f3)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/4.1
Changelog: https://github.com/mongodb/node-mongodb-native/blob/4.1/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

14 Sep 17:39

nbbeeken

v3.7.1

28f721d

v3.7.1

The MongoDB Node.js team is pleased to announce version 3.7.1 of the mongodb package!

Release Highlights

This release contains an internal improvement that makes our monitor utilize the new hello handshake for monitoring when available.

Features

NODE-3424: use hello for monitoring commands (#2964) (910c564)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/3.7
Changelog: https://github.com/mongodb/node-mongodb-native/blob/3.7/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

31 Aug 21:12

nbbeeken

v3.7.0

44df7d7

v3.7.0

The MongoDB Node.js team is pleased to announce version 3.7.0 of the mongodb package!

Release Highlights

Versioned API

Versioned API is a new feature in MongoDB 5.0 that allows user-selectable API versions, subsets of MongoDB server semantics, to be declared on a client. During communication with a server, clients with a declared API version will force the server to behave in a manner compatible with the API version. Declaring an API version on a client can be used to ensure consistent responses from a server, providing long term API stability for an application. The declared API version is applied to all commands run through the client, including those sent through the generic RunCommand helper. Specifying versioned API options in the command document AND declaring an API version on the client is not supported and will lead to undefined behavior.

Declare an API version on a client

// Declare API version "1" for the client
client = new MongoClient(uri, { serverApi: { version: '1' } });

cursor = client.db('database').collection('coll').find(...);

Strict mode

Declaring a strict API version will cause the MongoDB server to reject all commands that are not part of the declared API version. This includes command options and aggregation pipeline stages. For example, the following find call would fail because the tailable option is not part of version 1:

// Declare API version "1" for the client, with strict on
client = new MongoClient(uri, { serverApi: { version: '1', strict: true } });

// Fails with an error
cursor = client.db('database').collection('coll').find({ ... }, { tailable: true });

Deprecation Errors

The deprecationErrors option can be used to enable command failures when using functionality that is deprecated from version 1. Note that at the time of this writing, no deprecations in version 1 exist.

// Declare API version "1" for the client, with deprecationErrors on
client = new MongoClient(uri, { serverApi: { version: '1', deprecationErrors: true } });

// Note: since API version "1" is the initial version, there are no deprecated commands to provide as an example yet.

Features

NODE-3191: backport versioned api (#2850) (93a47fd)

Bug Fixes

NODE-3377: driver should allow arbitrary explain levels (#2961) (96c8ab4)
NODE-3463: pass explain error through to callback (#2949) (e5975af)

Documentation

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

30 Aug 19:04

nbbeeken

v3.6.12

ffcd6ba

v3.6.12

The MongoDB Node.js team is pleased to announce version 3.6.12 of the mongodb package!

Bug Fixes

NODE-3487: check for nullish aws mechanism property (#2957) (5902b4c)
NODE-3528: add support for snappy v7 (#2947) (54f5c2d)

Documentation

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

24 Aug 20:42

nbbeeken

v4.1.1

cb7b8ed

v4.1.1

The MongoDB Node.js team is pleased to announce version 4.1.1 of the mongodb package!

Release Highlights

Error handling

We introduced better organization and consistency to our existing errors in an effort to provide more detailed error types that can help identify issues clearly and quickly. Our readme has a new section that describes how to handle errors thrown by the driver and defines our approach to semver in the context of errors. Notably, we recommend only using instanceof checks to filter for a given error class as we do not guarantee error messages or names will be preserved between patch releases, only the subclass hierarchy.

Thanks so much to our summer interns @andymina and @W-A-James for undertaking this effort!

Notable fixes

This version of the driver brings in the latest BSON release which includes deserialization performance improvements.
The snappy package recently released a major version bump (v7) that makes use of a rust implementation of Snappy compression. Our driver can now make use of this version (while maintaining compatibility with the previous v6).
findOne() once again correctly returns null when no match is found instead of undefined. This change was unintentional and not consistent with our other APIs. It slipped through testing due to the nature of undefined and null being nearly (==) but not actually (===) equal. We apologize if this results in the need for any code changes.

This release also addresses some Typescript issues that require further explanation, let's dive in:

TypeScript support

Projections

Starting in MongoDB 4.4 projections can accept aggregation expressions and aggregation syntax.
This empowers users to create some pretty amazing and complex data model transformations on the database side.
Unfortunately, our initial release of typescript typing for projections was too narrow to allow these use cases and still pass the compiler checks.
Now projections are generic objects and the result of a cursor with a projection is typed as a generic object by default.

The recommended usage for projections alongside typescript is as follows:

interface Pet {
    name: string;
    buddies: Pet[];
}
interface PetBuddyCount {
    name: string;
    buddyCount: number;
}

const pets = db.collection<Pet>('pets');

const petBuddyCounts = await pets.find().project<PetBuddyCount>({
    name: 1,
    buddyCount: { $size: '$buddies' },
}).toArray();

By using a parameterized .project call you can now get the correct type information on the petBuddyCounts array.
You will need to build the projection type yourself based on the projection you define for your query, but this has the benefit of constraining your results to precisely your type expectations.

Generics in find/findOne

In our initial typescript release the find and findOne methods accepted a generic parameter that was passed to the filter argument of the API.

find<T>(f: Filter<T>): FindCursor<T>

Due to how typescript automatically resolves the types of generics, one could run into an issue when specifying a filter that was incorrectly typed.
The code below should be a Typescript error, TS hints to us the name is a string so it should only allow an array of string for $in.

// (using the same pets collection from the last example)
pets.find({ name: { $in: [1, 2] } });
// instead of the expected FindCursor<Pet> type TS was resolving to:
const res: FindCursor<{name: {$in: number[]}}> = pets.find(/* same arg as above */);

It uses the incorrectly typed filter that does not match the schema of Filter<TSchema> to automatically resolve a crazy return type.
The function definition has now been updated to be:

find<T>(f: Filter<TSchema>): FindCursor<T>

So the Filter argument will no longer be automatically resolved to the passed in type, giving us the typescript compiler errors we love so much!

Bug Fixes

NODE-3454: projection types are too narrow (#2924) (48d6da9)
NODE-3468: remove generic overrides from find (#2935) (74bd7bd)
NODE-3511: deprecate fullResponse and remove associated buggy code paths (#2943) (dfc39d1)
NODE-3528: add support for snappy 7 (#2939) (0f7f300)
NODE-3546: revert findOne not found result type to null (#2945) (1c576e9)

Refactoring

NODE-3404 implement MongoRuntimeError children (#2912) (e69d99257)
NODE-3405 implement MongoRuntimeError children (#2913) (e69d99257)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/4.0
Changelog: https://github.com/mongodb/node-mongodb-native/blob/4.1/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Contributors

andymina and W-A-James

Assets 2

05 Aug 16:22

nbbeeken

v3.6.11

fbdc7c8

v3.6.11

The MongoDB Node.js team is pleased to announce version 3.6.11 of the mongodb package!

Release Highlights

This patch addresses a few bugs listed below.
Notably, we fixed an issue with the way we imported one of our optional dependencies that blocked webpack bundling.

If you are a webpack user you will still get warnings for our optional dependencies (if you don't use them).
You can hush the warnings by adding this option to your webpack config:

{
    // ...
    externals: [
        'mongodb-client-encryption',
        'aws4',
        'saslprep',
        'kerberos',
        'snappy',
        'bson-ext',
    ],
    // ...
}

It is important to note that this will leave the imports in place and not pull in the code to your bundle. If you later do adopt using these dependencies you'll want to revert the relevant setting.

Bug Fixes

NODE-1843: bulk operations ignoring provided sessions (#2898) (9244b17)
NODE-3199: unable to bundle driver due to uncaught require (#2903) (60efe9d)

Documentation

Reference: https://docs.mongodb.com/drivers/node/current/
API: http://mongodb.github.io/node-mongodb-native/3.6/api
Changelog: https://github.com/mongodb/node-mongodb-native/blob/3.6/HISTORY.md

We invite you to try the mongodb package immediately, and report any issues to the NODE project.

Assets 2

03 Aug 21:18

nbbeeken

v4.1.0

4ecaa37

v4.1.0

The MongoDB Node.js team is pleased to announce version 4.1.0 of the mongodb package!

Release Highlights

This release includes load balancer support, intended for use with the beta Serverless platform. When using the driver with Serverless, the SRV URI will automatically put the driver into this mode. When wanting to use a non-SRV URI one must add the loadBalanced=true option to the URI to put the driver into this mode. Being in this mode enables the driver to properly route transactions and cursors to the correct service behind the load balancer.

The release also fixes an important bug where the original release of the v4 driver enabled command monitoring by default, which caused many reported observations of performance degradation when upgrading from v3 of the driver. Command monitoring is now once again disabled by default and must be enabled by passing in { monitorCommands: true } to the client if desired.

Features

NODE-2843: implement sessions advanceClusterTime method (#2920) (1fd0244)
NODE-3011: Load Balancer Support (#2909) (c554a7a)

Bug Fixes

NODE-2883: Aggregate Operation should not require parent parameter (#2918) (dc6e2d6)
NODE-3058: accept null or undefined anywhere we permit nullish values (#2921) (b42a1b4)
NODE-3441: fix typings for createIndexes (#2915) (f87f376)
NODE-3442: AsyncIterator has incorrect return type (#2916) (4a10389)
NODE-3452: readonly filters not permitted by typings (#2927) (ce51e78)
NODE-3510: omit incorrect | void in declaration of Promise overload of rename() (#2922) (58c1e84)
NODE-3513: default command monitoring to off (#2926) (3c60245)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/4.0
Changelog: https://github.com/mongodb/node-mongodb-native/blob/4.0/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

20 Jul 20:55

dariakp

v4.0.1

ac52605

v4.0.1

The MongoDB Node.js team is pleased to announce version 4.0.1 of the mongodb package!

Release Highlights

This release fixes two small but important bugs from our 4.0.0 release:

Webpack will no longer throw an error when trying to bundle the driver
Snapshot sessions will now correctly apply the snapshot time when initiated with a distinct operation

We hope this improves your upgrade experience!

Bug Fixes

NODE-3199: unable to bundle driver due to uncaught require (#2904) (9e48bbd)
NODE-3393: snapshot time not applied if distinct executed first (#2908) (7aa3008)
NODE-3417: allow calling db() before MongoClient is connected (#2889) (51ea86d)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/4.0
Changelog: https://github.com/mongodb/node-mongodb-native/blob/4.0/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

13 Jul 17:37

nbbeeken

v4.0.0

ead7920

v4.0.0

The MongoDB Node.js team is delighted to announce the major version release 4.0.0 of the MongoDB Node.js Driver!

Release Highlights

We finally did it! The major version release of the MongoDB driver is now generally available! This release represents over a year's worth of effort that couldn't have been done without stellar contributions from the community and our Node.js DBX team. We hope you give it a try and are able to upgrade smoothly! 🎉

The biggest news is our migration to Typescript 🥳 offering first class support of type definitions in the driver itself.

Some cool new MongoDB 5.0 features now supported in the driver are:

Native support for Time Series Collections
- Time series collections efficiently store sequences of measurements over a period of time. Compared to normal collections, storing time series data in time series collections improves query efficiency and reduces the disk usage for time series data and secondary indexes
Snapshot reads on secondaries
- Support for read concern level "snapshot" (non-speculative) for read commands outside of transactions, including on secondaries. The snapshot reads on secondaries feature allows users to perform analytics with snapshot isolation on dedicated secondaries, including long running snapshot reads.

Below are only the changes since our last beta release, for the full set of breaking changes look at the upgrade guide here and for the full set of new features, take a look here.

⚠ BREAKING CHANGES (since beta.6)

NODE-3427: remove md5 hashing from GridFS API (#2899) (a488d88)
NODE-1797: error when ChangeStream used as iterator and emitter concurrently (#2871) (e0b3afe)
AND MORE!

Features (since beta.6)

NODE-3095: add timeseries options to db.createCollection (#2878) (c145c91)
NODE-3392: enable snapshot reads on secondaries (#2897) (523e05c)
NODE-3403: define MongoRuntimeError children (#2894) (cb0db49)
NODE-3410: added MongoRuntimeError (#2892) (ee903cb)
AND MORE!

Bug Fixes

NODE-1797: error when ChangeStream used as iterator and emitter concurrently (#2871) (e0b3afe)
NODE-1843: bulk operations ignoring provided sessions (#2868) (70810d1)
NODE-3063: fix custom csfle test script (#2884) (d73c80c)
NODE-3279: use "hello" for monitoring if supported (#2895) (5a8842a)
NODE-3386: listCollections result type definition (#2866) (c12979a)
NODE-3413: accept tls=false in mongodb+srv connection strings (#2886) (526c73f)
NODE-3416: make change stream generic default to Document (#2882) (3d490dc)
NODE-3430: watch method types on MongoClient and Db (#2900) (17cc291)

Documentation

Reference: https://docs.mongodb.com/drivers/node
API: https://mongodb.github.io/node-mongodb-native/4.0
Changelog: https://github.com/mongodb/node-mongodb-native/blob/4.0/HISTORY.md

We invite you to try the mongodb library immediately, and report any issues to the NODE project.

Assets 2

06 Jul 19:45

nbbeeken

v3.6.10

1297cd1

v3.6.10

The MongoDB Node.js team is pleased to announce version 3.6.10 of the mongodb package!

Release Highlights

This patch addresses a few bugs listed below. Notably the bsonRegExp option is now respected by the underlying BSON library, you can use this to decode regular expressions that contain syntax not permitted in native JS RegExp objects. Take a look at this example:

await collection.insertOne({ a: new BSONRegExp('(?-i)AA_') })
await collection.findOne({ a: new BSONRegExp('(?-i)AA_') }, { bsonRegExp: true })
// { _id: ObjectId,  a: BSONRegExp { pattern: '(?-i)AA_', options: '' } }

Also there was an issue with Cursor.forEach where user defined forEach callbacks that throw errors incorrectly handled catching errors. Take a look at the comments in this example:

collection.find({}).forEach(doc => {
    if(doc.bad) throw new Error('bad document!');
}).catch(error => {
    // now this is called! and error is `bad document!`
})
// before this fix the `bad document!` error would be thrown synchronously
// and have to be caught with try catch out here

Bug Fixes

NODE-2035: Exceptions thrown from awaited cursor forEach do not propagate (#2852) (a917dfa)
NODE-3150: added bsonRegExp option for v3.6 (#2843) (e4a9a57)
NODE-3358: Command monitoring objects hold internal state references (#2858) (750760c)
NODE-3380: perform retryable write checks against server (#2861) (621677a)
NODE-3397: report more helpful error with unsupported authMechanism in initial handshake (#2876) (3ce148d)

Documentation

Reference: https://docs.mongodb.com/drivers/node/current/
API: http://mongodb.github.io/node-mongodb-native/3.6/api
Changelog: https://github.com/mongodb/node-mongodb-native/blob/3.6/HISTORY.md

We invite you to try the mongodb package immediately, and report any issues to the NODE project.

Assets 2

Releases: mongodb/node-mongodb-native

v4.1.2

Release Highlights

Bug Fixes

Documentation

v3.7.1

Release Highlights

Features

Documentation

v3.7.0

Release Highlights

Versioned API

Declare an API version on a client

Strict mode

Deprecation Errors

Features

Bug Fixes

Documentation

v3.6.12

Bug Fixes

Documentation

v4.1.1

Release Highlights

Error handling

Notable fixes

TypeScript support

Projections

Generics in find/findOne

Bug Fixes

Refactoring

Documentation

Contributors

v3.6.11

Release Highlights

Bug Fixes

Documentation

v4.1.0

Release Highlights

Features

Bug Fixes

Documentation

v4.0.1

Release Highlights

Bug Fixes

Documentation

v4.0.0

Release Highlights

⚠ BREAKING CHANGES (since beta.6)

Features (since beta.6)

Bug Fixes

Documentation

v3.6.10

Release Highlights

Bug Fixes

Documentation