[Snyk] Upgrade mongodb from 6.5.0 to 6.7.0

[prernaadev01]

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


Snyk has created this PR to upgrade mongodb from 6.5.0 to 6.7.0.

:information_source: 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 **21 versions** ahead of your current version. - The recommended version was released on **21 days ago**.

Release notes

Package name: mongodb

• 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.

• 6.7.0-dev.20240619.sha.8d5d9846 - 2024-06-19
• 6.7.0-dev.20240618.sha.ec3cabaf - 2024-06-18
• 6.7.0-dev.20240615.sha.465ffd97 - 2024-06-15
• 6.7.0-dev.20240614.sha.3ed6a2ad - 2024-06-14
• 6.7.0-dev.20240613.sha.c1af6adc - 2024-06-13
• 6.7.0-dev.20240608.sha.0655c730 - 2024-06-08
• 6.7.0-dev.20240607.sha.aa429f8c - 2024-06-07
• 6.7.0-dev.20240530.sha.f56938f - 2024-05-30
• 6.6.2 - 2024-05-15
  

  6.6.2 (2024-05-15)

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

  Release Notes

  Server Selection performance regression due to incorrect RTT measurement

  Starting in version 6.6.0, when using the stream server 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

  • NODE-6171: RTT set to zero when serverMonitoringMode=stream (#4110) (7a7ec5b)

  Documentation

  • Reference
  • API
  • Changelog

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

• 6.6.2-dev.20240529.sha.d3031a5 - 2024-05-29
• 6.6.2-dev.20240525.sha.d1695c4 - 2024-05-25
• 6.6.2-dev.20240524.sha.652af8d - 2024-05-24
• 6.6.2-dev.20240523.sha.21b729b - 2024-05-23
• 6.6.2-dev.20240516.sha.6acb5e5 - 2024-05-16
• 6.6.1 - 2024-05-06
  

  6.6.1 (2024-05-06)

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

  Release Notes

  ref()-ed timer keeps event loop running until client.connect() resolves

  When the MongoClient is first starting up (client.connect()) monitoring connections begin the process of discovering servers to make them selectable. The ref()-ed serverSelectionTimeoutMS timer keeps Node.js' event loop running as the monitoring connections are created. In the last release we inadvertently unref()-ed this initial timer which would allow Node.js to close before the monitors could create connections.

  Bug Fixes

  • NODE-6151: MongoClient connect does not keep Node.js running (#4101) (7e0d9e6)

  Documentation

  • Reference
  • API
  • Changelog

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

• 6.6.1-dev.20240511.sha.7c91272 - 2024-05-11
• 6.6.1-dev.20240508.sha.f73362b - 2024-05-08
• 6.6.1-dev.20240507.sha.706cc56 - 2024-05-07
• 6.6.0 - 2024-05-03
  

  6.6.0 (2024-05-02)

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

  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.

  const documents = await users.aggregate().addStage({ $project: { name: true } }).toArray();

  Thank you @ prenaissance for contributing this feature!

  cause and package name included for MongoMissingDependencyErrors

  MongoMissingDependencyErrors now include a cause and a dependencyName field, which can be used to programmatically determine which package is missing and why the driver failed to load it.

  For example:

  MongoMissingDependencyError: The iHateJavascript module does not exist
      at findOne (mongodb/main.js:7:11)
      at Object.<anonymous> (mongodb/main.js:14:1)
      ... 3 lines matching cause stack trace ...
      at Module._load (node:internal/modules/cjs/loader:1021:12) {
    dependencyName: 'iHateJavascript',
    [Symbol(errorLabels)]: Set(0) {},
    [cause]: Error: Cannot find module 'iHateJavascript'
    Require stack:
    - mongodb/main.js
        at require (node:internal/modules/helpers:179:18)
        at findOne (mongodb/main.js:5:5)
        at Object.<anonymous> (mongodb/main.js:14:1) {
      code: 'MODULE_NOT_FOUND',
      requireStack: [ 'mongodb/main.js' ]
    }
  }
  

  ServerDescription Round Trip Time (RTT) measurement changes

  (1) ServerDescription.roundTripTime is now a moving average

  Previously, ServerDescription.roundTripTime was calculated as a weighted average of the most recently observed heartbeat duration and the previous duration. This update changes this behaviour to average ServerDescription.roundTripTime over 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 minRoundTripTime to ServerDescription

  A new minRoundTripTime property is now available on the ServerDescription class 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.

  type supported in SearchIndexDescription

  It is now possible to specify the type of a search index when creating a search index:

  const indexName = await collection.createSearchIndex({
    name: 'my-vector-search-index',
    // new! specifies that a `vectorSearch` index is created
    type: 'vectorSearch',
    definition: {
      mappings: { dynamic: false }
    }
  });

  Collection.findOneAndModify's UpdateFilter.$currentDate no longer throws on collections with limited schema

  Example:

  // collection has no schema
  collection.update(
      $currentData: {
         lastModified: true
      } // no longer throws a TS error
  );

  TopologyDescription now properly stringifies itself to JSON

  The TopologyDescription class 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 uses Maps internally, which get serialized to {} when JSON stringified. We recommend using Node's util.inspect() helper to print topology descriptions because inspect properly handles all JS types and all types we use in the driver. However, if JSON must be used, the TopologyDescription now provides a custom toJSON() hook:

  client.on('topologyDescriptionChanged', ({ newDescription }) => {
     // recommended!
      console.log('topology description changed', inspect(newDescription, { depth: Infinity, colors: true }))
  
      // now properly prints the entire topology description
      console.log('topology description changed', JSON.stringify(newDescription))
  });

  Omit readConcern and writeConcern in Collection.listSearchIndexes options argument

  Important

  readConcern and writeConcern are no longer viable keys in the options argument passed into Collection.listSearchIndexes

  This type change is a correctness fix.

  Collection.listSearchIndexes is an Atlas specific method, and Atlas' search indexes do not support readConcern and writeConcern options. The types for this function now reflect this functionality.

  Don't throw error when non-read operation in a transaction has a ReadPreferenceMode other than 'primary'

  The following error will now only be thrown when a user provides a ReadPreferenceMode other than primary and then tries to perform a command that involves a read:

  new MongoTransactionError('Read preference in a transaction must be primary');

  Prior to this change, the Node Driver would incorrectly throw this error even when the operation does not perform a read.
  Note: a RunCommandOperation is treated as a read operation for this error.

  TopologyDescription.error type is MongoError

  Important

  The TopologyDescription.error property type is now MongoError rather than MongoServerError.

  This type change is a correctness fix.

  Before this change, the following errors that were not instances of MongoServerError were already passed into TopologyDescription.error at runtime:

  • MongoNetworkError (excluding MongoNetworkRuntimeError)
  • MongoError with a MongoErrorLabel.HandshakeError label

  indexExists() no longer supports the full option

  The Collection.indexExists() helper supported an option, full, that modified the internals of the method. When full was set to true, the driver would always return false, regardless of whether or not the index exists.

  The full option is intended to modify the return type of index enumeration APIs (Collection.indexes() and Collection.indexInformation(), but since the return type of Collection.indexExists() this option does not make sense for the Collection.indexExists() helper.

  We have removed support for this option.

  indexExists(), indexes() and indexInformation() support cursor options in Typescript

  These 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() and Db.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:

  collection.indexes({ full: true });   // returns an array of index descriptions
  collection.indexes({ full: false });  // returns an object, mapping index names to index keys

  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:

  <div class="highlight highlight-source-ts notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="collection.indexes(); // returns IndexDescriptionCompact | IndexDescriptionInfo[] collection.indexes({ full: false }); // returns an IndexDescriptionCompact collection.indexes({ full: true }); // returns an IndexDescriptionInfo[]

  collection.indexInfo(); // returns IndexDescriptionCompact | IndexDescriptionInfo[] collection.indexInfo({ full: false }); // returns an IndexDescriptionCompact collection.indexInfo({ full: true }); // returns an IndexDescriptionInfo[]

  db.indexInfo(); // returns IndexDescriptionCompact | IndexDescriptionInfo[] db.indexInfo({ full: false }); // returns an IndexDescriptionCompact db.indexInfo({ full: true }); // returns an IndexDescriptionInfo[]">

  collection.indexes();   // returns IndexDescriptionCompact | IndexDescriptionInfo[]
  collection.indexes({ full: false });  // returns an IndexDescriptionCompact
  collection.indexes({ full: true });  // returns an IndexDescriptionInfo[]
  
  collection.indexInfo();   // returns IndexDescriptionCompact | IndexDescriptionInfo[]
  collection.indexInfo({ full: false });  // returns an IndexDescriptionCompact
  collection.indexInfo({ full: true });  // returns an IndexDescriptionInfo[]
  db.indexInfo();   // returns IndexDescriptionCompact | IndexDescriptionInfo[]
  db.indexInfo({ full: false });  // returns an IndexDescriptionCompact
  db.indexInfo({ full: true });  // returns an IndexDescriptionInfo[]

[github-actions[bot]]

Test Results

27 tests  ±0   27 :white_check_mark: ±0   0s :stopwatch: ±0s 27 suites ±0    0 :zzz: ±0   3 files   ±0    0 :x: ±0 

Results for commit 36643b2b. ± Comparison against base commit 932bcfa9.