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

DOCSP-37612: v6.5.0 release #881

Merged
merged 5 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .backportrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
// the branches available to backport to
"targetBranchChoices": [
"master",
"v6.4"
"v6.5",
"v6.4",
"v6.3",
"v6.2",
"v6.1",
Expand Down
2 changes: 1 addition & 1 deletion config/redirects
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
define: prefix docs/drivers/node
define: base https://www.mongodb.com/${prefix}
define: versions v3.6 v3.7 v4.0 v4.1 v4.2 v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v4.12 v4.13 v4.14 v4.15 v4.16 v4.17 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 v5.7 v5.8 v5.9 v6.0 v6.1 v6.2 v6.3 v6.4 master
define: versions v3.6 v3.7 v4.0 v4.1 v4.2 v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v4.12 v4.13 v4.14 v4.15 v4.16 v4.17 v5.0 v5.1 v5.2 v5.3 v5.4 v5.5 v5.6 v5.7 v5.8 v5.9 v6.0 v6.1 v6.2 v6.3 v6.4 v6.5 master

symlink: current -> master

Expand Down
2 changes: 1 addition & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ toc_landing_pages = [
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

[constants]
version = "6.4"
version = "6.5"
api = "https://mongodb.github.io/node-mongodb-native/{+version+}"
driver-long = "MongoDB Node.js driver"
driver-short = "Node.js driver"
Expand Down
2 changes: 1 addition & 1 deletion source/includes/mongodb-compatibility-table-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- MongoDB 3.0
- MongoDB 2.6

* - 6.0 to 6.4
* - 6.0 to 6.5
- ✓
- ✓
- ✓
Expand Down
71 changes: 55 additions & 16 deletions source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ What's New
.. facet::
:name: genre
:values: reference

.. meta::
:keywords: version, update, upgrade, backwards compatibility


Learn what's new in:

* :ref:`Version 6.5 <version-6.5>`
* :ref:`Version 6.4 <version-6.4>`
* :ref:`Version 6.3 <version-6.3>`
* :ref:`Version 6.2 <version-6.2>`
Expand Down Expand Up @@ -56,6 +57,44 @@ Learn what's new in:
* :ref:`Version 3.7 <version-3.7>`
* :ref:`Version 3.6 <version-3.6>`

.. _version-6.5:

What's New in 6.5
-----------------

The {+driver-short+} v6.5 release includes the following features:

- Moved ``ObjectId`` generation to the ``pkFactory`` class for bulk write
operations.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: match tense

Suggested change
- Moved ``ObjectId`` generation to the ``pkFactory`` class for bulk write
operations.
- Moves ``ObjectId`` generation to the ``pkFactory`` class for bulk write
operations.


.. warning::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: should this warning be indented to be under the preceding bullet point?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure you can put an admonition in a list, but I'll try it out.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, that didn't work (unexpected indentation error)


If you previously specified the ``pkFactory`` to handle bulk writes,
the ``_id`` fields of the documents inserted by using bulk writes may
be inconsistent with the behavior in this version.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you previously specified the ``pkFactory`` to handle bulk writes,
the ``_id`` fields of the documents inserted by using bulk writes may
be inconsistent with the behavior in this version.
If you previously specified that a ``pkFactory`` instance handles bulk writes,
the ``_id`` fields of the documents inserted by using bulk writes may
be inconsistent with the behavior in this version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call! Will update to clarify an instance.


- Fixes the read preference sent with read operations when directly connected
to a secondary in the replica set to ``primaryPreferred``.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Fixes the read preference sent with read operations when directly connected
to a secondary in the replica set to ``primaryPreferred``.
- Sets the read preference that is sent with read operations to ``primaryPreferred`` when
you are directly connected to a secondary in the replica set.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the rewording. I'll use parts of this suggestion, but will continue to use the verb "fixes" to make sure it's understood that way. From the release notes:

Fixed applying read preference to commands depending on topology


- Fixes a memory leak in promise creation for socket operations.

- Reduces first-time connection latency when connecting to a DNS seedlist by
querying the ``SRV`` and ``TXT`` records in parallel.

- Adds tracking to container metadata when running a client in Kubernetes
or a container environment in the ``client.env.container`` field of the
handshake document.

- Adds the original error document returned by the server to the
``errorResponse`` field of the ``MongoServerError`` document.

- Deprecates the ``CloseOptions`` interface which is unused by the driver.

To learn more about this release, see the
`v6.5.0 Release Highlights
<https://github.com/mongodb/node-mongodb-native/releases/tag/v6.5.0>`__ on
GitHub.
Comment on lines +94 to +97
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: maybe out of scope, but I noticed the v6.4 section is missing this link

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I'll add it.


.. _version-6.4:

What's New in 6.4
Expand All @@ -73,7 +112,7 @@ The {+driver-short+} v6.4 release includes the following features:
release notes for `BSON 6.3.0
<https://github.com/mongodb/js-bson/releases/tag/v6.3.0>`__ and `BSON 6.4.0
<https://github.com/mongodb/js-bson/releases/tag/v6.4.0>`__.

- Read operations that result in an ``ExceededTimeLimit`` error are retried.

- Fixes a request issue related to :ref:`TLS sockets <node-connect-tls>` and
Expand Down Expand Up @@ -116,9 +155,9 @@ The {+driver-short+} v6.3 release includes the following features:
``MongoClientOptions`` instance or as a connection string option. The
following example shows how to create a client with the option set to
``stream``:

.. code-block:: js

new MongoClient('<connection string>', { serverMonitoringMode: 'stream' });

- Fixes a connection leak when the ``serverApi`` client option is set.
Expand Down Expand Up @@ -180,7 +219,7 @@ The {+driver-short+} v6.1 release includes the following features:
authenticating by using the ``MONGODB-AWS`` authentication mechanism.
To instruct the driver to use your region options, you must set both
of the following environment variables:

- ``AWS_STS_REGIONAL_ENDPOINTS``
- ``AWS_REGION``

Expand All @@ -198,8 +237,8 @@ What's New in 6.0

.. warning:: Breaking Changes in v6.0

This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 6.x Breaking Changes section <node-breaking-changes-v6.x>` in the
This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 6.x Breaking Changes section <node-breaking-changes-v6.x>` in the
Upgrade guide.

The {+driver-short+} v6.0 release includes the following features:
Expand Down Expand Up @@ -240,13 +279,13 @@ The {+driver-short+} v6.0 release includes the following features:
options. The value of ``keepAlive`` is permanently set to ``true`` and the
value of ``keepAliveInitialDelay`` is set to 300000 milliseconds (300
seconds).

To learn how to set keepalive settings at a system level,
see the :manual:`Does TCP keepalive time affect MongoDB Deployments? </faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments->`
FAQ entry in the Server manual.

- Removes the following options for the ``Db.command()`` method:

- ``willRetryWrite``
- ``omitReadPreference``
- ``writeConcern``
Expand Down Expand Up @@ -288,7 +327,7 @@ The {+driver-short+} v5.9 release includes the following features:
uses the rounding behavior from previous versions of the driver. For more information,
see the `Release Notes for v5.5 of the js-bson package <https://github.com/mongodb/js-bson/releases/tag/v5.5.0>`__
on GitHub.

- Added support for detecting the ``AWS_STS_REGIONAL_ENDPOINTS`` and ``AWS_REGION``
environment variables and setting the appropriate options when calling the
``fromNodeProviderChain()`` method in the AWS SDK.
Expand Down Expand Up @@ -492,8 +531,8 @@ What's New in 5.0

.. warning:: Breaking Changes in v5.0

This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 5.x Breaking Changes section <node-breaking-changes-v5.x>` in the
This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 5.x Breaking Changes section <node-breaking-changes-v5.x>` in the
Upgrade guide.

New features of the 5.0 {+driver-short+} release include:
Expand Down Expand Up @@ -866,16 +905,16 @@ What's New in 4.0

.. warning:: Breaking Changes in v4.0

This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 4.x Breaking Changes section <node-breaking-changes-v4.x>` in
This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 4.x Breaking Changes section <node-breaking-changes-v4.x>` in
the Upgrade guide.

New features of the 4.0 Node.js driver release include:

.. important::

In this release of the driver, the deprecated ``collection.count()`` method was
inadvertently changed to behave like ``collection.countDocuments()``. This behavior
In this release of the driver, the deprecated ``collection.count()`` method was
inadvertently changed to behave like ``collection.countDocuments()``. This behavior
is corrected in :ref:`version 4.4 <version-4.4>`.


Expand Down
Loading