[Snyk] Upgrade mongodb from 6.0.0 to 6.8.0 #4
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.0.0 to 6.8.0. See this package in npm: mongodb See this project in Snyk: https://app.snyk.io/org/zntb/project/82e2e138-3fd0-4b68-a3ab-ab4147389797?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.0.0 to 6.8.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 110 versions ahead of your current version.
The recommended version was released on 2 months ago.
Release notes
Package name: mongodb
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
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.6.1 (2024-05-06)
The MongoDB Node.js team is pleased to announce version 6.6.1 of the
mongodbpackage!Release Notes
ref()-ed timer keeps event loop running untilclient.connect()resolvesWhen the
MongoClientis first starting up (client.connect()) monitoring connections begin the process of discovering servers to make them selectable. Theref()-edserverSelectionTimeoutMStimer keeps Node.js' event loop running as the monitoring connections are created. In the last release we inadvertentlyunref()-ed this initial timer which would allow Node.js to close before the monitors could create connections.Bug Fixes
Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.6.0 (2024-05-02)
The MongoDB Node.js team is pleased to announce version 6.6.0 of the
mongodbpackage!Release Notes
Aggregation pipelines can now add stages manually
When creating an aggregation pipeline cursor, a new generic method
addStage()has been added in the fluid API for users to add aggregation pipeline stages in a general manner.Thank you @ prenaissance for contributing this feature!
cause and package name included for
MongoMissingDependencyErrorsMongoMissingDependencyErrors now include acauseand adependencyNamefield, which can be used to programmatically determine which package is missing and why the driver failed to load it.For example:
ServerDescriptionRound Trip Time (RTT) measurement changes(1)
ServerDescription.roundTripTimeis now a moving averagePreviously,
ServerDescription.roundTripTimewas calculated as a weighted average of the most recently observed heartbeat duration and the previous duration. This update changes this behaviour to averageServerDescription.roundTripTimeover the last 10 observed heartbeats. This should reduce the likelihood that the selected server changes as a result of momentary spikes in server latency.(2) Added
minRoundTripTimetoServerDescriptionA new
minRoundTripTimeproperty is now available on theServerDescriptionclass which gives the minimum RTT over the last 10 heartbeats. Note that this value will be reported as 0 when fewer than 2 samples have been observed.typesupported inSearchIndexDescriptionIt is now possible to specify the type of a search index when creating a search index:
Collection.findOneAndModify'sUpdateFilter.$currentDateno longer throws on collections with limited schemaExample:
TopologyDescriptionnow properly stringifies itself to JSONThe
TopologyDescriptionclass is exposed by the driver in server selection errors and topology monitoring events to provide insight into the driver's current representation of the server's topology and to aid in debugging. However, the TopologyDescription usesMaps internally, which get serialized to{}when JSON stringified. We recommend using Node'sutil.inspect()helper to print topology descriptions becauseinspectproperly handles all JS types and all types we use in the driver. However, if JSON must be used, theTopologyDescriptionnow provides a customtoJSON()hook:// recommended!
console.log('topology description changed', inspect(newDescription, { depth: Infinity, colors: true }))
});
Omit
readConcernandwriteConcerninCollection.listSearchIndexesoptions argumentImportant
readConcernandwriteConcernare no longer viable keys in the options argument passed intoCollection.listSearchIndexesThis type change is a correctness fix.
Collection.listSearchIndexesis an Atlas specific method, and Atlas' search indexes do not supportreadConcernandwriteConcernoptions. The types for this function now reflect this functionality.Don't throw error when non-read operation in a transaction has a
ReadPreferenceModeother than'primary'The following error will now only be thrown when a user provides a
ReadPreferenceModeother thanprimaryand then tries to perform a command that involves a read:Prior to this change, the Node Driver would incorrectly throw this error even when the operation does not perform a read.
Note: a
RunCommandOperationis treated as a read operation for this error.TopologyDescription.errortype isMongoErrorImportant
The
TopologyDescription.errorproperty type is nowMongoErrorrather thanMongoServerError.This type change is a correctness fix.
Before this change, the following errors that were not instances of
MongoServerErrorwere already passed intoTopologyDescription.errorat runtime:MongoNetworkError(excludingMongoNetworkRuntimeError)MongoErrorwith aMongoErrorLabel.HandshakeErrorlabelindexExists()no longer supports thefulloptionThe
Collection.indexExists()helper supported an option,full, that modified the internals of the method. Whenfullwas set totrue, the driver would always returnfalse, regardless of whether or not the index exists.The
fulloption is intended to modify the return type of index enumeration APIs (Collection.indexes()andCollection.indexInformation(), but since the return type ofCollection.indexExists()this option does not make sense for theCollection.indexExists()helper.We have removed support for this option.
indexExists(),indexes()andindexInformation()support cursor options in TypescriptThese APIs have supported cursor options at runtime since the 4.x version of the driver, but our Typescript has incorrectly omitted cursor options from these APIs.
Index information helpers have accurate Typescript return types
Collection.indexInformation(),Collection.indexes()andDb.indexInformation()are helpers that return index information for a given collection or database. These helpers take an option,full, that configures whether the return value contains full index descriptions or a compact summary:However, the Typescript return type of these helpers was always
Document. Thanks to @ prenaissance, these helpers now have accurate type information! The helpers return a new type,IndexDescriptionCompact | IndexDescriptionInfo[], which accurately reflects the return type of these helpers. The helpers also support type narrowing by providing a boolean literal as an option to the API:IndexDescriptionCompact | IndexDescriptionInfo[]collection.indexes({ full: false }); // returns an
IndexDescriptionCompactcollection.indexes({ full: true }); // returns an
IndexDescriptionInfo[]collection.indexInfo(); // returns
IndexDescriptionCompact | IndexDescriptionInfo[]collection.indexInfo({ full: false }); // returns an
IndexDescriptionCompactcollection.indexInfo({ full: true }); // returns an
IndexDescriptionInfo[]db.indexInfo(); // returns
IndexDescriptionCompact | IndexDescriptionInfo[]db.indexInfo({ full: false }); // returns an
IndexDescriptionCompactdb.indexInfo({ full: true }); // returns an
IndexDescriptionInfo[]AWS credentials with expirations no longer throw when using on-demand AWS KMS credentials
In addition to letting users provide KMS credentials manually, client-side encryption supports fetching AWS KMS credentials on-demand using the AWS SDK. However, AWS credential mechanisms that returned access keys with expiration timestamps caused the driver to throw an error.
The driver will no longer throw an error when receiving an expiration token from the AWS SDK.
ClusterTimeinterfacesignatureoptionalityThe
ClusterTimeinterface incorrectly reported thesignaturefield as required, the server may omit it, so the typescript has been updated to reflect reality.Summary
Features
timeoutMSanddefaultTimeoutMS(#4068) (ddd1e81)causeand package name for allMongoMissingDependencyErrors (#4067) (62ea94b)minRoundTripTimetoServerDescriptionand changeroundTripTimeto a moving average (#4059) (0e3d6ea)typeoption in create search index helpers (#4060) (3598c23)bsonto ^6.5.0 (#4035) (8ab2055)bsonto ^6.7.0 (#4099) (7f191cf)Bug Fixes
Collection.findOneAndModifyUpdateFilter.$currentDate(#4047) (a8670a7)ReadPreferenceModeother thanprimary(#4075) (39fc198)vtocreateIndexescommand whenversionis specified (#4043) (1879a04)TopologyDescription.errortype toMongoError(#4028) (30432e8)fullis set totrue(#4034) (0ebc1ac)libmongocryptafter fetching AWS KMS credentials (#4057) (c604e74)ClusterTime.signaturecan be undefined (#4069) (ce55ca9)Performance Improvements
setTimeoutcallback (#4094) (6abc074)Documentation
We invite you to try the
mongodblibrary immediately, and report any issues to the NODE project.6.5.0 (2024-03-11)
The MongoDB Node.js team is pleased to announce version 6.5.0 of the
mongodbpackage!Release Notes
Bulk Write Operations Generate Ids using
pkFactoryWhen performing inserts, the driver automatically generates
_ids for each document if there is no_idpresent. By default, the driver generatesObjectIds. An option,pkFactory, can be used to configure the driver to generate_ids that are not object ids.For a long time, only
Collection.insertandCollection.insertManyactually used thepkFactory, if configured. Notably,Collection.bulkWrite(),Collection.initializeOrderedBulkOp()andCollection.initializeOrderedBulkOp()always generatedObjectIds, regardless of what was configured on collection.The driver always generates
_ids for inserted documents using thepkFactory.