[Snyk] Upgrade mongodb from 6.3.0 to 6.9.0 #181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Snyk has created this PR to upgrade mongodb from 6.3.0 to 6.9.0. See this package in npm: mongodb See this project in Snyk: https://app.snyk.io/org/sicarchitect/project/5b43f087-5806-4b90-a489-b1875712a039?utm_source=github&utm_medium=referral&page=upgrade-pr
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade mongodb from 6.3.0 to 6.9.0.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 99 versions ahead of your current version.
The recommended version was released on 23 days ago.
Release notes
Package name: mongodb
6.9.0 (2024-09-06)
The MongoDB Node.js team is pleased to announce version 6.9.0 of the
mongodbpackage!Release Notes
Driver support of upcoming MongoDB server release
Increased the driver's max supported Wire Protocol version and server version in preparation for the upcoming release of MongoDB 8.0.
MongoDB 3.6 server support deprecated
Warning
Support for 3.6 servers is deprecated and will be removed in a future version.
Support for explicit resource management
The driver now natively supports explicit resource management for
MongoClient,ClientSession,ChangeStreamsand cursors. Additionally, on compatible Node.js versions, explicit resource management can be used withcursor.stream()and theGridFSDownloadStream, since these classes inherit resource management from Node.js' readable streams.This feature is experimental and subject to changes at any time. This feature will remain experimental until the proposal has reached stage 4 and Node.js declares its implementation of async disposable resources as stable.
To use explicit resource management with the Node driver, you must:
tslibpolyfills for your applicationSymbol.asyncDispose(see the TS 5.2 release announcement for more information).Explicit resource management is a feature that ensures that resources' disposal methods are always called when the resources' scope is exited. For driver resources, explicit resource management guarantees that the resources' corresponding
closemethod is called when the resource goes out of scope.{
try {
const client = MongoClient.connect('<uri>');
try {
const session = client.startSession();
const cursor = client.db('my-db').collection("my-collection").find({}, { session });
try {
const doc = await cursor.next();
} finally {
await cursor.close();
}
} finally {
await session.endSession();
}
} finally {
await client.close();
}
}
// with explicit resource management:
{
await using client = MongoClient.connect('<uri>');
await using session = client.startSession();
await using cursor = client.db('my-db').collection('my-collection').find({}, { session });
const doc = await cursor.next();
}
// outside of scope, the cursor, session and mongo client will be cleaned up automatically.
The full explicit resource management proposal can be found here.
Driver now supports auto selecting between IPv4 and IPv6 connections
For users on Node versions that support the
autoSelectFamilyandautoSelectFamilyAttemptTimeoutoptions (Node 18.13+), they can now be provided to theMongoClientand will be passed through to socket creation.autoSelectFamilywill default totruewithautoSelectFamilyAttemptTimeoutby default not defined. Example:Allow passing through
allowPartialTrustChainNode.js TLS optionThis option is now exposed through the MongoClient constructor's options parameter and controls the
X509_V_FLAG_PARTIAL_CHAINOpenSSL flag.Fixed
enableUtf8ValidationoptionStarting in v6.8.0 we inadvertently removed the ability to disable UTF-8 validation when deserializing BSON. Validation is normally a good thing, but it was always meant to be configurable and the recent Node.js runtime issues (v22.7.0) make this option indispensable for avoiding errors from mistakenly generated invalid UTF-8 bytes.
Add duration indicating time elapsed between connection creation and when the connection is ready
ConnectionReadyEventnow has adurationMSproperty that represents the time between the connection creation event and when the connection ready event is fired.Add duration indicating time elapsed between the beginning and end of a connection checkout operation
ConnectionCheckedOutEvent/ConnectionCheckFailedEventnow have adurationMSproperty that represents the time between checkout start and success/failure.Create native cryptoCallbacks 🔐
Node.js bundles OpenSSL, which means we can access the crypto APIs from C++ directly, avoiding the need to define them in JavaScript and call back into the JS engine to perform encryption. Now, when running the bindings in a version of Node.js that bundles OpenSSL 3 (should correspond to Node.js 18+), the
cryptoCallbacksoption will be ignored and C++ defined callbacks will be used instead. This improves the performance of encryption dramatically, as much as 5x faster. 🚀This improvement was made to mongodb-client-encryption@6.1.0 which is available now!
Only permit mongocryptd spawn path and arguments to be own properties
We have added some defensive programming to the options that specify spawn path and spawn arguments for
mongocryptddue to the sensitivity of the system resource they control, namely, launching a process. Now,mongocryptdSpawnPathandmongocryptdSpawnArgsmust be own properties ofautoEncryption.extraOptions. This makes it more difficult for a global prototype pollution bug related to these options to occur.Support for range v2: Queryable Encryption supports range queries
Queryable encryption range queries are now officially supported. To use this feature, you must:
Important
Collections and documents encrypted with range queryable fields with a 7.0 server are not compatible with range queries on 8.0 servers.
Documentation for queryable encryption can be found in the MongoDB server manual.
insertManyandbulkWriteacceptReadonlyArrayinputsThis improves the typescript developer experience, developers tend to use
ReadonlyArraybecause it can help understand where mutations are made and when enablingnoUncheckedIndexedAccessleads to a better type narrowing experience.Please note, that the array is read only but not the documents, the driver adds
_idfields to your documents unless you request that the server generate the_idwithforceServerObjectIdFix retryability criteria for write concern errors on pre-4.4 sharded clusters
Previously, the driver would erroneously retry writes on pre-4.4 sharded clusters based on a nested code in the server response (error.result.writeConcernError.code). Per the common drivers specification, retryability should be based on the top-level code (error.code). With this fix, the driver avoids unnecessary retries.
The
LocalKMSProviderConfiguration'skeyproperty acceptsBinaryfor auto encryptionIn #4160 we fixed a type issue where a
localKMS provider at runtime accepted aBSONBinaryinstance but the Typescript inaccurately only permittedBufferandstring. The same change has now been applied toAutoEncryptionOptions.BulkOperationBase(superclass ofUnorderedBulkOperationandOrderedBulkOperation) now reportslengthproperty in TypescriptThe
lengthgetter for these classes was defined manually usingObject.definePropertywhich hid it from typescript. Thanks to @ sis0k0 we now have the getter defined on the class, which is functionally the same, but a greatly improved DX when working with types. 🎉MongoWriteConcernError.codeis overwritten by nested code withinMongoWriteConcernError.result.writeConcernError.codeMongoWriteConcernErroris now correctly formed such that the original top-level code is preservedMongoWriteConcernError.codeshould be set toMongoWriteConcernError.result.writeConcernError.codewriteConcernError.codeOptimized
cursor.toArray()Prior to this change,
toArray()simply used the cursor's async iterator API, which parses BSON documents lazily (see more here).toArray(), however, eagerly fetches the entire set of results, pushing each document into the returned array. As such,toArraydoes not have the same benefits from lazy parsing as other parts of the cursor API.With this change, when
toArray()accumulates documents, it empties the current batch of documents into the array before calling the async iterator again, which means each iteration will fetch the next batch rather than wrap each document in a promise. This allows thecursor.toArray()to avoid the required delays associated with async/await execution, and allows for a performance improvement of up to 5% on average! 🎉Note: This performance optimization does not apply if a transform has been provided to
cursor.map()beforetoArrayis called.Fixed mixed use of
cursor.next()andcursor[Symbol.asyncIterator]In 6.8.0, we inadvertently prevented the use of
cursor.next()along with usingfor awaitsyntax to iterate cursors. If your code made use of the following pattern and the call tocursor.nextretrieved all your documents in the first batch, then the for-await loop would never be entered. This issue is now fixed.for await (const doc of cursor) {
// process doc
// ...
}
Features
mongocryptdSpawnPathandmongocryptdSpawnArgs(#4151) (f48f8d3)allowPartialTrustChainTLS flag (#4228) (d6c147d)Bug Fixes
error.writeConcern.codeto determine retryability (#4155) (b26c328)Performance Improvements
Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.8.2 (2024-09-12)
The MongoDB Node.js team is pleased to announce version 6.8.2 of the
mongodbpackage!Release Notes
Fixed mixed use of cursor.next() and cursor[Symbol.asyncIterator]
In 6.8.0, we inadvertently prevented the use of cursor.next() along with using for await syntax to iterate cursors. If your code made use of the following pattern and the call to cursor.next retrieved all your documents in the first batch, then the for-await loop would never be entered. This issue is now fixed.
for await (const doc of cursor) {
// process doc
// ...
}
Bug Fixes
Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.8.1 (2024-09-06)
The MongoDB Node.js team is pleased to announce version 6.8.1 of the
mongodbpackage!Release Notes
Fixed
enableUtf8ValidationoptionStarting in v6.8.0 we inadvertently removed the ability to disable UTF-8 validation when deserializing BSON. Validation is normally a good thing, but it was always meant to be configurable and the recent Node.js runtime issues (v22.7.0) make this option indispensable for avoiding errors from mistakenly generated invalid UTF-8 bytes.
Bug Fixes
Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.8.0 (2024-06-27)
The MongoDB Node.js team is pleased to announce version 6.8.0 of the
mongodbpackage!Release Notes
Add
ReadConcernMajorityNotAvailableYetto retryable errorsReadConcernMajorityNotAvailableYet(error code134) is now a retryable read error.ClientEncryption.createDataKey() and other helpers now support named KMS providers
KMS providers can now be associated with a name and multiple keys can be provided per-KMS provider. The following example configures a ClientEncryption object with multiple AWS keys:
'aws:key1': {
accessKeyId: ...,
secretAccessKey: ...
},
'aws:key2': {
accessKeyId: ...,
secretAccessKey: ...
},
clientEncryption.createDataKey('aws:key-1', { ... });
Named KMS providers are supported for azure, AWS, KMIP, local and gcp KMS providers. Named KMS providers cannot be used if the application is using the automatic KMS provider refresh capability.
This feature requires mongodb-client-encryption>=6.0.1.
KMIP data keys now support a
delegatedoptionWhen creating a KMIP data key,
delegatedcan now be specified. If true, the KMIP provider will perform encryption / decryption of the data key locally, ensuring that the encryption key never leaves the KMIP server.This feature requires mongodb-client-encryption>=6.0.1.
Cursor responses are now parsed lazily 🦥
MongoDB cursors (find, aggregate, etc.) operate on batches of documents equal to
batchSize. Each time the driver runs out of documents for the current batch it gets more (getMore) and returns each document one at a time through APIs likecursor.next()orfor await (const doc of cursor).Prior to this change, the Node.js driver was designed in such a way that the entire BSON response was decoded after it was received. Parsing BSON, just like parsing JSON, is a synchronous blocking operation. This means that throughout a cursor's lifetime invocations of
.next()that need to fetch a new batch hold up on parsingbatchSize(default 1000) documents before returning to the user.In an effort to provide more responsiveness, the driver now decodes BSON "on demand". By operating on the layers of data returned by the server, the driver now receives a batch, and only obtains metadata like size, and if there are more documents to iterate after this batch. After that, each document is parsed out of the BSON as the cursor is iterated.
A perfect example of where this comes in handy is our beloved
mongosh! 💚That
Type "it" for moremessage would now print after parsing only the documents displayed rather than after the entire batch is parsed.Add Signature to Github Releases
The Github release for the
mongodbpackage now contains a detached signature file for the NPM package (namedmongodb-X.Y.Z.tgz.sig), on every major and patch release to 6.x and 5.x. To verify the signature, follow the instructions in the 'Release Integrity' section of theREADME.mdfile.The
LocalKMSProviderConfiguration'skeyproperty acceptsBinaryA
localKMS provider at runtime accepted aBSONBinaryinstance but the Typescript inaccurately only permittedBufferandstring.Clarified cursor state properties
The cursor has a few properties that represent the current state from the perspective of the driver and server. This PR corrects an issue that never made it to a release but we would like to take the opportunity to re-highlight what each of these properties mean.
cursor.closed-cursor.close()has been called, and there are no more documents stored in the cursor.cursor.killed-cursor.close()was called while the cursor still had a non-zero id, and the driver sent a killCursors command to free server-side resourcescursor.id == null- The cursor has yet to send it's first command (ex.find,aggregate)cursor.id.isZero()- The server sent the driver a cursor id of0indicating a cursor no longer exists on the server side because all data has been returned to the driver.cursor.bufferedCount()- The amount of documents stored locally in the cursor.Features
Bug Fixes
Binaryas local KMS provider key (#4160) (fb724eb)Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.7.0 (2024-05-29)
The MongoDB Node.js team is pleased to announce version 6.7.0 of the
mongodbpackage!Release Notes
Support for MONGODB-OIDC Authentication
MONGODB-OIDCis now supported as an authentication mechanism for MongoDB server versions 7.0+. The currently supported facets to authenticate with are callback authentication, human interaction callback authentication, Azure machine authentication, and GCP machine authentication.Azure Machine Authentication
The
MongoClientmust be instantiated withauthMechanism=MONGODB-OIDCin the URI or in the client options. Additional required auth mechanism properties ofTOKEN_RESOURCEandENVIRONMENTare required and another optional username can be provided. Example:GCP Machine Authentication
The
MongoClientmust be instantiated withauthMechanism=MONGODB-OIDCin the URI or in the client options. Additional required auth mechanism properties ofTOKEN_RESOURCEandENVIRONMENTare required. Example:Callback Authentication
The user can provide a custom callback to the
MongoClientthat returns a valid response with an access token. The callback is provided as an auth mechanism property an has the signature of:// params.timeoutContext is an AbortSignal that will abort after 30 seconds for non-human and 5 minutes for human.
// params.version is the current OIDC API version.
// params.idpInfo is the IdP info returned from the server.
// params.username is the optional username.
// Make a call to get a token.
const token = ...;
return {
accessToken: token,
expiresInSeconds: 300,
refreshToken: token
};
}
const client = new MongoClient('mongodb+srv://<host>:<port>/?authMechanism=MONGODB-OIDC', {
authMechanismProperties: {
OIDC_CALLBACK: oidcCallback
}
});
await client.connect();
For callbacks that require human interaction, set the callback to the
OIDC_HUMAN_CALLBACKproperty:Fixed error when useBigInt64=true was set on Db or MongoClient
Fixed an issue where when setting
useBigInt64=trueon MongoClients or Dbs an internal functioncompareTopologyVersionwould throw an error when encountering a bigint value.Features
Bug Fixes
Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.6.2 (2024-05-15)
The MongoDB Node.js team is pleased to announce version 6.6.2 of the
mongodbpackage!Release Notes
Server Selection performance regression due to incorrect RTT measurement
Starting in version 6.6.0, when using the
streamserver monitoring mode, heartbeats were incorrectly timed as having a duration of 0, leading to server selection viewing each server as equally desirable for selection.Bug Fixes
Documentation