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.

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

[Snyk] Upgrade mongodb from 6.2.0 to 6.8.0 #65

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

Conversation

lydmoon
Copy link
Owner

@lydmoon lydmoon commented Sep 3, 2024

snyk-top-banner

Snyk has created this PR to upgrade mongodb from 6.2.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 106 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

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

  • 6.7.0-dev.20240627.sha.fb724eb6 - 2024-06-27
  • 6.7.0-dev.20240626.sha.4f32decc - 2024-06-26
  • 6.7.0-dev.20240625.sha.27cb35bb - 2024-06-25
  • 6.7.0-dev.20240621.sha.8fb43f86 - 2024-06-21
  • 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

    Documentation

    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

    Documentation

    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 }))

    <span class="pl-c">// now properly prints the entire topology description</span>
    <span class="pl-smi">console</span><span class="pl-kos">.</span><span class="pl-en">log</span><span class="pl-kos">(</span><span class="pl-s">'topology description changed'</span><span class="pl-kos">,</span> <span class="pl-smi">JSON</span><span class="pl-kos">.</span><span class="pl-en">stringify</span><span class="pl-kos">(</span><span class="pl-s1">newDescription</span><span class="pl-kos">)</span><span class="pl-kos">)</span>
    

    });

    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:

    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[]

    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.

    ClusterTime interface signature optionality

    The ClusterTime interface incorrectly reported the signature field as required, the server may omit it, so the typescript has been updated to reflect reality.

    Summary

    Features

    Bug Fixes

    Performance Improvements

    Documentation

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

  • 6.6.0-dev.20240504.sha.2609953 - 2024-05-04
  • 6.5.0 - 2024-03-11

    6.5.0 (2024-03-11)

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

    Release Notes

    Bulk Write Operations Generate Ids using pkFactory

    When performing inserts, the driver automatically generates _ids for each document if there is no _id present. By default, the driver generates ObjectIds. An option, pkFactory, can be used to configure the driver to generate _ids that are not object ids.

    For a long time, only Collection.insert and Collection.insertMany actually used the pkFactory, if configured. Notably, Collection.bulkWrite(), Collection.initializeOrderedBulkOp() and Collection.initializeOrderedBulkOp() always generated ObjectIds, regardless of what was configured on collection.

    The driver always generates _ids for inserted documents using the pkFactory.

    Caution

    If you a...

Snyk has created this PR to upgrade mongodb from 6.2.0 to 6.8.0.

See this package in npm:
mongodb

See this project in Snyk:
https://app.snyk.io/org/lydiamoon7/project/db315a82-4a35-495f-9f45-8c58e365dfea?utm_source=github&utm_medium=referral&page=upgrade-pr
@lydmoon lydmoon self-assigned this Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants