chore: changelog and changelog for release version 2.3.4

Author: aaronchung-bitquill

CHANGELOG.md

@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/#semantic-versioning-200).
 
+## [2.3.4] - 2024-03-01
+### :magic_wand: Added
+- Documentation:
+  - Bundled Uber Jar for Federated Authentication. See [UsingTheFederatedAuthPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
+  - Using the Read Write Splitting Plugin's internal connection pool with Spring applications. See [UsingTheReadWriteSplittingPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#internal-connection-pools).
+- Spring Framework application code examples with load balanced access to database cluster reader instances ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
+- New configuration preset `SF_` optimized for Spring Framework applications ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
+- Lightweight alternative for IAM token generator that requires fewer dependencies ([PR #867](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/867)).
+
+### :bug: Fixed
+- Fixes to session state transfer ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
+- Enhanced Host Monitoring Plugin (EFM) v2 plugin to use `ConcurrentHashMap` instead of `HashMap` to avoid `ConcurrentModificationException` ([Issue #855](https://github.com/awslabs/aws-advanced-jdbc-wrapper/issues/855)).
+- Move lock location and skip executing `Statement.getConnection` when running `Statement.cancel` to fix `Statement.cancel` for MySQL ([PR #851](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/851))
+- Remove Telemetry trace associated with a Monitor thread because traces for long-running tasks is an anti-pattern ([PR #875](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/875)). 
+
+### :crab: Changed
+- HostSelector implementations to take into account HostAvailability ([PR #856](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/856)).
+- Reduced the number of Regular Expression checks with `Matcher.find` to improve performance ([PR #854](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/854)).
+- HostSpec class to not use a default lastUpdateTime and instead use null ([PR 877](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/877)).
+- Moved Reader Selection Strategies out of the `UsingTheReadWriteSplittingPlugin` doc and into its own page. See [ReaderSelectionStrategies](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/ReaderSelectionStrategies.md). 
+
 ## [2.3.3] - 2024-01-23
 ### :magic_wand: Added
 - Documentation:
@@ -262,6 +283,7 @@ The Amazon Web Services (AWS) Advanced JDBC Driver allows an application to take
 - The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
 - The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
 
+[2.3.4]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.3.3...2.3.4
 [2.3.3]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.3.2...2.3.3
 [2.3.2]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.3.1...2.3.2
 [2.3.1]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.3.0...2.3.1

Maintenance.md

@@ -18,6 +18,7 @@
 | November 29, 2023 | [Release 2.3.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.1) |
 | December 18, 2023 | [Release 2.3.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.2) |
 | January 23, 2024  | [Release 2.3.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.3) |
+| March 1, 2024     | [Release 2.3.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.4) |
 
 `aws-advanced-jdbc-wrapper` [follows semver](https://semver.org/#semantic-versioning-200) which means we will only
 release breaking changes in major versions. Generally speaking patches will be released to fix existing problems without
@@ -71,4 +72,4 @@ from the updated source after the PRs are merged.
 | Major Version | Latest Minor Version | Status      | Initial Release | Maintenance Window Start | Maintenance Window End |
 |---------------|----------------------|-------------|-----------------|--------------------------|------------------------|
 | 1             | 1.0.2                | Maintenance | Oct 5, 2022     | Apr 28, 2023             | Apr 28, 2024           | 
-| 2             | 2.3.3                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 
+| 2             | 2.3.4                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 

benchmarks/README.md

@@ -7,5 +7,5 @@ The benchmarks do not measure the performance of target JDBC drivers nor the per
 ## Usage
 1. Build the benchmarks with the following command `../gradlew jmhJar`.
     1. the JAR file will be outputted to `build/libs`
-2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.3.3-jmh.jar`.
+2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.3.4-jmh.jar`.
     1. you may have to update the command based on the exact version of the produced JAR file

docs/GettingStarted.md

@@ -16,7 +16,7 @@ If you are using the AWS JDBC Driver as part of a Gradle project, include the wr
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.3'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.4'
     implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
 }
 ```
@@ -30,16 +30,16 @@ You can use pre-compiled packages that can be downloaded directly from [GitHub R
 For example, the following command uses wget to download the wrapper:
 
 ```bash
-wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.3/aws-advanced-jdbc-wrapper-2.3.3.jar
+wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.4/aws-advanced-jdbc-wrapper-2.3.4.jar
 ```
 
 Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
 
 ```bash
-export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.3.jar
+export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.4.jar
 ```
 
-> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.3.3.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar). 
+> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.3.4.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar). 
 
 ### As a Maven Dependency
 
@@ -50,7 +50,7 @@ You can use [Maven's dependency management](https://search.maven.org/search?q=g:
     <dependency>
         <groupId>software.amazon.jdbc</groupId>
         <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-        <version>2.3.3</version>
+        <version>2.3.4</version>
     </dependency>
 </dependencies>
 ```
@@ -61,15 +61,15 @@ You can use [Gradle's dependency management](https://search.maven.org/search?q=g
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.3'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.4'
 }
 ```
 
 To add a Gradle dependency in a Kotlin syntax, use the following configuration:
 
 ```kotlin
 dependencies {
-    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.3.3")
+    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.3.4")
 }
 ```
 

docs/using-the-jdbc-driver/UsingTheJdbcDriver.md

@@ -193,7 +193,7 @@ If there is an unreleased feature you would like to try, it may be available in
   <dependency>
     <groupId>software.amazon.jdbc</groupId>
     <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-    <version>2.3.4-SNAPSHOT</version>
+    <version>2.3.5-SNAPSHOT</version>
     <scope>system</scope>
     <systemPath>path-to-snapshot-jar</systemPath>
   </dependency>

examples/SpringBootHikariExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using Hikari and the
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.3.3
+>    - AWS JDBC Driver 2.3.4
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringHibernateExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Spring Boot and Hibernate application with t
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Hibernate
->    - AWS JDBC Driver 2.3.3
+>    - AWS JDBC Driver 2.3.4
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11

examples/SpringTxFailoverExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using the AWS JDBC D
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.3.3
+>    - AWS JDBC Driver 2.3.4
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringWildflyExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Wildfly and Spring Boot application with the
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Wildfly 26.1.1 Final
->    - AWS JDBC Driver 2.3.3
+>    - AWS JDBC Driver 2.3.4
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11
@@ -38,7 +38,7 @@ Create a Gradle project with the following project hierarchy:
               │       └───main
               │       │   │───module.xml
               │       │   │───postgresql-42.5.4.jar
-              │       │   └───aws-advanced-jdbc-wrapper-2.3.3.jar
+              │       │   └───aws-advanced-jdbc-wrapper-2.3.4.jar
       └───standalone
           ├───configuration
               ├───amazon
@@ -135,7 +135,7 @@ Since this example uses the PostgreSQL JDBC driver as the target driver, you nee
 <module xmlns="urn:jboss:module:1.1" name="software.amazon.jdbc">
 
   <resources>
-    <resource-root path="aws-advanced-jdbc-wrapper-2.3.3.jar"/>
+    <resource-root path="aws-advanced-jdbc-wrapper-2.3.4.jar"/>
     <resource-root path="postgresql-42.5.4.jar"/>
   </resources>
 </module>

examples/SpringWildflyExample/wildfly/modules/software/amazon/jdbc/main/module.xml

@@ -19,7 +19,7 @@
 <module xmlns="urn:jboss:module:1.1" name="software.amazon.jdbc">
 
   <resources>
-    <resource-root path="aws-advanced-jdbc-wrapper-2.3.3.jar"/>
+    <resource-root path="aws-advanced-jdbc-wrapper-2.3.4.jar"/>
     <resource-root path="postgresql-42.5.4.jar"/>
   </resources>
 </module>

examples/VertxExample/README.md

@@ -3,7 +3,7 @@
 In this tutorial, you will set up a Vert.x application with the AWS JDBC Driver, and use the driver to execute some simple database operations on an Aurora PostgreSQL database.
 
 > Note: this tutorial was written using the following technologies:
->    - AWS JDBC Driver 2.3.3
+>    - AWS JDBC Driver 2.3.4
 >    - PostgreSQL 42.5.4
 >    - Java 8
 >    - Vert.x 4.4.2

gradle.properties

@@ -14,6 +14,6 @@
 
 aws-advanced-jdbc-wrapper.version.major=2
 aws-advanced-jdbc-wrapper.version.minor=3
-aws-advanced-jdbc-wrapper.version.subminor=3
+aws-advanced-jdbc-wrapper.version.subminor=4
 snapshot=false
 nexus.publish=true

wrapper/src/test/resources/hibernate_files/hibernate-core.gradle

@@ -61,7 +61,7 @@ dependencies {
         transitive = true
     }
     testImplementation "joda-time:joda-time:2.3"
-    testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.3.3.jar')
+    testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.3.4.jar')
     testImplementation dbLibs.postgresql
     testImplementation dbLibs.mysql
     testImplementation dbLibs.h2

wrapper/src/test/resources/hibernate_files/java-module.gradle

@@ -97,7 +97,7 @@ dependencies {
     // Since both the DB2 driver and HANA have a package "net.jpountz" we have to add dependencies conditionally
     // This is due to the "no split-packages" requirement of Java 9+
 
-    testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.3.3.jar')
+    testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.3.4.jar')
     testRuntimeOnly dbLibs.mysql
 
     if ( db.startsWith( 'db2' ) ) {