Merge pull request #357 from programmatix/release/3.4

3.4.1 release

Author: RichardSmedley

modules/hello-world/pages/start-using-sdk.adoc

@@ -61,7 +61,7 @@ We recommend running the latest Java LTS version (i.e. at the time of writing JD
 // Other supported Java versions will work, too.
 Couchbase publishes all stable artifacts to https://search.maven.org/search?q=com.couchbase.client[Maven Central].
 
-The latest version (as of October 2022) is https://search.maven.org/artifact/com.couchbase.client/java-client/3.4.0/jar[3.4.0].
+The latest version (as of December 2022) is https://search.maven.org/artifact/com.couchbase.client/java-client/3.4.1/jar[3.4.1].
 
 You can use your favorite dependency management tool to install the SDK.
 
@@ -76,7 +76,7 @@ Maven::
     <dependency>
         <groupId>com.couchbase.client</groupId>
         <artifactId>java-client</artifactId>
-        <version>3.4.0</version>
+        <version>3.4.1</version>
     </dependency>
 </dependencies>
 ----
@@ -87,7 +87,7 @@ Gradle::
 --
 [source,groovy]
 ----
-implementation 'com.couchbase.client:java-client:3.4.0'
+implementation 'com.couchbase.client:java-client:3.4.1'
 ----
 --
 ====

modules/project-docs/pages/sdk-full-installation.adoc

@@ -33,7 +33,7 @@ We recommend running the latest Java LTS version (i.e. at the time of writing JD
 Java 17 has various enhancements like sealed classes, pattern matching for switch expressions (in preview), and further updates and improvements on core libraries.
 
 Couchbase publishes all stable artifacts to https://search.maven.org/search?q=com.couchbase.client[Maven Central].
-The latest version (as of October 2022) is https://search.maven.org/artifact/com.couchbase.client/java-client/3.4.0/jar[3.4.0].
+The latest version (as of December 2022) is https://search.maven.org/artifact/com.couchbase.client/java-client/3.4.1/jar[3.4.1].
 
 You can use your favorite dependency management tool to install the SDK.
 
@@ -51,7 +51,7 @@ The following snippet shows how to do it with https://maven.apache.org/[Maven].
     <dependency>
         <groupId>com.couchbase.client</groupId>
         <artifactId>java-client</artifactId>
-        <version>3.4.0</version>
+        <version>3.4.1</version>
     </dependency>
 </dependencies>
 ----
@@ -63,7 +63,7 @@ For https://gradle.org/[Gradle], you can use:
 
 [source,groovy]
 ----
-implementation 'com.couchbase.client:java-client:3.4.0'
+implementation 'com.couchbase.client:java-client:3.4.1'
 ----
 --
 ====

modules/project-docs/pages/sdk-release-notes.adoc

@@ -17,6 +17,71 @@ See the xref:project-docs:sdk-full-installation.adoc[Full Installation] guide fo
 
 
 // tag::all[]
+== Version 3.4.1 (7 December 2022)
+
+Version 3.4.1 is the second release of the 3.4 series.
+The headline change is support for the KV range scan feature (`collection.scan()`), added at @Stability.Volatile level.
+This feature will be available in a future version of Couchbase Server.
+
+https://packages.couchbase.com/clients/java/3.4.1/Couchbase-Java-Client-3.4.1.zip[Download] |
+https://docs.couchbase.com/sdk-api/couchbase-java-client-3.4.1/index.html[API Reference] |
+http://docs.couchbase.com/sdk-api/couchbase-core-io-2.4.1/[Core API Reference]
+
+The supported and tested dependencies for this release are:
+
+* com.couchbase.client:**java-client:3.4.1**
+* com.couchbase.client:**core-io:2.4.1**
+* io.projectreactor:**reactor-core:3.5.0**
+* org.reactivestreams:**reactive-streams:1.0.4**
+
+Optional artifacts on top of this SDK version are tested for the following compatibilities:
+
+.Optional Artifact Version Compatibility
+[options="header"]
+|=======================
+| Artifact                  | Couchbase Version | Built Against              | API Stability
+| `tracing-opentelemetry`   | 1.2.1             | OpenTelemetry 1.19.0       | Committed
+| `tracing-opentracing`     | 1.2.1             | OpenTracing 0.33.0         | Committed
+| `metrics-opentelemetry`   | 0.4.1             | OpenTelemetry 1.19.0       | Volatile
+| `metrics-micrometer`      | 0.4.1             | Micrometer 1.10.0          | Volatile
+|=======================
+
+
+=== Improvements
+* https://issues.couchbase.com/browse/JVMCBC-1163[JVMCBC-1163]:
+Dependencies have been updated.
+* https://issues.couchbase.com/browse/JVMCBC-1156[JVMCBC-1156]:
+The traffic tracing functionality has been enchanced to perform Wireshark-style dissection of portions of the KV protocol.
+* https://issues.couchbase.com/browse/JCBC-1984[JCBC-1984]:
+KV range scan functionality (`collection.scan()`) added at @Stability.Volatile level.
+Users are encouraged to experiment with the feature and provide feedback ahead of its formal release in 3.5.0.
+* https://issues.couchbase.com/browse/JCBC-2018[JCBC-2018]:
+Make Core and CoreEnvironment Autocloseable.
+* https://issues.couchbase.com/browse/JCBC-2009[JCBC-2009]:
+Fixed an issue where ArraySetOptions was extending CommonDatastructureOptions incorrectly.
+* https://issues.couchbase.com/browse/JCBC-2021[JCBC-2021]:
+Diagnostics for an endpoint now include the state of the endpoint's circuit breaker.
+* https://issues.couchbase.com/browse/JCBC-2027[JCBC-2027]:
+The `ClusterEnvironment.Builder` methods that take a `Builder` are deprecated in favor of the overloads that take a `Consumer<Builder>`.
+For example, `ioConfig(IoConfig.Builder)` is deprecated in favor of `ioConfig(Consumer<IoConfig.Builder>)`.
+The methods that take a `Consumer<Builder>` are preferable because they allow customizing the config without clobbering the previous values.
+* https://issues.couchbase.com/browse/JCBC-2028[JCBC-2028]:
+`Cluster.connect` now throws an `IllegalArgumentException` if you pass a pre-built `ClusterEnvironment` and a connection string incompatible with the environment.
+Before this change, an incompatibility was logged as a warning, and the connection string scheme and parameters were ignored.
+`ConnectionStringIgnoredEvent` is now deprecated, since the SDK never publishes it anymore.
+** A pre-built environment without TLS enabled is incompatible with a connection string that specifies the secure `couchases` scheme.
+** A pre-built environment is incompatible with a connection string that has parameters.
+* https://issues.couchbase.com/browse/JVMCBC-1159[JVMCBC-1159]:
+Transactions now support upcoming server query_context changes.
+
+=== Bugs
+* https://issues.couchbase.com/browse/JVMCBC-1157[JVMCBC-1157]:
+The SDK no longer rejects a `PersistTo` requirement in a bucket using the Magma storage engine. Before this change, the SDK would refuse the request because it misidentified Magma buckets as ephemeral (unable to persist documents).
+* https://issues.couchbase.com/browse/JVMCBC-1167[JVMCBC-1167]:
+If you call `CancellationErrorContext.getWaitUntilReadyContext()` on an error context that didn't come from a "wait until ready" request, the method is now guaranteed to return null instead of sometimes throwing a `ClassCastException`.
+* https://issues.couchbase.com/browse/JCBC-2024[JCBC-2024]:
+Fixed a memory leak in ManagerMessageHandler.
+
 == Version 3.4.0 (24 October 2022)
 
 Version 3.4.0 is the first release of the 3.4 series.

modules/project-docs/partials/attributes.adoc

@@ -1,5 +1,5 @@
 :java-api-link: https://docs.couchbase.com/sdk-api/couchbase-java-client/
-:java-current-version: 3.4.0
+:java-current-version: 3.4.1
 :version-server: 7.1
 :version-common: 7.1.2
 :name-sdk: Java SDK

pom.xml

@@ -22,7 +22,7 @@
         <dependency>
             <groupId>com.couchbase.client</groupId>
             <artifactId>java-client</artifactId>
-            <version>3.4.0</version>
+            <version>3.4.1</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>