[Snyk] Upgrade mongodb from 6.7.0 to 6.8.0

[kazimanzurrashid]

This PR was automatically created by Snyk using the credentials of a real user.


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

• The recommended version was released on 22 days ago.

Release notes

Package name: mongodb

• 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

  • NODE-5718: add ReadConcernMajorityNotAvailableYet to retryable errors (#4154) (4f32dec)
  • NODE-5801: allow multiple providers providers per type (#4137) (4d209ce)
  • NODE-5853: support delegated KMIP data key option (#4129) (aa429f8)
  • NODE-6136: parse cursor responses on demand (#4112) (3ed6a2a)
  • NODE-6157: add signature to github releases (#4119) (f38c5fe)

  Bug Fixes

  • NODE-5801: use more specific key typing for multiple KMS provider support (#4146) (465ffd9)
  • NODE-6085: add TS support for KMIP data key options (#4128) (f790cc1)
  • NODE-6241: allow Binary as local KMS provider key (#4160) (fb724eb)
  • NODE-6242: close becomes true after calling close when documents still remain (#4161) (e3d70c3)

  Documentation

  • Reference
  • API
  • Changelog

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

• 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

  • NODE-5464: OIDC machine and callback workflow (#3912) (2ba8434)

  Bug Fixes

  • NODE-6165: useBigInt64 causes compareTopologyVersion to throw (#4109) (21b729b)

  Documentation

  • Reference
  • API
  • Changelog

  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:

• 🧐 View latest project report
• 📜 Customise PR templates
• 🛠 Adjust upgrade PR settings
• 🔕 Ignore this dependency or unsubscribe from future upgrade PRs