From a6e9bb2dd8dabf13a735e468e4d2852e16d18bb0 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 15 Aug 2024 17:30:12 -0400 Subject: [PATCH 1/5] what's new --- source/whats-new.txt | 134 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 133 insertions(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 8a5cb77b..05989595 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -4,4 +4,136 @@ What's New ========== -.. TODO \ No newline at end of file +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Learn what's new in: + +* :ref:`Version 5.1.3 ` +* :ref:`Version 5.1.2 ` +* :ref:`Version 5.1.1 ` +* :ref:`Version 5.1 ` +* :ref:`Version 5.0 ` + +.. _kotlin-sync-version-5.1.3: + +What's New in 5.1.3 +------------------- + +The 5.1.3 driver patch release includes the following changes: + +.. sharedinclude:: dbx/jvm/v5.1.3-wn-items.rst + +.. _kotlin-sync-version-5.1.2: + +What's New in 5.1.2 +------------------- + +The 5.1.2 driver patch release includes the following changes: + +- Support for encoding Kotlin data classes with nullable + generic parameter types. For example, you can encode the ``Container`` class + in the following code: + + .. code-block:: kotlin + + @Serializable + data class Box( + val boxed: T + ) + + @Serializable + data class Container( + val box: Box + ) + +.. _kotlin-sync-version-5.1.1: + +What's New in 5.1.1 +------------------- + +The 5.1.1 driver patch release includes the following changes: + +- When using the ``MONGODB-OIDC`` authentication mechanism, you must not + include comma characters in the ``authMechanismProperties`` connection + string value. To learn more about this behavior, see the + :ref:`MONGODB-OIDC ` section of the Enterprise + Authentication guide. + +.. _kotlin-sync-version-5.1: + +What's New in 5.1 +----------------- + +.. warning:: Deprecations in this release + + To avoid breaking changes in future major releases of the driver, + replace any application code that depends on deprecated program elements. + +This section includes the following information: + +- :ref:`kotlin-deprecations-5.1` +- :ref:`kotlin-improvements-5.1` +- :ref:`kotlin-new-features-5.1` + +.. _kotlin-deprecations-5.1: + +Deprecations in 5.1 +~~~~~~~~~~~~~~~~~~~ + +- Support for {+mdb-server+} v3.6 is deprecated and will be removed in the + next driver version release. To learn how to upgrade your {+mdb-server+} + deployment, see :manual:`Release Notes ` in the {+mdb-server+} + manual. + +.. _kotlin-improvements-5.1: + +Improvements in 5.1 +~~~~~~~~~~~~~~~~~~~ + +- Internal testing of GraalVM native image technology. These tests involve building + native applications by using the GraalVM native-image tool. + +- Enhanced support for the ``MONGODB-OIDC`` authentication mechanism. + To learn more about OIDC, see the :ref:`kotlin-oidc` section of the + Enterprise Authentication Mechanisms guide. + +- Fixes an issue in which operations used the incorrect codec when using + a polymorphic ``MongoCollection`` instance. This ensures that + discriminator information is not lost when using ``bson-kotlinx``. + +- Fixes an issue in which the class discriminator was the first field + when decoding, resulting in field type errors when using a polymorphic + ``MongoCollection`` instance. + +.. _kotlin-new-features-5.1: + +New Features in 5.1 +~~~~~~~~~~~~~~~~~~~ + +- Support for polymorphic serialization. To learn more, see the + :ref:`kotlin-polymorphic` section of the Kotlin Serialization guide. + +- Introduces the ``serverMonitoringMode`` connection URI option. To + learn more, see the :ref:`connection-options` guide. + +.. _version-5.0: + +What's New in 5.0 +----------------- + +New features of the 5.0 driver release include: + +- The ``KotlinSerializerCodecProvider`` constructor now accepts + ``serializersModule`` and ``bsonConfiguration`` objects: + + .. code-block:: kotlin + + KotlinSerializerCodec.create(clazz.kotlin, serializersModule=serializersModule, bsonConfiguration=bsonConfiguration) + + This makes it easier to customize your configuration. + +- Fixes a Kotlin reflection bug that resulted in container type erasure. From 93314fad978bc0aa98af19000b4a6e9c2043db67 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 15 Aug 2024 17:35:42 -0400 Subject: [PATCH 2/5] go through links --- 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 05989595..89c7fee6 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -118,7 +118,7 @@ New Features in 5.1 :ref:`kotlin-polymorphic` section of the Kotlin Serialization guide. - Introduces the ``serverMonitoringMode`` connection URI option. To - learn more, see the :ref:`connection-options` guide. + learn more, see the :ref:`kotlin-sync-connection-options` guide. .. _version-5.0: From 6915e157957e22d550f804d330cbfb3bf1b57976 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 15 Aug 2024 17:40:29 -0400 Subject: [PATCH 3/5] add to toc --- source/index.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.txt b/source/index.txt index 55df6e49..85e154ef 100644 --- a/source/index.txt +++ b/source/index.txt @@ -25,6 +25,7 @@ /issues-and-help /compatibility Validate Driver Artifact Signatures + /whats-new View the Source API Documentation <{+api+}/com.mongodb.kotlin.client/index.html> From a6920fa11b35327a636b345526f49231ffffc5c1 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 16 Aug 2024 15:55:22 -0400 Subject: [PATCH 4/5] review comments --- source/whats-new.txt | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 89c7fee6..32adfb4d 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -16,7 +16,7 @@ Learn what's new in: * :ref:`Version 5.1.2 ` * :ref:`Version 5.1.1 ` * :ref:`Version 5.1 ` -* :ref:`Version 5.0 ` +* :ref:`Version 5.0 ` .. _kotlin-sync-version-5.1.3: @@ -59,9 +59,9 @@ The 5.1.1 driver patch release includes the following changes: - When using the ``MONGODB-OIDC`` authentication mechanism, you must not include comma characters in the ``authMechanismProperties`` connection - string value. To learn more about this behavior, see the - :ref:`MONGODB-OIDC ` section of the Enterprise - Authentication guide. + string value. To learn more about this behavior, see + `MongoCredential <{+core-api+}/com/mongodb/MongoCredential.html>`__ in the + API documentation. .. _kotlin-sync-version-5.1: @@ -75,11 +75,11 @@ What's New in 5.1 This section includes the following information: -- :ref:`kotlin-deprecations-5.1` -- :ref:`kotlin-improvements-5.1` -- :ref:`kotlin-new-features-5.1` +- :ref:`kotlin-sync-deprecations-5.1` +- :ref:`kotlin-sync-improvements-5.1` +- :ref:`kotlin-sync-new-features-5.1` -.. _kotlin-deprecations-5.1: +.. _kotlin-sync-deprecations-5.1: Deprecations in 5.1 ~~~~~~~~~~~~~~~~~~~ @@ -89,7 +89,7 @@ Deprecations in 5.1 deployment, see :manual:`Release Notes ` in the {+mdb-server+} manual. -.. _kotlin-improvements-5.1: +.. _kotlin-sync-improvements-5.1: Improvements in 5.1 ~~~~~~~~~~~~~~~~~~~ @@ -98,8 +98,9 @@ Improvements in 5.1 native applications by using the GraalVM native-image tool. - Enhanced support for the ``MONGODB-OIDC`` authentication mechanism. - To learn more about OIDC, see the :ref:`kotlin-oidc` section of the - Enterprise Authentication Mechanisms guide. + To learn more about OIDC, see + `MongoCredential <{+core-api+}/com/mongodb/MongoCredential.html>`__ in the + API documentation. - Fixes an issue in which operations used the incorrect codec when using a polymorphic ``MongoCollection`` instance. This ensures that @@ -109,18 +110,20 @@ Improvements in 5.1 when decoding, resulting in field type errors when using a polymorphic ``MongoCollection`` instance. -.. _kotlin-new-features-5.1: +.. _kotlin-sync-new-features-5.1: New Features in 5.1 ~~~~~~~~~~~~~~~~~~~ -- Support for polymorphic serialization. To learn more, see the - :ref:`kotlin-polymorphic` section of the Kotlin Serialization guide. +- Support for polymorphic serialization. + +.. TODO: Add link to Kotlin Serialization page when ready: https://jira.mongodb.org/browse/DOCSP-42666 . +.. ex. To learn more, see the :ref:`kotlin-sync-polymorphic` section of the Kotlin Sync Serialization guide. - Introduces the ``serverMonitoringMode`` connection URI option. To learn more, see the :ref:`kotlin-sync-connection-options` guide. -.. _version-5.0: +.. _kotlin-sync-version-5.0: What's New in 5.0 ----------------- From 7f1e4170a3454f6f8aaf9b7f8bcfd7c6e56d7d2c Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 16 Aug 2024 16:20:44 -0400 Subject: [PATCH 5/5] oidc todo --- source/whats-new.txt | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 32adfb4d..a5743dfe 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -59,9 +59,12 @@ The 5.1.1 driver patch release includes the following changes: - When using the ``MONGODB-OIDC`` authentication mechanism, you must not include comma characters in the ``authMechanismProperties`` connection - string value. To learn more about this behavior, see - `MongoCredential <{+core-api+}/com/mongodb/MongoCredential.html>`__ in the - API documentation. + string value. + +.. TODO: Link to OIDC content once completed +.. ex. To learn more about this behavior, see the + :ref:`MONGODB-OIDC ` section of the Enterprise + Authentication guide. .. _kotlin-sync-version-5.1: @@ -98,9 +101,11 @@ Improvements in 5.1 native applications by using the GraalVM native-image tool. - Enhanced support for the ``MONGODB-OIDC`` authentication mechanism. - To learn more about OIDC, see - `MongoCredential <{+core-api+}/com/mongodb/MongoCredential.html>`__ in the - API documentation. + +.. TODO: Link to OIDC content once completed +.. ex. To learn more about OIDC, see the + :ref:`MONGODB-OIDC ` section of the Enterprise + Authentication guide. - Fixes an issue in which operations used the incorrect codec when using a polymorphic ``MongoCollection`` instance. This ensures that