Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Snyk] Upgrade mongodb from 6.7.0 to 6.9.0 #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Snyk] Upgrade mongodb from 6.7.0 to 6.9.0 #2

wants to merge 1 commit into from

Conversation

abaum65
Copy link
Owner

@abaum65 abaum65 commented Oct 29, 2024

snyk-top-banner

Snyk has created this PR to upgrade mongodb from 6.7.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 47 versions ahead of your current version.

  • The recommended version was released on 2 months ago.

Release notes
Package name: mongodb
  • 6.9.0 - 2024-09-12

    6.9.0 (2024-09-06)

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

    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, ChangeStreams and cursors. Additionally, on compatible Node.js versions, explicit resource management can be used with cursor.stream() and the GridFSDownloadStream, 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:

    • Use Typescript 5.2 or greater (or another bundler that supports resource management)
    • Enable tslib polyfills for your application
    • Either use a compatible Node.js version or polyfill Symbol.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 close method is called when the resource goes out of scope.

    // before:
    {
    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 autoSelectFamily and autoSelectFamilyAttemptTimeout options (Node 18.13+), they can now be provided to the MongoClient and will be passed through to socket creation. autoSelectFamily will default to true with autoSelectFamilyAttemptTimeout by default not defined. Example:

    const client = new MongoClient(process.env.MONGODB_URI, { autoSelectFamilyAttemptTimeout: 100 });

    Allow passing through allowPartialTrustChain Node.js TLS option

    This option is now exposed through the MongoClient constructor's options parameter and controls the X509_V_FLAG_PARTIAL_CHAIN OpenSSL flag.

    Fixed enableUtf8Validation option

    Starting 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

    ConnectionReadyEvent now has a durationMS property 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/ConnectionCheckFailedEvent now have a durationMS property 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 cryptoCallbacks option 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 [email protected] 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 mongocryptd due to the sensitivity of the system resource they control, namely, launching a process. Now, mongocryptdSpawnPath and mongocryptdSpawnArgs must be own properties of autoEncryption.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:

    • use a version of mongodb-client-encryption > 6.1.0
    • use a Node driver version > 6.9.0
    • use an 8.0+ MongoDB enterprise server

    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.

    insertMany and bulkWrite accept ReadonlyArray inputs

    This improves the typescript developer experience, developers tend to use ReadonlyArray because it can help understand where mutations are made and when enabling noUncheckedIndexedAccess leads to a better type narrowing experience.

    Please note, that the array is read only but not the documents, the driver adds _id fields to your documents unless you request that the server generate the _id with forceServerObjectId

    Fix 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's key property accepts Binary for auto encryption

    In #4160 we fixed a type issue where a local KMS provider at runtime accepted a BSON Binary instance but the Typescript inaccurately only permitted Buffer and string. The same change has now been applied to AutoEncryptionOptions.

    BulkOperationBase (superclass of UnorderedBulkOperation and OrderedBulkOperation) now reports length property in Typescript

    The length getter for these classes was defined manually using Object.defineProperty which 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.code is overwritten by nested code within MongoWriteConcernError.result.writeConcernError.code

    MongoWriteConcernError is now correctly formed such that the original top-level code is preserved

    • If no top-level code exists, MongoWriteConcernError.code should be set to MongoWriteConcernError.result.writeConcernError.code
    • If a top-level code is passed into the constructor, it shouldn't be changed or overwritten by the nested writeConcernError.code

    Optimized 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, toArray does 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 the cursor.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() before toArray is called.

    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.

    const firstDoc = await cursor.next();

    for await (const doc of cursor) {
    // process doc
    // ...
    }

    Features

    Bug Fixes

    Performance Improvements

    Documentation

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

  • 6.9.0-dev.20241021.sha.30c61f2a - 2024-10-21
  • 6.9.0-dev.20241019.sha.e9e8bf5b - 2024-10-19
  • 6.9.0-dev.20241018.sha.a7d1d43e - 2024-10-18
  • 6.9.0-dev.20241016.sha.3d5bd513 - 2024-10-16
  • 6.9.0-dev.20241015.sha.7fde8ddc - 2024-10-15
  • 6.9.0-dev.20241012.sha.a473de95 - 2024-10-12
  • 6.9.0-dev.20241011.sha.8def42de - 2024-10-11
  • 6.9.0-dev.20241010.sha.6ecf198f - 2024-10-10
  • 6.9.0-dev.20241003.sha.91f30357 - 2024-10-03
  • 6.9.0-dev.20241002.sha.d56e235c - 2024-10-02
  • 6.9.0-dev.20241001.sha.85f7dcf9 - 2024-10-01
  • 6.9.0-dev.20240928.sha.3f9d2437 - 2024-09-28
  • 6.9.0-dev.20240927.sha.681ddd8d - 2024-09-27
  • 6.9.0-dev.20240926.sha.3d3da407 - 2024-09-26
  • 6.9.0-dev.20240918.sha.643a8755 - 2024-09-18
  • 6.9.0-dev.20240917.sha.20396e1b - 2024-09-17
  • 6.9.0-dev.20240913.sha.8b0f3541 - 2024-09-13
  • 6.8.2 - 2024-09-12

    6.8.2 (2024-09-12)

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

    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.

    const firstDoc = await cursor.next();

    for await (const doc of cursor) {
    // process doc
    // ...
    }

    Bug Fixes

    Documentation

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

  • 6.8.1 - 2024-09-06

    6.8.1 (2024-09-06)

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

    Release Notes

    Fixed enableUtf8Validation option

    Starting 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 mongodb library immediately, and report any issues to the NODE project.

  • 6.8.0 - 2024-06-27

    6.8.0 (2024-06-27)

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

    Release Notes

    Add ReadConcernMajorityNotAvailableYet to retryable errors

    ReadConcernMajorityNotAvailableYet (error code 134) 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:

    const clientEncryption = new ClientEncryption(keyVaultClient, {
    '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 delegated option

    When creating a KMIP data key, delegated can 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.

    clientEncryption.createDataKey('kmip', { masterKey: { delegated: true } } );

    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 like cursor.next() or for 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 parsing batchSize (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! 💚

    test> db.test.find()
[
	{ _id: ObjectId('665f7fc5c9d5d52227434c65'), ... },
  ...
]
Type "it" for more

    That Type "it" for more message 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 mongodb package now contains a detached signature file for the NPM package (named
    mongodb-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 the README.md file.

    The LocalKMSProviderConfiguration's key property accepts Binary

    A local KMS provider at runtime accepted a BSON Binary instance but the Typescript inaccurately only permitted Buffer and string.

    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 resources
    • cursor.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 of 0 indicating 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

    Documentation

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

  • 6.8.0-dev.20240912.sha.8347db9c - 2024-09-12
  • 6.8.0-dev.20240910.sha.833eaa41 - 2024-09-10
  • 6.8.0-dev.20240907.sha.91ceaf05 - 2024-09-07
  • 6.8.0-dev.20240905.sha.65e0e15c - 2024-09-05
  • 6.8.0-dev.20240904.sha.fb13ebfd - 2024-09-04
  • 6.8.0-dev.20240830.sha.1f10bdf8 - 2024-08-30
  • 6.8.0-dev.20240829.sha.6d65ae77 - 2024-08-29
  • 6.8.0-dev.20240824.sha.40ace73c - 2024-08-24
  • 6.8.0-dev.20240822.sha.f5254030 - 2024-08-22
  • 6.8.0-dev.20240821.sha.55bdeaa9 - 2024-08-21
  • 6.8.0-dev.20240813.sha.b70c8850 - 2024-08-13
  • 6.8.0-dev.20240808.sha.5565d500 - 2024-08-08
  • 6.8.0-dev.20240802.sha.54efb7d4 - 2024-08-02
  • 6.8.0-dev.20240731.sha.b26c3280 - 2024-07-31
  • 6.8.0-dev.20240727.sha.e9025843 - 2024-07-27
  • 6.8.0-dev.20240725.sha.74916f29 - 2024-07-25
  • 6.8.0-dev.20240720.sha.357ca086 - 2024-07-20
  • 6.8.0-dev.20240717.sha.35d88404 - 2024-07-17
  • 6.8.0-dev.20240716.sha.4b219d36 - 2024-07-16
  • 6.8.0-dev.20240712.sha.320dde04 - 2024-07-12
  • 6.8.0-dev.20240710.sha.fb442edc - 2024-07-10
  • 6.8.0-dev.20240709.sha.9a5e6110 - 2024-07-09
  • 6.8.0-dev.20240703.sha.5abf5fca - 2024-07-03
  • 6.8.0-dev.20240702.sha.f48f8d36 - 2024-07-02
  • 6.8.0-dev.20240629.sha.d85f827a - 2024-06-29
  • 6.8.0-dev.20240628.sha.45bc0982 - 2024-06-28
  • 6.7.0 - 2024-05-29

    6.7.0 (2024-05-29)

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

    Release Notes

    Support for MONGODB-OIDC Authentication

    MONGODB-OIDC is 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 MongoClient must be instantiated with authMechanism=MONGODB-OIDC in the URI or in the client options. Additional required auth mechanism properties of TOKEN_RESOURCE and ENVIRONMENT are required and another optional username can be provided. Example:

    const client = new MongoClient('mongodb+srv://<username>@<host>:<port>/?authMechanism=MONGODB-OIDC&authMechanismProperties=TOKEN_RESOURCE:<azure_token>,ENVIRONMENT:azure');
await client.connect();

    GCP Machine Authentication

    The MongoClient must be instantiated with authMechanism=MONGODB-OIDC in the URI or in the client options. Additional required auth mechanism properties of TOKEN_RESOURCE and ENVIRONMENT are required. Example:

    const client = new MongoClient('mongodb+srv://<host>:<port>/?authMechanism=MONGODB-OIDC&authMechanismProperties=TOKEN_RESOURCE:<gcp_token>,ENVIRONMENT:gcp');
await client.connect();

    Callback Authentication

    The user can provide a custom callback to the MongoClient that returns a valid response with an access token. The callback is provided as an auth mechanism property an has the signature of:

    const oidcCallBack = (params: OIDCCallbackParams): Promise<OIDCResponse> => {
    // 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_CALLBACK property:

    const client = new MongoClient('mongodb+srv://<host>:<port>/?authMechanism=MONGODB-OIDC', {
  authMechanismProperties: {
    OIDC_HUMAN_CALLBACK: oidcCallback
  }
});
await client.connect();

    Fixed error when useBigInt64=true was set on Db or MongoClient

    Fixed an issue where when setting useBigInt64=true on MongoClients or Dbs an internal function compareTopologyVersion would throw an error when encountering a bigint value.

    Features

    Bug Fixes

    Documentation

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

from mongodb GitHub release notes

Important

  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

[//]: # 'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"mongodb","from":"6.7.0","to":"6.9.0"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"067b9b4e-bbe7-4df3-a035-5bc5a26b7af1","prPublicId":"067b9b...

@snyk-bot
fix: upgrade mongodb from 6.7.0 to 6.9.0
25b895f 
Snyk has created this PR to upgrade mongodb from 6.7.0 to 6.9.0.

See this package in npm:
mongodb

See this project in Snyk:
https://app.snyk.io/org/abaum65/project/fc76c2ff-c72c-4c02-9a90-695c1e839c1c?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
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@abaum65 @snyk-bot