From 2d152d87b89636bd4539bee52cde2cca6f2ee620 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:31:26 -0500 Subject: [PATCH 1/8] v6.8 --- config/redirects | 2 +- snooty.toml | 2 +- .../mongodb-compatibility-table-node.rst | 2 +- source/whats-new.txt | 65 +++++++++++++++++++ 4 files changed, 68 insertions(+), 3 deletions(-) diff --git a/config/redirects b/config/redirects index 0fd3293c..ac1f802d 100644 --- a/config/redirects +++ b/config/redirects @@ -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 v6.5 v6.6 v6.7 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 v6.6 v6.7 v6.8 master symlink: current -> master diff --git a/snooty.toml b/snooty.toml index 9786c6d2..27e759fd 100644 --- a/snooty.toml +++ b/snooty.toml @@ -19,7 +19,7 @@ toc_landing_pages = [ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" [constants] -version = "6.7" +version = "6.8" api = "https://mongodb.github.io/node-mongodb-native/{+version+}" driver-long = "MongoDB Node.js driver" driver-short = "Node.js driver" diff --git a/source/includes/mongodb-compatibility-table-node.rst b/source/includes/mongodb-compatibility-table-node.rst index 3dbfb0e9..2e0d5953 100644 --- a/source/includes/mongodb-compatibility-table-node.rst +++ b/source/includes/mongodb-compatibility-table-node.rst @@ -16,7 +16,7 @@ - MongoDB 3.0 - MongoDB 2.6 - * - 6.0 to 6.7 + * - 6.0 to 6.8 - ✓ - ✓ - ✓ diff --git a/source/whats-new.txt b/source/whats-new.txt index d1bf9cc4..e479920f 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -19,6 +19,7 @@ What's New Learn what's new in: +* :ref:`Version 6.8 ` * :ref:`Version 6.7 ` * :ref:`Version 6.6 ` * :ref:`Version 6.5 ` @@ -58,6 +59,70 @@ Learn what's new in: * :ref:`Version 3.7 ` * :ref:`Version 3.6 ` +.. _version-6.8: + +What's New in 6.8 +----------------- + +The {+driver-short+} v6.7 release includes the following features: + +- Fixes a bug where a local KMS provider accepted a ``BSON Binary`` instance at + runtime, but the TypeScript compiler allowed only values of type ``Buffer`` and + ``string``. + +- The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error. + +- KMS providers can now be associated with a name, and multiple keys can be provided + for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or + later. + + The following code example configures a ``ClientEncryption`` object with multiple AWS keys: + +.. code-block:: javascript + :copyable: true + + const clientEncryption = new ClientEncryption(keyVaultClient, { + 'aws:key1': { + accessKeyId: ..., + secretAccessKey: ... + }, + 'aws:key2': { + accessKeyId: ..., + secretAccessKey: ... + }, + + clientEncryption.createDataKey('aws:key-1', { ... }); + + .. note:: + + You can't use named KMS providers if your application uses the automatic + KMS provider refresh capability. + +- When you create a KMIP data key, you can now specify the ``delegated`` option. If this + option is set to ``true``, the KMIP provider performs encryption and decryption of + the data key locally, ensuring that the encryption key never leaves the KMIP server. + This feature requires ``mongodb-client-encryption`` v6.0.1 or later. + +.. code-block:: javascript + :copyable: true + + clientEncryption.createDataKey('kmip', { masterKey: { delegated: true } } ); + +- The driver now decodes BSON responses as the cursor iterates over them, + rather than decoding the entire BSON response when it is received. + +- The Github release for the ``mongodb`` package now contains a detached signature file for + the NPM package (named mongodb-X.Y.Z.tgz.sig). This change applies to every major + and patch release for versions 5 and 6 of the driver. To verify the package signature, + follow the instructions in the Release Integrity section of the + `README.md `__ + file in the driver's GitHub repository. + +To learn more about this release, see the +`v6.8.0 Release Notes +`__ on +GitHub. + .. _version-6.7: What's New in 6.7 From df36bdb4b4314539d9b83a443e07b02d936d51b5 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:33:40 -0500 Subject: [PATCH 2/8] code fix --- source/whats-new.txt | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index e479920f..5e9cbecd 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -74,7 +74,8 @@ The {+driver-short+} v6.7 release includes the following features: - KMS providers can now be associated with a name, and multiple keys can be provided for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or - later. + later. You can't use named KMS providers if your application uses the automatic + KMS provider refresh capability. The following code example configures a ``ClientEncryption`` object with multiple AWS keys: @@ -93,11 +94,6 @@ The {+driver-short+} v6.7 release includes the following features: clientEncryption.createDataKey('aws:key-1', { ... }); - .. note:: - - You can't use named KMS providers if your application uses the automatic - KMS provider refresh capability. - - When you create a KMIP data key, you can now specify the ``delegated`` option. If this option is set to ``true``, the KMIP provider performs encryption and decryption of the data key locally, ensuring that the encryption key never leaves the KMIP server. From 4f9b654a6d713086225b66f3b6545df494c39123 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:36:28 -0500 Subject: [PATCH 3/8] reword --- source/whats-new.txt | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 5e9cbecd..b1d45f4a 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -73,11 +73,8 @@ The {+driver-short+} v6.7 release includes the following features: - The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error. - KMS providers can now be associated with a name, and multiple keys can be provided - for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or - later. You can't use named KMS providers if your application uses the automatic - KMS provider refresh capability. - - The following code example configures a ``ClientEncryption`` object with multiple AWS keys: + for each KMS provider. The following code example shows how to configure a + ``ClientEncryption`` object with multiple AWS keys: .. code-block:: javascript :copyable: true @@ -94,9 +91,14 @@ The {+driver-short+} v6.7 release includes the following features: clientEncryption.createDataKey('aws:key-1', { ... }); + You can't use named KMS providers if your application uses the automatic + KMS provider refresh capability. + This feature requires ``mongodb-client-encryption`` v6.0.1 or later. + - When you create a KMIP data key, you can now specify the ``delegated`` option. If this option is set to ``true``, the KMIP provider performs encryption and decryption of the data key locally, ensuring that the encryption key never leaves the KMIP server. + The following code example This feature requires ``mongodb-client-encryption`` v6.0.1 or later. .. code-block:: javascript From 6a5e9f894c4d1e6e4150cf7a10cd095e02a62e25 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:37:59 -0500 Subject: [PATCH 4/8] fix code --- source/whats-new.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index b1d45f4a..de35c4c6 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -73,8 +73,12 @@ The {+driver-short+} v6.7 release includes the following features: - The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error. - KMS providers can now be associated with a name, and multiple keys can be provided - for each KMS provider. The following code example shows how to configure a - ``ClientEncryption`` object with multiple AWS keys: + for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or later. + You can't use named KMS providers if your application uses the automatic + KMS provider refresh capability. + + The following code example shows how to configure a ``ClientEncryption`` object with + multiple AWS keys: .. code-block:: javascript :copyable: true @@ -91,10 +95,6 @@ The {+driver-short+} v6.7 release includes the following features: clientEncryption.createDataKey('aws:key-1', { ... }); - You can't use named KMS providers if your application uses the automatic - KMS provider refresh capability. - This feature requires ``mongodb-client-encryption`` v6.0.1 or later. - - When you create a KMIP data key, you can now specify the ``delegated`` option. If this option is set to ``true``, the KMIP provider performs encryption and decryption of the data key locally, ensuring that the encryption key never leaves the KMIP server. From e886f08ff5f7069502fa55052d131d16972b015e Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 12:39:07 -0500 Subject: [PATCH 5/8] fixes --- source/whats-new.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index de35c4c6..495d6497 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -98,8 +98,9 @@ The {+driver-short+} v6.7 release includes the following features: - When you create a KMIP data key, you can now specify the ``delegated`` option. If this option is set to ``true``, the KMIP provider performs encryption and decryption of the data key locally, ensuring that the encryption key never leaves the KMIP server. - The following code example This feature requires ``mongodb-client-encryption`` v6.0.1 or later. + + The following code example shows how to specify this option: .. code-block:: javascript :copyable: true @@ -110,7 +111,7 @@ The {+driver-short+} v6.7 release includes the following features: rather than decoding the entire BSON response when it is received. - The Github release for the ``mongodb`` package now contains a detached signature file for - the NPM package (named mongodb-X.Y.Z.tgz.sig). This change applies to every major + the NPM package (named ``mongodb-X.Y.Z.tgz.sig``). This change applies to every major and patch release for versions 5 and 6 of the driver. To verify the package signature, follow the instructions in the Release Integrity section of the `README.md `__ From 18668280b2c8227b02e7631199b340a97e0b3e94 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:18:26 -0500 Subject: [PATCH 6/8] code block --- source/whats-new.txt | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 495d6497..75f2155c 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -80,20 +80,20 @@ The {+driver-short+} v6.7 release includes the following features: The following code example shows how to configure a ``ClientEncryption`` object with multiple AWS keys: -.. code-block:: javascript - :copyable: true + .. code-block:: javascript + :copyable: true - const clientEncryption = new ClientEncryption(keyVaultClient, { - 'aws:key1': { - accessKeyId: ..., - secretAccessKey: ... - }, - 'aws:key2': { - accessKeyId: ..., - secretAccessKey: ... - }, + const clientEncryption = new ClientEncryption(keyVaultClient, { + 'aws:key1': { + accessKeyId: ..., + secretAccessKey: ... + }, + 'aws:key2': { + accessKeyId: ..., + secretAccessKey: ... + }, - clientEncryption.createDataKey('aws:key-1', { ... }); + clientEncryption.createDataKey('aws:key-1', { ... }); - When you create a KMIP data key, you can now specify the ``delegated`` option. If this option is set to ``true``, the KMIP provider performs encryption and decryption of @@ -102,10 +102,10 @@ The {+driver-short+} v6.7 release includes the following features: The following code example shows how to specify this option: -.. code-block:: javascript - :copyable: true + .. code-block:: javascript + :copyable: true - clientEncryption.createDataKey('kmip', { masterKey: { delegated: true } } ); + clientEncryption.createDataKey('kmip', { masterKey: { delegated: true } } ); - The driver now decodes BSON responses as the cursor iterates over them, rather than decoding the entire BSON response when it is received. From dbe1589a8e0914ee0ddb7504f2d603d10c57a674 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:34:53 -0500 Subject: [PATCH 7/8] js feedback --- source/whats-new.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 75f2155c..5e36b022 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -64,7 +64,7 @@ Learn what's new in: What's New in 6.8 ----------------- -The {+driver-short+} v6.7 release includes the following features: +The {+driver-short+} v6.8 release includes the following features: - Fixes a bug where a local KMS provider accepted a ``BSON Binary`` instance at runtime, but the TypeScript compiler allowed only values of type ``Buffer`` and @@ -72,8 +72,8 @@ The {+driver-short+} v6.7 release includes the following features: - The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error. -- KMS providers can now be associated with a name, and multiple keys can be provided - for each KMS provider. This feature requires ``mongodb-client-encryption`` v6.0.1 or later. +- You can now associate a name, and provide multiple keys for, KMS providers. + This feature requires ``mongodb-client-encryption`` v6.0.1 or later. You can't use named KMS providers if your application uses the automatic KMS provider refresh capability. @@ -110,9 +110,9 @@ The {+driver-short+} v6.7 release includes the following features: - The driver now decodes BSON responses as the cursor iterates over them, rather than decoding the entire BSON response when it is received. -- The Github release for the ``mongodb`` package now contains a detached signature file for - the NPM package (named ``mongodb-X.Y.Z.tgz.sig``). This change applies to every major - and patch release for versions 5 and 6 of the driver. To verify the package signature, +- The Github release for the ``mongodb`` package now contains a detached signature file, + ``mongodb-X.Y.Z.tgz.sig``, for the NPM package. This change applies to every major + and patch release for versions 5.x and 6.x of the driver. To verify the package signature, follow the instructions in the Release Integrity section of the `README.md `__ file in the driver's GitHub repository. From f46f5c19afb1ee19d39591b905ef73ebd7987d84 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:46:06 -0500 Subject: [PATCH 8/8] add with --- source/whats-new.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 5e36b022..6fa7b583 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -72,7 +72,7 @@ The {+driver-short+} v6.8 release includes the following features: - The ``ReadConcernMajorityNotAvailableYet`` error is now a retryable read error. -- You can now associate a name, and provide multiple keys for, KMS providers. +- You can now associate a name with, and provide multiple keys for, KMS providers. This feature requires ``mongodb-client-encryption`` v6.0.1 or later. You can't use named KMS providers if your application uses the automatic KMS provider refresh capability.