From 9fdae84c7dfec6f9ef62450807b7f3d1a9bb4f50 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 20 Oct 2025 18:25:58 -0700 Subject: [PATCH 01/90] wip --- .../amazon/jdbc/PluginServiceImpl.java | 1 + .../jdbc/dialect/AuroraMysqlDialect.java | 31 +++++-------------- .../amazon/jdbc/dialect/AuroraPgDialect.java | 31 +++++-------------- ...AuroraInitialConnectionStrategyPlugin.java | 4 +++ .../ClusterAwareWriterFailoverHandler.java | 2 ++ .../failover/FailoverConnectionPlugin.java | 1 + .../failover2/FailoverConnectionPlugin.java | 1 + .../plugin/staledns/AuroraStaleDnsHelper.java | 2 ++ 8 files changed, 27 insertions(+), 46 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 4bf4f62db..d60865306 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -729,6 +729,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); + // TODO: refreshHostList this.refreshHostList(connection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index e64352899..db85e28be 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -22,10 +22,7 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect { @@ -89,26 +86,14 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); - } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); - }; + return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( + properties, + initialUrl, + servicesContainer, + TOPOLOGY_QUERY, + NODE_ID_QUERY, + IS_READER_QUERY, + IS_WRITER_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index c81d85f70..7af673e4e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -21,10 +21,7 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.logging.Logger; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; /** @@ -139,26 +136,14 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); - } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); - }; + return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( + properties, + initialUrl, + servicesContainer, + TOPOLOGY_QUERY, + NODE_ID_QUERY, + IS_READER_QUERY, + IS_WRITER_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 01b9bf8e9..ddf77a3ce 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -194,6 +194,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); @@ -215,6 +216,7 @@ private Connection getVerifiedWriterConnection( if (this.pluginService.getHostRole(writerCandidateConn) != HostRole.WRITER) { // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); @@ -271,6 +273,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); @@ -305,6 +308,7 @@ private Connection getVerifiedReaderConnection( if (this.pluginService.getHostRole(readerCandidateConn) != HostRole.READER) { // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); if (this.hasNoReaders()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 8504842c6..9ffd4ef65 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -283,6 +283,7 @@ public WriterFailoverResult call() { } conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { @@ -444,6 +445,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(this.currentReaderConnection); final List topology = this.pluginService.getAllHosts(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index ef2f95550..be0b229ce 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -936,6 +936,7 @@ public Connection connect( } if (isInitialConnection) { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 1449ca514..5ad38cda9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -787,6 +787,7 @@ public Connection connect( } if (isInitialConnection) { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 682c3080f..0ae4efb16 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -91,8 +91,10 @@ public Connection getVerifiedConnection( // This is if-statement is only reached if the connection url is a writer cluster endpoint. // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); } else { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } From 739c421c351aedbfd4f08197c2eccbeadbd6b4a7 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Tue, 21 Oct 2025 14:30:34 -0700 Subject: [PATCH 02/90] Remove flaky and unstable suggested clusterId functionality (#1570) --- CHANGELOG.md | 9 + .../UsingTheJdbcDriver.md | 6 +- .../using-plugins/UsingTheFailover2Plugin.md | 22 +-- .../using-plugins/UsingTheFailoverPlugin.md | 28 +-- .../java/software/amazon/jdbc/Driver.java | 2 - .../hostlistprovider/RdsHostListProvider.java | 150 +------------- .../monitoring/ClusterTopologyMonitor.java | 2 - .../ClusterTopologyMonitorImpl.java | 5 - .../MonitoringRdsHostListProvider.java | 29 --- .../aurora/TestAuroraHostListProvider.java | 4 - .../tests/AdvancedPerformanceTest.java | 3 +- .../container/tests/PerformanceTest.java | 6 - .../RdsHostListProviderTest.java | 187 +----------------- .../RdsMultiAzDbClusterListProviderTest.java | 173 +--------------- 14 files changed, 57 insertions(+), 569 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bcc00d5f..c63e99922 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,15 @@ 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). +## [3.0.0] - TBD + +### :bug: Fixed + +### :crab: Changed +- Breaking Change: Remove suggested ClusterId functionality. For applications that use a single cluster database **no changes are required**. For application that access multiple database clusters, all connection string **should be** reviewed and a mandatory `clusterId` parameter **should be added**. ([PR #1570](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1570)). + +### :magic_wand: Added + ## [2.6.5] - 2025-10-16 ### :magic_wand: Added diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md index 26d0161e0..46bab7c64 100644 --- a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md +++ b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md @@ -5,9 +5,9 @@ The JDBC Wrapper also supports [connection pooling](./DataSource.md#Using-the-Aw ## Using the AWS JDBC Driver with plain RDS databases It is possible to use the AWS JDBC Driver with plain RDS databases, but individual features may or may not be compatible. For example, failover handling and enhanced failure monitoring are not compatible with plain RDS databases and the relevant plugins must be disabled. Plugins can be enabled or disabled as seen in the [Connection Plugin Manager Parameters](#connection-plugin-manager-parameters) section. Please note that some plugins have been enabled by default. Plugin compatibility can be verified in the [plugins table](#list-of-available-plugins). -## Using the AWS JDBC Driver with custom endpoints and other non-standard URLs +## Using the AWS JDBC Driver to access multiple database clusters > [!WARNING]\ -> If connecting using a non-standard RDS URL (e.g. a custom endpoint, ip address, rds proxy, or custom domain URL), the clusterId property must be set. If the `clusterId` is omitted when using a non-standard RDS URL, you may experience various issues. For more information, please see the [AWS Advanced JDBC Driver Parameters](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters) section. +> If connecting to multiple database clusters within a single application, each connection string must set `clusterId` property. If the `clusterId` is omitted, you may experience various issues. For more information, please see the [AWS Advanced JDBC Driver Parameters](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters) section. ## Wrapper Protocol The AWS JDBC Driver uses the protocol prefix `jdbc:aws-wrapper:`. Internally, the JDBC Wrapper will replace this protocol prefix with `jdbc:`, making the final protocol `jdbc:aws-wrapper:{suffix}` where `suffix` is specific to the desired underlying protocol. For example, to connect to a PostgreSQL database, you would use the protocol `jdbc:aws-wrapper:postgresql:`, and inside the AWS JDBC Driver, the final protocol that will be used to connect to a database will be `jdbc:postgresql:`. @@ -78,7 +78,7 @@ These parameters are applicable to any instance of the AWS JDBC Driver. | Parameter | Value | Required | Description | Default Value | |---------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| -| `clusterId` | `String` | If connecting using a non-standard RDS URL (e.g. an IP address, custom endpoint, rds proxy, or custom domain URL): Yes

Otherwise: No

:warning:If `clusterId` is omitted when using a non-standard RDS URL, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. | None | +| `clusterId` | `String` | If connecting to multiple database clusters within a single application: Yes

Otherwise: No

:warning:If `clusterId` is omitted, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | | `wrapperLoggerLevel` | `String` | No | Logger level of the AWS JDBC Driver.

If it is used, it must be one of the following values: `OFF`, `SEVERE`, `WARNING`, `INFO`, `CONFIG`, `FINE`, `FINER`, `FINEST`, `ALL`. | `null` | | `database` | `String` | No | Database name. | `null` | | `user` | `String` | No | Database username. | `null` | diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md index 01c3db395..3f9a67daa 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md @@ -55,17 +55,17 @@ Verify plugin compatibility within your driver configuration using the [compatib ### Failover Plugin v2 Configuration Parameters In addition to the parameters that you can configure for the underlying driver, you can pass the following parameters for the AWS JDBC Driver through the connection URL to specify additional failover behavior. -| Parameter | Value | Required | Description | Default Value | -|---------------------------------------|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | -| `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | -| `clusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds when a cluster is not in failover. It refers to the regular, slow monitoring rate explained above. | `30000` | -| `failoverTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt reconnecting to a new writer or reader instance after a cluster failover is initiated. | `300000` | -| `clusterTopologyHighRefreshRateMs` | Integer | No | Interval of time in milliseconds to wait between attempts to update cluster topology after the writer has come back online following a failover event. It corresponds to the increased monitoring rate described earlier. Usually, the topology monitoring component uses this increased monitoring rate for 30s after a new writer was detected. | `100` | -| `failoverReaderHostSelectorStrategy` | String | No | Strategy used to select a reader node during failover. For more information on the available reader selection strategies, see this [table](../ReaderSelectionStrategies.md). | `random` | -| `clusterId` | `String` | If connecting using a non-standard RDS URL (e.g. an IP address, custom endpoint, rds proxy, or custom domain URL): Yes

Otherwise: No

:warning:If `clusterId` is omitted when using a non-standard RDS URL, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. | None | -| `telemetryFailoverAdditionalTopTrace` | Boolean | No | Allows the driver to produce an additional telemetry span associated with failover. Such span helps to facilitate telemetry analysis in AWS CloudWatch. | `false` | -| `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | +| Parameter | Value | Required | Description | Default Value | +|---------------------------------------|:--------:|:----------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | +| `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | +| `clusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds when a cluster is not in failover. It refers to the regular, slow monitoring rate explained above. | `30000` | +| `failoverTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt reconnecting to a new writer or reader instance after a cluster failover is initiated. | `300000` | +| `clusterTopologyHighRefreshRateMs` | Integer | No | Interval of time in milliseconds to wait between attempts to update cluster topology after the writer has come back online following a failover event. It corresponds to the increased monitoring rate described earlier. Usually, the topology monitoring component uses this increased monitoring rate for 30s after a new writer was detected. | `100` | +| `failoverReaderHostSelectorStrategy` | String | No | Strategy used to select a reader node during failover. For more information on the available reader selection strategies, see this [table](../ReaderSelectionStrategies.md). | `random` | +| `clusterId` | `String` | If connecting to multiple database clusters within a single application:: Yes

Otherwise: No

| A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | +| `telemetryFailoverAdditionalTopTrace` | Boolean | No | Allows the driver to produce an additional telemetry span associated with failover. Such span helps to facilitate telemetry analysis in AWS CloudWatch. | `false` | +| `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md index 73b246fb6..cd26f54d6 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md @@ -23,20 +23,20 @@ Verify plugin compatibility within your driver configuration using the [compatib ### Failover Parameters In addition to the parameters that you can configure for the underlying driver, you can pass the following parameters to the AWS JDBC Driver through the connection URL to specify additional failover behavior. -| Parameter | Value | Required | Description | Default Value | -|----------------------------------------|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | -| `clusterId` | `String` | If connecting using a non-standard RDS URL (e.g. an IP address, custom endpoint, rds proxy, or custom domain URL): Yes

Otherwise: No

:warning:If `clusterId` is omitted when using a non-standard RDS URL, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. | None | -| `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | -| `enableClusterAwareFailover` | Boolean | No | Set to `true` to enable the fast failover behavior offered by the AWS Advanced JDBC Driver. Set to `false` for simple JDBC connections that do not require fast failover functionality. | `true` | -| `failoverClusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds during a writer failover process. During the writer failover process, cluster topology may be refreshed at a faster pace than normal to speed up discovery of the newly promoted writer. | `2000` | -| `failoverReaderConnectTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt to connect to a reader instance during a reader failover process. | `30000` | -| `failoverTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt reconnecting to a new writer or reader instance after a cluster failover is initiated. | `300000` | -| `failoverWriterReconnectIntervalMs` | Integer | No | Interval of time in milliseconds to wait between attempts to reconnect to a failed writer during a writer failover process. | `2000` | -| `enableConnectFailover` | Boolean | No | Enables/disables cluster-aware failover if the initial connection to the database fails due to a network exception. Note that this may result in a connection to a different instance in the cluster than was specified by the URL. | `false` | -| `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | -| ~~`keepSessionStateOnFailover`~~ | Boolean | No | This parameter is no longer available. If specified, it will be ignored by the driver. See [Session State](../SessionState.md) for more details. | `false` | -| ~~`enableFailoverStrictReader`~~ | Boolean | No | This parameter is no longer available and, if specified, it will be ignored by the driver. See `failoverMode` (`reader-or-writer` or `strict-reader`) for more details. | | +| Parameter | Value | Required | Description | Default Value | +|----------------------------------------|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | +| `clusterId` | `String` | If connecting to multiple database clusters within a single application: Yes

Otherwise: No

:warning:If `clusterId` is omitted, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | +| `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | +| `enableClusterAwareFailover` | Boolean | No | Set to `true` to enable the fast failover behavior offered by the AWS Advanced JDBC Driver. Set to `false` for simple JDBC connections that do not require fast failover functionality. | `true` | +| `failoverClusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds during a writer failover process. During the writer failover process, cluster topology may be refreshed at a faster pace than normal to speed up discovery of the newly promoted writer. | `2000` | +| `failoverReaderConnectTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt to connect to a reader instance during a reader failover process. | `30000` | +| `failoverTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt reconnecting to a new writer or reader instance after a cluster failover is initiated. | `300000` | +| `failoverWriterReconnectIntervalMs` | Integer | No | Interval of time in milliseconds to wait between attempts to reconnect to a failed writer during a writer failover process. | `2000` | +| `enableConnectFailover` | Boolean | No | Enables/disables cluster-aware failover if the initial connection to the database fails due to a network exception. Note that this may result in a connection to a different instance in the cluster than was specified by the URL. | `false` | +| `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | +| ~~`keepSessionStateOnFailover`~~ | Boolean | No | This parameter is no longer available. If specified, it will be ignored by the driver. See [Session State](../SessionState.md) for more details. | `false` | +| ~~`enableFailoverStrictReader`~~ | Boolean | No | This parameter is no longer available and, if specified, it will be ignored by the driver. See `failoverMode` (`reader-or-writer` or `strict-reader`) for more details. | | ## Host Pattern When connecting to Aurora clusters, the [`clusterInstanceHostPattern`](#failover-parameters) parameter is required if the connection string does not provide enough information about the database cluster domain name. If the Aurora cluster endpoint is used directly, the AWS JDBC Driver will recognize the standard Aurora domain name and can re-build a proper Aurora instance name when needed. In cases where the connection string uses an IP address, a custom domain name, or localhost, the driver won't know how to build a proper domain name for a database instance endpoint. For example, if a custom domain was being used and the cluster instance endpoints followed a pattern of `instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc., the driver would need to know how to construct the instance endpoints using the specified custom domain. Since there isn't enough information from the custom domain alone to create the instance endpoints, you should set the `clusterInstanceHostPattern` to `?.customHost`, making the connection string `jdbc:aws-wrapper:postgresql://customHost:1234/test?clusterInstanceHostPattern=?.customHost`. Refer to [this diagram](../../images/failover_behavior.png) about AWS JDBC Driver behavior during failover for different connection URLs and more details and examples. diff --git a/wrapper/src/main/java/software/amazon/jdbc/Driver.java b/wrapper/src/main/java/software/amazon/jdbc/Driver.java index 7d59e83ff..8616e0ae7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/Driver.java +++ b/wrapper/src/main/java/software/amazon/jdbc/Driver.java @@ -423,10 +423,8 @@ public static void resetConnectionInitFunc() { public static void clearCaches() { CoreServicesContainer.getInstance().getStorageService().clearAll(); RdsUtils.clearCache(); - RdsHostListProvider.clearAll(); PluginServiceImpl.clearCache(); DialectManager.resetEndpointCache(); - MonitoringRdsHostListProvider.clearCache(); CustomEndpointMonitorImpl.clearCache(); OpenedConnectionTracker.clearCache(); AwsSecretsManagerCacheHolder.clearCache(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 738eebcc3..ea372e5a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -70,10 +70,10 @@ public class RdsHostListProvider implements DynamicHostListProvider { + "after which it will be updated during the next interaction with the connection."); public static final AwsWrapperProperty CLUSTER_ID = new AwsWrapperProperty( - "clusterId", "", + "clusterId", "1", "A unique identifier for the cluster. " + "Connections with the same cluster id share a cluster topology cache. " - + "If unspecified, a cluster id is automatically created for AWS RDS clusters."); + + "If unspecified, a cluster id is '1'."); public static final AwsWrapperProperty CLUSTER_INSTANCE_HOST_PATTERN = new AwsWrapperProperty( @@ -88,11 +88,8 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); protected static final int defaultTopologyQueryTimeoutMs = 5000; - protected static final long suggestedClusterIdRefreshRateNano = TimeUnit.MINUTES.toNanos(10); - protected static final CacheMap suggestedPrimaryClusterIdCache = new CacheMap<>(); - protected static final CacheMap primaryClusterIdCache = new CacheMap<>(); - protected final FullServicesContainer servicesContainer; + protected final HostListProviderService hostListProviderService; protected final String originalUrl; protected final String topologyQuery; @@ -110,10 +107,6 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected String clusterId; protected HostSpec clusterInstanceTemplate; - // A primary clusterId is a clusterId that is based off of a cluster endpoint URL - // (rather than a GUID or a value provided by the user). - protected boolean isPrimaryClusterId; - protected volatile boolean isInitialized = false; protected Properties properties; @@ -160,8 +153,7 @@ protected void init() throws SQLException { this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); - this.clusterId = UUID.randomUUID().toString(); - this.isPrimaryClusterId = false; + this.clusterId = CLUSTER_ID.getString(this.properties); this.refreshRateNano = TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); @@ -182,34 +174,8 @@ protected void init() throws SQLException { validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); - - final String clusterIdSetting = CLUSTER_ID.getString(this.properties); - if (!StringUtils.isNullOrEmpty(clusterIdSetting)) { - this.clusterId = clusterIdSetting; - } else if (rdsUrlType == RdsUrlType.RDS_PROXY) { - // Each proxy is associated with a single cluster, so it's safe to use RDS Proxy Url as cluster - // identification - this.clusterId = this.initialHostSpec.getUrl(); - } else if (rdsUrlType.isRds()) { - final ClusterSuggestedResult clusterSuggestedResult = - getSuggestedClusterId(this.initialHostSpec.getHostAndPort()); - if (clusterSuggestedResult != null && !StringUtils.isNullOrEmpty(clusterSuggestedResult.clusterId)) { - this.clusterId = clusterSuggestedResult.clusterId; - this.isPrimaryClusterId = clusterSuggestedResult.isPrimaryClusterId; - } else { - final String clusterRdsHostUrl = - rdsHelper.getRdsClusterHostUrl(this.initialHostSpec.getHost()); - if (!StringUtils.isNullOrEmpty(clusterRdsHostUrl)) { - this.clusterId = this.clusterInstanceTemplate.isPortSpecified() - ? String.format("%s:%s", clusterRdsHostUrl, this.clusterInstanceTemplate.getPort()) - : clusterRdsHostUrl; - this.isPrimaryClusterId = true; - primaryClusterIdCache.put(this.clusterId, true, suggestedClusterIdRefreshRateNano); - } - } - } - this.isInitialized = true; + } finally { lock.unlock(); } @@ -230,25 +196,8 @@ protected void init() throws SQLException { protected FetchTopologyResult getTopology(final Connection conn, final boolean forceUpdate) throws SQLException { init(); - final String suggestedPrimaryClusterId = suggestedPrimaryClusterIdCache.get(this.clusterId); - - // Change clusterId by accepting a suggested one - if (!StringUtils.isNullOrEmpty(suggestedPrimaryClusterId) - && !this.clusterId.equals(suggestedPrimaryClusterId)) { - - final String oldClusterId = this.clusterId; - this.clusterId = suggestedPrimaryClusterId; - this.isPrimaryClusterId = true; - this.clusterIdChanged(oldClusterId); - } - final List storedHosts = this.getStoredTopology(); - // This clusterId is a primary one and is about to create a new entry in the cache. - // When a primary entry is created it needs to be suggested for other (non-primary) entries. - // Remember a flag to do suggestion after cache is updated. - final boolean needToSuggest = storedHosts == null && this.isPrimaryClusterId; - if (storedHosts == null || forceUpdate) { // need to re-fetch topology @@ -264,9 +213,6 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); - if (needToSuggest) { - this.suggestPrimaryCluster(hosts); - } return new FetchTopologyResult(false, hosts); } } @@ -279,73 +225,6 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f } } - protected void clusterIdChanged(final String oldClusterId) throws SQLException { - // do nothing - } - - protected ClusterSuggestedResult getSuggestedClusterId(final String url) { - Map entries = this.servicesContainer.getStorageService().getEntries(Topology.class); - if (entries == null) { - return null; - } - - for (final Entry entry : entries.entrySet()) { - final String key = entry.getKey(); // clusterId - final List hosts = entry.getValue().getHosts(); - final boolean isPrimaryCluster = primaryClusterIdCache.get(key, false, - suggestedClusterIdRefreshRateNano); - if (key.equals(url)) { - return new ClusterSuggestedResult(url, isPrimaryCluster); - } - if (hosts == null) { - continue; - } - for (final HostSpec host : hosts) { - if (host.getHostAndPort().equals(url)) { - LOGGER.finest(() -> Messages.get("RdsHostListProvider.suggestedClusterId", - new Object[] {key, url})); - return new ClusterSuggestedResult(key, isPrimaryCluster); - } - } - } - return null; - } - - protected void suggestPrimaryCluster(final @NonNull List primaryClusterHosts) { - if (Utils.isNullOrEmpty(primaryClusterHosts)) { - return; - } - - Map entries = this.servicesContainer.getStorageService().getEntries(Topology.class); - if (entries == null) { - return; - } - - for (final Entry entry : entries.entrySet()) { - final String clusterId = entry.getKey(); - final List clusterHosts = entry.getValue().getHosts(); - final boolean isPrimaryCluster = primaryClusterIdCache.get(clusterId, false, - suggestedClusterIdRefreshRateNano); - final String suggestedPrimaryClusterId = suggestedPrimaryClusterIdCache.get(clusterId); - if (isPrimaryCluster - || !StringUtils.isNullOrEmpty(suggestedPrimaryClusterId) - || Utils.isNullOrEmpty(clusterHosts)) { - continue; - } - - // The entry is non-primary - for (final HostSpec host : clusterHosts) { - if (Utils.containsHostAndPort(primaryClusterHosts, host.getHostAndPort())) { - // Instance on this cluster matches with one of the instance on primary cluster - // Suggest the primary clusterId to this entry - suggestedPrimaryClusterIdCache.put(clusterId, this.clusterId, - suggestedClusterIdRefreshRateNano); - break; - } - } - } - } - /** * Obtain a cluster topology from database. * @@ -503,14 +382,6 @@ protected String getHostEndpoint(final String nodeName) { return topology == null ? null : topology.getHosts(); } - /** - * Clear topology cache for all clusters. - */ - public static void clearAll() { - primaryClusterIdCache.clear(); - suggestedPrimaryClusterIdCache.clear(); - } - /** * Clear topology cache for the current cluster. */ @@ -667,15 +538,4 @@ public String getClusterId() throws UnsupportedOperationException, SQLException init(); return this.clusterId; } - - public static class ClusterSuggestedResult { - - public String clusterId; - public boolean isPrimaryClusterId; - - public ClusterSuggestedResult(final String clusterId, final boolean isPrimaryClusterId) { - this.clusterId = clusterId; - this.isPrimaryClusterId = isPrimaryClusterId; - } - } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java index 73ea62399..3ec9a9a87 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java @@ -28,8 +28,6 @@ public interface ClusterTopologyMonitor extends Monitor { boolean canDispose(); - void setClusterId(final String clusterId); - List forceRefresh(final boolean writerImportant, final long timeoutMs) throws SQLException, TimeoutException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 92227de29..4ddfa0fd0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -156,11 +156,6 @@ public boolean canDispose() { return true; } - @Override - public void setClusterId(String clusterId) { - this.clusterId = clusterId; - } - @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 0bc4cf897..438e6fca6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -71,10 +71,6 @@ public MonitoringRdsHostListProvider( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); } - public static void clearCache() { - clearAll(); - } - @Override protected void init() throws SQLException { super.init(); @@ -114,31 +110,6 @@ protected List queryForTopology(final Connection conn) throws SQLExcep } } - @Override - protected void clusterIdChanged(final String oldClusterId) throws SQLException { - MonitorService monitorService = this.servicesContainer.getMonitorService(); - final ClusterTopologyMonitorImpl existingMonitor = - monitorService.get(ClusterTopologyMonitorImpl.class, oldClusterId); - if (existingMonitor != null) { - this.servicesContainer.getMonitorService().runIfAbsent( - ClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> existingMonitor); - assert monitorService.get(ClusterTopologyMonitorImpl.class, this.clusterId) == existingMonitor; - existingMonitor.setClusterId(this.clusterId); - monitorService.remove(ClusterTopologyMonitorImpl.class, oldClusterId); - } - - final StorageService storageService = this.servicesContainer.getStorageService(); - final Topology existingTopology = storageService.get(Topology.class, oldClusterId); - final List existingHosts = existingTopology == null ? null : existingTopology.getHosts(); - if (existingHosts != null) { - storageService.set(this.clusterId, new Topology(existingHosts)); - } - } - @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { diff --git a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java b/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java index c35f6b0f8..5303763f7 100644 --- a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java +++ b/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java @@ -26,8 +26,4 @@ public TestAuroraHostListProvider( FullServicesContainer servicesContainer, Properties properties, String originalUrl) { super(properties, originalUrl, servicesContainer, "", "", ""); } - - public static void clearCache() { - AuroraHostListProvider.clearAll(); - } } diff --git a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java index 38087f2dc..e2b19303c 100644 --- a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java @@ -69,6 +69,7 @@ import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; import software.amazon.jdbc.plugin.efm2.HostMonitorServiceImpl; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; +import software.amazon.jdbc.util.CoreServicesContainer; import software.amazon.jdbc.util.StringUtils; @TestMethodOrder(MethodOrderer.MethodName.class) @@ -686,7 +687,7 @@ private void ensureClusterHealthy() throws InterruptedException { auroraUtil.makeSureInstancesUp(TimeUnit.MINUTES.toSeconds(5)); - TestAuroraHostListProvider.clearCache(); + CoreServicesContainer.getInstance().getStorageService().clearAll(); TestPluginServiceImpl.clearHostAvailabilityCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); diff --git a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java index 73e0b338c..68e131917 100644 --- a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java @@ -149,8 +149,6 @@ public void test_FailureDetectionTime_EnhancedMonitoringEnabled(final String efm OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); - MonitoringRdsHostListProvider.clearCache(); enhancedFailureMonitoringPerfDataList.clear(); @@ -231,8 +229,6 @@ public void test_FailureDetectionTime_FailoverAndEnhancedMonitoringEnabled(final OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); - MonitoringRdsHostListProvider.clearCache(); failoverWithEfmPerfDataList.clear(); @@ -319,8 +315,6 @@ private void test_FailoverTime_SocketTimeout(final String plugins) throws IOExce OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); - MonitoringRdsHostListProvider.clearCache(); failoverWithSocketTimeoutPerfDataList.clear(); diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 797d151be..cc337d2a3 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -17,20 +17,16 @@ package software.amazon.jdbc.hostlistprovider; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; -import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -109,7 +105,6 @@ void setUp() throws SQLException { @AfterEach void tearDown() throws Exception { - RdsHostListProvider.clearAll(); storageService.clearAll(); closeable.close(); } @@ -234,8 +229,7 @@ void testGetCachedTopology_returnStoredTopology() throws SQLException { } @Test - void testTopologyCache_NoSuggestedClusterId() throws SQLException { - RdsHostListProvider.clearAll(); + void testTopologyCache() throws SQLException { RdsHostListProvider provider1 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.domain.com/")); provider1.init(); @@ -256,8 +250,7 @@ void testTopologyCache_NoSuggestedClusterId() throws SQLException { assertEquals(topologyClusterA, topologyProvider1); RdsHostListProvider provider2 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-b.domain.com/")); - provider2.init(); - assertNull(provider2.getStoredTopology()); + assertNotNull(provider2.getStoredTopology()); final List topologyClusterB = Arrays.asList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) @@ -268,162 +261,15 @@ void testTopologyCache_NoSuggestedClusterId() throws SQLException { .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(2, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForRds() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForInstance() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); + List topologyProvider2 = provider2.refresh(mock(Connection.class)); + assertNotEquals(topologyClusterB, topologyProvider2); - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://instance-a-3.xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); + topologyProvider2 = provider2.forceRefresh(mock(Connection.class)); + assertEquals(topologyClusterB, topologyProvider2); assertEquals(1, storageService.size(Topology.class)); } - @Test - void testTopologyCache_AcceptSuggestion() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://instance-a-2.xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doAnswer(a -> topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - // RdsHostListProvider.logCache(); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - doAnswer(a -> topologyClusterA).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertNotEquals(provider1.clusterId, provider2.clusterId); - assertFalse(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - assertEquals(2, storageService.size(Topology.class)); - assertEquals("cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com", - RdsHostListProvider.suggestedPrimaryClusterIdCache.get(provider1.clusterId)); - - // RdsHostListProvider.logCache(); - - topologyProvider1 = provider1.forceRefresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - // RdsHostListProvider.logCache(); - } - @Test void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); @@ -605,25 +451,4 @@ void testGetTopology_returnsLatestWriter() throws SQLException { assertEquals(expectedWriterHost.getHost(), result.hosts.get(0).getHost()); } - - @Test - void testClusterUrlUsedAsDefaultClusterId() throws SQLException { - String readerClusterUrl = "mycluster.cluster-ro-XYZ.us-east-1.rds.amazonaws.com"; - String expectedClusterId = "mycluster.cluster-XYZ.us-east-1.rds.amazonaws.com:1234"; - String connectionString = "jdbc:someprotocol://" + readerClusterUrl + ":1234/test"; - RdsHostListProvider provider1 = Mockito.spy(getRdsHostListProvider(connectionString)); - assertEquals(expectedClusterId, provider1.getClusterId()); - - List mockTopology = - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host").build()); - doReturn(mockTopology).when(provider1).queryForTopology(any(Connection.class)); - provider1.refresh(); - assertEquals(mockTopology, provider1.getStoredTopology()); - verify(provider1, times(1)).queryForTopology(mockConnection); - - RdsHostListProvider provider2 = Mockito.spy(getRdsHostListProvider(connectionString)); - assertEquals(expectedClusterId, provider2.getClusterId()); - assertEquals(mockTopology, provider2.getStoredTopology()); - verify(provider2, never()).queryForTopology(mockConnection); - } } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java index df6d6ee50..5c0343487 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java @@ -17,16 +17,13 @@ package software.amazon.jdbc.hostlistprovider; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; @@ -102,7 +99,6 @@ void setUp() throws SQLException { @AfterEach void tearDown() throws Exception { - RdsMultiAzDbClusterListProvider.clearAll(); storageService.clearAll(); closeable.close(); } @@ -118,7 +114,7 @@ private RdsMultiAzDbClusterListProvider getRdsMazDbClusterHostListProvider(Strin "fang", "li"); provider.init(); - // provider.clusterId = "cluster-id"; + // provider.clusterId = "1"; return provider; } @@ -205,8 +201,7 @@ void testGetCachedTopology_returnCachedTopology() throws SQLException { } @Test - void testTopologyCache_NoSuggestedClusterId() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); + void testTopologyCache() throws SQLException { RdsMultiAzDbClusterListProvider provider1 = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-a.domain.com/")); @@ -229,8 +224,7 @@ void testTopologyCache_NoSuggestedClusterId() throws SQLException { RdsMultiAzDbClusterListProvider provider2 = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-b.domain.com/")); - provider2.init(); - assertNull(provider2.getStoredTopology()); + assertNotNull(provider2.getStoredTopology()); final List topologyClusterB = Arrays.asList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) @@ -241,168 +235,15 @@ void testTopologyCache_NoSuggestedClusterId() throws SQLException { .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(2, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForRds() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForInstance() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); + List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); + assertNotEquals(topologyClusterB, topologyProvider2); - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://instance-a-3.xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); + topologyProvider2 = provider2.forceRefresh(Mockito.mock(Connection.class)); + assertEquals(topologyClusterB, topologyProvider2); assertEquals(1, storageService.size(Topology.class)); } - @Test - void testTopologyCache_AcceptSuggestion() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://instance-a-2.xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doAnswer(a -> topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - // RdsMultiAzDbClusterListProvider.logCache(); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - doAnswer(a -> topologyClusterA).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertNotEquals(provider1.clusterId, provider2.clusterId); - assertFalse(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - assertEquals(2, storageService.size(Topology.class)); - assertEquals("cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com", - RdsMultiAzDbClusterListProvider.suggestedPrimaryClusterIdCache.get(provider1.clusterId)); - - // RdsMultiAzDbClusterListProvider.logCache(); - - topologyProvider1 = provider1.forceRefresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - // RdsMultiAzDbClusterListProvider.logCache(); - } - @Test void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); From ce45f9a2a69867f2534b50abcc296ae50a41dd61 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Tue, 21 Oct 2025 15:16:26 -0700 Subject: [PATCH 03/90] remove deprecated code (#1572) --- CHANGELOG.md | 1 + .../jdbc/ConnectionProviderManager.java | 49 ------------- .../amazon/jdbc/PartialPluginService.java | 47 ------------- .../software/amazon/jdbc/PluginService.java | 20 ------ .../amazon/jdbc/PluginServiceImpl.java | 69 ------------------- .../amazon/jdbc/dialect/DialectManager.java | 22 ------ .../AbstractPgExceptionHandler.java | 12 ---- .../jdbc/exceptions/ExceptionHandler.java | 22 ------ .../jdbc/exceptions/ExceptionManager.java | 22 ------ .../exceptions/GenericExceptionHandler.java | 12 ---- .../exceptions/MySQLExceptionHandler.java | 12 ---- .../TargetDriverDialectManager.java | 22 ------ 12 files changed, 1 insertion(+), 309 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c63e99922..fbb95e078 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### :crab: Changed - Breaking Change: Remove suggested ClusterId functionality. For applications that use a single cluster database **no changes are required**. For application that access multiple database clusters, all connection string **should be** reviewed and a mandatory `clusterId` parameter **should be added**. ([PR #1570](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1570)). +- Breaking Change: Remove deprecated code. ([PR #1572](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1572)). ### :magic_wand: Added diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java index a8d1e6100..0f8687930 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java @@ -45,20 +45,6 @@ public ConnectionProviderManager( this.effectiveConnProvider = effectiveConnProvider; } - /** - * Setter that can optionally be called to request a non-default {@link ConnectionProvider}. The - * requested ConnectionProvider will be used to establish future connections unless it does not - * support a requested URL, in which case the default ConnectionProvider will be used. See - * {@link ConnectionProvider#acceptsUrl} for more info. - * - * @param connProvider the {@link ConnectionProvider} to use to establish new connections - * @deprecated Use {@link Driver#setCustomConnectionProvider(ConnectionProvider)} instead. - */ - @Deprecated - public static void setConnectionProvider(ConnectionProvider connProvider) { - Driver.setCustomConnectionProvider(connProvider); - } - /** * Get the {@link ConnectionProvider} to use to establish a connection using the given driver * protocol, host details, and properties. If a non-default ConnectionProvider has been set using @@ -163,18 +149,6 @@ public HostSpec getHostSpecByStrategy(List hosts, HostRole role, Strin return this.defaultProvider.getHostSpecByStrategy(hosts, role, strategy, props); } - /** - * Clears the non-default {@link ConnectionProvider} if it has been set. The default - * ConnectionProvider will be used if the non-default ConnectionProvider has not been set or has - * been cleared. - * - * @deprecated Use {@link Driver#resetCustomConnectionProvider()} instead - */ - @Deprecated - public static void resetProvider() { - Driver.resetCustomConnectionProvider(); - } - /** * Releases any resources held by the available {@link ConnectionProvider} instances. */ @@ -185,29 +159,6 @@ public static void releaseResources() { } } - /** - * Sets a custom connection initialization function. It'll be used - * for every brand-new database connection. - * - * @param func A function that initialize a new connection - * - * @deprecated @see Driver#setConnectionInitFunc(ConnectionInitFunc) - */ - @Deprecated - public static void setConnectionInitFunc(final @NonNull ConnectionInitFunc func) { - Driver.setConnectionInitFunc(func); - } - - /** - * Resets a custom connection initialization function. - * - * @deprecated Use {@link Driver#resetConnectionInitFunc()} instead - */ - @Deprecated - public static void resetConnectionInitFunc() { - Driver.resetConnectionInitFunc(); - } - public void initConnection( final @Nullable Connection connection, final @NonNull String protocol, diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 51ee4d6fd..7d5becc8a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -187,12 +187,6 @@ public String getOriginalUrl() { return this.originalUrl; } - @Override - public void setAllowedAndBlockedHosts(AllowedAndBlockedHosts allowedAndBlockedHosts) { - throw new UnsupportedOperationException( - Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"setAllowedAndBlockedHosts"})); - } - @Override public boolean acceptsStrategy(HostRole role, String strategy) throws SQLException { throw new UnsupportedOperationException( @@ -216,12 +210,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { return this.hostListProvider.getHostRole(conn); } - @Override - @Deprecated - public ConnectionProvider getConnectionProvider() { - return this.pluginManager.defaultConnProvider; - } - @Override public ConnectionProvider getDefaultConnectionProvider() { return this.connectionProviderManager.getDefaultProvider(); @@ -538,11 +526,6 @@ public void releaseResources() { Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"releaseResources"})); } - @Override - public boolean isNetworkException(Throwable throwable) { - return this.isNetworkException(throwable, this.targetDriverDialect); - } - @Override public boolean isNetworkException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { if (this.exceptionHandler != null) { @@ -559,11 +542,6 @@ public boolean isNetworkException(final String sqlState) { return this.exceptionManager.isNetworkException(this.dbDialect, sqlState); } - @Override - public boolean isLoginException(Throwable throwable) { - return this.isLoginException(throwable, this.targetDriverDialect); - } - @Override public boolean isLoginException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { if (this.exceptionHandler != null) { @@ -666,31 +644,6 @@ public T getPlugin(final Class pluginClazz) { return null; } - @Override - public void setStatus(Class clazz, @Nullable T status, boolean clusterBound) { - throw new UnsupportedOperationException( - Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"setStatus"})); - } - - @Override - public void setStatus(Class clazz, @Nullable T status, String key) { - throw new UnsupportedOperationException( - Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"setStatus"})); - } - - @Override - public T getStatus(@NonNull Class clazz, boolean clusterBound) { - throw new UnsupportedOperationException( - Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"getStatus"})); - } - - @Override - public T getStatus(@NonNull Class clazz, String key) { - throw new UnsupportedOperationException( - Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"getStatus"})); - } - - @Override public boolean isPluginInUse(final Class pluginClazz) { try { return this.pluginManager.isWrapperFor(pluginClazz); diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index b01679aba..1ed394c27 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -84,15 +84,6 @@ EnumSet setCurrentConnection( String getOriginalUrl(); - /** - * Set the collection of hosts that should be allowed and/or blocked for connections. - * - * @param allowedAndBlockedHosts An object defining the allowed and blocked sets of hosts. - * @deprecated use StorageService#set(key, allowedAndBlockedHosts) instead. - */ - @Deprecated - void setAllowedAndBlockedHosts(AllowedAndBlockedHosts allowedAndBlockedHosts); - /** * Returns a boolean indicating if the available {@link ConnectionProvider} or * {@link ConnectionPlugin} instances support the selection of a host with the requested role and @@ -240,9 +231,6 @@ Connection forceConnect( HostSpecBuilder getHostSpecBuilder(); - @Deprecated - ConnectionProvider getConnectionProvider(); - ConnectionProvider getDefaultConnectionProvider(); boolean isPooledConnectionProvider(HostSpec host, Properties props); @@ -259,13 +247,5 @@ Connection forceConnect( T getPlugin(final Class pluginClazz); - void setStatus(final Class clazz, final @Nullable T status, final boolean clusterBound); - - void setStatus(final Class clazz, final @Nullable T status, final String key); - - T getStatus(final @NonNull Class clazz, final boolean clusterBound); - - T getStatus(final @NonNull Class clazz, final String key); - boolean isPluginInUse(final Class pluginClazz); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 4bf4f62db..2288f946b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -218,12 +218,6 @@ public String getOriginalUrl() { return this.originalUrl; } - @Override - @Deprecated - public void setAllowedAndBlockedHosts(AllowedAndBlockedHosts allowedAndBlockedHosts) { - this.servicesContainer.getStorageService().set(this.initialConnectionHostSpec.getHost(), allowedAndBlockedHosts); - } - @Override public boolean acceptsStrategy(HostRole role, String strategy) throws SQLException { return this.pluginManager.acceptsStrategy(role, strategy); @@ -244,12 +238,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { return this.hostListProvider.getHostRole(conn); } - @Override - @Deprecated - public ConnectionProvider getConnectionProvider() { - return this.pluginManager.defaultConnProvider; - } - @Override public ConnectionProvider getDefaultConnectionProvider() { return this.connectionProviderManager.getDefaultProvider(); @@ -663,12 +651,6 @@ public void releaseResources() { } } - @Override - @Deprecated - public boolean isNetworkException(Throwable throwable) { - return this.isNetworkException(throwable, this.targetDriverDialect); - } - @Override public boolean isNetworkException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { if (this.exceptionHandler != null) { @@ -685,12 +667,6 @@ public boolean isNetworkException(final String sqlState) { return this.exceptionManager.isNetworkException(this.dialect, sqlState); } - @Override - @Deprecated - public boolean isLoginException(Throwable throwable) { - return this.isLoginException(throwable, this.targetDriverDialect); - } - @Override public boolean isLoginException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { if (this.exceptionHandler != null) { @@ -805,51 +781,6 @@ public static void clearCache() { hostAvailabilityExpiringCache.clear(); } - @Deprecated // Use StorageService#set instead. - public void setStatus(final Class clazz, final @Nullable T status, final boolean clusterBound) { - String clusterId = null; - if (clusterBound) { - try { - clusterId = this.hostListProvider.getClusterId(); - } catch (Exception ex) { - // do nothing - } - } - this.setStatus(clazz, status, clusterId); - } - - @Deprecated // Use StorageService#set instead. - public void setStatus(final Class clazz, final @Nullable T status, final String key) { - final String cacheKey = this.getStatusCacheKey(clazz, key); - if (status == null) { - statusesExpiringCache.remove(cacheKey); - } else { - statusesExpiringCache.put(cacheKey, status, DEFAULT_STATUS_CACHE_EXPIRE_NANO); - } - } - - @Deprecated // Use StorageService#get instead. - public T getStatus(final @NonNull Class clazz, final boolean clusterBound) { - String clusterId = null; - if (clusterBound) { - try { - clusterId = this.hostListProvider.getClusterId(); - } catch (Exception ex) { - // do nothing - } - } - return this.getStatus(clazz, clusterId); - } - - @Deprecated // Use StorageService#get instead. - public T getStatus(final @NonNull Class clazz, String key) { - return clazz.cast(statusesExpiringCache.get(this.getStatusCacheKey(clazz, key))); - } - - protected String getStatusCacheKey(final Class clazz, final String key) { - return String.format("%s::%s", key == null ? "" : key.trim().toLowerCase(), clazz.getName()); - } - public boolean isPluginInUse(final Class pluginClazz) { try { return this.pluginManager.isWrapperFor(pluginClazz); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index d29a1b3dd..4f96efba8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -92,28 +92,6 @@ public DialectManager(PluginService pluginService) { this.pluginService = pluginService; } - /** - * Sets a custom dialect handler. - * - * @param dialect A custom dialect to use. - * - * @deprecated Use software.amazon.jdbc.Driver instead - */ - @Deprecated - public static void setCustomDialect(final @NonNull Dialect dialect) { - Driver.setCustomDialect(dialect); - } - - /** - * Resets a custom dialect handler. - * - * @deprecated Use software.amazon.jdbc.Driver instead - */ - @Deprecated - public static void resetCustomDialect() { - Driver.resetCustomDialect(); - } - public static void resetEndpointCache() { knownEndpointDialects.clear(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/exceptions/AbstractPgExceptionHandler.java b/wrapper/src/main/java/software/amazon/jdbc/exceptions/AbstractPgExceptionHandler.java index 65072fa54..2fc89fcb4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/exceptions/AbstractPgExceptionHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/exceptions/AbstractPgExceptionHandler.java @@ -27,12 +27,6 @@ public abstract class AbstractPgExceptionHandler implements ExceptionHandler { public abstract List getAccessErrors(); - @Override - @Deprecated - public boolean isNetworkException(Throwable throwable) { - return this.isNetworkException(throwable, null); - } - @Override public boolean isNetworkException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; @@ -68,12 +62,6 @@ public boolean isNetworkException(final String sqlState) { return false; } - @Override - @Deprecated - public boolean isLoginException(final Throwable throwable) { - return this.isLoginException(throwable, null); - } - @Override public boolean isLoginException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionHandler.java b/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionHandler.java index ab886ece1..4288c4356 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionHandler.java @@ -21,33 +21,11 @@ public interface ExceptionHandler { - /** - * The method determines whether provided throwable is about any network issues. - * - * @param throwable A throwable object to check. - * @return true, if a provided throwable object is network-related. - * - * @deprecated Use similar method below that accepts throwable and target driver dialect. - */ - @Deprecated - boolean isNetworkException(Throwable throwable); - boolean isNetworkException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect); boolean isNetworkException(String sqlState); boolean isLoginException(String sqlState); - /** - * The method determines whether provided throwable is about any login or authentication issues. - * - * @param throwable A throwable object to check. - * @return true, if a provided throwable object is related to authentication. - - * @deprecated Use similar method below that accepts throwable and target driver dialect. - */ - @Deprecated - boolean isLoginException(Throwable throwable); - boolean isLoginException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionManager.java b/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionManager.java index b6f6f5a64..d2e034e17 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionManager.java @@ -22,28 +22,6 @@ public class ExceptionManager { - /** - * Sets a custom exception handler. - * - * @param exceptionHandler A custom exception handler to use. - * - * @deprecated Use software.amazon.jdbc.Driver instead - */ - @Deprecated - public static void setCustomHandler(final ExceptionHandler exceptionHandler) { - Driver.setCustomExceptionHandler(exceptionHandler); - } - - /** - * Resets a custom exception handler. - * - * @deprecated Use software.amazon.jdbc.Driver instead - */ - @Deprecated - public static void resetCustomHandler() { - Driver.resetCustomExceptionHandler(); - } - public boolean isLoginException( final Dialect dialect, final Throwable throwable, final TargetDriverDialect targetDriverDialect) { final ExceptionHandler handler = getHandler(dialect); diff --git a/wrapper/src/main/java/software/amazon/jdbc/exceptions/GenericExceptionHandler.java b/wrapper/src/main/java/software/amazon/jdbc/exceptions/GenericExceptionHandler.java index 79e811323..a7b959a0d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/exceptions/GenericExceptionHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/exceptions/GenericExceptionHandler.java @@ -38,12 +38,6 @@ public class GenericExceptionHandler implements ExceptionHandler { "08" ); - @Override - @Deprecated - public boolean isNetworkException(Throwable throwable) { - return this.isNetworkException(throwable, null); - } - @Override public boolean isNetworkException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; @@ -79,12 +73,6 @@ public boolean isNetworkException(final String sqlState) { return false; } - @Override - @Deprecated - public boolean isLoginException(Throwable throwable) { - return this.isLoginException(throwable, null); - } - @Override public boolean isLoginException(final Throwable throwable, TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/exceptions/MySQLExceptionHandler.java b/wrapper/src/main/java/software/amazon/jdbc/exceptions/MySQLExceptionHandler.java index 5ca8e7136..66568b218 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/exceptions/MySQLExceptionHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/exceptions/MySQLExceptionHandler.java @@ -27,12 +27,6 @@ public class MySQLExceptionHandler implements ExceptionHandler { public static final String SET_NETWORK_TIMEOUT_ON_CLOSED_CONNECTION = "setNetworkTimeout cannot be called on a closed connection"; - @Override - @Deprecated - public boolean isNetworkException(Throwable throwable) { - return this.isNetworkException(throwable, null); - } - @Override public boolean isNetworkException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; @@ -74,12 +68,6 @@ public boolean isNetworkException(final String sqlState) { return sqlState.startsWith("08"); } - @Override - @Deprecated - public boolean isLoginException(Throwable throwable) { - return this.isLoginException(throwable, null); - } - @Override public boolean isLoginException(final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) { Throwable exception = throwable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/TargetDriverDialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/TargetDriverDialectManager.java index 865dbfe7e..47040059c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/TargetDriverDialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/TargetDriverDialectManager.java @@ -70,28 +70,6 @@ public class TargetDriverDialectManager implements TargetDriverDialectProvider { PropertyDefinition.registerPluginProperties(TargetDriverDialectManager.class); } - /** - * Sets a custom target driver dialect handler. - * - * @param targetDriverDialect A custom driver dialect to use. - * - * @deprecated Use software.amazon.jdbc.Driver instead - */ - @Deprecated - public static void setCustomDialect(final @NonNull TargetDriverDialect targetDriverDialect) { - software.amazon.jdbc.Driver.setCustomTargetDriverDialect(targetDriverDialect); - } - - /** - * Resets a custom target driver dialect. - * - * @deprecated Use {@link software.amazon.jdbc.Driver#resetCustomTargetDriverDialect()} instead - */ - @Deprecated - public static void resetCustomDialect() { - software.amazon.jdbc.Driver.resetCustomTargetDriverDialect(); - } - @Override public TargetDriverDialect getDialect( final @NonNull Driver driver, From 9ce95e532e217b2bdd6fcb00ca7fc6eb37f445e0 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 21 Oct 2025 17:19:02 -0700 Subject: [PATCH 04/90] wip --- .../main/java/software/amazon/jdbc/PluginServiceImpl.java | 2 +- .../plugin/AuroraInitialConnectionStrategyPlugin.java | 8 ++++---- .../failover/ClusterAwareWriterFailoverHandler.java | 4 ++-- .../jdbc/plugin/failover/FailoverConnectionPlugin.java | 2 +- .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 2 +- .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index d60865306..dd8aa420b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -730,7 +730,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); // TODO: refreshHostList - this.refreshHostList(connection); + this.refreshHostList(); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index ddf77a3ce..568f12cb6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -195,7 +195,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); if (writerCandidate == null || writerCandidate.getRole() != HostRole.WRITER) { @@ -217,7 +217,7 @@ private Connection getVerifiedWriterConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); continue; @@ -274,7 +274,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); if (readerCandidate == null) { @@ -309,7 +309,7 @@ private Connection getVerifiedReaderConnection( // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); if (this.hasNoReaders()) { // It seems that cluster has no readers. Simulate Aurora reader cluster endpoint logic diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 9ffd4ef65..49f92b78b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -284,7 +284,7 @@ public WriterFailoverResult call() { conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(conn); + this.pluginService.forceRefreshHostList(); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. @@ -446,7 +446,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(this.currentReaderConnection); + this.pluginService.forceRefreshHostList(); final List topology = this.pluginService.getAllHosts(); if (!topology.isEmpty()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index be0b229ce..85dd4a52a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -937,7 +937,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 5ad38cda9..19b8710a4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -788,7 +788,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 0ae4efb16..6ad27b8a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -92,10 +92,10 @@ public Connection getVerifiedConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(conn); + this.pluginService.forceRefreshHostList(); } else { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } LOGGER.finest(() -> Utils.logTopology(this.pluginService.getAllHosts())); From 3e87ebb13281edaf5952bf76be315a81ec4adb99 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:54:06 -0700 Subject: [PATCH 05/90] adopt GDB (#1573) --- CHANGELOG.md | 1 + README.md | 4 + .../CompatibilityDatabaseTypes.md | 12 +- .../CompatibilityEndpoints.md | 18 +-- .../using-the-jdbc-driver/DatabaseDialects.md | 8 +- ...heAuroraInitialConnectionStrategyPlugin.md | 2 + .../using-plugins/UsingTheFailover2Plugin.md | 2 +- .../using-plugins/UsingTheFailoverPlugin.md | 1 + .../jdbc/dialect/AuroraMysqlDialect.java | 27 ++-- .../amazon/jdbc/dialect/AuroraPgDialect.java | 35 +++-- .../amazon/jdbc/dialect/DialectCodes.java | 2 + .../amazon/jdbc/dialect/DialectManager.java | 14 ++ .../dialect/GlobalAuroraMysqlDialect.java | 130 ++++++++++++++++ .../jdbc/dialect/GlobalAuroraPgDialect.java | 143 ++++++++++++++++++ .../amazon/jdbc/dialect/MysqlDialect.java | 3 +- .../amazon/jdbc/dialect/PgDialect.java | 1 + .../amazon/jdbc/dialect/RdsMysqlDialect.java | 1 + .../amazon/jdbc/dialect/RdsPgDialect.java | 1 + .../amazon/jdbc/dialect/UnknownDialect.java | 2 + .../AuroraGlobalDbHostListProvider.java | 114 ++++++++++++++ .../hostlistprovider/RdsHostListProvider.java | 90 +++++------ ...oraGlobalDbMonitoringHostListProvider.java | 111 ++++++++++++++ .../ClusterTopologyMonitorImpl.java | 34 +++-- .../GlobalDbClusterTopologyMonitorImpl.java | 110 ++++++++++++++ .../MonitoringRdsHostListProvider.java | 2 +- .../MultiAzClusterTopologyMonitorImpl.java | 2 +- ...AuroraInitialConnectionStrategyPlugin.java | 10 +- .../plugin/staledns/AuroraStaleDnsHelper.java | 7 +- .../amazon/jdbc/util/ConnectionUrlParser.java | 54 +++++++ .../software/amazon/jdbc/util/RdsUrlType.java | 1 + .../software/amazon/jdbc/util/RdsUtils.java | 18 ++- ..._advanced_jdbc_wrapper_messages.properties | 3 + .../container/tests/PerformanceTest.java | 1 - .../jdbc/util/ConnectionUrlParserTest.java | 61 ++++++++ .../amazon/jdbc/util/RdsUtilsTests.java | 9 ++ 35 files changed, 928 insertions(+), 106 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java diff --git a/CHANGELOG.md b/CHANGELOG.md index fbb95e078..3718161f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Breaking Change: Remove deprecated code. ([PR #1572](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1572)). ### :magic_wand: Added +- Added support of Global Databases including and Global Database endpoint. ([PR #1573](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1573)). ## [2.6.5] - 2025-10-16 diff --git a/README.md b/README.md index a4fea1549..e0fc3f6e2 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,10 @@ With the `failover` plugin, the downtime during certain DB cluster operations, s Visit [this page](./docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md) for more details. +### Using the AWS JDBC Driver with Amazon Aurora Global Databases + +This driver supports in-region `failover` and between-regions `planned failover` and `switchover` of [Amazon Aurora Global Databases](https://aws.amazon.com/ru/rds/aurora/global-database/). A [Global Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-connecting.html) is also recognized and can be handled to minimize potential stale DNS issues. Please check [failover plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md), [failover2 plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md) and [Aurora Initial Connection Strategy plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) for more information. + ### Plain Amazon RDS databases The AWS JDBC Driver also works with RDS provided databases that are not Aurora. diff --git a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md index e0876f3db..733af5f34 100644 --- a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md +++ b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md @@ -8,20 +8,20 @@ | customEndpoint | ✓ | ✓ | ✓ | | [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ | ✓ | ✓ | | [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ | ✓ | ✓ | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✗ | ✓ | ✓ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✗ | ✓ | ✓ | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | ✓ | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | ✓ | ✓ | | [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ | ✓ | ✓ | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | -| auroraStaleDns | ✗ | ✓ | ✓ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✗ | ✓ | ✓ | +| auroraStaleDns | ✓ | ✓ | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | | connectTime | ✓ | ✓ | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | ✓ | ✓ | -| fastestResponseStrategy | ✗ | ✓ | ✓ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✗ | ✓ | ✓ | +| fastestResponseStrategy | ✓ | ✓ | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | ✓ | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | ✓ (PostgreSQL only) | ✓ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | ✓ | ✓ |
diff --git a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md index 621dcdfc3..81a17ce70 100644 --- a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md +++ b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md @@ -23,22 +23,22 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | logQuery | ✓ | | dataCache | ✓ | | customEndpoint | ✗ | -| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✗ | -| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✗ | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✗ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✗ | -| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires special configuration) | +| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ (requires `initialConnection` plugin) | +| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ (requires `initialConnection` plugin) | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | +| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires `initialConnection` plugin) | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | -| auroraStaleDns | ✗ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✗ | +| auroraStaleDns | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | | connectTime | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | -| fastestResponseStrategy | ✗ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✗ | +| fastestResponseStrategy | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | diff --git a/docs/using-the-jdbc-driver/DatabaseDialects.md b/docs/using-the-jdbc-driver/DatabaseDialects.md index 9264c912f..a8c18c464 100644 --- a/docs/using-the-jdbc-driver/DatabaseDialects.md +++ b/docs/using-the-jdbc-driver/DatabaseDialects.md @@ -16,12 +16,14 @@ The AWS Advanced JDBC Driver is a wrapper that requires an underlying driver, an Dialect codes specify what kind of database any connections will be made to. | Dialect Code Reference | Value | Database | -| ---------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AURORA_MYSQL` | `aurora-mysql` | Aurora MySQL | +| ---------------------------- | ---------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------| +| `AURORA_MYSQL` | `aurora-mysql` | [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.html) | +| `GLOBAL_AURORA_MYSQL` | `global-aurora-mysql` | [Aurora Global Database MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html) | | `RDS_MULTI_AZ_MYSQL_CLUSTER` | `rds-multi-az-mysql-cluster` | [Amazon RDS MySQL Multi-AZ DB Cluster Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) | | `RDS_MYSQL` | `rds-mysql` | Amazon RDS MySQL | | `MYSQL` | `mysql` | MySQL | -| `AURORA_PG` | `aurora-pg` | Aurora PostgreSQL | +| `AURORA_PG` | `aurora-pg` | [Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.html) | +| `GLOBAL_AURORA_PG` | `global-aurora-pg` | [Aurora Global Database PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html) | | `RDS_MULTI_AZ_PG_CLUSTER` | `rds-multi-az-pg-cluster` | [Amazon RDS PostgreSQL Multi-AZ DB Cluster Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) | | `RDS_PG` | `rds-pg` | Amazon RDS PostgreSQL | | `PG` | `pg` | PostgreSQL | diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md index 70f23c974..9483f7989 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md @@ -5,6 +5,8 @@ When this plugin is enabled, if the initial connection is to a reader cluster en This plugin also helps retrieve connections more reliably. When a user connects to a cluster endpoint, the actual instance for a new connection is resolved by DNS. During failover, the cluster elects another instance to be the writer. While DNS is updating, which can take up to 40-60 seconds, if a user tries to connect to the cluster endpoint, they may be connecting to an old node. This plugin helps by replacing the out of date endpoint if DNS is updating. +When using Aurora Global Database, the user has an option to use an [Aurora Global Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-connecting.html). The Global Writer Endpoint makes a user application configuration easier. However, similar to the cluster writer endpoint mentioned above, it can also be affected by DNS updates. The Aurora Initial Connection Strategy Plugin recognizes an Aurora Global Writer Endpoint and substitutes it with the current writer endpoint. + Verify plugin compatibility within your driver configuration using the [compatibility guide](../Compatibility.md). ## Enabling the Aurora Initial Connection Strategy Plugin diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md index 3f9a67daa..621e74f92 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md @@ -59,6 +59,7 @@ In addition to the parameters that you can configure for the underlying driver, |---------------------------------------|:--------:|:----------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | | `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | +| `globalClusterInstanceHostPatterns` | String | For Global Databases: Yes

Otherwise: No | This parameter is similar to the `clusterInstanceHostPattern` parameter but it provides a comma-separated list of instance host patterns. This parameter is required for Aurora Global Databases. The list should contain host patterns for each region of the global database. Each host pattern can be based on an RDS instance endpoint or a custom user domain name. If a custom domain name is used, the instance template pattern should be prefixed with the AWS region name in square brackets (`[]`).

The parameter is ignored for other types of databases (Aurora Clusters, RDS Clusters, plain RDS databases, etc.).

Example: for an Aurora Global Database with two AWS regions `us-east-2` and `us-west-2`, the parameter value should be set to `?.XYZ1.us-east-2.rds.amazonaws.com,?.XYZ2.us-west-2.rds.amazonaws.com`. Please note that user identifiers are different for different AWS regions (`XYZ1` and `XYZ2` in the example above).

Example: if using custom domain names, the parameter value should be similar to `[us-east-2]?.customHost,[us-west-2]?.anotherCustomHost`. The port can also be provided: `[us-east-2]?.customHost:8888,[us-west-2]?.anotherCustomHost:9999` | | | `clusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds when a cluster is not in failover. It refers to the regular, slow monitoring rate explained above. | `30000` | | `failoverTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt reconnecting to a new writer or reader instance after a cluster failover is initiated. | `300000` | | `clusterTopologyHighRefreshRateMs` | Integer | No | Interval of time in milliseconds to wait between attempts to update cluster topology after the writer has come back online following a failover event. It corresponds to the increased monitoring rate described earlier. Usually, the topology monitoring component uses this increased monitoring rate for 30s after a new writer was detected. | `100` | @@ -68,7 +69,6 @@ In addition to the parameters that you can configure for the underlying driver, | `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | - Please refer to the original [Failover Plugin](./UsingTheFailoverPlugin.md) for more details about error codes, configurations, connection pooling and sample codes. ### Sample Code diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md index cd26f54d6..6cff3ab62 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md @@ -28,6 +28,7 @@ In addition to the parameters that you can configure for the underlying driver, | `failoverMode` | String | No | Defines a mode for failover process. Failover process may prioritize nodes with different roles and connect to them. Possible values:

- `strict-writer` - Failover process follows writer node and connects to a new writer when it changes.
- `reader-or-writer` - During failover, the driver tries to connect to any available/accessible reader node. If no reader is available, the driver will connect to a writer node. This logic mimics the logic of the Aurora read-only cluster endpoint.
- `strict-reader` - During failover, the driver tries to connect to any available reader node. If no reader is available, the driver raises an error. Reader failover to a writer node will only be allowed for single-node clusters. This logic mimics the logic of the Aurora read-only cluster endpoint.

If this parameter is omitted, default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | Default value depends on connection url. For Aurora read-only cluster endpoint, it's set to `reader-or-writer`. Otherwise, it's `strict-writer`. | | `clusterId` | `String` | If connecting to multiple database clusters within a single application: Yes

Otherwise: No

:warning:If `clusterId` is omitted, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | | `clusterInstanceHostPattern` | String | If connecting using an IP address or custom domain URL: Yes

Otherwise: No | This parameter is not required unless connecting to an AWS RDS cluster via an IP address or custom domain URL. In those cases, this parameter specifies the cluster instance DNS pattern that will be used to build a complete instance endpoint. A "?" character in this pattern should be used as a placeholder for the DB instance identifiers of the instances in the cluster. See [here](#host-pattern) for more information.

Example: `?.my-domain.com`, `any-subdomain.?.my-domain.com:9999`

Use case Example: If your cluster instance endpoints follow this pattern:`instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc. and you want your initial connection to be to `customHost:1234`, then your connection string should look like this: `jdbc:aws-wrapper:mysql://customHost:1234/test?clusterInstanceHostPattern=?.customHost` | If the provided connection string is not an IP address or custom domain, the JDBC Driver will automatically acquire the cluster instance host pattern from the customer-provided connection string. | +| `globalClusterInstanceHostPatterns` | String | For Global Databases: Yes

Otherwise: No | This parameter is similar to `clusterInstanceHostPattern` parameter but it provides a coma-separated list of instance host patterns. This parameter is required for Aurora Global Databases. The list should contains host pattern for each region of a global database. Each host pattern can be based on a RDS instance endpoint or a custom user domain name. If custom domain name is used, an instance template pattern should be prefixed with a AWS region name in square brackets (`[]`).

The parameter is ignored for other types of databases (Aurora Clusters, RDS Clusters, plain RDS databases, etc.).

Example: for an Aurora Global Database with two AWS regions `us-east-2` and `us-west-2`, the parameter value is `?.XYZ1.us-east-2.rds.amazonaws.com,?.XYZ2.us-west-2.rds.amazonaws.com`. Please pay attention that user identifiers are different for different AWS regions (`XYZ1` and `XYZ2` as in the example above).

In case of custom domain names, the parameter value can be `[us-east-2]?.customHost,[us-west-2]?.anotherCustomHost`. Port can be also provided: `[us-east-2]?.customHost:8888,[us-west-2]?.anotherCustomHost:9999` | | | `enableClusterAwareFailover` | Boolean | No | Set to `true` to enable the fast failover behavior offered by the AWS Advanced JDBC Driver. Set to `false` for simple JDBC connections that do not require fast failover functionality. | `true` | | `failoverClusterTopologyRefreshRateMs` | Integer | No | Cluster topology refresh rate in milliseconds during a writer failover process. During the writer failover process, cluster topology may be refreshed at a faster pace than normal to speed up discovery of the newly promoted writer. | `2000` | | `failoverReaderConnectTimeoutMs` | Integer | No | Maximum allowed time in milliseconds to attempt to connect to a reader instance during a reader failover process. | `30000` | diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index e64352899..2f5a8c91c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -20,6 +20,7 @@ import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; +import java.util.Arrays; import java.util.Collections; import java.util.List; import software.amazon.jdbc.PluginService; @@ -29,19 +30,19 @@ public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect { - private static final String TOPOLOGY_QUERY = + protected final String topologyQuery = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, REPLICA_LAG_IN_MILLISECONDS, LAST_UPDATE_TIMESTAMP " + "FROM information_schema.replica_host_status " // filter out nodes that haven't been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; - private static final String IS_WRITER_QUERY = + protected final String isWriterQuery = "SELECT SERVER_ID FROM information_schema.replica_host_status " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; - private static final String NODE_ID_QUERY = "SELECT @@aurora_server_id"; - private static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; + protected final String nodeIdQuery = "SELECT @@aurora_server_id"; + protected final String isReaderQuery = "SELECT @@innodb_read_only"; private static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; @@ -84,7 +85,9 @@ public boolean isDialect(final Connection connection) { @Override public List getDialectUpdateCandidates() { - return Collections.singletonList(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); + return Arrays.asList( + DialectCodes.GLOBAL_AURORA_MYSQL, + DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); } @Override @@ -96,18 +99,18 @@ public HostListProviderSupplier getHostListProvider() { properties, initialUrl, servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); + this.topologyQuery, + this.nodeIdQuery, + this.isReaderQuery, + this.isWriterQuery); } return new AuroraHostListProvider( properties, initialUrl, servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); + this.topologyQuery, + this.nodeIdQuery, + this.isReaderQuery); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index c81d85f70..a12046ea4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -20,6 +20,8 @@ import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; +import java.util.Arrays; +import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; @@ -34,14 +36,14 @@ public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect, BlueGreenDialect { private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); - private static final String extensionsSql = + protected final String extensionsSql = "SELECT (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " + "FROM pg_catalog.pg_settings " + "WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'"; - private static final String topologySql = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; + protected final String topologySql = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; - private static final String TOPOLOGY_QUERY = + protected final String topologyQuery = "SELECT SERVER_ID, CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, COALESCE(REPLICA_LAG_IN_MSEC, 0), LAST_UPDATE_TIMESTAMP " + "FROM pg_catalog.aurora_replica_status() " @@ -51,13 +53,13 @@ public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect + "OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "OR LAST_UPDATE_TIMESTAMP IS NULL"; - private static final String IS_WRITER_QUERY = + protected final String isWriterQuery = "SELECT SERVER_ID FROM pg_catalog.aurora_replica_status() " + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()"; - private static final String NODE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; - private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; + protected final String nodeIdQuery = "SELECT pg_catalog.aurora_db_instance_identifier()"; + protected final String isReaderQuery = "SELECT pg_catalog.pg_is_in_recovery()"; protected static final String LIMITLESS_ROUTER_ENDPOINT_QUERY = "select router_endpoint, load from pg_catalog.aurora_limitless_router_endpoints()"; @@ -68,6 +70,13 @@ public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect private static final String TOPOLOGY_TABLE_EXIST_QUERY = "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; + @Override + public List getDialectUpdateCandidates() { + return Arrays.asList(DialectCodes.GLOBAL_AURORA_PG, + DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, + DialectCodes.RDS_PG); + } + @Override public boolean isDialect(final Connection connection) { if (!super.isDialect(connection)) { @@ -146,18 +155,18 @@ public HostListProviderSupplier getHostListProvider() { properties, initialUrl, servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); + topologyQuery, + nodeIdQuery, + isReaderQuery, + isWriterQuery); } return new AuroraHostListProvider( properties, initialUrl, servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); + topologyQuery, + nodeIdQuery, + isReaderQuery); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectCodes.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectCodes.java index 74c48a67c..47c0de3c5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectCodes.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectCodes.java @@ -17,12 +17,14 @@ package software.amazon.jdbc.dialect; public class DialectCodes { + public static final String GLOBAL_AURORA_MYSQL = "global-aurora-mysql"; public static final String AURORA_MYSQL = "aurora-mysql"; public static final String RDS_MYSQL = "rds-mysql"; public static final String MYSQL = "mysql"; // https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html public static final String RDS_MULTI_AZ_MYSQL_CLUSTER = "rds-multi-az-mysql-cluster"; + public static final String GLOBAL_AURORA_PG = "global-aurora-pg"; public static final String AURORA_PG = "aurora-pg"; public static final String RDS_PG = "rds-pg"; // https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index 4f96efba8..273edf82a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -60,7 +60,9 @@ public class DialectManager implements DialectProvider { put(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, new RdsMultiAzDbClusterMysqlDialect()); put(DialectCodes.RDS_PG, new RdsPgDialect()); put(DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, new RdsMultiAzDbClusterPgDialect()); + put(DialectCodes.GLOBAL_AURORA_MYSQL, new GlobalAuroraMysqlDialect()); put(DialectCodes.AURORA_MYSQL, new AuroraMysqlDialect()); + put(DialectCodes.GLOBAL_AURORA_PG, new GlobalAuroraPgDialect()); put(DialectCodes.AURORA_PG, new AuroraPgDialect()); put(DialectCodes.UNKNOWN, new UnknownDialect()); } @@ -145,6 +147,12 @@ public Dialect getDialect( if (driverProtocol.contains("mysql")) { RdsUrlType type = this.rdsHelper.identifyRdsType(host); + if (type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER) { + this.canUpdate = false; + this.dialectCode = DialectCodes.GLOBAL_AURORA_MYSQL; + this.dialect = knownDialectsByCode.get(DialectCodes.GLOBAL_AURORA_MYSQL); + return this.dialect; + } if (type.isRdsCluster()) { this.canUpdate = true; this.dialectCode = DialectCodes.AURORA_MYSQL; @@ -173,6 +181,12 @@ public Dialect getDialect( this.dialect = knownDialectsByCode.get(DialectCodes.AURORA_PG); return this.dialect; } + if (RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER.equals(type)) { + this.canUpdate = false; + this.dialectCode = DialectCodes.GLOBAL_AURORA_PG; + this.dialect = knownDialectsByCode.get(DialectCodes.GLOBAL_AURORA_PG); + return this.dialect; + } if (type.isRdsCluster()) { this.canUpdate = true; this.dialectCode = DialectCodes.AURORA_PG; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java new file mode 100644 index 000000000..3e4db74e6 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -0,0 +1,130 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.Collections; +import java.util.List; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; +import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; + +public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect { + + protected final String globalDbStatusTableExistQuery = + "SELECT 1 AS tmp FROM information_schema.tables WHERE" + + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_STATUS'"; + + protected final String globalDbStatusQuery = + "SELECT count(1) FROM information_schema.aurora_global_db_status"; + + protected final String globalDbInstanceStatusTableExistQuery = + "SELECT 1 AS tmp FROM information_schema.tables WHERE" + + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_INSTANCE_STATUS'"; + + protected final String globalTopologyQuery = + "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + + "FROM information_schema.aurora_global_db_instance_status "; + + protected final String regionByNodeIdQuery = + "SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?"; + + @Override + public boolean isDialect(final Connection connection) { + Statement stmt = null; + ResultSet rs = null; + try { + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbStatusTableExistQuery); + + if (rs.next()) { + rs.close(); + stmt.close(); + + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbInstanceStatusTableExistQuery); + + if (rs.next()) { + rs.close(); + stmt.close(); + + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbStatusQuery); + + if (rs.next()) { + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; + } + } + } + return false; + } catch (final SQLException ex) { + // ignore + } finally { + if (rs != null) { + try { + rs.close(); + } catch (SQLException ex) { + // ignore + } + } + if (stmt != null) { + try { + stmt.close(); + } catch (SQLException ex) { + // ignore + } + } + } + return false; + } + + @Override + public List getDialectUpdateCandidates() { + return Collections.emptyList(); + } + + @Override + public HostListProviderSupplier getHostListProvider() { + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new AuroraGlobalDbMonitoringHostListProvider( + properties, + initialUrl, + servicesContainer, + this.globalTopologyQuery, + this.nodeIdQuery, + this.isReaderQuery, + this.isWriterQuery, + this.regionByNodeIdQuery); + } + return new AuroraGlobalDbHostListProvider( + properties, + initialUrl, + servicesContainer, + this.globalTopologyQuery, + this.nodeIdQuery, + this.isReaderQuery); + }; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java new file mode 100644 index 000000000..289ced4ae --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -0,0 +1,143 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.Collections; +import java.util.List; +import java.util.logging.Logger; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; +import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; + +public class GlobalAuroraPgDialect extends AuroraPgDialect { + + private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); + + protected final String globalDbStatusFuncExistQuery = + "select 'aurora_global_db_status'::regproc"; + + protected final String globalDbInstanceStatusFuncExistQuery = + "select 'aurora_global_db_instance_status'::regproc"; + + protected final String globalTopologyQuery = + "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + + "FROM aurora_global_db_instance_status()"; + + protected final String globalDbStatusQuery = + "SELECT count(1) FROM aurora_global_db_status()"; + + protected final String regionByNodeIdQuery = + "SELECT AWS_REGION FROM aurora_global_db_instance_status() WHERE SERVER_ID = ?"; + + @Override + public boolean isDialect(final Connection connection) { + Statement stmt = null; + ResultSet rs = null; + try { + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.extensionsSql); + if (rs.next()) { + final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); + LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); + if (!auroraUtils) { + return false; + } + } + rs.close(); + stmt.close(); + + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbStatusFuncExistQuery); + + if (rs.next()) { + rs.close(); + stmt.close(); + + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbInstanceStatusFuncExistQuery); + + if (rs.next()) { + rs.close(); + stmt.close(); + + stmt = connection.createStatement(); + rs = stmt.executeQuery(this.globalDbStatusQuery); + + if (rs.next()) { + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; + } + } + } + return false; + } catch (final SQLException ex) { + // ignore + } finally { + if (rs != null) { + try { + rs.close(); + } catch (SQLException ex) { + // ignore + } + } + if (stmt != null) { + try { + stmt.close(); + } catch (SQLException ex) { + // ignore + } + } + } + return false; + } + + @Override + public List getDialectUpdateCandidates() { + return Collections.emptyList(); + } + + @Override + public HostListProviderSupplier getHostListProvider() { + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new AuroraGlobalDbMonitoringHostListProvider( + properties, + initialUrl, + servicesContainer, + this.globalTopologyQuery, + this.nodeIdQuery, + this.isReaderQuery, + this.isWriterQuery, + this.regionByNodeIdQuery); + } + return new AuroraGlobalDbHostListProvider( + properties, + initialUrl, + servicesContainer, + this.globalTopologyQuery, + this.nodeIdQuery, + this.isReaderQuery); + }; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index de9f181d3..7c930bb5e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -34,8 +34,9 @@ public class MysqlDialect implements Dialect { private static final List dialectUpdateCandidates = Arrays.asList( - DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, + DialectCodes.GLOBAL_AURORA_MYSQL, DialectCodes.AURORA_MYSQL, + DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, DialectCodes.RDS_MYSQL ); private static MySQLExceptionHandler mySQLExceptionHandler; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 075cf242d..40363b4da 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -37,6 +37,7 @@ public class PgDialect implements Dialect { private static final List dialectUpdateCandidates = Arrays.asList( + DialectCodes.GLOBAL_AURORA_PG, DialectCodes.AURORA_PG, DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, DialectCodes.RDS_PG); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java index 22e010ea7..b91f6a1e3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java @@ -35,6 +35,7 @@ public class RdsMysqlDialect extends MysqlDialect implements BlueGreenDialect { private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, + DialectCodes.GLOBAL_AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index d59b9f2eb..33d2c480a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -37,6 +37,7 @@ public class RdsPgDialect extends PgDialect implements BlueGreenDialect { private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, + DialectCodes.GLOBAL_AURORA_PG, DialectCodes.AURORA_PG); private static final String extensionsSql = "SELECT (setting LIKE '%rds_tools%') AS rds_tools, " diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java index 65b9eb544..f9bd1e4a3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java @@ -31,6 +31,8 @@ public class UnknownDialect implements Dialect { private static final List dialectUpdateCandidates = Arrays.asList( + DialectCodes.GLOBAL_AURORA_PG, + DialectCodes.GLOBAL_AURORA_MYSQL, DialectCodes.AURORA_PG, DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java new file mode 100644 index 000000000..d85069323 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java @@ -0,0 +1,114 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.Arrays; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import software.amazon.jdbc.AwsWrapperProperty; +import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.util.ConnectionUrlParser; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.RdsUtils; +import software.amazon.jdbc.util.StringUtils; + +public class AuroraGlobalDbHostListProvider extends AuroraHostListProvider { + + static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbHostListProvider.class.getName()); + + public static final AwsWrapperProperty GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS = + new AwsWrapperProperty( + "globalClusterInstanceHostPatterns", + null, + "Comma-separated list of the cluster instance DNS patterns that will be used to " + + "build a complete instance endpoints. " + + "A \"?\" character in these patterns should be used as a placeholder for cluster instance names. " + + "This parameter is required for Global Aurora Databases. " + + "Each region in the Global Aurora Database should be specified in the list."); + + protected final RdsUtils rdsUtils = new RdsUtils(); + + protected Map globalClusterInstanceTemplateByAwsRegion; + + static { + PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); + } + + public AuroraGlobalDbHostListProvider(Properties properties, String originalUrl, + final FullServicesContainer servicesContainer, String topologyQuery, + String nodeIdQuery, String isReaderQuery) { + super(properties, originalUrl, servicesContainer, topologyQuery, nodeIdQuery, isReaderQuery); + } + + @Override + protected void initSettings() throws SQLException { + super.initSettings(); + + String templates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + if (StringUtils.isNullOrEmpty(templates)) { + throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); + } + + HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); + this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) + .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) + .collect(Collectors.toMap( + k -> k.getValue1(), + v -> { + this.validateHostPatternSetting(v.getValue2().getHost()); + return v.getValue2(); + })); + LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" + + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")) + ); + } + + @Override + protected HostSpec createHost(final ResultSet resultSet) throws SQLException { + + // suggestedWriterNodeId is not used for Aurora Global Database clusters. + // Topology query can detect a writer for itself. + + // According to the topology query the result set + // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. + String hostName = resultSet.getString(1); + final boolean isWriter = resultSet.getBoolean(2); + final float nodeLag = resultSet.getFloat(3); + final String awsRegion = resultSet.getString(4); + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L; + + final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); + if (clusterInstanceTemplateForRegion == null) { + throw new SQLException("Can't find cluster template for region " + awsRegion); + } + + return createHost(hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index ea372e5a2..026d96e4d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -88,8 +88,8 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); protected static final int defaultTopologyQueryTimeoutMs = 5000; - protected final FullServicesContainer servicesContainer; + protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; protected final String originalUrl; protected final String topologyQuery; @@ -141,46 +141,49 @@ protected void init() throws SQLException { if (this.isInitialized) { return; } - - // initial topology is based on connection string - this.initialHostList = - connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, - this.hostListProviderService::getHostSpecBuilder); - if (this.initialHostList == null || this.initialHostList.isEmpty()) { - throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", - new Object[] {this.originalUrl})); - } - this.initialHostSpec = this.initialHostList.get(0); - this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); - - this.clusterId = CLUSTER_ID.getString(this.properties); - this.refreshRateNano = - TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); - if (clusterInstancePattern != null) { - this.clusterInstanceTemplate = - ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); - } else { - this.clusterInstanceTemplate = - hostSpecBuilder - .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) - .hostId(this.initialHostSpec.getHostId()) - .port(this.initialHostSpec.getPort()) - .build(); - } - - validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); - - this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); + this.initSettings(); this.isInitialized = true; - } finally { lock.unlock(); } } + protected void initSettings() throws SQLException { + + // initial topology is based on connection string + this.initialHostList = + connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, + this.hostListProviderService::getHostSpecBuilder); + if (this.initialHostList == null || this.initialHostList.isEmpty()) { + throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", + new Object[] {this.originalUrl})); + } + this.initialHostSpec = this.initialHostList.get(0); + this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); + + this.clusterId = CLUSTER_ID.getString(this.properties); + this.refreshRateNano = + TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); + + HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); + String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); + if (clusterInstancePattern != null) { + this.clusterInstanceTemplate = + ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); + } else { + this.clusterInstanceTemplate = + hostSpecBuilder + .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) + .hostId(this.initialHostSpec.getHostId()) + .port(this.initialHostSpec.getPort()) + .build(); + } + + validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); + + this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); + } + /** * Get cluster topology. It may require an extra call to database to fetch the latest topology. A * cached copy of topology is returned if it's not yet outdated (controlled by {@link @@ -332,19 +335,20 @@ protected HostSpec createHost(final ResultSet resultSet) throws SQLException { // Calculate weight based on node lag in time and CPU utilization. final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, isWriter, weight, lastUpdateTime); + return createHost(hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); } protected HostSpec createHost( String host, final boolean isWriter, final long weight, - final Timestamp lastUpdateTime) { + final Timestamp lastUpdateTime, + final HostSpec clusterInstanceTemplate) { host = host == null ? "?" : host; - final String endpoint = getHostEndpoint(host); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() + final String endpoint = getHostEndpoint(host, clusterInstanceTemplate); + final int port = clusterInstanceTemplate.isPortSpecified() + ? clusterInstanceTemplate.getPort() : this.initialHostSpec.getPort(); final HostSpec hostSpec = this.hostListProviderService.getHostSpecBuilder() @@ -366,8 +370,8 @@ protected HostSpec createHost( * @param nodeName A host name. * @return Host dns endpoint */ - protected String getHostEndpoint(final String nodeName) { - final String host = this.clusterInstanceTemplate.getHost(); + protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { + final String host = clusterInstanceTemplate.getHost(); return host.replace("?", nodeName); } @@ -431,7 +435,7 @@ public RdsUrlType getRdsUrlType() throws SQLException { return this.rdsUrlType; } - private void validateHostPatternSetting(final String hostPattern) { + protected void validateHostPatternSetting(final String hostPattern) { if (!rdsHelper.isDnsPatternValid(hostPattern)) { // "Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host // pattern must contain a '?' diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java new file mode 100644 index 000000000..50bb4263d --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java @@ -0,0 +1,111 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider.monitoring; + +import java.sql.SQLException; +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; +import software.amazon.jdbc.util.ConnectionUrlParser; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Pair; +import software.amazon.jdbc.util.RdsUtils; +import software.amazon.jdbc.util.StringUtils; +import software.amazon.jdbc.util.connection.ConnectionService; + +public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostListProvider { + + static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbMonitoringHostListProvider.class.getName()); + + protected Map globalClusterInstanceTemplateByAwsRegion = new HashMap<>(); + + protected final RdsUtils rdsUtils = new RdsUtils(); + + protected String regionByNodeIdQuery; + + static { + // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. + PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); + } + + public AuroraGlobalDbMonitoringHostListProvider(Properties properties, String originalUrl, + final FullServicesContainer servicesContainer, String globalTopologyQuery, + String nodeIdQuery, String isReaderQuery, String writerTopologyQuery, + String regionByNodeIdQuery) { + + super(properties, originalUrl, servicesContainer, globalTopologyQuery, nodeIdQuery, isReaderQuery, + writerTopologyQuery); + this.regionByNodeIdQuery = regionByNodeIdQuery; + } + + @Override + protected void initSettings() throws SQLException { + super.initSettings(); + + String templates = AuroraGlobalDbHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + if (StringUtils.isNullOrEmpty(templates)) { + throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); + } + + HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); + this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) + .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) + .collect(Collectors.toMap( + Pair::getValue1, + v -> { + this.validateHostPatternSetting(v.getValue2().getHost()); + return v.getValue2(); + })); + LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" + + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")) + ); + } + + protected ClusterTopologyMonitor initMonitor() throws SQLException { + return this.servicesContainer.getMonitorService().runIfAbsent( + ClusterTopologyMonitorImpl.class, + this.clusterId, + this.servicesContainer, + this.properties, + (servicesContainer) -> + new GlobalDbClusterTopologyMonitorImpl( + servicesContainer, + this.clusterId, + this.initialHostSpec, + this.properties, + this.clusterInstanceTemplate, + this.refreshRateNano, + this.highRefreshRateNano, + this.topologyQuery, + this.writerTopologyQuery, + this.nodeIdQuery, + this.globalClusterInstanceTemplateByAwsRegion, + this.regionByNodeIdQuery)); + } + +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 4ddfa0fd0..e53d59420 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -81,7 +81,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final long highRefreshRateNano; protected final FullServicesContainer servicesContainer; protected final Properties properties; - protected final Properties monitoringProperties; + protected Properties monitoringProperties; protected final HostSpec initialHostSpec; protected final String topologyQuery; protected final String nodeIdQuery; @@ -129,6 +129,10 @@ public ClusterTopologyMonitorImpl( this.writerTopologyQuery = writerTopologyQuery; this.nodeIdQuery = nodeIdQuery; + this.initSettings(); + } + + protected void initSettings() { this.monitoringProperties = PropertyUtils.copyProperties(properties); this.properties.stringPropertyNames().stream() .filter(p -> p.startsWith(MONITORING_PROPERTY_PREFIX)) @@ -534,7 +538,8 @@ protected List openAnyConnectionAndUpdateTopology() { } else { final String nodeId = this.getNodeId(this.monitoringConnection.get()); if (!StringUtils.isNullOrEmpty(nodeId)) { - this.writerHostSpec.set(this.createHost(nodeId, true, 0, null)); + this.writerHostSpec.set(this.createHost(nodeId, true, 0, null, + this.getClusterInstanceTemplate(nodeId, this.monitoringConnection.get()))); LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", @@ -575,6 +580,10 @@ protected List openAnyConnectionAndUpdateTopology() { return hosts; } + protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { + return this.clusterInstanceTemplate; + } + protected String getNodeId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); @@ -691,7 +700,7 @@ protected String getWriterNodeId(final Connection connection) throws SQLExceptio } protected String getSuggestedWriterNodeId(final Connection connection) throws SQLException { - // Aurora topology query can detect a writer for itself so it doesn't need any suggested writer node ID. + // Aurora topology query can detect a writer for itself, so it doesn't need any suggested writer node ID. return null; // intentionally null } @@ -771,19 +780,20 @@ protected HostSpec createHost( // Calculate weight based on node lag in time and CPU utilization. final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, isWriter, weight, lastUpdateTime); + return createHost(hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); } protected HostSpec createHost( String nodeName, final boolean isWriter, final long weight, - final Timestamp lastUpdateTime) { + final Timestamp lastUpdateTime, + final HostSpec clusterInstanceTemplate) { nodeName = nodeName == null ? "?" : nodeName; - final String endpoint = getHostEndpoint(nodeName); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() + final String endpoint = getHostEndpoint(nodeName, clusterInstanceTemplate); + final int port = clusterInstanceTemplate.isPortSpecified() + ? clusterInstanceTemplate.getPort() : this.initialHostSpec.getPort(); final HostSpec hostSpec = this.servicesContainer.getHostListProviderService().getHostSpecBuilder() @@ -799,8 +809,8 @@ protected HostSpec createHost( return hostSpec; } - protected String getHostEndpoint(final String nodeName) { - final String host = this.clusterInstanceTemplate.getHost(); + protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { + final String host = clusterInstanceTemplate.getHost(); return host.replace("?", nodeName); } @@ -903,12 +913,12 @@ public void run() { if (this.monitor.nodeThreadsWriterConnection.get() == null) { // while writer connection isn't yet established this reader connection may update topology if (updateTopology) { - this.readerThreadFetchTopology(connection, writerHostSpec); + this.readerThreadFetchTopology(connection, this.writerHostSpec); } else if (this.monitor.nodeThreadsReaderConnection.get() == null) { if (this.monitor.nodeThreadsReaderConnection.compareAndSet(null, connection)) { // let's use this connection to update topology updateTopology = true; - this.readerThreadFetchTopology(connection, writerHostSpec); + this.readerThreadFetchTopology(connection, this.writerHostSpec); } } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java new file mode 100644 index 000000000..4b661dbc5 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java @@ -0,0 +1,110 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider.monitoring; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.StringUtils; + + +public class GlobalDbClusterTopologyMonitorImpl extends ClusterTopologyMonitorImpl { + + private static final Logger LOGGER = Logger.getLogger(GlobalDbClusterTopologyMonitorImpl.class.getName()); + + protected final Map globalClusterInstanceTemplateByAwsRegion; + protected final String regionByNodeIdQuery; + + public GlobalDbClusterTopologyMonitorImpl( + final FullServicesContainer servicesContainer, + final String clusterId, + final HostSpec initialHostSpec, + final Properties properties, + final HostSpec clusterInstanceTemplate, + final long refreshRateNano, + final long highRefreshRateNano, + final String topologyQuery, + final String writerTopologyQuery, + final String nodeIdQuery, + final Map globalClusterInstanceTemplateByAwsRegion, + final String regionByNodeIdQuery) { + + super(servicesContainer, clusterId, initialHostSpec, properties, clusterInstanceTemplate, + refreshRateNano, highRefreshRateNano, topologyQuery, writerTopologyQuery, nodeIdQuery); + this.globalClusterInstanceTemplateByAwsRegion = globalClusterInstanceTemplateByAwsRegion; + this.regionByNodeIdQuery = regionByNodeIdQuery; + } + + @Override + protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { + try { + try (final PreparedStatement stmt = connection.prepareStatement(this.regionByNodeIdQuery)) { + stmt.setString(1, nodeId); + try (final ResultSet resultSet = stmt.executeQuery()) { + if (resultSet.next()) { + String awsRegion = resultSet.getString(1); + if (!StringUtils.isNullOrEmpty(awsRegion)) { + final HostSpec clusterInstanceTemplateForRegion + = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); + if (clusterInstanceTemplateForRegion == null) { + throw new SQLException("Can't find cluster template for region " + awsRegion); + } + return clusterInstanceTemplateForRegion; + } + } + } + } + } catch (SQLException ex) { + throw new RuntimeException(ex); + } + return this.clusterInstanceTemplate; + } + + @Override + protected HostSpec createHost( + final ResultSet resultSet, + final String suggestedWriterNodeId) throws SQLException { + + // suggestedWriterNodeId is not used for Aurora Global Database clusters. + // Topology query can detect a writer for itself. + + // According to the topology query the result set + // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. + String hostName = resultSet.getString(1); + final boolean isWriter = resultSet.getBoolean(2); + final float nodeLag = resultSet.getFloat(3); + final String awsRegion = resultSet.getString(4); + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L; + + final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); + if (clusterInstanceTemplateForRegion == null) { + throw new SQLException("Can't find cluster template for region " + awsRegion); + } + + return createHost(hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 438e6fca6..f3a39b7a9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -83,7 +83,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.servicesContainer, this.properties, (servicesContainer) -> new ClusterTopologyMonitorImpl( - this.servicesContainer, + servicesContainer, this.clusterId, this.initialHostSpec, this.properties, diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java index 36bab8f90..7c744b0d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java @@ -123,6 +123,6 @@ protected HostSpec createHost( String hostId = resultSet.getString("id"); // "1034958454" final boolean isWriter = hostId.equals(suggestedWriterNodeId); - return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now())); + return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now()), this.clusterInstanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 01b9bf8e9..b47e94a93 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -143,7 +143,13 @@ public Connection connect( final RdsUrlType type = this.rdsUtils.identifyRdsType(hostSpec.getHost()); + if (!type.isRdsCluster()) { + // It's not a cluster endpoint. Continue with a normal workflow. + return connectFunc.call(); + } + if (type == RdsUrlType.RDS_WRITER_CLUSTER + || type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER || isInitialConnection && this.verifyOpenedConnectionType == VerifyOpenedConnectionType.WRITER) { Connection writerCandidateConn = this.getVerifiedWriterConnection(props, isInitialConnection, connectFunc); if (writerCandidateConn == null) { @@ -190,7 +196,9 @@ private Connection getVerifiedWriterConnection( try { writerCandidate = Utils.getWriter(this.pluginService.getAllHosts()); - if (writerCandidate == null || this.rdsUtils.isRdsClusterDns(writerCandidate.getHost())) { + if (writerCandidate == null + || this.rdsUtils.isRdsClusterDns(writerCandidate.getHost()) + || this.rdsUtils.isGlobalDbWriterClusterDns(writerCandidate.getHost())) { // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 682c3080f..69864104d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -32,6 +32,7 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.telemetry.TelemetryCounter; @@ -66,7 +67,11 @@ public Connection getVerifiedConnection( final Properties props, final JdbcCallable connectFunc) throws SQLException { - if (!this.rdsUtils.isWriterClusterDns(hostSpec.getHost())) { + final RdsUrlType type = this.rdsUtils.identifyRdsType(hostSpec.getHost()); + + if (type != RdsUrlType.RDS_WRITER_CLUSTER + && type != RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER) { + // It's not a writer cluster endpoint. Continue with a normal workflow. return connectFunc.call(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java b/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java index 435907141..cd37e2647 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java @@ -43,6 +43,11 @@ public class ConnectionUrlParser { // follows by any char except "/", "?" or "#" + "(?:[/?#].*)?"); // Anything starting with either "/", "?" or "#" + private static final Pattern URL_WITH_REGION_PATTERN = + Pattern.compile( + "^(\\[(?.+)\\])?(?[a-zA-Z0-9\\?\\.\\-]+)(:(?[0-9]+))?$", + Pattern.CASE_INSENSITIVE); + static final Pattern EMPTY_STRING_IN_QUOTATIONS = Pattern.compile("\"(\\s*)\""); private static final RdsUtils rdsUtils = new RdsUtils(); @@ -90,6 +95,55 @@ public static HostSpec parseHostPortPair(final String url, final HostRole role, return getHostSpec(hostPortPair, role, hostSpecBuilderSupplier.get()); } + /** + * Parse strings in the following formats: + * "url", for example: "instance-1.XYZ.us-east-2.rds.amazonaws.com" + * "url:port", for example: "instance-1.XYZ.us-east-2.rds.amazonaws.com:9999" + * "[region_name]url", for example: "us-east-2:instance-1.any-domain.com" + * "[region_name]url:port", for example: "us-east-2:instance-1.any-domain.com:9999" + */ + public static Pair parseHostPortPairWithRegionPrefix( + final String urlWithRegionPrefix, + final Supplier hostSpecBuilderSupplier) { + + final Matcher matcher = URL_WITH_REGION_PATTERN.matcher(urlWithRegionPrefix); + if (!matcher.find()) { + throw new IllegalArgumentException( + Messages.get( + "ConnectionUrlParser.cantParseUrl", + new Object[] {urlWithRegionPrefix})); + } + String awsRegion = matcher.group("region"); + final String host = matcher.group("domain"); + final String port = matcher.group("port"); + + if (StringUtils.isNullOrEmpty(host)) { + throw new IllegalArgumentException( + Messages.get( + "ConnectionUrlParser.cantParseHost", + new Object[] {urlWithRegionPrefix})); + } + + if (StringUtils.isNullOrEmpty(awsRegion)) { + awsRegion = rdsUtils.getRdsRegion(host); + if (StringUtils.isNullOrEmpty(awsRegion)) { + throw new IllegalArgumentException( + Messages.get( + "ConnectionUrlParser.cantParseAwsRegion", + new Object[] {urlWithRegionPrefix})); + } + } + + final RdsUrlType urlType = rdsUtils.identifyRdsType(host); + + // Assign HostRole of READER if using the reader cluster URL, otherwise assume a HostRole of WRITER + final HostRole hostRole = RdsUrlType.RDS_READER_CLUSTER.equals(urlType) ? HostRole.READER : HostRole.WRITER; + final String[] hostPortPair = StringUtils.isNullOrEmpty(port) + ? new String[] { host } + : new String[] { host, port }; + return Pair.create(awsRegion, getHostSpec(hostPortPair, hostRole, hostSpecBuilderSupplier.get())); + } + private static HostSpec getHostSpec(final String[] hostPortPair, final HostRole hostRole, final HostSpecBuilder hostSpecBuilder) { String hostId = rdsUtils.getRdsInstanceId(hostPortPair[0]); diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUrlType.java b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUrlType.java index dff1e663a..a7e2a7da7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUrlType.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUrlType.java @@ -24,6 +24,7 @@ public enum RdsUrlType { RDS_PROXY(true, false), RDS_INSTANCE(true, false), RDS_AURORA_LIMITLESS_DB_SHARD_GROUP(true, false), + RDS_GLOBAL_WRITER_CLUSTER(true, true), OTHER(false, false); private final boolean isRds; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java index e9177a277..e048320f6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java @@ -176,6 +176,14 @@ public class RdsUtils { ".*(?-old1)\\..*", Pattern.CASE_INSENSITIVE); + // https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.GlobalDatabase.html + private static final Pattern AURORA_GLOBAL_WRITER_DNS_PATTERN = + Pattern.compile( + "^(?.+)\\." + + "(?global-)?" + + "(?[a-zA-Z0-9]+\\.global\\.rds\\.amazonaws\\.com\\.?)$", + Pattern.CASE_INSENSITIVE); + private static final Map cachedPatterns = new ConcurrentHashMap<>(); private static final Map cachedDnsPatterns = new ConcurrentHashMap<>(); @@ -323,6 +331,11 @@ public String getRdsClusterHostUrl(final String host) { return null; } + public boolean isGlobalDbWriterClusterDns(final String host) { + final String dnsGroup = getDnsGroup(getPreparedHost(host)); + return dnsGroup != null && dnsGroup.equalsIgnoreCase("global-"); + } + public boolean isIP(final String ip) { return isIPv4(ip) || isIPv6(ip); } @@ -347,6 +360,8 @@ public RdsUrlType identifyRdsType(final String host) { if (isIP(host)) { return RdsUrlType.IP_ADDRESS; + } else if (isGlobalDbWriterClusterDns(host)) { + return RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER; } else if (isWriterClusterDns(host)) { return RdsUrlType.RDS_WRITER_CLUSTER; } else if (isReaderClusterDns(host)) { @@ -452,7 +467,8 @@ private String getDnsGroup(final String host) { } return cachedDnsPatterns.computeIfAbsent(host, (k) -> { final Matcher matcher = cacheMatcher(k, - AURORA_DNS_PATTERN, AURORA_CHINA_DNS_PATTERN, AURORA_OLD_CHINA_DNS_PATTERN, AURORA_GOV_DNS_PATTERN); + AURORA_DNS_PATTERN, AURORA_CHINA_DNS_PATTERN, AURORA_OLD_CHINA_DNS_PATTERN, + AURORA_GOV_DNS_PATTERN, AURORA_GLOBAL_WRITER_DNS_PATTERN); return getRegexGroup(matcher, DNS_GROUP); }); } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index c5ea7c275..2a53c0832 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -97,6 +97,9 @@ ConnectionProvider.unsupportedHostSpecSelectorStrategy=Unsupported host selectio ConnectionUrlBuilder.missingJdbcProtocol=Missing JDBC protocol and/or host name. Could not construct URL. ConnectionUrlParser.protocolNotFound=Url should contain a driver protocol. Protocol is not found in url: ''{0}'' +ConnectionUrlParser.cantParseUrl=Can''t parse URL from ''{0}''. +ConnectionUrlParser.cantParseHost=Can''t parse host from ''{0}''. +ConnectionUrlParser.cantParseAwsRegion=Can''t parse AWS region from ''{0}''. ConnectTimeConnectionPlugin.connectTime=Connected in {0} nanos. diff --git a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java index 68e131917..1c521f617 100644 --- a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java @@ -63,7 +63,6 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.OpenedConnectionTracker; import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; import software.amazon.jdbc.plugin.efm2.HostMonitorServiceImpl; diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/ConnectionUrlParserTest.java b/wrapper/src/test/java/software/amazon/jdbc/util/ConnectionUrlParserTest.java index 056fccd78..39e8ac98b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/ConnectionUrlParserTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/ConnectionUrlParserTest.java @@ -17,7 +17,10 @@ package software.amazon.jdbc.util; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; import java.util.ArrayList; import java.util.Arrays; @@ -36,6 +39,64 @@ class ConnectionUrlParserTest { + @Test + void testParseHostPortPairWithRegionPrefix() { + Pair pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "?.XYZ.us-east-2.rds.amazonaws.com", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("us-east-2", pair.getValue1()); + assertEquals("?.XYZ.us-east-2.rds.amazonaws.com", pair.getValue2().getHost()); + assertFalse(pair.getValue2().isPortSpecified()); + + pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "[test-region]?.XYZ.us-east-2.rds.amazonaws.com", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("test-region", pair.getValue1()); + assertEquals("?.XYZ.us-east-2.rds.amazonaws.com", pair.getValue2().getHost()); + assertFalse(pair.getValue2().isPortSpecified()); + + pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "?.XYZ.us-east-2.rds.amazonaws.com:9999", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("us-east-2", pair.getValue1()); + assertEquals("?.XYZ.us-east-2.rds.amazonaws.com", pair.getValue2().getHost()); + assertTrue(pair.getValue2().isPortSpecified()); + assertEquals(9999, pair.getValue2().getPort()); + + pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "[test-region]?.XYZ.us-east-2.rds.amazonaws.com:9999", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("test-region", pair.getValue1()); + assertEquals("?.XYZ.us-east-2.rds.amazonaws.com", pair.getValue2().getHost()); + assertTrue(pair.getValue2().isPortSpecified()); + assertEquals(9999, pair.getValue2().getPort()); + + pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "[test-region]?.custom-domain.com", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("test-region", pair.getValue1()); + assertEquals("?.custom-domain.com", pair.getValue2().getHost()); + assertFalse(pair.getValue2().isPortSpecified()); + + pair = ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "[test-region]?.custom-domain.com:9999", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + assertEquals("test-region", pair.getValue1()); + assertEquals("?.custom-domain.com", pair.getValue2().getHost()); + assertTrue(pair.getValue2().isPortSpecified()); + assertEquals(9999, pair.getValue2().getPort()); + + assertThrows(IllegalArgumentException.class, () -> + ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "?.custom-domain.com", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy()))); + + assertThrows(IllegalArgumentException.class, () -> + ConnectionUrlParser.parseHostPortPairWithRegionPrefix( + "?.custom-domain.com:9999", + () -> new HostSpecBuilder(new SimpleHostAvailabilityStrategy()))); + } + @ParameterizedTest @MethodSource("testGetHostsFromConnectionUrlArguments") void testGetHostsFromConnectionUrl_returnCorrectHostList(String testUrl, List expected) { diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java index 59ee12619..05ce83b7b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java @@ -116,6 +116,9 @@ public class RdsUtilsTests { private static final String usIsoEastRegionLimitlessDbShardGroup = "database-test-name.shardgrp-XYZ.rds.us-iso-east-1.c2s.ic.gov"; + private static final String globalDbWriterCluster = + "global-cluster-test-name.global-XYZ.global.rds.amazonaws.com"; + @BeforeEach public void setupTests() { RdsUtils.clearCache(); @@ -414,6 +417,12 @@ public void testGetRdsRegion() { assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionLimitlessDbShardGroup)); } + @Test + public void testIsGlobalDbWriterClusterDns() { + assertFalse(target.isGlobalDbWriterClusterDns(usEastRegionCluster)); + assertTrue(target.isGlobalDbWriterClusterDns(globalDbWriterCluster)); + } + @Test public void testBrokenPathsHostPattern() { final String incorrectChinaHostPattern = "?.rds.cn-northwest-1.rds.amazonaws.com.cn"; From db03a0abfa443450492439fc92e72b1d449e6cad Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 22 Oct 2025 14:52:37 -0700 Subject: [PATCH 06/90] respect AWS region connecting with cluster reader endpoint for GDB (#1575) --- ...AuroraInitialConnectionStrategyPlugin.java | 26 ++++++++++++++++--- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index b47e94a93..361e9da77 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -21,11 +21,14 @@ import java.util.Collections; import java.util.HashMap; import java.util.HashSet; +import java.util.List; import java.util.Map; import java.util.Properties; import java.util.Set; import java.util.concurrent.TimeUnit; import java.util.logging.Logger; +import java.util.stream.Collectors; +import org.jetbrains.annotations.Nullable; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; @@ -37,6 +40,7 @@ import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; +import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.WrapperUtils; @@ -161,7 +165,8 @@ public Connection connect( if (type == RdsUrlType.RDS_READER_CLUSTER || isInitialConnection && this.verifyOpenedConnectionType == VerifyOpenedConnectionType.READER) { - Connection readerCandidateConn = this.getVerifiedReaderConnection(props, isInitialConnection, connectFunc); + Connection readerCandidateConn = + this.getVerifiedReaderConnection(type, hostSpec, props, isInitialConnection, connectFunc); if (readerCandidateConn == null) { // Can't get a reader connection. Continue with a normal workflow. LOGGER.finest("Continue with normal workflow."); @@ -254,6 +259,8 @@ private Connection getVerifiedWriterConnection( } private Connection getVerifiedReaderConnection( + final RdsUrlType rdsUrlType, + final HostSpec hostSpec, final Properties props, final boolean isInitialConnection, final JdbcCallable connectFunc) @@ -266,6 +273,9 @@ private Connection getVerifiedReaderConnection( Connection readerCandidateConn; HostSpec readerCandidate; + final String awsRegion = rdsUrlType == RdsUrlType.RDS_READER_CLUSTER + ? this.rdsUtils.getRdsRegion(hostSpec.getHost()) + : null; while (this.getTime() < endTimeNano) { @@ -273,7 +283,7 @@ private Connection getVerifiedReaderConnection( readerCandidate = null; try { - readerCandidate = this.getReader(props); + readerCandidate = this.getReader(props, awsRegion); if (readerCandidate == null || this.rdsUtils.isRdsClusterDns(readerCandidate.getHost())) { @@ -371,12 +381,20 @@ private void delay(final long delayMs) { } } - private HostSpec getReader(final Properties props) throws SQLException { + private HostSpec getReader(final Properties props, final @Nullable String awsRegion) throws SQLException { final String strategy = READER_HOST_SELECTOR_STRATEGY.getString(props); if (this.pluginService.acceptsStrategy(HostRole.READER, strategy)) { try { - return this.pluginService.getHostSpecByStrategy(HostRole.READER, strategy); + if (!StringUtils.isNullOrEmpty(awsRegion)) { + final List hostsInRegion = this.pluginService.getHosts() + .stream() + .filter(x -> awsRegion.equalsIgnoreCase(this.rdsUtils.getRdsRegion(x.getHost()))) + .collect(Collectors.toList()); + return this.pluginService.getHostSpecByStrategy(hostsInRegion, HostRole.READER, strategy); + } else { + return this.pluginService.getHostSpecByStrategy(HostRole.READER, strategy); + } } catch (UnsupportedOperationException ex) { throw ex; } catch (SQLException ex) { From 73e94e524d8003d8bc0ba16bbf6124f287aaca6f Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:30:28 -0700 Subject: [PATCH 07/90] fix javadocs (#1576) --- gradle.properties | 6 +++--- .../amazon/jdbc/ConnectionProviderManager.java | 2 +- .../jdbc/hostlistprovider/RdsHostListProvider.java | 1 + .../software/amazon/jdbc/util/ConnectionUrlParser.java | 4 ++++ .../jdbc/util/connection/ConnectionServiceImpl.java | 10 ++++++++++ .../software/amazon/jdbc/util/monitoring/Monitor.java | 2 ++ 6 files changed, 21 insertions(+), 4 deletions(-) diff --git a/gradle.properties b/gradle.properties index 435022aff..a7c788727 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,9 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -aws-advanced-jdbc-wrapper.version.major=2 -aws-advanced-jdbc-wrapper.version.minor=6 -aws-advanced-jdbc-wrapper.version.subminor=5 +aws-advanced-jdbc-wrapper.version.major=3 +aws-advanced-jdbc-wrapper.version.minor=0 +aws-advanced-jdbc-wrapper.version.subminor=0 snapshot=false nexus.publish=true diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java index 0f8687930..014acf082 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProviderManager.java @@ -48,7 +48,7 @@ public ConnectionProviderManager( /** * Get the {@link ConnectionProvider} to use to establish a connection using the given driver * protocol, host details, and properties. If a non-default ConnectionProvider has been set using - * {@link #setConnectionProvider} and {@link ConnectionProvider#acceptsUrl} returns true, the + * {@link Driver#setCustomConnectionProvider} and {@link ConnectionProvider#acceptsUrl} returns true, the * non-default ConnectionProvider will be returned. Otherwise, the default ConnectionProvider will * be returned. See {@link ConnectionProvider#acceptsUrl} for more info. * diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 026d96e4d..cc17096e5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -368,6 +368,7 @@ protected HostSpec createHost( * Build a host dns endpoint based on host/node name. * * @param nodeName A host name. + * @param clusterInstanceTemplate A cluster instance template * @return Host dns endpoint */ protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java b/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java index cd37e2647..b66f631e4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ConnectionUrlParser.java @@ -101,6 +101,10 @@ public static HostSpec parseHostPortPair(final String url, final HostRole role, * "url:port", for example: "instance-1.XYZ.us-east-2.rds.amazonaws.com:9999" * "[region_name]url", for example: "us-east-2:instance-1.any-domain.com" * "[region_name]url:port", for example: "us-east-2:instance-1.any-domain.com:9999" + * + * @param urlWithRegionPrefix Url with region prexix + * @param hostSpecBuilderSupplier A host builder supplier + * @return A pair of region and HostSpec */ public static Pair parseHostPortPairWithRegionPrefix( final String urlWithRegionPrefix, diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java index 8c7b80b3d..540aea280 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java @@ -49,6 +49,16 @@ public class ConnectionServiceImpl implements ConnectionService { /** * Constructs a {@link ConnectionServiceImpl} instance. * + * @param storageService An instance of storage service + * @param monitorService An instance of monitor service + * @param telemetryFactory An instance of telemetry factory + * @param connectionProvider An instance of connection provider + * @param originalUrl An original Url + * @param targetDriverProtocol A target driver protocol + * @param driverDialect An instance of driver dialect + * @param dbDialect An instance of database dialect + * @param props Properties + * @throws SQLException if errors occurred while creating an instance * @deprecated Use {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} instead. */ @Deprecated diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/Monitor.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/Monitor.java index fbdd55063..78e111d88 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/Monitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/Monitor.java @@ -26,6 +26,8 @@ public interface Monitor { * Executes the monitoring loop for this monitor. This method should be called in the run() method of the thread * submitted during the call to {@link #start()}. Additionally, the monitoring loop should regularly update the last * activity timestamp so that the {@link MonitorService} can detect whether the monitor is stuck or not. + * + * @throws Exception if there's an error executing the monitoring logic. */ void monitor() throws Exception; From 3ba3efa9c81aad37538c3a81cb95a34c05e69b15 Mon Sep 17 00:00:00 2001 From: Aaron <69273634+aaron-congo@users.noreply.github.com> Date: Fri, 24 Oct 2025 15:32:37 -0700 Subject: [PATCH 08/90] chore: remove mutable keys from HostSpec#hashCode and document immutability requirements (#1565) Co-authored-by: Adnan Khan --- .github/workflows/main.yml | 3 +++ .github/workflows/maven_release.yml | 3 +++ .github/workflows/maven_snapshot.yml | 3 +++ .github/workflows/remove-old-artifacts.yml | 3 +++ .github/workflows/run-hibernate-orm-tests.yml | 3 +++ .../workflows/run-standard-integration-tests.yml | 3 +++ .../main/java/software/amazon/jdbc/HostSpec.java | 10 +++++----- .../plugin/customendpoint/CustomEndpointPlugin.java | 5 +++-- .../limitless/LimitlessRouterServiceImpl.java | 8 +++----- .../amazon/jdbc/util/events/DataAccessEvent.java | 4 ++-- .../software/amazon/jdbc/util/events/Event.java | 4 ++++ .../amazon/jdbc/util/events/EventSubscriber.java | 4 ++++ .../jdbc/util/monitoring/AbstractMonitor.java | 1 - .../amazon/jdbc/util/monitoring/MonitorService.java | 7 ++++--- .../jdbc/util/monitoring/MonitorServiceImpl.java | 9 ++++----- .../jdbc/util/monitoring/MonitorSettings.java | 7 ++++--- .../java/integration/TestEnvironmentRequest.java | 7 +++---- .../container/ConnectionStringHelper.java | 4 ++-- .../integration/container/TestDriverProvider.java | 4 ++-- .../java/integration/container/TestEnvironment.java | 4 ++-- .../condition/DisableOnTestFeatureCondition.java | 4 ++-- .../condition/EnableOnTestFeatureCondition.java | 4 ++-- .../util/monitoring/MonitorServiceImplTest.java | 13 ++++++------- 23 files changed, 70 insertions(+), 47 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d0325b382..5d780649a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -16,6 +16,9 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true +permissions: + contents: read + jobs: markdown-link-check: runs-on: ubuntu-latest diff --git a/.github/workflows/maven_release.yml b/.github/workflows/maven_release.yml index c5ad886ff..fa4d699a0 100644 --- a/.github/workflows/maven_release.yml +++ b/.github/workflows/maven_release.yml @@ -5,6 +5,9 @@ on: types: - published +permissions: + contents: read + jobs: ubuntu-latest-jdbc-wrapper-release-to-maven: name: 'Build And Release to Maven' diff --git a/.github/workflows/maven_snapshot.yml b/.github/workflows/maven_snapshot.yml index fda0edcd3..cde9b6337 100644 --- a/.github/workflows/maven_snapshot.yml +++ b/.github/workflows/maven_snapshot.yml @@ -6,6 +6,9 @@ on: - main workflow_dispatch: +permissions: + contents: read + jobs: ubuntu-latest-jdbc-wrapper-snapshot-to-maven: name: 'Build And Upload Snapshot to Maven' diff --git a/.github/workflows/remove-old-artifacts.yml b/.github/workflows/remove-old-artifacts.yml index 60e2408d3..0a1d96058 100644 --- a/.github/workflows/remove-old-artifacts.yml +++ b/.github/workflows/remove-old-artifacts.yml @@ -5,6 +5,9 @@ on: # Every day at 1am - cron: '0 1 * * *' +permissions: + actions: write + jobs: remove-old-artifacts: runs-on: ubuntu-latest diff --git a/.github/workflows/run-hibernate-orm-tests.yml b/.github/workflows/run-hibernate-orm-tests.yml index c6fc6d948..e1138a27f 100644 --- a/.github/workflows/run-hibernate-orm-tests.yml +++ b/.github/workflows/run-hibernate-orm-tests.yml @@ -6,6 +6,9 @@ on: branches: - main +permissions: + contents: read + jobs: hibernate-integration-tests: name: 'Run Hibernate ORM integration tests' diff --git a/.github/workflows/run-standard-integration-tests.yml b/.github/workflows/run-standard-integration-tests.yml index 1471e55da..43309463f 100644 --- a/.github/workflows/run-standard-integration-tests.yml +++ b/.github/workflows/run-standard-integration-tests.yml @@ -12,6 +12,9 @@ on: - '**/release_draft.yml' - '**/maven*.yml' +permissions: + contents: read + jobs: standard-integration-tests: name: 'Run standard container integration tests' diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java b/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java index 63197de04..3b6f64ca1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java +++ b/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java @@ -38,13 +38,13 @@ public class HostSpec { protected final String host; protected final int port; + protected final HostRole role; + protected final Timestamp lastUpdateTime; + protected final Set aliases = ConcurrentHashMap.newKeySet(); + protected final Set allAliases = ConcurrentHashMap.newKeySet(); protected volatile HostAvailability availability; - protected HostRole role; - protected Set aliases = ConcurrentHashMap.newKeySet(); - protected Set allAliases = ConcurrentHashMap.newKeySet(); protected long weight; // Greater or equal 0. Lesser the weight, the healthier node. protected String hostId; - protected Timestamp lastUpdateTime; protected HostAvailabilityStrategy hostAvailabilityStrategy; private HostSpec( @@ -212,7 +212,7 @@ public String toString() { @Override public int hashCode() { - return Objects.hash(this.host, this.port, this.availability, this.role, this.weight, this.lastUpdateTime); + return Objects.hash(this.host, this.port, this.role); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/customendpoint/CustomEndpointPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/customendpoint/CustomEndpointPlugin.java index adfb408e9..49a9dbc9a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/customendpoint/CustomEndpointPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/customendpoint/CustomEndpointPlugin.java @@ -19,6 +19,7 @@ import java.sql.Connection; import java.sql.SQLException; import java.util.Collections; +import java.util.EnumSet; import java.util.HashSet; import java.util.Properties; import java.util.Set; @@ -53,8 +54,8 @@ public class CustomEndpointPlugin extends AbstractConnectionPlugin { private static final Logger LOGGER = Logger.getLogger(CustomEndpointPlugin.class.getName()); protected static final String TELEMETRY_WAIT_FOR_INFO_COUNTER = "customEndpoint.waitForInfo.counter"; protected static final RegionUtils regionUtils = new RegionUtils(); - protected static final Set monitorErrorResponses = - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)); + protected static final EnumSet monitorErrorResponses = + EnumSet.of(MonitorErrorResponse.RECREATE); public static final AwsWrapperProperty CUSTOM_ENDPOINT_INFO_REFRESH_RATE_MS = new AwsWrapperProperty( "customEndpointInfoRefreshRateMs", "30000", diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImpl.java index ae4e7b026..5bfecd9dc 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImpl.java @@ -17,12 +17,10 @@ package software.amazon.jdbc.plugin.limitless; import java.sql.SQLException; -import java.util.Collections; -import java.util.HashSet; +import java.util.EnumSet; import java.util.List; import java.util.Map; import java.util.Properties; -import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.TimeUnit; import java.util.concurrent.locks.ReentrantLock; @@ -51,8 +49,8 @@ public class LimitlessRouterServiceImpl implements LimitlessRouterService { "600000", // 10min "Interval in milliseconds for an Limitless router monitor to be considered inactive and to be disposed."); protected static final Map forceGetLimitlessRoutersLockMap = new ConcurrentHashMap<>(); - protected static final Set monitorErrorResponses = - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)); + protected static final EnumSet monitorErrorResponses = + EnumSet.of(MonitorErrorResponse.RECREATE); protected final FullServicesContainer servicesContainer; protected final PluginService pluginService; protected final LimitlessQueryHelper queryHelper; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/events/DataAccessEvent.java b/wrapper/src/main/java/software/amazon/jdbc/util/events/DataAccessEvent.java index a47bd0842..908c60ff0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/events/DataAccessEvent.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/events/DataAccessEvent.java @@ -24,8 +24,8 @@ * data. */ public class DataAccessEvent implements Event { - protected @NonNull Class dataClass; - protected @NonNull Object key; + protected final @NonNull Class dataClass; + protected final @NonNull Object key; /** * Constructor for a DataAccessEvent. diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/events/Event.java b/wrapper/src/main/java/software/amazon/jdbc/util/events/Event.java index 2714f6786..6c5e81ace 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/events/Event.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/events/Event.java @@ -18,6 +18,10 @@ /** * A marker interface for events that need to be communicated between different components. + * + *

All implementations of this interface MUST be immutable or use both the default {@link Object#equals} and + * {@link Object#hashCode} implementations, as instances will be used as keys in hash-based collections. Mutable + * implementations may cause undefined behavior when used as Map keys or Set elements. */ public interface Event { } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/events/EventSubscriber.java b/wrapper/src/main/java/software/amazon/jdbc/util/events/EventSubscriber.java index 34e63b452..877c7ef21 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/events/EventSubscriber.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/events/EventSubscriber.java @@ -24,6 +24,10 @@ * {@link java.util.HashSet} to prevent duplicate subscriptions, so classes implementing this interface should consider * whether they need to override {@link Object#equals(Object)} and {@link Object#hashCode()}. * + *

All implementations of this interface MUST be immutable or use both the default {@link Object#equals} and + * {@link Object#hashCode} implementations, as instances will be used as keys in hash-based collections. Mutable + * implementations may cause undefined behavior when used as Map keys or Set elements. + * * @see EventPublisher */ public interface EventSubscriber { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/AbstractMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/AbstractMonitor.java index a406cdc5d..418feb349 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/AbstractMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/AbstractMonitor.java @@ -92,7 +92,6 @@ public void stop() { Thread.currentThread().interrupt(); this.monitorExecutor.shutdownNow(); } finally { - // TODO: Should this be removed? close() should be called in the run() method finally block close(); this.state.set(MonitorState.STOPPED); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java index f48564434..bf4c9496a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java @@ -17,8 +17,8 @@ package software.amazon.jdbc.util.monitoring; import java.sql.SQLException; +import java.util.EnumSet; import java.util.Properties; -import java.util.Set; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; @@ -40,7 +40,8 @@ public interface MonitorService { * @param heartbeatTimeoutNanos a duration in nanoseconds defining the maximum amount of time that a monitor should * take between updating its last-updated timestamp. If a monitor has not updated its * last-updated timestamp within this duration it will be considered stuck. - * @param errorResponses a {@link Set} defining actions to take if the monitor is stuck or in an error state. + * @param errorResponses a {@link EnumSet} defining actions to take if the monitor is stuck or in an error + * state. * @param producedDataClass the class of data produced by the monitor. * @param the type of the monitor. */ @@ -48,7 +49,7 @@ void registerMonitorTypeIfAbsent( Class monitorClass, long expirationTimeoutNanos, long heartbeatTimeoutNanos, - Set errorResponses, + EnumSet errorResponses, @Nullable Class producedDataClass); /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index ec33655a8..97de15f57 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -19,12 +19,12 @@ import java.sql.SQLException; import java.util.ArrayList; import java.util.Collections; +import java.util.EnumSet; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Properties; -import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; @@ -59,8 +59,7 @@ public class MonitorServiceImpl implements MonitorService, EventSubscriber { static { Map, Supplier> suppliers = new HashMap<>(); - Set recreateOnError = - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)); + EnumSet recreateOnError = EnumSet.of(MonitorErrorResponse.RECREATE); MonitorSettings defaultSettings = new MonitorSettings( TimeUnit.MINUTES.toNanos(15), TimeUnit.MINUTES.toNanos(3), recreateOnError); @@ -150,7 +149,7 @@ protected void handleMonitorError( Monitor monitor = errorMonitorItem.getMonitor(); monitor.stop(); - Set errorResponses = cacheContainer.getSettings().getErrorResponses(); + EnumSet errorResponses = cacheContainer.getSettings().getErrorResponses(); if (errorResponses != null && errorResponses.contains(MonitorErrorResponse.RECREATE)) { cacheContainer.getCache().computeIfAbsent(key, k -> { LOGGER.fine(Messages.get("MonitorServiceImpl.recreatingMonitor", new Object[] {monitor})); @@ -166,7 +165,7 @@ public void registerMonitorTypeIfAbsent( Class monitorClass, long expirationTimeoutNanos, long heartbeatTimeoutNanos, - Set errorResponses, + EnumSet errorResponses, @Nullable Class producedDataClass) { monitorCaches.computeIfAbsent( monitorClass, diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorSettings.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorSettings.java index 6774058e8..4e181e058 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorSettings.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorSettings.java @@ -16,6 +16,7 @@ package software.amazon.jdbc.util.monitoring; +import java.util.EnumSet; import java.util.Set; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; @@ -26,7 +27,7 @@ public class MonitorSettings { private final long expirationTimeoutNanos; private final long inactiveTimeoutNanos; - private @Nullable final Set errorResponses; + private @Nullable final EnumSet errorResponses; /** * Constructs a MonitorSettings instance. @@ -40,7 +41,7 @@ public class MonitorSettings { * no action will be performed. */ public MonitorSettings( - long expirationTimeoutNanos, long inactiveTimeoutNanos, @NonNull Set errorResponses) { + long expirationTimeoutNanos, long inactiveTimeoutNanos, @NonNull EnumSet errorResponses) { this.expirationTimeoutNanos = expirationTimeoutNanos; this.inactiveTimeoutNanos = inactiveTimeoutNanos; this.errorResponses = errorResponses; @@ -54,7 +55,7 @@ public long getInactiveTimeoutNanos() { return inactiveTimeoutNanos; } - public @Nullable Set getErrorResponses() { + public @Nullable EnumSet getErrorResponses() { return errorResponses; } } diff --git a/wrapper/src/test/java/integration/TestEnvironmentRequest.java b/wrapper/src/test/java/integration/TestEnvironmentRequest.java index 7e4b64daf..91ff6f6d0 100644 --- a/wrapper/src/test/java/integration/TestEnvironmentRequest.java +++ b/wrapper/src/test/java/integration/TestEnvironmentRequest.java @@ -19,8 +19,7 @@ import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import java.util.HashSet; -import java.util.Set; +import java.util.EnumSet; @JsonIgnoreProperties(ignoreUnknown = true) public class TestEnvironmentRequest { @@ -41,7 +40,7 @@ public class TestEnvironmentRequest { private TargetJvm targetJvm; @JsonProperty("features") - private final Set features = new HashSet<>(); + private final EnumSet features = EnumSet.noneOf(TestEnvironmentFeatures.class); @JsonProperty("numOfInstances") private int numOfInstances = 1; @@ -93,7 +92,7 @@ public TargetJvm getTargetJvm() { } @JsonIgnore - public Set getFeatures() { + public EnumSet getFeatures() { return this.features; } diff --git a/wrapper/src/test/java/integration/container/ConnectionStringHelper.java b/wrapper/src/test/java/integration/container/ConnectionStringHelper.java index ba3ab227f..7e8b2dfc8 100644 --- a/wrapper/src/test/java/integration/container/ConnectionStringHelper.java +++ b/wrapper/src/test/java/integration/container/ConnectionStringHelper.java @@ -21,8 +21,8 @@ import integration.TestEnvironmentFeatures; import integration.TestEnvironmentInfo; import integration.TestInstanceInfo; +import java.util.EnumSet; import java.util.Properties; -import java.util.Set; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.util.StringUtils; @@ -196,7 +196,7 @@ public static Properties getDefaultProperties() { props.setProperty(PropertyDefinition.USER.name, envInfo.getDatabaseInfo().getUsername()); props.setProperty(PropertyDefinition.PASSWORD.name, envInfo.getDatabaseInfo().getPassword()); - final Set features = envInfo.getRequest().getFeatures(); + final EnumSet features = envInfo.getRequest().getFeatures(); props.setProperty(PropertyDefinition.ENABLE_TELEMETRY.name, "true"); props.setProperty(PropertyDefinition.TELEMETRY_SUBMIT_TOPLEVEL.name, "true"); props.setProperty( diff --git a/wrapper/src/test/java/integration/container/TestDriverProvider.java b/wrapper/src/test/java/integration/container/TestDriverProvider.java index 817d0a1b0..7a7d0df1d 100644 --- a/wrapper/src/test/java/integration/container/TestDriverProvider.java +++ b/wrapper/src/test/java/integration/container/TestDriverProvider.java @@ -39,8 +39,8 @@ import java.sql.SQLException; import java.util.ArrayList; import java.util.Arrays; +import java.util.EnumSet; import java.util.List; -import java.util.Set; import java.util.concurrent.TimeUnit; import java.util.logging.Logger; import java.util.stream.Collectors; @@ -187,7 +187,7 @@ public void beforeEach(ExtensionContext context) throws Exception { @Override public void afterEach(ExtensionContext context) throws Exception { - Set features = TestEnvironment.getCurrent() + EnumSet features = TestEnvironment.getCurrent() .getInfo() .getRequest() .getFeatures(); diff --git a/wrapper/src/test/java/integration/container/TestEnvironment.java b/wrapper/src/test/java/integration/container/TestEnvironment.java index a31eed239..51ba07fdb 100644 --- a/wrapper/src/test/java/integration/container/TestEnvironment.java +++ b/wrapper/src/test/java/integration/container/TestEnvironment.java @@ -37,9 +37,9 @@ import java.io.IOException; import java.util.ArrayList; import java.util.Collections; +import java.util.EnumSet; import java.util.HashMap; import java.util.List; -import java.util.Set; import java.util.concurrent.TimeUnit; import java.util.logging.Logger; import software.amazon.jdbc.Driver; @@ -249,7 +249,7 @@ public boolean isTestDriverAllowed(TestDriver testDriver) { boolean disabledByFeature; boolean driverCompatibleToDatabaseEngine; - final Set features = this.info.getRequest().getFeatures(); + final EnumSet features = this.info.getRequest().getFeatures(); final DatabaseEngine databaseEngine = this.info.getRequest().getDatabaseEngine(); switch (testDriver) { diff --git a/wrapper/src/test/java/integration/container/condition/DisableOnTestFeatureCondition.java b/wrapper/src/test/java/integration/container/condition/DisableOnTestFeatureCondition.java index 841383cae..c38ecde02 100644 --- a/wrapper/src/test/java/integration/container/condition/DisableOnTestFeatureCondition.java +++ b/wrapper/src/test/java/integration/container/condition/DisableOnTestFeatureCondition.java @@ -21,7 +21,7 @@ import integration.TestEnvironmentFeatures; import integration.container.TestEnvironment; import java.util.Arrays; -import java.util.Set; +import java.util.EnumSet; import org.junit.jupiter.api.extension.ConditionEvaluationResult; import org.junit.jupiter.api.extension.ExecutionCondition; import org.junit.jupiter.api.extension.ExtensionContext; @@ -33,7 +33,7 @@ public DisableOnTestFeatureCondition() {} @Override public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) { - Set features = + EnumSet features = TestEnvironment.getCurrent().getInfo().getRequest().getFeatures(); boolean disabled = diff --git a/wrapper/src/test/java/integration/container/condition/EnableOnTestFeatureCondition.java b/wrapper/src/test/java/integration/container/condition/EnableOnTestFeatureCondition.java index 673a3379e..6c88c60ca 100644 --- a/wrapper/src/test/java/integration/container/condition/EnableOnTestFeatureCondition.java +++ b/wrapper/src/test/java/integration/container/condition/EnableOnTestFeatureCondition.java @@ -21,7 +21,7 @@ import integration.TestEnvironmentFeatures; import integration.container.TestEnvironment; import java.util.Arrays; -import java.util.Set; +import java.util.EnumSet; import java.util.logging.Logger; import org.junit.jupiter.api.extension.ConditionEvaluationResult; import org.junit.jupiter.api.extension.ExecutionCondition; @@ -37,7 +37,7 @@ public EnableOnTestFeatureCondition() {} @Override public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) { - final Set features = + final EnumSet features = TestEnvironment.getCurrent().getInfo().getRequest().getFeatures(); boolean enabled = diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/monitoring/MonitorServiceImplTest.java b/wrapper/src/test/java/software/amazon/jdbc/util/monitoring/MonitorServiceImplTest.java index 89923f3f6..6a01a5799 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/monitoring/MonitorServiceImplTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/monitoring/MonitorServiceImplTest.java @@ -28,8 +28,7 @@ import static org.mockito.Mockito.spy; import java.sql.SQLException; -import java.util.Collections; -import java.util.HashSet; +import java.util.EnumSet; import java.util.Properties; import java.util.concurrent.TimeUnit; import org.junit.jupiter.api.AfterEach; @@ -85,7 +84,7 @@ public void testMonitorError_monitorReCreated() throws SQLException, Interrupted NoOpMonitor.class, TimeUnit.MINUTES.toNanos(1), TimeUnit.MINUTES.toNanos(1), - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)), + EnumSet.of(MonitorErrorResponse.RECREATE), null ); String key = "testMonitor"; @@ -129,7 +128,7 @@ public void testMonitorStuck_monitorReCreated() throws SQLException, Interrupted NoOpMonitor.class, TimeUnit.MINUTES.toNanos(1), 1, // heartbeat times out immediately - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)), + EnumSet.of(MonitorErrorResponse.RECREATE), null ); String key = "testMonitor"; @@ -175,7 +174,7 @@ public void testMonitorExpired() throws SQLException, InterruptedException { TimeUnit.MINUTES.toNanos(1), // even though we pass a re-create policy, we should not re-create it if the monitor is expired since this // indicates it is not being used. - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)), + EnumSet.of(MonitorErrorResponse.RECREATE), null ); String key = "testMonitor"; @@ -237,7 +236,7 @@ public void testRemove() throws SQLException, InterruptedException { TimeUnit.MINUTES.toNanos(1), // even though we pass a re-create policy, we should not re-create it if the monitor is expired since this // indicates it is not being used. - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)), + EnumSet.of(MonitorErrorResponse.RECREATE), null ); @@ -272,7 +271,7 @@ public void testStopAndRemove() throws SQLException, InterruptedException { TimeUnit.MINUTES.toNanos(1), // even though we pass a re-create policy, we should not re-create it if the monitor is expired since this // indicates it is not being used. - new HashSet<>(Collections.singletonList(MonitorErrorResponse.RECREATE)), + EnumSet.of(MonitorErrorResponse.RECREATE), null ); From 2829afff01934fdfbf5ede03e76a99aa47e4e27f Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Fri, 24 Oct 2025 16:31:34 -0700 Subject: [PATCH 09/90] deprecate enableGreenNodeReplacement parameter (#1578) Co-authored-by: Karen <64801825+karenc-bq@users.noreply.github.com> --- .../UsingTheJdbcDriver.md | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md index 46bab7c64..67bc00ac9 100644 --- a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md +++ b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md @@ -76,27 +76,27 @@ logging.level.software.amazon.jdbc=trace ## AWS Advanced JDBC Driver Parameters These parameters are applicable to any instance of the AWS JDBC Driver. -| Parameter | Value | Required | Description | Default Value | -|---------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| -| `clusterId` | `String` | If connecting to multiple database clusters within a single application: Yes

Otherwise: No

:warning:If `clusterId` is omitted, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | -| `wrapperLoggerLevel` | `String` | No | Logger level of the AWS JDBC Driver.

If it is used, it must be one of the following values: `OFF`, `SEVERE`, `WARNING`, `INFO`, `CONFIG`, `FINE`, `FINER`, `FINEST`, `ALL`. | `null` | -| `database` | `String` | No | Database name. | `null` | -| `user` | `String` | No | Database username. | `null` | -| `password` | `String` | No | Database password. | `null` | -| `wrapperDialect` | `String` | No | Please see [this page on database dialects](./DatabaseDialects.md), and whether you should include it. | `null` | -| `wrapperLogUnclosedConnections` | `Boolean` | No | Allows the AWS JDBC Driver to capture a stacktrace for each connection that is opened. If the `finalize()` method is reached without the connection being closed, the stacktrace is printed to the log. This helps developers to detect and correct the source of potential connection leaks. | `false` | -| `loginTimeout` | `Integer` | No | Login timeout in milliseconds. | `null` | -| `connectTimeout` | `Integer` | No | Socket connect timeout in milliseconds. | `null` | -| `socketTimeout` | `Integer` | No | Socket timeout in milliseconds. | `null` | -| `tcpKeepAlive` | `Boolean` | No | Enable or disable TCP keep-alive probe. | `false` | -| `targetDriverAutoRegister` | `Boolean` | No | Allows the AWS JDBC Driver to register a target driver based on `wrapperTargetDriverDialect` configuration parameter or, if it's missed, on a connection url protocol. | `true` | -| `transferSessionStateOnSwitch` | `Boolean` | No | Enables transferring the session state to a new connection. | `true` | -| `resetSessionStateOnClose` | `Boolean` | No | Enables resetting the session state before closing connection. | `true` | -| `rollbackOnSwitch` | `Boolean` | No | Enables rolling back a current transaction, if any in effect, before switching to a new connection. | `true` | -| `awsProfile` | `String` | No | Allows users to specify a profile name for AWS credentials. This parameter is used by plugins that require AWS credentials, like the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md). | `null` | -| `enableGreenNodeReplacement` | `Boolean` | No | Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | -| `wrapperCaseSensitive`,
`wrappercasesensitive` | `Boolean` | No | Allows the driver to change case sensitivity for parameter names in the connection string and in connection properties. Set parameter to `false` to allow case-insensitive parameter names. | `true` | -| `skipWrappingForPackages` | `String` | No | Register Java package names (separated by comma) which will be left unwrapped. This setting modifies all future connections established by the driver, not just a particular connection. | `com.pgvector` | +| Parameter | Value | Required | Description | Default Value | +|---------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| `clusterId` | `String` | If connecting to multiple database clusters within a single application: Yes

Otherwise: No

:warning:If `clusterId` is omitted, you may experience various issues. | A unique identifier for the cluster. Connections with the same cluster id share a cluster topology cache. This parameter is optional and defaults to `1`. When supporting multiple database clusters, this parameter becomes mandatory. Each connection string must include the `clusterId` parameter with a value that can be any number or string. However, all connection strings associated with the same database cluster must use identical `clusterId` values, while connection strings belonging to different database clusters must specify distinct values. Examples of value: `1`, `2`, `1234`, `abc-1`, `abc-2`. | `1` | +| `wrapperLoggerLevel` | `String` | No | Logger level of the AWS JDBC Driver.

If it is used, it must be one of the following values: `OFF`, `SEVERE`, `WARNING`, `INFO`, `CONFIG`, `FINE`, `FINER`, `FINEST`, `ALL`. | `null` | +| `database` | `String` | No | Database name. | `null` | +| `user` | `String` | No | Database username. | `null` | +| `password` | `String` | No | Database password. | `null` | +| `wrapperDialect` | `String` | No | Please see [this page on database dialects](./DatabaseDialects.md), and whether you should include it. | `null` | +| `wrapperLogUnclosedConnections` | `Boolean` | No | Allows the AWS JDBC Driver to capture a stacktrace for each connection that is opened. If the `finalize()` method is reached without the connection being closed, the stacktrace is printed to the log. This helps developers to detect and correct the source of potential connection leaks. | `false` | +| `loginTimeout` | `Integer` | No | Login timeout in milliseconds. | `null` | +| `connectTimeout` | `Integer` | No | Socket connect timeout in milliseconds. | `null` | +| `socketTimeout` | `Integer` | No | Socket timeout in milliseconds. | `null` | +| `tcpKeepAlive` | `Boolean` | No | Enable or disable TCP keep-alive probe. | `false` | +| `targetDriverAutoRegister` | `Boolean` | No | Allows the AWS JDBC Driver to register a target driver based on `wrapperTargetDriverDialect` configuration parameter or, if it's missed, on a connection url protocol. | `true` | +| `transferSessionStateOnSwitch` | `Boolean` | No | Enables transferring the session state to a new connection. | `true` | +| `resetSessionStateOnClose` | `Boolean` | No | Enables resetting the session state before closing connection. | `true` | +| `rollbackOnSwitch` | `Boolean` | No | Enables rolling back a current transaction, if any in effect, before switching to a new connection. | `true` | +| `awsProfile` | `String` | No | Allows users to specify a profile name for AWS credentials. This parameter is used by plugins that require AWS credentials, like the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md). | `null` | +| ~~`enableGreenNodeReplacement`~~ | `Boolean` | No | **Deprecated. Use `bg` plugin instead.** Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | +| `wrapperCaseSensitive`,
`wrappercasesensitive` | `Boolean` | No | Allows the driver to change case sensitivity for parameter names in the connection string and in connection properties. Set parameter to `false` to allow case-insensitive parameter names. | `true` | +| `skipWrappingForPackages` | `String` | No | Register Java package names (separated by comma) which will be left unwrapped. This setting modifies all future connections established by the driver, not just a particular connection. | `com.pgvector` | ## Plugins The AWS JDBC Driver uses plugins to execute JDBC methods. You can think of a plugin as an extensible code module that adds extra logic around any JDBC method calls. The AWS JDBC Driver has a number of [built-in plugins](#list-of-available-plugins) available for use. From 2fe376a53f51afb4a12538aa8085d9304552c7c7 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Fri, 24 Oct 2025 16:32:04 -0700 Subject: [PATCH 10/90] Remove deprecated configuration parameters (#1577) --- .../using-plugins/UsingTheFailoverPlugin.md | 3 +-- examples/SpringTxFailoverExample/README.md | 4 ---- .../src/main/resources/application.yml | 3 +-- .../test/java/integration/container/tests/FailoverTest.java | 4 ++-- 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md index 6cff3ab62..54bdc01d8 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md @@ -36,8 +36,7 @@ In addition to the parameters that you can configure for the underlying driver, | `failoverWriterReconnectIntervalMs` | Integer | No | Interval of time in milliseconds to wait between attempts to reconnect to a failed writer during a writer failover process. | `2000` | | `enableConnectFailover` | Boolean | No | Enables/disables cluster-aware failover if the initial connection to the database fails due to a network exception. Note that this may result in a connection to a different instance in the cluster than was specified by the URL. | `false` | | `skipFailoverOnInterruptedThread` | Boolean | No | Enable to skip failover if the current thread is interrupted. This may leave the Connection in an invalid state so the Connection should be disposed. | `false` | -| ~~`keepSessionStateOnFailover`~~ | Boolean | No | This parameter is no longer available. If specified, it will be ignored by the driver. See [Session State](../SessionState.md) for more details. | `false` | -| ~~`enableFailoverStrictReader`~~ | Boolean | No | This parameter is no longer available and, if specified, it will be ignored by the driver. See `failoverMode` (`reader-or-writer` or `strict-reader`) for more details. | | + ## Host Pattern When connecting to Aurora clusters, the [`clusterInstanceHostPattern`](#failover-parameters) parameter is required if the connection string does not provide enough information about the database cluster domain name. If the Aurora cluster endpoint is used directly, the AWS JDBC Driver will recognize the standard Aurora domain name and can re-build a proper Aurora instance name when needed. In cases where the connection string uses an IP address, a custom domain name, or localhost, the driver won't know how to build a proper domain name for a database instance endpoint. For example, if a custom domain was being used and the cluster instance endpoints followed a pattern of `instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc., the driver would need to know how to construct the instance endpoints using the specified custom domain. Since there isn't enough information from the custom domain alone to create the instance endpoints, you should set the `clusterInstanceHostPattern` to `?.customHost`, making the connection string `jdbc:aws-wrapper:postgresql://customHost:1234/test?clusterInstanceHostPattern=?.customHost`. Refer to [this diagram](../../images/failover_behavior.png) about AWS JDBC Driver behavior during failover for different connection URLs and more details and examples. diff --git a/examples/SpringTxFailoverExample/README.md b/examples/SpringTxFailoverExample/README.md index 4822b34d5..77996c6d8 100644 --- a/examples/SpringTxFailoverExample/README.md +++ b/examples/SpringTxFailoverExample/README.md @@ -127,12 +127,8 @@ spring: max-lifetime: 1260000 auto-commit: false maximum-pool-size: 3 - data-source-properties: - keepSessionStateOnFailover: true ``` -Please also note the use of the [`keepSessionStateOnFailover`](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md#failover-parameters) property. When failover occurs, the connection's auto commit value is reset to true. When the auto commit value is set to false or transactions are used, further operations such as a rollback or commit on the same connection will cause errors. This parameter is used when connections cannot be reconfigured manually as seen in this [example](https://github.com/aws/aws-advanced-jdbc-wrapper/tree/main/examples/AWSDriverExample/src/main/java/software/amazon/PgFailoverSample.java). - ## Step 4: Set up a data access object Set up a simple data access object (DAO) interface and implementation. The data access object will be responsible for executing any queries. In this tutorial, only a get method will be included, but other methods are available within the sample code. diff --git a/examples/SpringTxFailoverExample/src/main/resources/application.yml b/examples/SpringTxFailoverExample/src/main/resources/application.yml index 31f8417a8..1d46238b4 100644 --- a/examples/SpringTxFailoverExample/src/main/resources/application.yml +++ b/examples/SpringTxFailoverExample/src/main/resources/application.yml @@ -9,5 +9,4 @@ spring: max-lifetime: 1260000 auto-commit: false maximum-pool-size: 3 - data-source-properties: - keepSessionStateOnFailover: true + diff --git a/wrapper/src/test/java/integration/container/tests/FailoverTest.java b/wrapper/src/test/java/integration/container/tests/FailoverTest.java index 347264561..758e5ca5f 100644 --- a/wrapper/src/test/java/integration/container/tests/FailoverTest.java +++ b/wrapper/src/test/java/integration/container/tests/FailoverTest.java @@ -505,11 +505,11 @@ public void test_takeOverConnectionProperties() throws SQLException { /** * Current writer dies, a reader instance is nominated to be a new writer, failover to the new - * writer. Autocommit is set to false and the keepSessionStateOnFailover property is set to true. + * writer. Autocommit is set to false. */ @TestTemplate @EnableOnNumOfInstances(min = 2) - public void test_failFromWriterWhereKeepSessionStateOnFailoverIsTrue() throws SQLException { + public void test_failFromWriter() throws SQLException { final String initialWriterId = this.currentWriter; TestInstanceInfo initialWriterInstanceInfo = From b993e25c84a723f1ce6f26dfcfcb64ede8ce3113 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 27 Oct 2025 13:27:17 -0700 Subject: [PATCH 11/90] dialect cleanup wip --- .../jdbc/dialect/AuroraDialectUtils.java | 110 +++++++++++ .../jdbc/dialect/AuroraMysqlDialect.java | 26 ++- .../amazon/jdbc/dialect/AuroraPgDialect.java | 28 ++- .../jdbc/dialect/MultiAzDialectUtils.java | 108 +++++++++++ .../RdsMultiAzDbClusterMysqlDialect.java | 30 ++- .../dialect/RdsMultiAzDbClusterPgDialect.java | 30 ++- .../amazon/jdbc/dialect/TopologyDialect.java | 43 +++++ .../jdbc/dialect/TopologyQueryHostSpec.java | 49 +++++ .../hostlistprovider/RdsHostListProvider.java | 11 +- .../ClusterTopologyMonitorImpl.java | 179 ++---------------- .../MonitoringRdsHostListProvider.java | 27 +-- .../MonitoringRdsMultiAzHostListProvider.java | 74 -------- .../MultiAzClusterTopologyMonitorImpl.java | 128 ------------- .../jdbc/plugin/DefaultConnectionPlugin.java | 1 + .../amazon/jdbc/util/TopologyUtils.java | 149 +++++++++++++++ .../util/monitoring/MonitorServiceImpl.java | 2 - ..._advanced_jdbc_wrapper_messages.properties | 14 +- 17 files changed, 608 insertions(+), 401 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java new file mode 100644 index 000000000..0c8c0221c --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -0,0 +1,110 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import org.jsoup.internal.StringUtil; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; +import software.amazon.jdbc.util.Utils; + +public class AuroraDialectUtils { + private static final Logger LOGGER = Logger.getLogger(AuroraDialectUtils.class.getName()); + protected String writerIdQuery; + + public AuroraDialectUtils(String writerIdQuery) { + this.writerIdQuery = writerIdQuery; + } + + public @Nullable List processQueryResults(ResultSet resultSet) + throws SQLException { + if (resultSet.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("AuroraTopologyProcessor.unexpectedTopologyQueryColumnCount")); + return null; + } + + // Data is result set is ordered by last updated time so the latest records go last. + // When adding hosts to a map, the newer records replace the older ones. + List hosts = new ArrayList<>(); + while (resultSet.next()) { + try { + hosts.add(createHost(resultSet)); + } catch (Exception e) { + LOGGER.finest( + Messages.get("AuroraTopologyProcessor.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return hosts; + } + + protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { + // According to the topology query the result set should contain 4 columns: + // node ID, 1/0 (writer/reader), CPU utilization, instance lag + String hostName = resultSet.getString(1); + final boolean isWriter = resultSet.getBoolean(2); + final float cpuUtilization = resultSet.getFloat(3); + final float instanceLag = resultSet.getFloat(4); + Timestamp lastUpdateTime; + try { + lastUpdateTime = resultSet.getTimestamp(5); + } catch (Exception e) { + lastUpdateTime = Timestamp.from(Instant.now()); + } + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); + + return new TopologyQueryHostSpec(hostName, isWriter, weight, lastUpdateTime); + } + + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { + if (resultSet.next()) { + return !StringUtils.isNullOrEmpty(resultSet.getString(1)); + } + } + } + + return false; + } + + // Returns a writer node ID if connected to a writer node. Returns null otherwise. + protected String getWriterNodeId(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { + if (resultSet.next()) { + return resultSet.getString(1); + } + } + } + return null; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index db85e28be..bead002ea 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -22,9 +22,10 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; +import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect { +public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { private static final String TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " @@ -47,6 +48,8 @@ public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); + @Override public boolean isDialect(final Connection connection) { Statement stmt = null; @@ -113,5 +116,26 @@ public boolean isBlueGreenStatusAvailable(final Connection connection) { } } + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public @Nullable List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + throws SQLException { + return AuroraMysqlDialect.dialectUtils.processQueryResults(rs); + } + + @Override + @Nullable public String getWriterId(final Connection connection) { + // The Aurora topology query can detect the writer without a suggested writer ID, so we intentionally return null. + return null; + } + + @Override + public boolean isWriterInstance(Connection connection) throws SQLException { + return dialectUtils.isWriterInstance(connection); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 7af673e4e..e85a36ef0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -20,7 +20,9 @@ import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; +import java.util.List; import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.util.DriverInfo; @@ -28,7 +30,7 @@ * Suitable for the following AWS PG configurations. * - Regional Cluster */ -public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect, BlueGreenDialect { +public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); private static final String extensionsSql = @@ -65,6 +67,8 @@ public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect private static final String TOPOLOGY_TABLE_EXIST_QUERY = "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; + private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); + @Override public boolean isDialect(final Connection connection) { if (!super.isDialect(connection)) { @@ -146,6 +150,28 @@ public HostListProviderSupplier getHostListProvider() { IS_WRITER_QUERY); } + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + @Nullable public String getWriterId(final Connection connection) { + // The Aurora topology query can detect the writer without a suggested writer ID, so we intentionally return null. + return null; + } + + @Override + public boolean isWriterInstance(Connection connection) throws SQLException { + return AuroraPgDialect.dialectUtils.isWriterInstance(connection); + } + + @Override + public @Nullable List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + throws SQLException { + return AuroraPgDialect.dialectUtils.processQueryResults(rs); + } + @Override public String getLimitlessRouterEndpointQuery() { return LIMITLESS_ROUTER_ENDPOINT_QUERY; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java new file mode 100644 index 000000000..3d885033f --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -0,0 +1,108 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; + +public class MultiAzDialectUtils { + private static final Logger LOGGER = Logger.getLogger(MultiAzDialectUtils.class.getName()); + private final String writerIdQuery; + private final String writerIdQueryColumn; + private final String instanceIdQuery; + + public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, String instanceIdQuery) { + this.writerIdQuery = writerIdQuery; + this.writerIdQueryColumn = writerIdQueryColumn; + this.instanceIdQuery = instanceIdQuery; + } + + public @Nullable List processQueryResults(ResultSet resultSet, String suggestedWriterId) + throws SQLException { + List hosts = new ArrayList<>(); + while (resultSet.next()) { + try { + final TopologyQueryHostSpec host = createHost(resultSet, suggestedWriterId); + hosts.add(host); + } catch (Exception e) { + LOGGER.finest( + Messages.get("ClusterTopologyMonitorImpl.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return hosts; + } + + protected TopologyQueryHostSpec createHost( + final ResultSet resultSet, + final String suggestedWriterNodeId) throws SQLException { + + String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" + String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" + String hostId = resultSet.getString("id"); // "1034958454" + final boolean isWriter = hostId.equals(suggestedWriterNodeId); + + return new TopologyQueryHostSpec(instanceName, isWriter, 0, Timestamp.from(Instant.now())); + } + + public @Nullable String getSuggestedWriterId(Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { + if (resultSet.next()) { + String writerId = resultSet.getString(this.writerIdQueryColumn); + if (!StringUtils.isNullOrEmpty(writerId)) { + // Replica status exists and shows a writer instance ID, which means that this instance is a reader. + return writerId; + } + } + } + + // Replica status doesn't exist, which means that this instance is a writer. + try (final ResultSet resultSet = stmt.executeQuery(this.instanceIdQuery)) { + if (resultSet.next()) { + return resultSet.getString(1); + } + } + } + return null; + } + + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { + if (resultSet.next()) { + String nodeId = resultSet.getString(this.writerIdQueryColumn); + // The writer ID is only returned when connected to a reader, so if the query does not return a value, it + // means we are connected to a writer. + return StringUtils.isNullOrEmpty(nodeId); + } + } + } + return false; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index 930cf1631..439135aa8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -24,17 +24,18 @@ import java.util.List; import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsMultiAzHostListProvider; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect { +public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect implements TopologyDialect { private static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; @@ -54,6 +55,8 @@ public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect { EnumSet.of(FailoverRestriction.DISABLE_TASK_A, FailoverRestriction.ENABLE_WRITER_IN_TASK_B); protected final RdsUtils rdsUtils = new RdsUtils(); + protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( + FETCH_WRITER_NODE_QUERY, FETCH_WRITER_NODE_QUERY_COLUMN_NAME, NODE_ID_QUERY); @Override public boolean isDialect(final Connection connection) { @@ -97,7 +100,7 @@ public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsMultiAzHostListProvider( + return new MonitoringRdsHostListProvider( properties, initialUrl, servicesContainer, @@ -136,4 +139,25 @@ public void prepareConnectProperties( public EnumSet getFailoverRestrictions() { return RDS_MULTI_AZ_RESTRICTIONS; } + + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + throws SQLException { + return dialectUtils.processQueryResults(rs, suggestedWriterId); + } + + @Override + public @Nullable String getWriterId(Connection connection) throws SQLException { + return dialectUtils.getSuggestedWriterId(connection); + } + + @Override + public boolean isWriterInstance(Connection connection) throws SQLException { + return dialectUtils.isWriterInstance(connection); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index eb3796adb..fd0664c86 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -20,17 +20,18 @@ import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; +import java.util.Collections; import java.util.List; import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsMultiAzHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -public class RdsMultiAzDbClusterPgDialect extends PgDialect { +public class RdsMultiAzDbClusterPgDialect extends PgDialect implements TopologyDialect { private static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterPgDialect.class.getName()); @@ -54,6 +55,9 @@ public class RdsMultiAzDbClusterPgDialect extends PgDialect { private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; + protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( + FETCH_WRITER_NODE_QUERY, FETCH_WRITER_NODE_QUERY_COLUMN_NAME, NODE_ID_QUERY); + @Override public ExceptionHandler getExceptionHandler() { if (exceptionHandler == null) { @@ -83,7 +87,7 @@ public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsMultiAzHostListProvider( + return new MonitoringRdsHostListProvider( properties, initialUrl, servicesContainer, @@ -107,4 +111,24 @@ public HostListProviderSupplier getHostListProvider() { } }; } + + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public @Nullable String getWriterId(final Connection connection) throws SQLException { + return dialectUtils.getSuggestedWriterId(connection); + } + + @Override + public boolean isWriterInstance(Connection connection) throws SQLException { + return dialectUtils.isWriterInstance(connection); + } + + @Override + public @Nullable List processQueryResults(ResultSet rs, String suggestedWriterId) throws SQLException { + return this.dialectUtils.processQueryResults(rs, suggestedWriterId); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java new file mode 100644 index 000000000..dc0cdf108 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -0,0 +1,43 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.List; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; + +public interface TopologyDialect { + String getTopologyQuery(); + + @Nullable + List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + throws SQLException; + + @Nullable + String getWriterId(final Connection connection) throws SQLException; + + // TODO: can we remove this and use getHostRole instead? + boolean isWriterInstance(final Connection connection) throws SQLException; + + HostSpec identifyConnection(Connection connection) throws SQLException; + + HostRole getHostRole(Connection conn) throws SQLException; +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java new file mode 100644 index 000000000..4ee19c2c4 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java @@ -0,0 +1,49 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Timestamp; + +public class TopologyQueryHostSpec { + private final String instanceId; + private final boolean isWriter; + private final long weight; + private final Timestamp lastUpdateTime; + + public TopologyQueryHostSpec(String instanceId, boolean isWriter, long weight, Timestamp lastUpdateTime) { + this.instanceId = instanceId; + this.isWriter = isWriter; + this.weight = weight; + this.lastUpdateTime = lastUpdateTime; + } + + public String getInstanceId() { + return instanceId; + } + + public boolean isWriter() { + return isWriter; + } + + public long getWeight() { + return weight; + } + + public Timestamp getLastUpdateTime() { + return lastUpdateTime; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 738eebcc3..89824556d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -95,9 +95,6 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; protected final String originalUrl; - protected final String topologyQuery; - protected final String nodeIdQuery; - protected final String isReaderQuery; protected RdsUrlType rdsUrlType; protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null ? TimeUnit.MILLISECONDS.toNanos(Long.parseLong(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue)) @@ -125,17 +122,11 @@ public class RdsHostListProvider implements DynamicHostListProvider { public RdsHostListProvider( final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery) { + final FullServicesContainer servicesContainer) { this.properties = properties; this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; this.hostListProviderService = servicesContainer.getHostListProviderService(); - this.topologyQuery = topologyQuery; - this.nodeIdQuery = nodeIdQuery; - this.isReaderQuery = isReaderQuery; } protected void init() throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 92227de29..fa3f42859 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -22,10 +22,7 @@ import java.sql.SQLSyntaxErrorException; import java.sql.Statement; import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; -import java.util.Comparator; -import java.util.HashMap; import java.util.List; import java.util.Properties; import java.util.concurrent.ConcurrentHashMap; @@ -39,12 +36,12 @@ import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Level; import java.util.logging.Logger; -import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.util.ExecutorFactory; @@ -55,6 +52,7 @@ import software.amazon.jdbc.util.ServiceUtility; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; +import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; @@ -79,13 +77,11 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final long refreshRateNano; protected final long highRefreshRateNano; + protected final TopologyDialect dialect; protected final FullServicesContainer servicesContainer; protected final Properties properties; protected final Properties monitoringProperties; protected final HostSpec initialHostSpec; - protected final String topologyQuery; - protected final String nodeIdQuery; - protected final String writerTopologyQuery; protected final HostSpec clusterInstanceTemplate; protected String clusterId; @@ -107,27 +103,23 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust public ClusterTopologyMonitorImpl( final FullServicesContainer servicesContainer, + final TopologyDialect dialect, final String clusterId, final HostSpec initialHostSpec, final Properties properties, final HostSpec clusterInstanceTemplate, final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery) { + final long highRefreshRateNano) { super(monitorTerminationTimeoutSec); - this.clusterId = clusterId; this.servicesContainer = servicesContainer; + this.dialect = dialect; + this.clusterId = clusterId; this.initialHostSpec = initialHostSpec; this.clusterInstanceTemplate = clusterInstanceTemplate; this.properties = properties; this.refreshRateNano = refreshRateNano; this.highRefreshRateNano = highRefreshRateNano; - this.topologyQuery = topologyQuery; - this.writerTopologyQuery = writerTopologyQuery; - this.nodeIdQuery = nodeIdQuery; this.monitoringProperties = PropertyUtils.copyProperties(properties); this.properties.stringPropertyNames().stream() @@ -526,7 +518,7 @@ protected List openAnyConnectionAndUpdateTopology() { new Object[]{this.initialHostSpec.getHost()})); try { - if (!StringUtils.isNullOrEmpty(this.getWriterNodeId(this.monitoringConnection.get()))) { + if (this.dialect.isWriterInstance(this.monitoringConnection.get())) { this.isVerifiedWriterConnection = true; writerVerifiedByThisThread = true; @@ -537,7 +529,7 @@ protected List openAnyConnectionAndUpdateTopology() { "ClusterTopologyMonitorImpl.writerMonitoringConnection", new Object[]{this.writerHostSpec.get().getHost()})); } else { - final String nodeId = this.getNodeId(this.monitoringConnection.get()); + final String nodeId = this.dialect.getInstanceId(this.monitoringConnection.get()); if (!StringUtils.isNullOrEmpty(nodeId)) { this.writerHostSpec.set(this.createHost(nodeId, true, 0, null)); LOGGER.finest( @@ -580,20 +572,6 @@ protected List openAnyConnectionAndUpdateTopology() { return hosts; } - protected String getNodeId(final Connection connection) { - try { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } catch (SQLException ex) { - // do nothing - } - return null; - } - protected void closeConnection(final @Nullable Connection connection) { try { if (connection != null && !connection.isClosed()) { @@ -633,7 +611,7 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { return null; } try { - final List hosts = this.queryForTopology(connection); + final List hosts = this.topologyUtils.queryForTopology(connection); if (!Utils.isNullOrEmpty(hosts)) { this.updateTopologyCache(hosts); } @@ -657,128 +635,6 @@ protected void updateTopologyCache(final @NonNull List hosts) { } } - // Returns a writer node ID if connected to a writer node. Returns null otherwise. - protected String getWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerTopologyQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - protected @Nullable List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - final String suggestedWriterNodeId = this.getSuggestedWriterNodeId(conn); - try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.topologyQuery)) { - return this.processQueryResults(resultSet, suggestedWriterNodeId); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("ClusterTopologyMonitorImpl.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - protected String getSuggestedWriterNodeId(final Connection connection) throws SQLException { - // Aurora topology query can detect a writer for itself so it doesn't need any suggested writer node ID. - return null; // intentionally null - } - - protected @Nullable List processQueryResults( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - if (resultSet.getMetaData().getColumnCount() == 0) { - // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.unexpectedTopologyQueryColumnCount")); - return null; - } - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (resultSet.next()) { - try { - final HostSpec host = createHost(resultSet, suggestedWriterNodeId); - hostMap.put(host.getHost(), host); - } catch (Exception e) { - LOGGER.finest( - Messages.get("ClusterTopologyMonitorImpl.errorProcessingQueryResults", new Object[]{e.getMessage()})); - return null; - } - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.invalidTopology")); - hosts.clear(); - } else if (writerCount == 1) { - hosts.add(writers.get(0)); - } else { - // Take the latest updated writer node as the current writer. All others will be ignored. - List sortedWriters = writers.stream() - .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) - .collect(Collectors.toList()); - hosts.add(sortedWriters.get(0)); - } - - return hosts; - } - - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora clusters. Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float cpuUtilization = resultSet.getFloat(3); - final float nodeLag = resultSet.getFloat(4); - Timestamp lastUpdateTime; - try { - lastUpdateTime = resultSet.getTimestamp(5); - } catch (Exception e) { - lastUpdateTime = Timestamp.from(Instant.now()); - } - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - - return createHost(hostName, isWriter, weight, lastUpdateTime); - } - protected HostSpec createHost( String nodeName, final boolean isWriter, @@ -854,10 +710,9 @@ public void run() { if (connection != null) { - String writerId = null; + boolean isWriter = false; try { - writerId = this.monitor.getWriterNodeId(connection); - + isWriter = this.dialect.isWriterInstance(connection); } catch (SQLSyntaxErrorException ex) { LOGGER.severe(() -> Messages.get("NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); @@ -868,11 +723,11 @@ public void run() { connection = null; } - if (!StringUtils.isNullOrEmpty(writerId)) { + if (isWriter) { try { if (this.servicesContainer.getPluginService().getHostRole(connection) != HostRole.WRITER) { // The first connection after failover may be stale. - writerId = null; + isWriter = false; } } catch (SQLException e) { // Invalid connection, retry. @@ -880,7 +735,7 @@ public void run() { } } - if (!StringUtils.isNullOrEmpty(writerId)) { + if (isWriter) { // this prevents closing connection in finally block if (!this.monitor.nodeThreadsWriterConnection.compareAndSet(null, connection)) { // writer connection is already setup @@ -888,7 +743,7 @@ public void run() { } else { // writer connection is successfully set to writerConnection - LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[]{writerId})); + LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[]{hostSpec.getUrl()})); // When nodeThreadsWriterConnection and nodeThreadsWriterHostSpec are both set, the topology monitor may // set ignoreNewTopologyRequestsEndTimeNano, in which case other threads will use the cached topology // for the ignore duration, so we need to update the topology before setting nodeThreadsWriterHostSpec. @@ -938,7 +793,7 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla List hosts; try { - hosts = this.monitor.queryForTopology(connection); + hosts = this.monitor.topologyUtils.queryForTopology(connection); if (hosts == null) { return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 0bc4cf897..f6dba75d0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -29,9 +29,13 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; @@ -53,20 +57,14 @@ public class MonitoringRdsHostListProvider extends RdsHostListProvider protected final FullServicesContainer servicesContainer; protected final PluginService pluginService; protected final long highRefreshRateNano; - protected final String writerTopologyQuery; public MonitoringRdsHostListProvider( final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String writerTopologyQuery) { - super(properties, originalUrl, servicesContainer, topologyQuery, nodeIdQuery, isReaderQuery); + final FullServicesContainer servicesContainer) { + super(properties, originalUrl, servicesContainer); this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); - this.writerTopologyQuery = writerTopologyQuery; this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); } @@ -81,6 +79,13 @@ protected void init() throws SQLException { } protected ClusterTopologyMonitor initMonitor() throws SQLException { + Dialect dialect = this.servicesContainer.getPluginService().getDialect(); + if (!(dialect instanceof TopologyDialect)) { + throw new SQLException( + Messages.get("TopologyUtils.topologyDialectRequired", new Object[]{dialect.getClass().getName()})); + } + + TopologyDialect topologyDialect = (TopologyDialect) dialect; return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, this.clusterId, @@ -88,15 +93,13 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.properties, (servicesContainer) -> new ClusterTopologyMonitorImpl( this.servicesContainer, + topologyDialect, this.clusterId, this.initialHostSpec, this.properties, this.clusterInstanceTemplate, this.refreshRateNano, - this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery)); + this.highRefreshRateNano)); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java deleted file mode 100644 index c11da2be9..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.SQLException; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.util.FullServicesContainer; - -public class MonitoringRdsMultiAzHostListProvider extends MonitoringRdsHostListProvider { - - private static final Logger LOGGER = Logger.getLogger(MonitoringRdsMultiAzHostListProvider.class.getName()); - - protected final String fetchWriterNodeQuery; - protected final String fetchWriterNodeColumnName; - - public MonitoringRdsMultiAzHostListProvider( - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeColumnName) { - super( - properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery, - ""); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeColumnName = fetchWriterNodeColumnName; - } - - @Override - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent(MultiAzClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> new MultiAzClusterTopologyMonitorImpl( - servicesContainer, - this.clusterId, - this.initialHostSpec, - this.properties, - this.hostListProviderService, - this.clusterInstanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery, - this.fetchWriterNodeQuery, - this.fetchWriterNodeColumnName)); - } - -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java deleted file mode 100644 index 36bab8f90..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java +++ /dev/null @@ -1,128 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.StringUtils; - -public class MultiAzClusterTopologyMonitorImpl extends ClusterTopologyMonitorImpl { - - private static final Logger LOGGER = Logger.getLogger(MultiAzClusterTopologyMonitorImpl.class.getName()); - - protected final String fetchWriterNodeQuery; - protected final String fetchWriterNodeColumnName; - - public MultiAzClusterTopologyMonitorImpl( - final FullServicesContainer servicesContainer, - final String clusterId, - final HostSpec initialHostSpec, - final Properties properties, - final HostListProviderService hostListProviderService, - final HostSpec clusterInstanceTemplate, - final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeColumnName) { - super( - servicesContainer, - clusterId, - initialHostSpec, - properties, - clusterInstanceTemplate, - refreshRateNano, - highRefreshRateNano, - topologyQuery, - writerTopologyQuery, - nodeIdQuery); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeColumnName = fetchWriterNodeColumnName; - } - - // Returns a writer node ID if connected to a writer node. Returns null otherwise. - @Override - protected String getWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.fetchWriterNodeQuery)) { - if (resultSet.next()) { - String nodeId = resultSet.getString(this.fetchWriterNodeColumnName); - if (!StringUtils.isNullOrEmpty(nodeId)) { - // Replica status exists and shows a writer node ID. - // That means that this node (this connection) is a reader - return null; - } - } - } - // Replica status doesn't exist. That means that this node is a writer. - try (final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - @Override - protected String getSuggestedWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.fetchWriterNodeQuery)) { - if (resultSet.next()) { - String nodeId = resultSet.getString(this.fetchWriterNodeColumnName); - if (!StringUtils.isNullOrEmpty(nodeId)) { - // Replica status exists and shows a writer node ID. - // That means that this node (this connection) is a reader. - // But we now what replication source is and that is a writer node. - return nodeId; - } - } - } - // Replica status doesn't exist. That means that this node is a writer. - try (final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - @Override - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" - String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - String hostId = resultSet.getString("id"); // "1034958454" - final boolean isWriter = hostId.equals(suggestedWriterNodeId); - - return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now())); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java index 66277275b..b879ba60b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java @@ -16,6 +16,7 @@ package software.amazon.jdbc.plugin; +import java.beans.beancontext.BeanContext; import java.sql.Connection; import java.sql.SQLException; import java.util.ArrayList; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java new file mode 100644 index 000000000..d8447ac07 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -0,0 +1,149 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +package software.amazon.jdbc.util; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.SQLSyntaxErrorException; +import java.sql.Statement; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.List; +import java.util.concurrent.Executor; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.dialect.TopologyQueryHostSpec; +import software.amazon.jdbc.hostavailability.HostAvailability; + +public class TopologyUtils { + private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); + protected static final int DEFAULT_QUERY_TIMEOUT_MS = 1000; + + protected final Executor networkTimeoutExecutor = new SynchronousExecutor(); + protected final TopologyDialect dialect; + protected final HostSpec clusterInstanceTemplate; + protected final HostSpec initialHostSpec; + protected final HostSpecBuilder hostSpecBuilder; + + public TopologyUtils( + TopologyDialect dialect, HostSpec clusterInstanceTemplate, HostSpec initialHostSpec, HostSpecBuilder hostSpecBuilder) { + this.dialect = dialect; + this.clusterInstanceTemplate = clusterInstanceTemplate; + this.initialHostSpec = initialHostSpec; + this.hostSpecBuilder = hostSpecBuilder; + } + + public List queryForTopology(Connection conn) throws SQLException { + int networkTimeout = -1; + try { + networkTimeout = conn.getNetworkTimeout(); + // The topology query is not monitored by the EFM plugin, so it needs a socket timeout + if (networkTimeout == 0) { + conn.setNetworkTimeout(this.networkTimeoutExecutor, DEFAULT_QUERY_TIMEOUT_MS); + } + } catch (SQLException e) { + LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", + new Object[] {e.getMessage()})); + } + + final String writerId = this.dialect.getWriterId(conn); + try (final Statement stmt = conn.createStatement(); + final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { + List queryHosts = this.dialect.processQueryResults(resultSet, writerId); + return this.processQueryResults(queryHosts); + } catch (final SQLSyntaxErrorException e) { + throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); + } finally { + if (networkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); + } + } + } + + protected @Nullable List processQueryResults(@Nullable List queryHosts) { + if (queryHosts == null) { + return null; + } + + List hosts = new ArrayList<>(); + List writers = new ArrayList<>(); + for (TopologyQueryHostSpec queryHost : queryHosts) { + if (queryHost.isWriter()) { + writers.add(this.toHostspec(queryHost)); + } else { + hosts.add(this.toHostspec(queryHost)); + } + } + + int writerCount = writers.size(); + if (writerCount == 0) { + LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.invalidTopology")); + return null; + } else if (writerCount == 1) { + hosts.add(writers.get(0)); + } else { + // Assume the latest updated writer instance is the current writer. Other potential writers will be ignored. + List sortedWriters = writers.stream() + .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) + .collect(Collectors.toList()); + hosts.add(sortedWriters.get(0)); + } + + return hosts; + } + + protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { + final String instanceId = queryHost.getInstanceId() == null ? "?" : queryHost.getInstanceId(); + final String endpoint = this.clusterInstanceTemplate.getHost().replace("?", instanceId); + final int port = this.clusterInstanceTemplate.isPortSpecified() + ? this.clusterInstanceTemplate.getPort() + : this.initialHostSpec.getPort(); + + final HostSpec hostSpec = this.hostSpecBuilder + .host(endpoint) + .port(port) + .role(queryHost.isWriter() ? HostRole.WRITER : HostRole.READER) + .availability(HostAvailability.AVAILABLE) + .weight(queryHost.getWeight()) + .lastUpdateTime(queryHost.getLastUpdateTime()) + .build(); + hostSpec.addAlias(instanceId); + hostSpec.setHostId(instanceId); + return hostSpec; + } + + public HostRole getHostRole(Connection conn) throws SQLException { + try (final Statement stmt = conn.createStatement(); + final ResultSet rs = stmt.executeQuery(this.isReaderQuery)) { + if (rs.next()) { + boolean isReader = rs.getBoolean(1); + return isReader ? HostRole.READER : HostRole.WRITER; + } + } catch (SQLException e) { + throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole"), e); + } + + throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index ec33655a8..0122e5e99 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -36,7 +36,6 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; -import software.amazon.jdbc.hostlistprovider.monitoring.MultiAzClusterTopologyMonitorImpl; import software.amazon.jdbc.plugin.strategy.fastestresponse.NodeResponseTimeMonitor; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.ExecutorFactory; @@ -65,7 +64,6 @@ public class MonitorServiceImpl implements MonitorService, EventSubscriber { TimeUnit.MINUTES.toNanos(15), TimeUnit.MINUTES.toNanos(3), recreateOnError); suppliers.put(ClusterTopologyMonitorImpl.class, () -> new CacheContainer(defaultSettings, Topology.class)); - suppliers.put(MultiAzClusterTopologyMonitorImpl.class, () -> new CacheContainer(defaultSettings, Topology.class)); suppliers.put(NodeResponseTimeMonitor.class, () -> new CacheContainer(defaultSettings, null)); defaultSuppliers = Collections.unmodifiableMap(suppliers); } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index c5ea7c275..e67efb909 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -27,6 +27,10 @@ AdfsCredentialsProviderFactory.signOnPagePostActionRequestFailed=ADFS SignOn Pag AdfsCredentialsProviderFactory.signOnPageRequestFailed=ADFS SignOn Page Request Failed with HTTP status ''{0}'', reason phrase ''{1}'', and response ''{2}'' AdfsCredentialsProviderFactory.signOnPageUrl=ADFS SignOn URL: ''{0}'' +AuroraTopologyProcessor.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} +AuroraDialect.invalidTopology=The topology query returned an invalid topology - no writer instance detected. +AuroraTopologyProcessor.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. + AuthenticationToken.useCachedToken=Use cached authentication token = ''{0}'' AuthenticationToken.generatedNewToken=Generated new authentication token = ''{0}'' AuthenticationToken.javaSdkNotInClasspath=Required dependency 'AWS Java SDK RDS v2.x' is not on the classpath. @@ -355,6 +359,11 @@ TargetDriverDialectManager.useDialect=Target driver dialect set to: ''{0}'', {1} TargetDriverDialectManager.unexpectedClass=Unexpected DataSource class. Expected class(es): {0}, actual class: {1}. TargetDriverDialect.unsupported=This target driver dialect does not support this operation. MysqlConnectorJDriverHelper.canNotRegister=Can''t register driver com.mysql.cj.jdbc.Driver. + +TopologyUtils.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} +TopologyUtils.topologyDialectRequired=Unable to fetch topology because the dialect does not support topology queries. Dialect: {0} +TopologyUtils.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS Db cluster. + MariadbDriverHelper.canNotRegister=Can''t register driver org.mariadb.jdbc.Driver. AuroraInitialConnectionStrategyPlugin.unsupportedStrategy=Unsupported host selection strategy ''{0}''. @@ -370,9 +379,6 @@ NodeResponseTimeMonitor.openedConnection=Opened Response time connection: {0}. ClusterTopologyMonitorImpl.startMonitoringThread=[clusterId: ''{0}''] Start cluster topology monitoring thread for ''{1}''. ClusterTopologyMonitorImpl.stopMonitoringThread=Stop cluster topology monitoring thread for ''{0}''. ClusterTopologyMonitorImpl.exceptionDuringMonitoringStop=Stopping cluster topology monitoring after unhandled exception was thrown in monitoring thread for node ''{0}''. -ClusterTopologyMonitorImpl.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS Db cluster. -ClusterTopologyMonitorImpl.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} -ClusterTopologyMonitorImpl.invalidTopology=The topology query returned an invalid topology - no writer instance detected. ClusterTopologyMonitorImpl.topologyNotUpdated=Topology hasn''t been updated after {0} ms. ClusterTopologyMonitorImpl.openedMonitoringConnection=Opened monitoring connection to node ''{0}''. ClusterTopologyMonitorImpl.ignoringTopologyRequest=A topology refresh was requested, but the topology was already updated recently. Returning cached hosts: @@ -382,8 +388,6 @@ ClusterTopologyMonitorImpl.startingNodeMonitoringThreads=Starting node monitorin ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors=The writer host detected by the node monitors was picked up by the topology monitor: ''{0}''. ClusterTopologyMonitorImpl.writerMonitoringConnection=The monitoring connection is connected to a writer: ''{0}''. ClusterTopologyMonitorImpl.errorFetchingTopology=An error occurred while querying for topology: {0} -ClusterTopologyMonitorImpl.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} -ClusterTopologyMonitorImpl.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. # Blue/Green Deployment bgd.inProgressConnectionClosed=Connection has been closed since Blue/Green switchover is in progress. From 9df6e1d11161608e5d311cf7072067b4cde986e4 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 28 Oct 2025 16:24:24 -0700 Subject: [PATCH 12/90] wip --- .../amazon/jdbc/dialect/AuroraMysqlDialect.java | 17 +++++++++++++++++ .../amazon/jdbc/dialect/AuroraPgDialect.java | 1 + .../amazon/jdbc/dialect/TopologyDialect.java | 6 ++++-- .../monitoring/ClusterTopologyMonitorImpl.java | 8 +++----- .../MonitoringRdsHostListProvider.java | 2 ++ .../amazon/jdbc/util/TopologyUtils.java | 4 ++++ 6 files changed, 31 insertions(+), 7 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index bead002ea..7c58d8b36 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -23,6 +23,8 @@ import java.util.Collections; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -137,5 +139,20 @@ public String getTopologyQuery() { public boolean isWriterInstance(Connection connection) throws SQLException { return dialectUtils.isWriterInstance(connection); } + + @Override + public HostSpec identifyConnection(Connection connection) throws SQLException { + return null; + } + + @Override + public HostRole getHostRole(Connection conn) throws SQLException { + return null; + } + + @Override + public String getIsReaderQuery() { + return ""; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index e85a36ef0..3f8a573d2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -92,6 +92,7 @@ public boolean isDialect(final Connection connection) { } catch (SQLException ex) { // ignore } finally { + // TODO: switch to try-with-resources here and check for any other places that can be cleaned up similarly if (stmt != null) { try { stmt.close(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index dc0cdf108..98d421c17 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -37,7 +37,9 @@ List processQueryResults(ResultSet rs, @Nullable String s // TODO: can we remove this and use getHostRole instead? boolean isWriterInstance(final Connection connection) throws SQLException; - HostSpec identifyConnection(Connection connection) throws SQLException; + HostSpec identifyConnection(Connection connection) throws SQLException - HostRole getHostRole(Connection conn) throws SQLException; + String getIsReaderQuery(); + + String get } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index fa3f42859..0f763659d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -17,10 +17,8 @@ package software.amazon.jdbc.hostlistprovider.monitoring; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; import java.sql.Timestamp; import java.util.ArrayList; import java.util.List; @@ -77,7 +75,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final long refreshRateNano; protected final long highRefreshRateNano; - protected final TopologyDialect dialect; + protected final TopologyUtils topologyUtils; protected final FullServicesContainer servicesContainer; protected final Properties properties; protected final Properties monitoringProperties; @@ -103,7 +101,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust public ClusterTopologyMonitorImpl( final FullServicesContainer servicesContainer, - final TopologyDialect dialect, + final TopologyUtils topologyUtils, final String clusterId, final HostSpec initialHostSpec, final Properties properties, @@ -113,7 +111,7 @@ public ClusterTopologyMonitorImpl( super(monitorTerminationTimeoutSec); this.servicesContainer = servicesContainer; - this.dialect = dialect; + this.topologyUtils = topologyUtils; this.clusterId = clusterId; this.initialHostSpec = initialHostSpec; this.clusterInstanceTemplate = clusterInstanceTemplate; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index f6dba75d0..1dec9d511 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -86,6 +86,8 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { } TopologyDialect topologyDialect = (TopologyDialect) dialect; + TopologyUtils topologyUtils = new TopologyUtils( + topologyDialect, this.clusterInstanceTemplate, this.initialHostSpec, this.pluginService.getHostSpecBuilder()); return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, this.clusterId, diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java index d8447ac07..a35c4498d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -146,4 +146,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); } + + HostSpec identifyConnection(Connection connection) throws SQLException { + + } } From 980ea01bead42a5abbaeed1c116690d9d868d085 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 08:08:09 -0700 Subject: [PATCH 13/90] Builds successfully --- .../amazon/jdbc/HostListProvider.java | 2 + .../jdbc/dialect/AuroraDialectUtils.java | 12 - .../jdbc/dialect/AuroraMysqlDialect.java | 23 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 21 +- .../jdbc/dialect/MultiAzDialectUtils.java | 6 +- .../RdsMultiAzDbClusterMysqlDialect.java | 32 +-- .../dialect/RdsMultiAzDbClusterPgDialect.java | 39 ++- .../amazon/jdbc/dialect/TopologyDialect.java | 8 +- .../AuroraHostListProvider.java | 14 +- .../hostlistprovider/RdsHostListProvider.java | 234 ++++-------------- .../RdsMultiAzDbClusterListProvider.java | 182 +------------- .../ClusterTopologyMonitorImpl.java | 39 ++- .../MonitoringRdsHostListProvider.java | 17 +- .../amazon/jdbc/util/TopologyUtils.java | 32 ++- .../aurora/TestAuroraHostListProvider.java | 5 +- .../RdsHostListProviderTest.java | 13 +- .../RdsMultiAzDbClusterListProviderTest.java | 17 +- 17 files changed, 172 insertions(+), 524 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java index 0aa93714a..1a147658f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java @@ -19,6 +19,7 @@ import java.sql.Connection; import java.sql.SQLException; import java.util.List; +import org.checkerframework.checker.nullness.qual.Nullable; public interface HostListProvider { @@ -40,6 +41,7 @@ public interface HostListProvider { */ HostRole getHostRole(Connection connection) throws SQLException; + @Nullable HostSpec identifyConnection(Connection connection) throws SQLException; String getClusterId() throws UnsupportedOperationException, SQLException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java index 0c8c0221c..647e93cc2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -95,16 +95,4 @@ public boolean isWriterInstance(final Connection connection) throws SQLException return false; } - - // Returns a writer node ID if connected to a writer node. Returns null otherwise. - protected String getWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 7c58d8b36..c4c22b2eb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -91,14 +91,8 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); + return (properties, initialUrl, servicesContainer) -> + new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } @Override @@ -141,18 +135,13 @@ public boolean isWriterInstance(Connection connection) throws SQLException { } @Override - public HostSpec identifyConnection(Connection connection) throws SQLException { - return null; - } - - @Override - public HostRole getHostRole(Connection conn) throws SQLException { - return null; + public String getIsReaderQuery() { + return IS_READER_QUERY; } @Override - public String getIsReaderQuery() { - return ""; + public String getInstanceIdQuery() { + return NODE_ID_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 3f8a573d2..191ac849f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -23,6 +23,7 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.util.DriverInfo; @@ -141,14 +142,8 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); + return (properties, initialUrl, servicesContainer) -> + new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } @Override @@ -156,6 +151,16 @@ public String getTopologyQuery() { return TOPOLOGY_QUERY; } + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return NODE_ID_QUERY; + } + @Override @Nullable public String getWriterId(final Connection connection) { // The Aurora topology query can detect the writer without a suggested writer ID, so we intentionally return null. diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java index 3d885033f..3a3075429 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -70,19 +70,19 @@ protected TopologyQueryHostSpec createHost( return new TopologyQueryHostSpec(instanceName, isWriter, 0, Timestamp.from(Instant.now())); } - public @Nullable String getSuggestedWriterId(Connection connection) throws SQLException { + public @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { if (resultSet.next()) { String writerId = resultSet.getString(this.writerIdQueryColumn); if (!StringUtils.isNullOrEmpty(writerId)) { - // Replica status exists and shows a writer instance ID, which means that this instance is a reader. return writerId; } } } - // Replica status doesn't exist, which means that this instance is a writer. + // Replica status doesn't exist, which means that this instance is a writer. We execute instanceIdQuery to get the + // ID of this writer instance. try (final ResultSet resultSet = stmt.executeQuery(this.instanceIdQuery)) { if (resultSet.next()) { return resultSet.getString(1); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index 439135aa8..d66ae416c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -100,26 +100,10 @@ public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); + return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } else { - return new RdsMultiAzDbClusterListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); + return new RdsMultiAzDbClusterListProvider(this, properties, initialUrl, servicesContainer); } }; } @@ -153,11 +137,21 @@ public List processQueryResults(ResultSet rs, @Nullable S @Override public @Nullable String getWriterId(Connection connection) throws SQLException { - return dialectUtils.getSuggestedWriterId(connection); + return dialectUtils.getWriterId(connection); } @Override public boolean isWriterInstance(Connection connection) throws SQLException { return dialectUtils.isWriterInstance(connection); } + + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return NODE_ID_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index fd0664c86..2188bec11 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -20,7 +20,6 @@ import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; -import java.util.Collections; import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; @@ -28,6 +27,7 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; @@ -87,27 +87,9 @@ public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); - + return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } else { - - return new RdsMultiAzDbClusterListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); + return new RdsMultiAzDbClusterListProvider(this, properties, initialUrl, servicesContainer); } }; } @@ -119,7 +101,7 @@ public String getTopologyQuery() { @Override public @Nullable String getWriterId(final Connection connection) throws SQLException { - return dialectUtils.getSuggestedWriterId(connection); + return dialectUtils.getWriterId(connection); } @Override @@ -128,7 +110,18 @@ public boolean isWriterInstance(Connection connection) throws SQLException { } @Override - public @Nullable List processQueryResults(ResultSet rs, String suggestedWriterId) throws SQLException { + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return NODE_ID_QUERY; + } + + @Override + public @Nullable List processQueryResults(ResultSet rs, String suggestedWriterId) + throws SQLException { return this.dialectUtils.processQueryResults(rs, suggestedWriterId); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index 98d421c17..928309741 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -21,10 +21,8 @@ import java.sql.SQLException; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -public interface TopologyDialect { +public interface TopologyDialect extends Dialect { String getTopologyQuery(); @Nullable @@ -37,9 +35,7 @@ List processQueryResults(ResultSet rs, @Nullable String s // TODO: can we remove this and use getHostRole instead? boolean isWriterInstance(final Connection connection) throws SQLException; - HostSpec identifyConnection(Connection connection) throws SQLException - String getIsReaderQuery(); - String get + String getInstanceIdQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java index fc53f9e1d..64ee0961c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java @@ -19,6 +19,7 @@ import java.util.Properties; import java.util.logging.Logger; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.FullServicesContainer; @@ -27,17 +28,10 @@ public class AuroraHostListProvider extends RdsHostListProvider { static final Logger LOGGER = Logger.getLogger(AuroraHostListProvider.class.getName()); public AuroraHostListProvider( + final TopologyDialect dialect, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery) { - super(properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery); + final FullServicesContainer servicesContainer) { + super(dialect, properties, originalUrl, servicesContainer); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 89824556d..65054208b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -17,16 +17,9 @@ package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; import java.util.Collections; -import java.util.Comparator; -import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Map.Entry; @@ -37,7 +30,6 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; -import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; @@ -46,7 +38,7 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; @@ -54,6 +46,7 @@ import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; +import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; @@ -92,9 +85,13 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected static final CacheMap suggestedPrimaryClusterIdCache = new CacheMap<>(); protected static final CacheMap primaryClusterIdCache = new CacheMap<>(); + protected final ReentrantLock lock = new ReentrantLock(); + protected final TopologyDialect dialect; + protected final Properties properties; + protected final String originalUrl; protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; - protected final String originalUrl; + protected RdsUrlType rdsUrlType; protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null ? TimeUnit.MILLISECONDS.toNanos(Long.parseLong(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue)) @@ -102,10 +99,9 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected List hostList = new ArrayList<>(); protected List initialHostList = new ArrayList<>(); protected HostSpec initialHostSpec; - - protected final ReentrantLock lock = new ReentrantLock(); protected String clusterId; protected HostSpec clusterInstanceTemplate; + protected TopologyUtils topologyUtils; // A primary clusterId is a clusterId that is based off of a cluster endpoint URL // (rather than a GUID or a value provided by the user). @@ -113,16 +109,16 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected volatile boolean isInitialized = false; - protected Properties properties; - static { PropertyDefinition.registerPluginProperties(RdsHostListProvider.class); } public RdsHostListProvider( + final TopologyDialect dialect, final Properties properties, final String originalUrl, final FullServicesContainer servicesContainer) { + this.dialect = dialect; this.properties = properties; this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; @@ -200,6 +196,12 @@ protected void init() throws SQLException { } } + this.topologyUtils = new TopologyUtils( + this.dialect, + this.clusterInstanceTemplate, + this.initialHostSpec, + this.servicesContainer.getPluginService().getHostSpecBuilder()); + this.isInitialized = true; } finally { lock.unlock(); @@ -251,7 +253,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f } // fetch topology from the DB - final List hosts = queryForTopology(conn); + final List hosts = this.topologyUtils.queryForTopology(conn); if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); @@ -274,7 +276,7 @@ protected void clusterIdChanged(final String oldClusterId) throws SQLException { // do nothing } - protected ClusterSuggestedResult getSuggestedClusterId(final String url) { + protected @Nullable ClusterSuggestedResult getSuggestedClusterId(final String url) { Map entries = this.servicesContainer.getStorageService().getEntries(Topology.class); if (entries == null) { return null; @@ -288,9 +290,7 @@ protected ClusterSuggestedResult getSuggestedClusterId(final String url) { if (key.equals(url)) { return new ClusterSuggestedResult(url, isPrimaryCluster); } - if (hosts == null) { - continue; - } + for (final HostSpec host : hosts) { if (host.getHostAndPort().equals(url)) { LOGGER.finest(() -> Messages.get("RdsHostListProvider.suggestedClusterId", @@ -345,131 +345,7 @@ protected void suggestPrimaryCluster(final @NonNull List primaryCluste * @throws SQLException if errors occurred while retrieving the topology. */ protected List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("RdsHostListProvider.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.topologyQuery)) { - return processQueryResults(resultSet); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("RdsHostListProvider.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - /** - * Form a list of hosts from the results of the topology query. - * - * @param resultSet The results of the topology query - * @return a list of {@link HostSpec} objects representing - * the topology that was returned by the - * topology query. The list will be empty if the topology query returned an invalid topology - * (no writer instance). - */ - private List processQueryResults(final ResultSet resultSet) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (resultSet.next()) { - final HostSpec host = createHost(resultSet); - hostMap.put(host.getHost(), host); - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.severe( - () -> Messages.get( - "RdsHostListProvider.invalidTopology")); - hosts.clear(); - } else if (writerCount == 1) { - hosts.add(writers.get(0)); - } else { - // Take the latest updated writer node as the current writer. All others will be ignored. - List sortedWriters = writers.stream() - .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) - .collect(Collectors.toList()); - hosts.add(sortedWriters.get(0)); - } - - return hosts; - } - - /** - * Creates an instance of HostSpec which captures details about a connectable host. - * - * @param resultSet the result set from querying the topology - * @return a {@link HostSpec} instance for a specific instance from the cluster - * @throws SQLException If unable to retrieve the hostName from the result set - */ - protected HostSpec createHost(final ResultSet resultSet) throws SQLException { - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final double cpuUtilization = resultSet.getDouble(3); - final double nodeLag = resultSet.getDouble(4); - Timestamp lastUpdateTime; - try { - lastUpdateTime = resultSet.getTimestamp(5); - } catch (Exception e) { - lastUpdateTime = Timestamp.from(Instant.now()); - } - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - - return createHost(hostName, isWriter, weight, lastUpdateTime); - } - - protected HostSpec createHost( - String host, - final boolean isWriter, - final long weight, - final Timestamp lastUpdateTime) { - - host = host == null ? "?" : host; - final String endpoint = getHostEndpoint(host); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.hostListProviderService.getHostSpecBuilder() - .host(endpoint) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(lastUpdateTime) - .build(); - hostSpec.addAlias(host); - hostSpec.setHostId(host); - return hostSpec; + return this.topologyUtils.queryForTopology(conn); } /** @@ -593,64 +469,52 @@ public FetchTopologyResult(final boolean isCachedData, final List host @Override public HostRole getHostRole(Connection conn) throws SQLException { - try (final Statement stmt = conn.createStatement(); - final ResultSet rs = stmt.executeQuery(this.isReaderQuery)) { - if (rs.next()) { - boolean isReader = rs.getBoolean(1); - return isReader ? HostRole.READER : HostRole.WRITER; - } - } catch (SQLException e) { - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole"), e); - } - - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); + return this.topologyUtils.getHostRole(conn); } @Override - public HostSpec identifyConnection(Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - final String instanceName = resultSet.getString(1); + public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { + // TODO: why do we return null in some unexpected scenarios and throw an exception in others? + try { + String instanceId = this.topologyUtils.getInstanceId(connection); + if (instanceId == null) { + throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); + } - List topology = this.refresh(connection); + List topology = this.refresh(connection); + boolean isForcedRefresh = false; + if (topology == null) { + topology = this.forceRefresh(connection); + isForcedRefresh = true; + } - boolean isForcedRefresh = false; - if (topology == null) { - topology = this.forceRefresh(connection); - isForcedRefresh = true; - } + if (topology == null) { + return null; + } + HostSpec foundHost = topology + .stream() + .filter(host -> Objects.equals(instanceId, host.getHostId())) + .findAny() + .orElse(null); + + if (foundHost == null && !isForcedRefresh) { + topology = this.forceRefresh(connection); if (topology == null) { return null; } - HostSpec foundHost = topology + foundHost = topology .stream() - .filter(host -> Objects.equals(instanceName, host.getHostId())) + .filter(host -> Objects.equals(instanceId, host.getHostId())) .findAny() .orElse(null); - - if (foundHost == null && !isForcedRefresh) { - topology = this.forceRefresh(connection); - if (topology == null) { - return null; - } - - foundHost = topology - .stream() - .filter(host -> Objects.equals(instanceName, host.getHostId())) - .findAny() - .orElse(null); - } - - return foundHost; } + + return foundHost; } catch (final SQLException e) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection"), e); } - - throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java index a63323176..8b134fd45 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java @@ -16,193 +16,19 @@ package software.amazon.jdbc.hostlistprovider; -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; import java.util.Properties; import java.util.logging.Logger; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Messages; public class RdsMultiAzDbClusterListProvider extends RdsHostListProvider { - private final String fetchWriterNodeQuery; - private final String fetchWriterNodeQueryHeader; static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterListProvider.class.getName()); public RdsMultiAzDbClusterListProvider( + final TopologyDialect dialect, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeQueryHeader - ) { - super(properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeQueryHeader = fetchWriterNodeQueryHeader; - } - - /** - * Obtain a cluster topology from database. - * - * @param conn A connection to database to fetch the latest topology. - * @return a list of {@link HostSpec} objects representing the topology - * @throws SQLException if errors occurred while retrieving the topology. - */ - protected List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("RdsHostListProvider.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - try { - final Statement stmt = conn.createStatement(); - String writerNodeId = processWriterNodeId(stmt.executeQuery(this.fetchWriterNodeQuery)); - if (writerNodeId == null) { - final ResultSet nodeIdResultSet = stmt.executeQuery(this.nodeIdQuery); - while (nodeIdResultSet.next()) { - writerNodeId = nodeIdResultSet.getString(1); - } - } - final ResultSet topologyResultSet = stmt.executeQuery(this.topologyQuery); - return processTopologyQueryResults(topologyResultSet, writerNodeId); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("RdsHostListProvider.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - /** - * Get writer node ID. - * - * @param fetchWriterNodeResultSet A ResultSet of writer node query - * @return String The ID of a writer node - * @throws SQLException if errors occurred while retrieving the topology - */ - private String processWriterNodeId(final ResultSet fetchWriterNodeResultSet) throws SQLException { - String writerNodeId = null; - if (fetchWriterNodeResultSet.next()) { - writerNodeId = fetchWriterNodeResultSet.getString(fetchWriterNodeQueryHeader); - } - return writerNodeId; - } - - /** - * Form a list of hosts from the results of the topology query. - * - * @param topologyResultSet The results of the topology query - * @param writerNodeId The writer node ID - * @return a list of {@link HostSpec} objects representing - * the topology that was returned by the - * topology query. The list will be empty if the topology query returned an invalid topology - * (no writer instance). - */ - private List processTopologyQueryResults( - final ResultSet topologyResultSet, - final String writerNodeId) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (topologyResultSet.next()) { - final HostSpec host = createHost(topologyResultSet, writerNodeId); - hostMap.put(host.getHost(), host); - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.severe(() -> Messages.get("RdsHostListProvider.invalidTopology")); - hosts.clear(); - } else { - hosts.add(writers.get(0)); - } - - return hosts; - } - - /** - * Creates an instance of HostSpec which captures details about a connectable host. - * - * @param resultSet the result set from querying the topology - * @return a {@link HostSpec} instance for a specific instance from the cluster - * @throws SQLException If unable to retrieve the hostName from the result set - */ - private HostSpec createHost(final ResultSet resultSet, final String writerNodeId) throws SQLException { - - String hostName = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" - String instanceName = hostName.substring(0, hostName.indexOf(".")); // "instance-name" - - // "instance-name.XYZ.us-west-2.rds.amazonaws.com" based on cluster instance template - final String endpoint = getHostEndpoint(instanceName); - - String hostId = resultSet.getString("id"); - int queryPort = resultSet.getInt("port"); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() - : queryPort; - final boolean isWriter = hostId.equals(writerNodeId); - - final HostSpec hostSpec = this.hostListProviderService.getHostSpecBuilder() - .host(endpoint) - .hostId(hostId) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(0) - .lastUpdateTime(Timestamp.from(Instant.now())) - .build(); - hostSpec.addAlias(hostName); - return hostSpec; - } - - /** - * Build a host dns endpoint based on host/node name. - * - * @param nodeName A host name. - * @return Host dns endpoint - */ - protected String getHostEndpoint(final String nodeName) { - final String host = this.clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); + final FullServicesContainer servicesContainer) { + super(dialect, properties, originalUrl, servicesContainer); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 0f763659d..7ab890ef5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -39,7 +39,6 @@ import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.util.ExecutorFactory; @@ -62,10 +61,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected static final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final long monitorTerminationTimeoutSec = 30; - - protected static final int defaultTopologyQueryTimeoutMs = 1000; protected static final int closeConnectionNetworkTimeoutMs = 500; - protected static final int defaultConnectionTimeoutMs = 5000; protected static final int defaultSocketTimeoutMs = 5000; @@ -73,25 +69,14 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected static final long highRefreshPeriodAfterPanicNano = TimeUnit.SECONDS.toNanos(30); protected static final long ignoreTopologyRequestNano = TimeUnit.SECONDS.toNanos(10); - protected final long refreshRateNano; - protected final long highRefreshRateNano; - protected final TopologyUtils topologyUtils; - protected final FullServicesContainer servicesContainer; - protected final Properties properties; - protected final Properties monitoringProperties; - protected final HostSpec initialHostSpec; - protected final HostSpec clusterInstanceTemplate; - - protected String clusterId; protected final AtomicReference writerHostSpec = new AtomicReference<>(null); protected final AtomicReference monitoringConnection = new AtomicReference<>(null); - protected boolean isVerifiedWriterConnection = false; - protected long highRefreshRateEndTimeNano = 0; + protected final Object topologyUpdated = new Object(); protected final AtomicBoolean requestToUpdateTopology = new AtomicBoolean(false); protected final AtomicLong ignoreNewTopologyRequestsEndTimeNano = new AtomicLong(-1); protected final ConcurrentHashMap submittedNodes = new ConcurrentHashMap<>(); - protected ExecutorService nodeExecutorService = null; + protected final ReentrantLock nodeExecutorLock = new ReentrantLock(); protected final AtomicBoolean nodeThreadsStop = new AtomicBoolean(false); protected final AtomicReference nodeThreadsWriterConnection = new AtomicReference<>(null); @@ -99,6 +84,20 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final AtomicReference nodeThreadsReaderConnection = new AtomicReference<>(null); protected final AtomicReference> nodeThreadsLatestTopology = new AtomicReference<>(null); + protected final long refreshRateNano; + protected final long highRefreshRateNano; + protected final TopologyUtils topologyUtils; + protected final FullServicesContainer servicesContainer; + protected final Properties properties; + protected final Properties monitoringProperties; + protected final HostSpec initialHostSpec; + protected final HostSpec clusterInstanceTemplate; + + protected ExecutorService nodeExecutorService = null; + protected boolean isVerifiedWriterConnection = false; + protected long highRefreshRateEndTimeNano = 0; + protected String clusterId; + public ClusterTopologyMonitorImpl( final FullServicesContainer servicesContainer, final TopologyUtils topologyUtils, @@ -516,7 +515,7 @@ protected List openAnyConnectionAndUpdateTopology() { new Object[]{this.initialHostSpec.getHost()})); try { - if (this.dialect.isWriterInstance(this.monitoringConnection.get())) { + if (this.topologyUtils.isWriterInstance(this.monitoringConnection.get())) { this.isVerifiedWriterConnection = true; writerVerifiedByThisThread = true; @@ -527,7 +526,7 @@ protected List openAnyConnectionAndUpdateTopology() { "ClusterTopologyMonitorImpl.writerMonitoringConnection", new Object[]{this.writerHostSpec.get().getHost()})); } else { - final String nodeId = this.dialect.getInstanceId(this.monitoringConnection.get()); + final String nodeId = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); if (!StringUtils.isNullOrEmpty(nodeId)) { this.writerHostSpec.set(this.createHost(nodeId, true, 0, null)); LOGGER.finest( @@ -710,7 +709,7 @@ public void run() { boolean isWriter = false; try { - isWriter = this.dialect.isWriterInstance(connection); + isWriter = this.monitor.topologyUtils.isWriterInstance(connection); } catch (SQLSyntaxErrorException ex) { LOGGER.severe(() -> Messages.get("NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 1dec9d511..be4aa66d9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -29,13 +29,10 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; -import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; @@ -59,10 +56,11 @@ public class MonitoringRdsHostListProvider extends RdsHostListProvider protected final long highRefreshRateNano; public MonitoringRdsHostListProvider( + final TopologyDialect dialect, final Properties properties, final String originalUrl, final FullServicesContainer servicesContainer) { - super(properties, originalUrl, servicesContainer); + super(dialect, properties, originalUrl, servicesContainer); this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( @@ -79,15 +77,6 @@ protected void init() throws SQLException { } protected ClusterTopologyMonitor initMonitor() throws SQLException { - Dialect dialect = this.servicesContainer.getPluginService().getDialect(); - if (!(dialect instanceof TopologyDialect)) { - throw new SQLException( - Messages.get("TopologyUtils.topologyDialectRequired", new Object[]{dialect.getClass().getName()})); - } - - TopologyDialect topologyDialect = (TopologyDialect) dialect; - TopologyUtils topologyUtils = new TopologyUtils( - topologyDialect, this.clusterInstanceTemplate, this.initialHostSpec, this.pluginService.getHostSpecBuilder()); return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, this.clusterId, @@ -95,7 +84,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.properties, (servicesContainer) -> new ClusterTopologyMonitorImpl( this.servicesContainer, - topologyDialect, + this.topologyUtils, this.clusterId, this.initialHostSpec, this.properties, diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java index a35c4498d..59a494322 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -25,6 +25,7 @@ import java.util.ArrayList; import java.util.Comparator; import java.util.List; +import java.util.Objects; import java.util.concurrent.Executor; import java.util.logging.Logger; import java.util.stream.Collectors; @@ -47,14 +48,17 @@ public class TopologyUtils { protected final HostSpecBuilder hostSpecBuilder; public TopologyUtils( - TopologyDialect dialect, HostSpec clusterInstanceTemplate, HostSpec initialHostSpec, HostSpecBuilder hostSpecBuilder) { + TopologyDialect dialect, + HostSpec clusterInstanceTemplate, + HostSpec initialHostSpec, + HostSpecBuilder hostSpecBuilder) { this.dialect = dialect; this.clusterInstanceTemplate = clusterInstanceTemplate; this.initialHostSpec = initialHostSpec; this.hostSpecBuilder = hostSpecBuilder; } - public List queryForTopology(Connection conn) throws SQLException { + public @Nullable List queryForTopology(Connection conn) throws SQLException { int networkTimeout = -1; try { networkTimeout = conn.getNetworkTimeout(); @@ -133,9 +137,27 @@ protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { return hostSpec; } + public @Nullable String getInstanceId(final Connection connection) { + try { + try (final Statement stmt = connection.createStatement(); + final ResultSet resultSet = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (resultSet.next()) { + return resultSet.getString(1); + } + } + } catch (SQLException ex) { + // do nothing + } + return null; + } + + public boolean isWriterInstance(Connection connection) throws SQLException { + return this.dialect.isWriterInstance(connection); + } + public HostRole getHostRole(Connection conn) throws SQLException { try (final Statement stmt = conn.createStatement(); - final ResultSet rs = stmt.executeQuery(this.isReaderQuery)) { + final ResultSet rs = stmt.executeQuery(this.dialect.getIsReaderQuery())) { if (rs.next()) { boolean isReader = rs.getBoolean(1); return isReader ? HostRole.READER : HostRole.WRITER; @@ -146,8 +168,4 @@ public HostRole getHostRole(Connection conn) throws SQLException { throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); } - - HostSpec identifyConnection(Connection connection) throws SQLException { - - } } diff --git a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java b/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java index c35f6b0f8..d9ddbb706 100644 --- a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java +++ b/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java @@ -17,14 +17,15 @@ package integration.container.aurora; import java.util.Properties; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.util.FullServicesContainer; public class TestAuroraHostListProvider extends AuroraHostListProvider { public TestAuroraHostListProvider( - FullServicesContainer servicesContainer, Properties properties, String originalUrl) { - super(properties, originalUrl, servicesContainer, "", "", ""); + FullServicesContainer servicesContainer, TopologyDialect dialect, Properties properties, String originalUrl) { + super(dialect, properties, originalUrl, servicesContainer); } public static void clearCache() { diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 797d151be..3574af62a 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -60,7 +60,7 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; @@ -80,7 +80,7 @@ class RdsHostListProviderTest { @Mock private PluginService mockPluginService; @Mock private HostListProviderService mockHostListProviderService; @Mock private EventPublisher mockEventPublisher; - @Mock Dialect mockTopologyAwareDialect; + @Mock private TopologyDialect mockDialect; @Captor private ArgumentCaptor queryCaptor; private AutoCloseable closeable; @@ -101,7 +101,7 @@ void setUp() throws SQLException { when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); when(mockConnection.createStatement()).thenReturn(mockStatement); when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); - when(mockHostListProviderService.getDialect()).thenReturn(mockTopologyAwareDialect); + when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); when(mockHostListProviderService.getHostSpecBuilder()) .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); @@ -115,11 +115,8 @@ void tearDown() throws Exception { } private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { - RdsHostListProvider provider = new RdsHostListProvider( - new Properties(), - originalUrl, - mockServicesContainer, - "foo", "bar", "baz"); + RdsHostListProvider provider = + new RdsHostListProvider(mockDialect, new Properties(), originalUrl, mockServicesContainer); provider.init(); return provider; } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java index df6d6ee50..af3955e09 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java @@ -55,7 +55,7 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; import software.amazon.jdbc.util.FullServicesContainer; @@ -74,7 +74,7 @@ class RdsMultiAzDbClusterListProviderTest { @Mock private PluginService mockPluginService; @Mock private HostListProviderService mockHostListProviderService; @Mock private EventPublisher mockEventPublisher; - @Mock Dialect mockTopologyAwareDialect; + @Mock private TopologyDialect mockDialect; @Captor private ArgumentCaptor queryCaptor; private AutoCloseable closeable; @@ -95,7 +95,7 @@ void setUp() throws SQLException { when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); when(mockConnection.createStatement()).thenReturn(mockStatement); when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); - when(mockHostListProviderService.getDialect()).thenReturn(mockTopologyAwareDialect); + when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); when(mockHostListProviderService.getHostSpecBuilder()) .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); } @@ -108,15 +108,8 @@ void tearDown() throws Exception { } private RdsMultiAzDbClusterListProvider getRdsMazDbClusterHostListProvider(String originalUrl) throws SQLException { - RdsMultiAzDbClusterListProvider provider = new RdsMultiAzDbClusterListProvider( - new Properties(), - originalUrl, - mockServicesContainer, - "foo", - "bar", - "baz", - "fang", - "li"); + RdsMultiAzDbClusterListProvider provider = + new RdsMultiAzDbClusterListProvider(mockDialect, new Properties(), originalUrl, mockServicesContainer); provider.init(); // provider.clusterId = "cluster-id"; return provider; From 227eac964a7459daa55c4a938310623b68715251 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 08:16:34 -0700 Subject: [PATCH 14/90] Remove unnecessary classes --- .../RdsMultiAzDbClusterMysqlDialect.java | 4 +- .../dialect/RdsMultiAzDbClusterPgDialect.java | 4 +- .../AuroraHostListProvider.java | 37 -- .../RdsMultiAzDbClusterListProvider.java | 34 -- .../aurora/TestAuroraHostListProvider.java | 34 -- .../tests/AdvancedPerformanceTest.java | 4 +- .../container/tests/AutoscalingTests.java | 6 +- .../container/tests/FailoverTest.java | 4 +- .../container/tests/PerformanceTest.java | 8 +- .../tests/ReadWriteSplittingTests.java | 6 +- .../RdsMultiAzDbClusterListProviderTest.java | 463 ------------------ .../FailoverConnectionPluginTest.java | 4 +- 12 files changed, 20 insertions(+), 588 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java delete mode 100644 wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java delete mode 100644 wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index d66ae416c..da55b460a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -27,7 +27,7 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; @@ -103,7 +103,7 @@ public HostListProviderSupplier getHostListProvider() { return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } else { - return new RdsMultiAzDbClusterListProvider(this, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); } }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index 2188bec11..14041d849 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -26,7 +26,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; -import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; @@ -89,7 +89,7 @@ public HostListProviderSupplier getHostListProvider() { if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); } else { - return new RdsMultiAzDbClusterListProvider(this, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); } }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java deleted file mode 100644 index 64ee0961c..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - - -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.util.FullServicesContainer; - - -public class AuroraHostListProvider extends RdsHostListProvider { - - static final Logger LOGGER = Logger.getLogger(AuroraHostListProvider.class.getName()); - - public AuroraHostListProvider( - final TopologyDialect dialect, - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java deleted file mode 100644 index 8b134fd45..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.util.FullServicesContainer; - -public class RdsMultiAzDbClusterListProvider extends RdsHostListProvider { - static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterListProvider.class.getName()); - - public RdsMultiAzDbClusterListProvider( - final TopologyDialect dialect, - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); - } -} diff --git a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java b/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java deleted file mode 100644 index d9ddbb706..000000000 --- a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package integration.container.aurora; - -import java.util.Properties; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; -import software.amazon.jdbc.util.FullServicesContainer; - -public class TestAuroraHostListProvider extends AuroraHostListProvider { - - public TestAuroraHostListProvider( - FullServicesContainer servicesContainer, TopologyDialect dialect, Properties properties, String originalUrl) { - super(dialect, properties, originalUrl, servicesContainer); - } - - public static void clearCache() { - AuroraHostListProvider.clearAll(); - } -} diff --git a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java index 38087f2dc..7af9f613c 100644 --- a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java @@ -29,7 +29,6 @@ import integration.container.ConnectionStringHelper; import integration.container.TestDriverProvider; import integration.container.TestEnvironment; -import integration.container.aurora.TestAuroraHostListProvider; import integration.container.aurora.TestPluginServiceImpl; import integration.container.condition.DisableOnTestFeature; import integration.container.condition.EnableOnTestFeature; @@ -66,6 +65,7 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.provider.Arguments; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; import software.amazon.jdbc.plugin.efm2.HostMonitorServiceImpl; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; @@ -686,7 +686,7 @@ private void ensureClusterHealthy() throws InterruptedException { auroraUtil.makeSureInstancesUp(TimeUnit.MINUTES.toSeconds(5)); - TestAuroraHostListProvider.clearCache(); + RdsHostListProvider.clearAll(); TestPluginServiceImpl.clearHostAvailabilityCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); diff --git a/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java b/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java index 307e00bb9..28a6c63e4 100644 --- a/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java +++ b/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java @@ -52,7 +52,7 @@ import software.amazon.jdbc.HikariPoolConfigurator; import software.amazon.jdbc.HikariPooledConnectionProvider; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPlugin; @@ -104,7 +104,7 @@ public void test_pooledConnectionAutoScaling_setReadOnlyOnOldConnection() final Properties props = getProps(); final long topologyRefreshRateMs = 5000; ReadWriteSplittingPlugin.READER_HOST_SELECTOR_STRATEGY.set(props, "leastConnections"); - AuroraHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, + RdsHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, Long.toString(topologyRefreshRateMs)); final TestEnvironmentInfo testInfo = TestEnvironment.getCurrent().getInfo(); @@ -186,7 +186,7 @@ public void test_pooledConnectionAutoScaling_failoverFromDeletedReader() final Properties props = getPropsWithFailover(); final long topologyRefreshRateMs = 5000; ReadWriteSplittingPlugin.READER_HOST_SELECTOR_STRATEGY.set(props, "leastConnections"); - AuroraHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, + RdsHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, Long.toString(topologyRefreshRateMs)); final TestEnvironmentInfo testInfo = TestEnvironment.getCurrent().getInfo(); diff --git a/wrapper/src/test/java/integration/container/tests/FailoverTest.java b/wrapper/src/test/java/integration/container/tests/FailoverTest.java index 347264561..7803ed185 100644 --- a/wrapper/src/test/java/integration/container/tests/FailoverTest.java +++ b/wrapper/src/test/java/integration/container/tests/FailoverTest.java @@ -62,7 +62,7 @@ import org.junit.jupiter.api.extension.ExtendWith; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.ds.AwsWrapperDataSource; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.util.SqlState; @@ -688,7 +688,7 @@ protected Properties initDefaultProxiedProps() { // Some tests temporarily disable connectivity for 5 seconds. The socket timeout needs to be less than this to // trigger driver failover. PropertyDefinition.SOCKET_TIMEOUT.set(props, "2000"); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set( + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set( props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); diff --git a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java index 73e0b338c..a1c1bcd72 100644 --- a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java @@ -61,7 +61,7 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.provider.Arguments; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.OpenedConnectionTracker; @@ -149,7 +149,7 @@ public void test_FailureDetectionTime_EnhancedMonitoringEnabled(final String efm OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); + RdsHostListProvider.clearAll(); MonitoringRdsHostListProvider.clearCache(); enhancedFailureMonitoringPerfDataList.clear(); @@ -231,7 +231,7 @@ public void test_FailureDetectionTime_FailoverAndEnhancedMonitoringEnabled(final OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); + RdsHostListProvider.clearAll(); MonitoringRdsHostListProvider.clearCache(); failoverWithEfmPerfDataList.clear(); @@ -319,7 +319,7 @@ private void test_FailoverTime_SocketTimeout(final String plugins) throws IOExce OpenedConnectionTracker.clearCache(); HostMonitorThreadContainer.releaseInstance(); HostMonitorServiceImpl.closeAllMonitors(); - AuroraHostListProvider.clearAll(); + RdsHostListProvider.clearAll(); MonitoringRdsHostListProvider.clearCache(); failoverWithSocketTimeoutPerfDataList.clear(); diff --git a/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java b/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java index b8c96edbe..8b3accba1 100644 --- a/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java +++ b/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java @@ -73,7 +73,7 @@ import software.amazon.jdbc.HikariPooledConnectionProvider; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverFailedSQLException; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; @@ -122,7 +122,7 @@ public void tearDownEach() { protected static Properties getProxiedPropsWithFailover() { final Properties props = getPropsWithFailover(); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); return props; @@ -130,7 +130,7 @@ protected static Properties getProxiedPropsWithFailover() { protected static Properties getProxiedProps() { final Properties props = getProps(); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); return props; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java deleted file mode 100644 index af3955e09..000000000 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java +++ /dev/null @@ -1,463 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doAnswer; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; -import org.mockito.Mock; -import org.mockito.Mockito; -import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.events.EventPublisher; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.storage.TestStorageServiceImpl; - -class RdsMultiAzDbClusterListProviderTest { - private StorageService storageService; - private RdsMultiAzDbClusterListProvider rdsMazDbClusterHostListProvider; - - @Mock private Connection mockConnection; - @Mock private Statement mockStatement; - @Mock private ResultSet mockResultSet; - @Mock private FullServicesContainer mockServicesContainer; - @Mock private PluginService mockPluginService; - @Mock private HostListProviderService mockHostListProviderService; - @Mock private EventPublisher mockEventPublisher; - @Mock private TopologyDialect mockDialect; - @Captor private ArgumentCaptor queryCaptor; - - private AutoCloseable closeable; - private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("foo").port(1234).build(); - private final List hosts = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); - - @BeforeEach - void setUp() throws SQLException { - closeable = MockitoAnnotations.openMocks(this); - storageService = new TestStorageServiceImpl(mockEventPublisher); - when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); - when(mockServicesContainer.getStorageService()).thenReturn(storageService); - when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); - when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); - when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); - when(mockConnection.createStatement()).thenReturn(mockStatement); - when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); - when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); - when(mockHostListProviderService.getHostSpecBuilder()) - .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); - } - - @AfterEach - void tearDown() throws Exception { - RdsMultiAzDbClusterListProvider.clearAll(); - storageService.clearAll(); - closeable.close(); - } - - private RdsMultiAzDbClusterListProvider getRdsMazDbClusterHostListProvider(String originalUrl) throws SQLException { - RdsMultiAzDbClusterListProvider provider = - new RdsMultiAzDbClusterListProvider(mockDialect, new Properties(), originalUrl, mockServicesContainer); - provider.init(); - // provider.clusterId = "cluster-id"; - return provider; - } - - @Test - void testGetTopology_returnCachedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("protocol://url/")); - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, false); - assertEquals(expected, result.hosts); - assertEquals(2, result.hosts.size()); - verify(rdsMazDbClusterHostListProvider, never()).queryForTopology(mockConnection); - } - - @Test - void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.isInitialized = true; - - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(hosts)); - - final List newHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, true); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(newHosts, result.hosts); - } - - @Test - void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clusterId = "cluster-id"; - rdsMazDbClusterHostListProvider.isInitialized = true; - - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - doReturn(new ArrayList<>()).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, false); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(2, result.hosts.size()); - assertEquals(expected, result.hosts); - } - - @Test - void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clear(); - - doReturn(new ArrayList<>()).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, true); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertNotNull(result.hosts); - assertEquals( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), - result.hosts); - } - - @Test - void testQueryForTopology_queryResultsInException() throws SQLException { - rdsMazDbClusterHostListProvider = getRdsMazDbClusterHostListProvider("protocol://url/"); - when(mockStatement.executeQuery(queryCaptor.capture())).thenThrow(new SQLSyntaxErrorException()); - - assertThrows( - SQLException.class, - () -> rdsMazDbClusterHostListProvider.queryForTopology(mockConnection)); - } - - @Test - void testGetCachedTopology_returnCachedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url"); - - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - final List result = rdsMazDbClusterHostListProvider.getStoredTopology(); - assertEquals(expected, result); - } - - @Test - void testTopologyCache_NoSuggestedClusterId() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-a.domain.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - - doReturn(topologyClusterA) - .when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-b.domain.com/")); - provider2.init(); - assertNull(provider2.getStoredTopology()); - - final List topologyClusterB = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(2, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForRds() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForInstance() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://instance-a-3.xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_AcceptSuggestion() throws SQLException { - RdsMultiAzDbClusterListProvider.clearAll(); - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://instance-a-2.xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doAnswer(a -> topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - // RdsMultiAzDbClusterListProvider.logCache(); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider( - "jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - doAnswer(a -> topologyClusterA).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertNotEquals(provider1.clusterId, provider2.clusterId); - assertFalse(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - assertEquals(2, storageService.size(Topology.class)); - assertEquals("cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com", - RdsMultiAzDbClusterListProvider.suggestedPrimaryClusterIdCache.get(provider1.clusterId)); - - // RdsMultiAzDbClusterListProvider.logCache(); - - topologyProvider1 = provider1.forceRefresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - // RdsMultiAzDbClusterListProvider.logCache(); - } - - @Test - void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - - when(mockResultSet.next()).thenReturn(false); - assertThrows(SQLException.class, () -> rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - - when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); - assertThrows(SQLException.class, () -> rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionNullTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("?.pattern").build(); - - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); - doReturn(null).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(null).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostNotInTopology() throws SQLException { - final List cachedTopology = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build()); - - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostInTopology() throws SQLException { - final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .hostId("instance-a-1") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(); - final List cachedTopology = Collections.singletonList(expectedHost); - - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-a-1"); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - final HostSpec actual = rdsMazDbClusterHostListProvider.identifyConnection(mockConnection); - assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); - assertEquals("instance-a-1", actual.getHostId()); - } - -} diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java index 1fb98265e..d49f76b58 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java @@ -58,7 +58,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUrlType; @@ -87,7 +87,7 @@ class FailoverConnectionPluginTest { @Mock Connection mockConnection; @Mock HostSpec mockHostSpec; @Mock HostListProviderService mockHostListProviderService; - @Mock AuroraHostListProvider mockHostListProvider; + @Mock RdsHostListProvider mockHostListProvider; @Mock JdbcCallable mockInitHostProviderFunc; @Mock ReaderFailoverHandler mockReaderFailoverHandler; @Mock WriterFailoverHandler mockWriterFailoverHandler; From 9332a7a94df9a9bf2a65a99a4830e2725c134816 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 09:31:21 -0700 Subject: [PATCH 15/90] Fix messages --- .../jdbc/dialect/AuroraDialectUtils.java | 4 ++-- .../jdbc/dialect/MultiAzDialectUtils.java | 2 +- .../amazon/jdbc/util/TopologyUtils.java | 6 ++--- ..._advanced_jdbc_wrapper_messages.properties | 22 ++++++++----------- 4 files changed, 15 insertions(+), 19 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java index 647e93cc2..2e4c0fe62 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -44,7 +44,7 @@ public AuroraDialectUtils(String writerIdQuery) { throws SQLException { if (resultSet.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("AuroraTopologyProcessor.unexpectedTopologyQueryColumnCount")); + LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); return null; } @@ -56,7 +56,7 @@ public AuroraDialectUtils(String writerIdQuery) { hosts.add(createHost(resultSet)); } catch (Exception e) { LOGGER.finest( - Messages.get("AuroraTopologyProcessor.errorProcessingQueryResults", new Object[]{e.getMessage()})); + Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); return null; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java index 3a3075429..a598d59a7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -50,7 +50,7 @@ public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, Str hosts.add(host); } catch (Exception e) { LOGGER.finest( - Messages.get("ClusterTopologyMonitorImpl.errorProcessingQueryResults", new Object[]{e.getMessage()})); + Messages.get("MultiAzDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); return null; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java index 59a494322..2d9315926 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -102,7 +102,7 @@ public TopologyUtils( int writerCount = writers.size(); if (writerCount == 0) { - LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.invalidTopology")); + LOGGER.warning(() -> Messages.get("TopologyUtils.invalidTopology")); return null; } else if (writerCount == 1) { hosts.add(writers.get(0)); @@ -163,9 +163,9 @@ public HostRole getHostRole(Connection conn) throws SQLException { return isReader ? HostRole.READER : HostRole.WRITER; } } catch (SQLException e) { - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole"), e); + throw new SQLException(Messages.get("TopologyUtils.errorGettingHostRole"), e); } - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); + throw new SQLException(Messages.get("TopologyUtils.errorGettingHostRole")); } } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index e67efb909..3e32cbf0a 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -27,9 +27,8 @@ AdfsCredentialsProviderFactory.signOnPagePostActionRequestFailed=ADFS SignOn Pag AdfsCredentialsProviderFactory.signOnPageRequestFailed=ADFS SignOn Page Request Failed with HTTP status ''{0}'', reason phrase ''{1}'', and response ''{2}'' AdfsCredentialsProviderFactory.signOnPageUrl=ADFS SignOn URL: ''{0}'' -AuroraTopologyProcessor.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} -AuroraDialect.invalidTopology=The topology query returned an invalid topology - no writer instance detected. -AuroraTopologyProcessor.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. +AuroraDialectUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} +AuroraDialectUtils.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. AuthenticationToken.useCachedToken=Use cached authentication token = ''{0}'' AuthenticationToken.generatedNewToken=Generated new authentication token = ''{0}'' @@ -38,13 +37,9 @@ AuthenticationToken.javaSdkNotInClasspath=Required dependency 'AWS Java SDK RDS RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy=An RDS Proxy url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom=A custom RDS url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.invalidPattern=Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host pattern must contain a '?' character as a placeholder for the DB instance identifiers of the instances in the cluster. -RdsHostListProvider.invalidTopology=The topology query returned an invalid topology - no writer instance detected. RdsHostListProvider.suggestedClusterId=ClusterId ''{0}'' is suggested for url ''{1}''. RdsHostListProvider.parsedListEmpty=Can''t parse connection string: ''{0}'' -RdsHostListProvider.invalidQuery=Error obtaining host list. Provided database might not be an Aurora Db cluster -RdsHostListProvider.errorGettingHostRole=An error occurred while obtaining the connected host's role. This could occur if the connection is broken or if you are not connected to an Aurora database. RdsHostListProvider.errorIdentifyConnection=An error occurred while obtaining the connection's host ID. -RdsHostListProvider.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} AwsSdk.unsupportedRegion=Unsupported AWS region ''{0}''. For supported regions please read https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html @@ -251,7 +246,6 @@ HostMonitorImpl.interruptedExceptionDuringMonitoring=Monitoring thread for node HostMonitorImpl.exceptionDuringMonitoringContinue=Continuing monitoring after unhandled exception was thrown in monitoring thread for node {0}. HostMonitorImpl.exceptionDuringMonitoringStop=Stopping monitoring after unhandled exception was thrown in monitoring thread for node {0}. HostMonitorImpl.monitorIsStopped=Monitoring was already stopped for node {0}. -HostMonitorImpl.stopped=Stopped monitoring thread for node ''{0}''. HostMonitorImpl.startMonitoringThreadNewContext=Start monitoring thread for checking new contexts for {0}. HostMonitorImpl.stopMonitoringThreadNewContext=Stop monitoring thread for checking new contexts for {0}. HostMonitorImpl.startMonitoringThread=Start monitoring thread for {0}. @@ -272,6 +266,8 @@ MonitorServiceImpl.stopAndRemoveMissingMonitorType=The monitor service received MonitorServiceImpl.stopAndRemoveMonitorsMissingType=The monitor service received a request to stop all monitors with type ''{0}'', but the monitor service does not have any monitors registered under the given type. Please ensure monitors are registered under the correct type. MonitorServiceImpl.unexpectedMonitorClass=Monitor type mismatch - the monitor ''{0}'' was unexpectedly found under the ''{1}'' monitor class category. Please verify that monitors are submitted under their concrete class. +MultiAzDialectUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} + NodeMonitoringThread.detectedWriter=Writer detected by node monitoring thread: ''{0}''. NodeMonitoringThread.invalidWriterQuery=The writer topology query is invalid: {0} NodeMonitoringThread.threadCompleted=Node monitoring thread completed in {0} ms. @@ -360,16 +356,16 @@ TargetDriverDialectManager.unexpectedClass=Unexpected DataSource class. Expected TargetDriverDialect.unsupported=This target driver dialect does not support this operation. MysqlConnectorJDriverHelper.canNotRegister=Can''t register driver com.mysql.cj.jdbc.Driver. +TopologyUtils.errorGettingHostRole=An error occurred while obtaining the connected host's role. This could occur if the connection is broken or if you are not connected to an Aurora database. TopologyUtils.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} -TopologyUtils.topologyDialectRequired=Unable to fetch topology because the dialect does not support topology queries. Dialect: {0} -TopologyUtils.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS Db cluster. +TopologyUtils.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS cluster. +TopologyUtils.invalidTopology=The topology query returned an invalid topology - no writer instance detected. MariadbDriverHelper.canNotRegister=Can''t register driver org.mariadb.jdbc.Driver. AuroraInitialConnectionStrategyPlugin.unsupportedStrategy=Unsupported host selection strategy ''{0}''. AuroraInitialConnectionStrategyPlugin.requireDynamicProvider=Dynamic host list provider is required. -NodeResponseTimeMonitor.stopped=Stopped Response time thread for node ''{0}''. NodeResponseTimeMonitor.responseTime=Response time for ''{0}'': {1} ms NodeResponseTimeMonitor.interruptedExceptionDuringMonitoring=Response time thread for node {0} was interrupted. NodeResponseTimeMonitor.exceptionDuringMonitoringStop=Stopping thread after unhandled exception was thrown in Response time thread for node {0}. @@ -379,7 +375,7 @@ NodeResponseTimeMonitor.openedConnection=Opened Response time connection: {0}. ClusterTopologyMonitorImpl.startMonitoringThread=[clusterId: ''{0}''] Start cluster topology monitoring thread for ''{1}''. ClusterTopologyMonitorImpl.stopMonitoringThread=Stop cluster topology monitoring thread for ''{0}''. ClusterTopologyMonitorImpl.exceptionDuringMonitoringStop=Stopping cluster topology monitoring after unhandled exception was thrown in monitoring thread for node ''{0}''. -ClusterTopologyMonitorImpl.topologyNotUpdated=Topology hasn''t been updated after {0} ms. +ClusterTopologyMonitorImpl.topologyNotUpdated=Topology has not been updated after {0} ms. ClusterTopologyMonitorImpl.openedMonitoringConnection=Opened monitoring connection to node ''{0}''. ClusterTopologyMonitorImpl.ignoringTopologyRequest=A topology refresh was requested, but the topology was already updated recently. Returning cached hosts: ClusterTopologyMonitorImpl.timeoutSetToZero=A topology refresh was requested, but the given timeout for the request was 0ms. Returning cached hosts: @@ -408,7 +404,7 @@ bgd.interrupted=[{0}] Interrupted. bgd.monitoringUnhandledException=[{0}] Unhandled exception while monitoring blue/green status. bgd.threadCompleted=[{0}] Blue/green status monitoring thread is completed. bgd.statusNotAvailable=[{0}] (status not available) currentPhase: {1} -bgd.usesVersion=[{0}] Blue/Green deployment uses version ''{1}'' which the driver doesn''t support. Version ''{2}'' will be used instead. +bgd.usesVersion=[{0}] Blue/Green deployment uses version ''{1}'' which the driver does not support. Version ''{2}'' will be used instead. bgd.noEntriesInStatusTable=[{0}] No entries in status table. bgd.exception=[{0}] currentPhase: {1}, exception while querying for blue/green status. bgd.unhandledSqlException=[{0}] Unhandled SQLException. From b5b7f5c794f62bcbc1e3a815d11143ce0803b6dd Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 09:40:13 -0700 Subject: [PATCH 16/90] Move HostListProvider/HostListProviderService to hostlistprovider package --- .../jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java | 2 +- .../software/amazon/jdbc/benchmarks/PluginBenchmarks.java | 2 +- .../amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java | 2 +- .../jdbc/benchmarks/testplugin/TestConnectionWrapper.java | 2 +- .../java/software/amazon/jdbc/BlockingHostListProvider.java | 1 + .../src/main/java/software/amazon/jdbc/ConnectionPlugin.java | 1 + .../java/software/amazon/jdbc/ConnectionPluginManager.java | 1 + .../main/java/software/amazon/jdbc/PartialPluginService.java | 2 ++ wrapper/src/main/java/software/amazon/jdbc/PluginService.java | 1 + .../src/main/java/software/amazon/jdbc/PluginServiceImpl.java | 2 ++ .../amazon/jdbc/dialect/HostListProviderSupplier.java | 2 +- .../hostlistprovider/ConnectionStringHostListProvider.java | 1 - .../amazon/jdbc/hostlistprovider/DynamicHostListProvider.java | 2 -- .../amazon/jdbc/{ => hostlistprovider}/HostListProvider.java | 4 +++- .../jdbc/{ => hostlistprovider}/HostListProviderService.java | 4 +++- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 1 - .../amazon/jdbc/hostlistprovider/StaticHostListProvider.java | 2 -- .../software/amazon/jdbc/plugin/AbstractConnectionPlugin.java | 2 +- .../jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java | 2 +- .../software/amazon/jdbc/plugin/DefaultConnectionPlugin.java | 3 +-- .../amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java | 2 +- .../amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java | 2 +- .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 2 +- .../plugin/readwritesplitting/ReadWriteSplittingPlugin.java | 2 +- .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 2 +- .../amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java | 2 +- .../java/software/amazon/jdbc/util/FullServicesContainer.java | 2 +- .../software/amazon/jdbc/util/FullServicesContainerImpl.java | 2 +- .../main/java/software/amazon/jdbc/util/ServiceUtility.java | 2 +- .../java/software/amazon/jdbc/wrapper/ConnectionWrapper.java | 2 +- .../test/java/software/amazon/jdbc/DialectDetectionTests.java | 1 + .../java/software/amazon/jdbc/PluginServiceImplTests.java | 1 + .../amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java | 1 - .../test/java/software/amazon/jdbc/mock/TestPluginOne.java | 2 +- .../jdbc/plugin/failover/FailoverConnectionPluginTest.java | 2 +- .../jdbc/plugin/limitless/LimitlessConnectionPluginTest.java | 2 +- .../jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java | 2 +- .../readwritesplitting/ReadWriteSplittingPluginTest.java | 2 +- 38 files changed, 39 insertions(+), 33 deletions(-) rename wrapper/src/main/java/software/amazon/jdbc/{ => hostlistprovider}/HostListProvider.java (93%) rename wrapper/src/main/java/software/amazon/jdbc/{ => hostlistprovider}/HostListProviderService.java (89%) diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java index 413a37e03..4963c09de 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java @@ -53,7 +53,7 @@ import software.amazon.jdbc.ConnectionPluginFactory; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.JdbcMethod; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java index a9c10b2f6..4d5ae319a 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java @@ -53,7 +53,7 @@ import software.amazon.jdbc.ConnectionProviderManager; import software.amazon.jdbc.Driver; import software.amazon.jdbc.HikariPooledConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.JdbcMethod; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java index ffed10f77..07fede27a 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java @@ -28,7 +28,7 @@ import java.util.Set; import java.util.logging.Logger; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java index a3c0cd7f2..483d6768c 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java @@ -20,7 +20,7 @@ import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.wrapper.ConnectionWrapper; diff --git a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java index 9fe7e40fb..31f3d1182 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java @@ -19,6 +19,7 @@ import java.sql.SQLException; import java.util.List; import java.util.concurrent.TimeoutException; +import software.amazon.jdbc.hostlistprovider.HostListProvider; public interface BlockingHostListProvider extends HostListProvider { diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java index d2d72b05c..ad271f2ad 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java @@ -23,6 +23,7 @@ import java.util.Map; import java.util.Properties; import java.util.Set; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; /** * Interface for connection plugins. This class implements ways to execute a JDBC method and to clean up resources used diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java index 2697c5b03..33f7618b9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java @@ -30,6 +30,7 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AuroraConnectionTrackerPlugin; import software.amazon.jdbc.plugin.AuroraInitialConnectionStrategyPlugin; import software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 51ee4d6fd..189c03c62 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -41,6 +41,8 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.HostAvailabilityStrategyFactory; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.states.SessionStateService; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index b01679aba..e3cbada1d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -28,6 +28,7 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index dd8aa420b..2c34797a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -46,6 +46,8 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.HostAvailabilityStrategyFactory; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.states.SessionStateService; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java index 0dfe44dc5..bee378f9f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java @@ -18,7 +18,7 @@ import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.util.FullServicesContainer; @FunctionalInterface diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 80f55bdad..bbf3209ed 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -25,7 +25,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.ConnectionUrlParser; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index 451c047f3..c4ef01aae 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,8 +16,6 @@ package software.amazon.jdbc.hostlistprovider; -import software.amazon.jdbc.HostListProvider; - // A marker interface for providers that can fetch a host list, and it changes depending on database status // A good example of such provider would be DB cluster provider (Aurora DB clusters, patroni DB clusters, etc.) // where cluster topology (nodes, their roles, their statuses) changes over time. diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java similarity index 93% rename from wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index 1a147658f..206a35415 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -14,12 +14,14 @@ * limitations under the License. */ -package software.amazon.jdbc; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; import java.sql.SQLException; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; public interface HostListProvider { diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java similarity index 89% rename from wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java index b2f6b5353..0413cb423 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java @@ -14,9 +14,11 @@ * limitations under the License. */ -package software.amazon.jdbc; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.Dialect; public interface HostListProviderService { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 65054208b..262f65f23 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -33,7 +33,6 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java index b37eb4cc3..8229e2cd3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java @@ -16,8 +16,6 @@ package software.amazon.jdbc.hostlistprovider; -import software.amazon.jdbc.HostListProvider; - // A marker interface for providers that fetch node lists, and it never changes since after. // An example of such provider is a provider that use connection string as a source. public interface StaticHostListProvider extends HostListProvider {} diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java index 035e4ecf9..22c5b13aa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java @@ -24,7 +24,7 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 568f12cb6..42cefc684 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -27,7 +27,7 @@ import java.util.concurrent.TimeUnit; import java.util.logging.Logger; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java index b879ba60b..b69c1cdad 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java @@ -16,7 +16,6 @@ package software.amazon.jdbc.plugin; -import java.beans.beancontext.BeanContext; import java.sql.Connection; import java.sql.SQLException; import java.util.ArrayList; @@ -35,7 +34,7 @@ import software.amazon.jdbc.ConnectionPlugin; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 057b152a6..637791549 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -43,7 +43,7 @@ import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 85dd4a52a..a0dfdb7e9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -33,7 +33,7 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 19b8710a4..daf670f79 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -31,7 +31,7 @@ import java.util.logging.Logger; import java.util.stream.Collectors; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 2d25675e2..27263c19c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -28,7 +28,7 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 6ad27b8a2..8aacc6528 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Properties; import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index a5babfc3c..b3cea1d1d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -25,7 +25,7 @@ import java.util.Properties; import java.util.Set; import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.JdbcMethod; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java index 7b7857175..cbe122ed8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java @@ -18,7 +18,7 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.monitoring.MonitorService; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java index db0ea3f57..349239668 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java @@ -18,7 +18,7 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.monitoring.MonitorService; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index fe150f835..e06261bcb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -21,7 +21,7 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.PartialPluginService; import software.amazon.jdbc.PluginServiceImpl; import software.amazon.jdbc.dialect.Dialect; diff --git a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java index c29f11c2a..a57d23183 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java @@ -39,7 +39,7 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.JdbcMethod; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java index 3b47f12bb..d86238214 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java @@ -50,6 +50,7 @@ import software.amazon.jdbc.dialect.RdsMysqlDialect; import software.amazon.jdbc.dialect.RdsPgDialect; import software.amazon.jdbc.exceptions.ExceptionManager; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.storage.StorageService; diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index db9a072a1..5ef1235ad 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -62,6 +62,7 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.profile.ConfigurationProfileBuilder; import software.amazon.jdbc.states.SessionStateService; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 3574af62a..e5e00aeaf 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -55,7 +55,6 @@ import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java index 9ca4c86dd..36f077f73 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java +++ b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java @@ -27,7 +27,7 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java index d49f76b58..859472bb4 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java @@ -49,7 +49,7 @@ import org.junit.jupiter.params.provider.ValueSource; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java index 411233100..13de74a6b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java @@ -35,7 +35,7 @@ import org.mockito.MockitoAnnotations; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java index 7c12f83fb..0b3e7c2a5 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java @@ -39,7 +39,7 @@ import org.mockito.MockitoAnnotations; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.HighestWeightHostSelector; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java index c7c7bdc1b..834e932d2 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java @@ -45,7 +45,7 @@ import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; From 15c9a47deae3bf27191b4dd261b6e3c1be695dd0 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 10:08:35 -0700 Subject: [PATCH 17/90] node -> instance, suggestedWriter -> writer --- .../amazon/jdbc/dialect/AuroraDialectUtils.java | 9 +++------ .../amazon/jdbc/dialect/AuroraMysqlDialect.java | 10 ++++------ .../amazon/jdbc/dialect/AuroraPgDialect.java | 13 ++++++------- .../jdbc/dialect/MultiAzDialectUtils.java | 12 ++++++------ .../RdsMultiAzDbClusterMysqlDialect.java | 16 ++++++++-------- .../dialect/RdsMultiAzDbClusterPgDialect.java | 17 +++++++++-------- .../amazon/jdbc/dialect/TopologyDialect.java | 3 +-- 7 files changed, 37 insertions(+), 43 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java index 2e4c0fe62..6d168153a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -26,15 +26,12 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; -import org.jsoup.internal.StringUtil; -import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.Utils; public class AuroraDialectUtils { private static final Logger LOGGER = Logger.getLogger(AuroraDialectUtils.class.getName()); - protected String writerIdQuery; + protected final String writerIdQuery; public AuroraDialectUtils(String writerIdQuery) { this.writerIdQuery = writerIdQuery; @@ -66,7 +63,7 @@ public AuroraDialectUtils(String writerIdQuery) { protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { // According to the topology query the result set should contain 4 columns: - // node ID, 1/0 (writer/reader), CPU utilization, instance lag + // instance ID, 1/0 (writer/reader), CPU utilization, instance lag String hostName = resultSet.getString(1); final boolean isWriter = resultSet.getBoolean(2); final float cpuUtilization = resultSet.getFloat(3); @@ -78,7 +75,7 @@ protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQL lastUpdateTime = Timestamp.from(Instant.now()); } - // Calculate weight based on node lag in time and CPU utilization. + // Calculate weight based on instance lag in time and CPU utilization. final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); return new TopologyQueryHostSpec(hostName, isWriter, weight, lastUpdateTime); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index c4c22b2eb..ce52f6532 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -23,8 +23,6 @@ import java.util.Collections; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -33,14 +31,14 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, REPLICA_LAG_IN_MILLISECONDS, LAST_UPDATE_TIMESTAMP " + "FROM information_schema.replica_host_status " - // filter out nodes that haven't been updated in the last 5 minutes + // filter out instances that haven't been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; private static final String IS_WRITER_QUERY = "SELECT SERVER_ID FROM information_schema.replica_host_status " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; - private static final String NODE_ID_QUERY = "SELECT @@aurora_server_id"; + private static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; private static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; private static final String BG_STATUS_QUERY = @@ -118,7 +116,7 @@ public String getTopologyQuery() { } @Override - public @Nullable List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + public @Nullable List processQueryResults(ResultSet rs, @Nullable String writerId) throws SQLException { return AuroraMysqlDialect.dialectUtils.processQueryResults(rs); } @@ -141,7 +139,7 @@ public String getIsReaderQuery() { @Override public String getInstanceIdQuery() { - return NODE_ID_QUERY; + return INSTANCE_ID_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 191ac849f..2d74d2db4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -23,7 +23,6 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.util.DriverInfo; @@ -45,18 +44,18 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror "SELECT SERVER_ID, CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, COALESCE(REPLICA_LAG_IN_MSEC, 0), LAST_UPDATE_TIMESTAMP " + "FROM pg_catalog.aurora_replica_status() " - // filter out nodes that haven't been updated in the last 5 minutes + // filter out instances that haven't been updated in the last 5 minutes + "WHERE EXTRACT(" + "EPOCH FROM(pg_catalog.NOW() OPERATOR(pg_catalog.-) LAST_UPDATE_TIMESTAMP)) OPERATOR(pg_catalog.<=) 300 " + "OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "OR LAST_UPDATE_TIMESTAMP IS NULL"; - private static final String IS_WRITER_QUERY = + private static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM pg_catalog.aurora_replica_status() " + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()"; - private static final String NODE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; + private static final String INSTANCE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; protected static final String LIMITLESS_ROUTER_ENDPOINT_QUERY = "select router_endpoint, load from pg_catalog.aurora_limitless_router_endpoints()"; @@ -68,7 +67,7 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror private static final String TOPOLOGY_TABLE_EXIST_QUERY = "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; - private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); + private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); @Override public boolean isDialect(final Connection connection) { @@ -158,7 +157,7 @@ public String getIsReaderQuery() { @Override public String getInstanceIdQuery() { - return NODE_ID_QUERY; + return INSTANCE_ID_QUERY; } @Override @@ -173,7 +172,7 @@ public boolean isWriterInstance(Connection connection) throws SQLException { } @Override - public @Nullable List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + public @Nullable List processQueryResults(ResultSet rs, @Nullable String writerId) throws SQLException { return AuroraPgDialect.dialectUtils.processQueryResults(rs); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java index a598d59a7..7c402bc78 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -41,12 +41,12 @@ public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, Str this.instanceIdQuery = instanceIdQuery; } - public @Nullable List processQueryResults(ResultSet resultSet, String suggestedWriterId) + public @Nullable List processQueryResults(ResultSet resultSet, String writerId) throws SQLException { List hosts = new ArrayList<>(); while (resultSet.next()) { try { - final TopologyQueryHostSpec host = createHost(resultSet, suggestedWriterId); + final TopologyQueryHostSpec host = createHost(resultSet, writerId); hosts.add(host); } catch (Exception e) { LOGGER.finest( @@ -60,12 +60,12 @@ public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, Str protected TopologyQueryHostSpec createHost( final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { + final String writerId) throws SQLException { String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" String hostId = resultSet.getString("id"); // "1034958454" - final boolean isWriter = hostId.equals(suggestedWriterNodeId); + final boolean isWriter = hostId.equals(writerId); return new TopologyQueryHostSpec(instanceName, isWriter, 0, Timestamp.from(Instant.now())); } @@ -96,10 +96,10 @@ public boolean isWriterInstance(final Connection connection) throws SQLException try (final Statement stmt = connection.createStatement()) { try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { if (resultSet.next()) { - String nodeId = resultSet.getString(this.writerIdQueryColumn); + String instanceId = resultSet.getString(this.writerIdQueryColumn); // The writer ID is only returned when connected to a reader, so if the query does not return a value, it // means we are connected to a writer. - return StringUtils.isNullOrEmpty(nodeId); + return StringUtils.isNullOrEmpty(instanceId); } } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index da55b460a..90e99c478 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -43,12 +43,12 @@ public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect implements Top "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; - // For reader nodes, the query returns a writer node ID. For a writer node, the query returns no data. - private static final String FETCH_WRITER_NODE_QUERY = "SHOW REPLICA STATUS"; + // For reader instances, the query returns a writer instance ID. For a writer instance, the query returns no data. + private static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; - private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "Source_Server_Id"; + private static final String WRITER_ID_QUERY_COLUMN = "Source_Server_Id"; - private static final String NODE_ID_QUERY = "SELECT @@server_id"; + private static final String INSTANCE_ID_QUERY = "SELECT @@server_id"; private static final String IS_READER_QUERY = "SELECT @@read_only"; private static final EnumSet RDS_MULTI_AZ_RESTRICTIONS = @@ -56,7 +56,7 @@ public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect implements Top protected final RdsUtils rdsUtils = new RdsUtils(); protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - FETCH_WRITER_NODE_QUERY, FETCH_WRITER_NODE_QUERY_COLUMN_NAME, NODE_ID_QUERY); + WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN, INSTANCE_ID_QUERY); @Override public boolean isDialect(final Connection connection) { @@ -130,9 +130,9 @@ public String getTopologyQuery() { } @Override - public List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) + public List processQueryResults(ResultSet rs, @Nullable String writerId) throws SQLException { - return dialectUtils.processQueryResults(rs, suggestedWriterId); + return dialectUtils.processQueryResults(rs, writerId); } @Override @@ -152,6 +152,6 @@ public String getIsReaderQuery() { @Override public String getInstanceIdQuery() { - return NODE_ID_QUERY; + return INSTANCE_ID_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index 14041d849..772e836a8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -40,8 +40,9 @@ public class RdsMultiAzDbClusterPgDialect extends PgDialect implements TopologyD private static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - // For reader nodes, the query should return a writer node ID. For a writer node, the query should return no data. - private static final String FETCH_WRITER_NODE_QUERY = + // For reader instances, the query should return a writer instance ID. + // For a writer instance, the query should return no data. + private static final String WRITER_ID_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" + " (SELECT dbi_resource_id FROM rds_tools.dbi_resource_id())"; @@ -49,14 +50,14 @@ public class RdsMultiAzDbClusterPgDialect extends PgDialect implements TopologyD private static final String IS_RDS_CLUSTER_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; - private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "multi_az_db_cluster_source_dbi_resource_id"; + private static final String WRITER_ID_QUERY_COLUMN = "multi_az_db_cluster_source_dbi_resource_id"; - private static final String NODE_ID_QUERY = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()"; + private static final String INSTANCE_ID_QUERY = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()"; private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - FETCH_WRITER_NODE_QUERY, FETCH_WRITER_NODE_QUERY_COLUMN_NAME, NODE_ID_QUERY); + WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN, INSTANCE_ID_QUERY); @Override public ExceptionHandler getExceptionHandler() { @@ -116,12 +117,12 @@ public String getIsReaderQuery() { @Override public String getInstanceIdQuery() { - return NODE_ID_QUERY; + return INSTANCE_ID_QUERY; } @Override - public @Nullable List processQueryResults(ResultSet rs, String suggestedWriterId) + public @Nullable List processQueryResults(ResultSet rs, String writerId) throws SQLException { - return this.dialectUtils.processQueryResults(rs, suggestedWriterId); + return this.dialectUtils.processQueryResults(rs, writerId); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index 928309741..57422b559 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -26,8 +26,7 @@ public interface TopologyDialect extends Dialect { String getTopologyQuery(); @Nullable - List processQueryResults(ResultSet rs, @Nullable String suggestedWriterId) - throws SQLException; + List processQueryResults(ResultSet rs, @Nullable String writerId) throws SQLException; @Nullable String getWriterId(final Connection connection) throws SQLException; From d021e00564adb3aa909f1a65130aa00370d0b506 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 10:22:02 -0700 Subject: [PATCH 18/90] Remove getWriterId from TopologyDialect --- .../software/amazon/jdbc/dialect/AuroraMysqlDialect.java | 9 +-------- .../software/amazon/jdbc/dialect/AuroraPgDialect.java | 8 +------- .../amazon/jdbc/dialect/MultiAzDialectUtils.java | 8 ++++---- .../jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java | 9 ++------- .../jdbc/dialect/RdsMultiAzDbClusterPgDialect.java | 9 ++------- .../software/amazon/jdbc/dialect/TopologyDialect.java | 5 +---- .../java/software/amazon/jdbc/util/TopologyUtils.java | 3 +-- 7 files changed, 12 insertions(+), 39 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index ce52f6532..a890b4f29 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -116,17 +116,10 @@ public String getTopologyQuery() { } @Override - public @Nullable List processQueryResults(ResultSet rs, @Nullable String writerId) - throws SQLException { + public @Nullable List processQueryResults(Connection conn, ResultSet rs) throws SQLException { return AuroraMysqlDialect.dialectUtils.processQueryResults(rs); } - @Override - @Nullable public String getWriterId(final Connection connection) { - // The Aurora topology query can detect the writer without a suggested writer ID, so we intentionally return null. - return null; - } - @Override public boolean isWriterInstance(Connection connection) throws SQLException { return dialectUtils.isWriterInstance(connection); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 2d74d2db4..c93d306d9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -160,19 +160,13 @@ public String getInstanceIdQuery() { return INSTANCE_ID_QUERY; } - @Override - @Nullable public String getWriterId(final Connection connection) { - // The Aurora topology query can detect the writer without a suggested writer ID, so we intentionally return null. - return null; - } - @Override public boolean isWriterInstance(Connection connection) throws SQLException { return AuroraPgDialect.dialectUtils.isWriterInstance(connection); } @Override - public @Nullable List processQueryResults(ResultSet rs, @Nullable String writerId) + public @Nullable List processQueryResults(Connection conn, ResultSet rs) throws SQLException { return AuroraPgDialect.dialectUtils.processQueryResults(rs); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java index 7c402bc78..5cdcb5e66 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -41,12 +41,12 @@ public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, Str this.instanceIdQuery = instanceIdQuery; } - public @Nullable List processQueryResults(ResultSet resultSet, String writerId) + public @Nullable List processQueryResults(Connection conn, ResultSet resultSet) throws SQLException { List hosts = new ArrayList<>(); while (resultSet.next()) { try { - final TopologyQueryHostSpec host = createHost(resultSet, writerId); + final TopologyQueryHostSpec host = createHost(resultSet, this.getWriterId(conn)); hosts.add(host); } catch (Exception e) { LOGGER.finest( @@ -60,7 +60,7 @@ public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, Str protected TopologyQueryHostSpec createHost( final ResultSet resultSet, - final String writerId) throws SQLException { + final @Nullable String writerId) throws SQLException { String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" @@ -70,7 +70,7 @@ protected TopologyQueryHostSpec createHost( return new TopologyQueryHostSpec(instanceName, isWriter, 0, Timestamp.from(Instant.now())); } - public @Nullable String getWriterId(Connection connection) throws SQLException { + protected @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { if (resultSet.next()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index 90e99c478..c318b6b3d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -130,14 +130,9 @@ public String getTopologyQuery() { } @Override - public List processQueryResults(ResultSet rs, @Nullable String writerId) + public List processQueryResults(Connection conn, ResultSet rs) throws SQLException { - return dialectUtils.processQueryResults(rs, writerId); - } - - @Override - public @Nullable String getWriterId(Connection connection) throws SQLException { - return dialectUtils.getWriterId(connection); + return dialectUtils.processQueryResults(conn, rs); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index 772e836a8..fe60cb2e1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -100,11 +100,6 @@ public String getTopologyQuery() { return TOPOLOGY_QUERY; } - @Override - public @Nullable String getWriterId(final Connection connection) throws SQLException { - return dialectUtils.getWriterId(connection); - } - @Override public boolean isWriterInstance(Connection connection) throws SQLException { return dialectUtils.isWriterInstance(connection); @@ -121,8 +116,8 @@ public String getInstanceIdQuery() { } @Override - public @Nullable List processQueryResults(ResultSet rs, String writerId) + public @Nullable List processQueryResults(Connection conn, ResultSet rs) throws SQLException { - return this.dialectUtils.processQueryResults(rs, writerId); + return this.dialectUtils.processQueryResults(conn, rs); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index 57422b559..f7cd8a694 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -26,10 +26,7 @@ public interface TopologyDialect extends Dialect { String getTopologyQuery(); @Nullable - List processQueryResults(ResultSet rs, @Nullable String writerId) throws SQLException; - - @Nullable - String getWriterId(final Connection connection) throws SQLException; + List processQueryResults(Connection conn, ResultSet rs) throws SQLException; // TODO: can we remove this and use getHostRole instead? boolean isWriterInstance(final Connection connection) throws SQLException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java index 2d9315926..598dc73bb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -71,10 +71,9 @@ public TopologyUtils( new Object[] {e.getMessage()})); } - final String writerId = this.dialect.getWriterId(conn); try (final Statement stmt = conn.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - List queryHosts = this.dialect.processQueryResults(resultSet, writerId); + List queryHosts = this.dialect.processQueryResults(conn, resultSet); return this.processQueryResults(queryHosts); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); From 2cb200aa579c7cede77d9e4f688e5325abecf0eb Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 17:03:53 -0700 Subject: [PATCH 19/90] Revert "wip" This reverts commit 9ce95e532e217b2bdd6fcb00ca7fc6eb37f445e0. --- .../main/java/software/amazon/jdbc/PluginServiceImpl.java | 2 +- .../plugin/AuroraInitialConnectionStrategyPlugin.java | 8 ++++---- .../failover/ClusterAwareWriterFailoverHandler.java | 4 ++-- .../jdbc/plugin/failover/FailoverConnectionPlugin.java | 2 +- .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 2 +- .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 2c34797a2..813d5dade 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -732,7 +732,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); // TODO: refreshHostList - this.refreshHostList(); + this.refreshHostList(connection); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 42cefc684..22672144a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -195,7 +195,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(writerCandidateConn); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); if (writerCandidate == null || writerCandidate.getRole() != HostRole.WRITER) { @@ -217,7 +217,7 @@ private Connection getVerifiedWriterConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(writerCandidateConn); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); continue; @@ -274,7 +274,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(readerCandidateConn); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); if (readerCandidate == null) { @@ -309,7 +309,7 @@ private Connection getVerifiedReaderConnection( // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(readerCandidateConn); if (this.hasNoReaders()) { // It seems that cluster has no readers. Simulate Aurora reader cluster endpoint logic diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 49f92b78b..9ffd4ef65 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -284,7 +284,7 @@ public WriterFailoverResult call() { conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(conn); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. @@ -446,7 +446,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(this.currentReaderConnection); final List topology = this.pluginService.getAllHosts(); if (!topology.isEmpty()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index a0dfdb7e9..86b92f8e1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -937,7 +937,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(); + this.pluginService.refreshHostList(conn); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index daf670f79..f1ec20f83 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -788,7 +788,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(); + this.pluginService.refreshHostList(conn); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 8aacc6528..985df22b5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -92,10 +92,10 @@ public Connection getVerifiedConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(); + this.pluginService.forceRefreshHostList(conn); } else { // TODO: refreshHostList - this.pluginService.refreshHostList(); + this.pluginService.refreshHostList(conn); } LOGGER.finest(() -> Utils.logTopology(this.pluginService.getAllHosts())); From 286e98cdbdbe36cb51f0374af83ea203ef0ee093 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 29 Oct 2025 17:09:16 -0700 Subject: [PATCH 20/90] Revert "wip" This reverts commit 9fdae84c7dfec6f9ef62450807b7f3d1a9bb4f50. --- .../java/software/amazon/jdbc/PluginServiceImpl.java | 1 - .../amazon/jdbc/dialect/AuroraMysqlDialect.java | 12 ++++++++++-- .../amazon/jdbc/dialect/AuroraPgDialect.java | 12 ++++++++++-- .../AuroraInitialConnectionStrategyPlugin.java | 4 ---- .../failover/ClusterAwareWriterFailoverHandler.java | 2 -- .../plugin/failover/FailoverConnectionPlugin.java | 1 - .../plugin/failover2/FailoverConnectionPlugin.java | 1 - .../jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 2 -- 8 files changed, 20 insertions(+), 15 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 813d5dade..69e4b6664 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -731,7 +731,6 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); - // TODO: refreshHostList this.refreshHostList(connection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index a890b4f29..7aa9e1d7c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -23,7 +23,10 @@ import java.util.Collections; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -89,8 +92,13 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> - new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + } + return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index c93d306d9..26dd11dc4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -23,7 +23,10 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; /** @@ -141,8 +144,13 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> - new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + } + return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 22672144a..a828183e1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -194,7 +194,6 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); @@ -216,7 +215,6 @@ private Connection getVerifiedWriterConnection( if (this.pluginService.getHostRole(writerCandidateConn) != HostRole.WRITER) { // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); @@ -273,7 +271,6 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); @@ -308,7 +305,6 @@ private Connection getVerifiedReaderConnection( if (this.pluginService.getHostRole(readerCandidateConn) != HostRole.READER) { // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); if (this.hasNoReaders()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 9ffd4ef65..8504842c6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -283,7 +283,6 @@ public WriterFailoverResult call() { } conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { @@ -445,7 +444,6 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(this.currentReaderConnection); final List topology = this.pluginService.getAllHosts(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 86b92f8e1..30fcb0701 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -936,7 +936,6 @@ public Connection connect( } if (isInitialConnection) { - // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index f1ec20f83..c0b1a7660 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -787,7 +787,6 @@ public Connection connect( } if (isInitialConnection) { - // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 985df22b5..6050df3ef 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -91,10 +91,8 @@ public Connection getVerifiedConnection( // This is if-statement is only reached if the connection url is a writer cluster endpoint. // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); } else { - // TODO: refreshHostList this.pluginService.refreshHostList(conn); } From b10371586929aaebbaf72d2b515d1afe4c0dc5da Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 29 Oct 2025 17:28:49 -0700 Subject: [PATCH 21/90] fix wrong nodeId in HostSpec (#1579) --- .../java/software/amazon/jdbc/HostSpec.java | 4 +-- .../jdbc/dialect/AuroraMysqlDialect.java | 2 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 3 +- .../RdsMultiAzDbClusterMysqlDialect.java | 6 +++- .../dialect/RdsMultiAzDbClusterPgDialect.java | 6 +++- .../ClusterTopologyMonitorImpl.java | 28 ++++++++++++++----- .../GlobalDbClusterTopologyMonitorImpl.java | 3 +- .../MultiAzClusterTopologyMonitorImpl.java | 2 +- 8 files changed, 39 insertions(+), 15 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java b/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java index 3b6f64ca1..5c3babb53 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java +++ b/wrapper/src/main/java/software/amazon/jdbc/HostSpec.java @@ -205,9 +205,9 @@ public Set asAliases() { } public String toString() { - return String.format("HostSpec@%s [host=%s, port=%d, %s, %s, weight=%d, %s]", + return String.format("HostSpec@%s [hostId=%s, host=%s, port=%d, %s, %s, weight=%d, %s]", Integer.toHexString(System.identityHashCode(this)), - this.host, this.port, this.role, this.availability, this.weight, this.lastUpdateTime); + this.hostId, this.host, this.port, this.role, this.availability, this.weight, this.lastUpdateTime); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 2f5a8c91c..1e44afdb0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -41,7 +41,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect "SELECT SERVER_ID FROM information_schema.replica_host_status " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; - protected final String nodeIdQuery = "SELECT @@aurora_server_id"; + protected final String nodeIdQuery = "SELECT @@aurora_server_id, @@aurora_server_id"; protected final String isReaderQuery = "SELECT @@innodb_read_only"; private static final String BG_STATUS_QUERY = diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index a12046ea4..c88f595af 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -58,7 +58,8 @@ public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()"; - protected final String nodeIdQuery = "SELECT pg_catalog.aurora_db_instance_identifier()"; + protected final String nodeIdQuery = + "SELECT pg_catalog.aurora_db_instance_identifier(), pg_catalog.aurora_db_instance_identifier()"; protected final String isReaderQuery = "SELECT pg_catalog.pg_is_in_recovery()"; protected static final String LIMITLESS_ROUTER_ENDPOINT_QUERY = "select router_endpoint, load from pg_catalog.aurora_limitless_router_endpoints()"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index 930cf1631..9c920c8e6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -47,7 +47,11 @@ public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect { private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "Source_Server_Id"; - private static final String NODE_ID_QUERY = "SELECT @@server_id"; + // The query return nodeId and nodeName. + // For example: "1845128080", "test-multiaz-instance-1" + private static final String NODE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + + " FROM mysql.rds_topology" + + " WHERE id = @@server_id"; private static final String IS_READER_QUERY = "SELECT @@read_only"; private static final EnumSet RDS_MULTI_AZ_RESTRICTIONS = diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index eb3796adb..0f6f51301 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -50,7 +50,11 @@ public class RdsMultiAzDbClusterPgDialect extends PgDialect { private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "multi_az_db_cluster_source_dbi_resource_id"; - private static final String NODE_ID_QUERY = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()"; + // The query return nodeId and nodeName. + // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" + private static final String NODE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + + " FROM rds_tools.show_topology()" + + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index e53d59420..80775f00d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -50,6 +50,7 @@ import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.ServiceUtility; @@ -536,10 +537,10 @@ protected List openAnyConnectionAndUpdateTopology() { "ClusterTopologyMonitorImpl.writerMonitoringConnection", new Object[]{this.writerHostSpec.get().getHost()})); } else { - final String nodeId = this.getNodeId(this.monitoringConnection.get()); - if (!StringUtils.isNullOrEmpty(nodeId)) { - this.writerHostSpec.set(this.createHost(nodeId, true, 0, null, - this.getClusterInstanceTemplate(nodeId, this.monitoringConnection.get()))); + final Pair pair = this.getNodeId(this.monitoringConnection.get()); + if (pair != null) { + this.writerHostSpec.set(this.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, + this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()))); LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", @@ -584,12 +585,23 @@ protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connecti return this.clusterInstanceTemplate; } - protected String getNodeId(final Connection connection) { + /** + * Identifies nodes across different database types using nodeId and nodeName values. + * + *

Database types handle these identifiers differently: + * - Aurora: Uses the instance (node) name as both nodeId and nodeName + * Example: "test-instance-1" for both values + * - RDS Cluster: Uses distinct values for nodeId and nodeName + * Example: + * nodeId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" + * nodeName: "test-multiaz-instance-1" + */ + protected Pair getNodeId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { if (resultSet.next()) { - return resultSet.getString(1); + return Pair.create(resultSet.getString(1), resultSet.getString(2)); } } } catch (SQLException ex) { @@ -780,10 +792,11 @@ protected HostSpec createHost( // Calculate weight based on node lag in time and CPU utilization. final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); + return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); } protected HostSpec createHost( + String nodeId, String nodeName, final boolean isWriter, final long weight, @@ -797,6 +810,7 @@ protected HostSpec createHost( : this.initialHostSpec.getPort(); final HostSpec hostSpec = this.servicesContainer.getHostListProviderService().getHostSpecBuilder() + .hostId(nodeId) .host(endpoint) .port(port) .role(isWriter ? HostRole.WRITER : HostRole.READER) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java index 4b661dbc5..0c2ee29a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java @@ -105,6 +105,7 @@ protected HostSpec createHost( throw new SQLException("Can't find cluster template for region " + awsRegion); } - return createHost(hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); + return createHost( + hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java index 7c744b0d5..de23fb34c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java @@ -123,6 +123,6 @@ protected HostSpec createHost( String hostId = resultSet.getString("id"); // "1034958454" final boolean isWriter = hostId.equals(suggestedWriterNodeId); - return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now()), this.clusterInstanceTemplate); + return createHost(hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), this.clusterInstanceTemplate); } } From 39a589be93941b0dbcb43de7432cffbfff4a3428 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 29 Oct 2025 18:02:08 -0700 Subject: [PATCH 22/90] feat: add support of RDS Proxy custom endpoints (#1583) --- .../hostlistprovider/RdsHostListProvider.java | 2 +- .../failover/FailoverConnectionPlugin.java | 1 + .../failover2/FailoverConnectionPlugin.java | 1 + .../software/amazon/jdbc/util/RdsUrlType.java | 1 + .../software/amazon/jdbc/util/RdsUtils.java | 55 +++++++++++++++++++ .../amazon/jdbc/util/RdsUtilsTests.java | 14 +++++ 6 files changed, 73 insertions(+), 1 deletion(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index cc17096e5..aed5f83d7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -447,7 +447,7 @@ protected void validateHostPatternSetting(final String hostPattern) { } final RdsUrlType rdsUrlType = rdsHelper.identifyRdsType(hostPattern); - if (rdsUrlType == RdsUrlType.RDS_PROXY) { + if (rdsUrlType == RdsUrlType.RDS_PROXY || rdsUrlType == RdsUrlType.RDS_PROXY_ENDPOINT) { // "An RDS Proxy url can't be used as the 'clusterInstanceHostPattern' configuration setting." final String message = Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy"); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index ef2f95550..25ce77ecb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -388,6 +388,7 @@ private boolean isNodeStillValid(final String node, final Map.global-.global.rds.amazonaws.com + // Example: test-global-db-name.global-123456789012.global.rds.amazonaws.com + // + // + // RDS Proxy + // RDS Proxy Endpoint: .proxy-..rds.amazonaws.com + // Example: test-rds-proxy-name.proxy-123456789012.us-east-2.rds.amazonaws.com + // + // RDS Proxy Custom Endpoint: .endpoint.proxy-..rds.amazonaws.com + // Example: test-custom-endpoint-name.endpoint.proxy-123456789012.us-east-2.rds.amazonaws.com private static final Pattern AURORA_DNS_PATTERN = Pattern.compile( @@ -184,6 +198,30 @@ public class RdsUtils { + "(?[a-zA-Z0-9]+\\.global\\.rds\\.amazonaws\\.com\\.?)$", Pattern.CASE_INSENSITIVE); + private static final Pattern RDS_PROXY_ENDPOINT_DNS_PATTERN = + Pattern.compile( + "^(?.+)\\.endpoint\\." + + "(?proxy-)?" + + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" + + "\\.rds\\.amazonaws\\.com\\.?)$", + Pattern.CASE_INSENSITIVE); + + private static final Pattern RDS_PROXY_ENDPOINT_CHINA_DNS_PATTERN = + Pattern.compile( + "^(?.+)\\.endpoint\\." + + "(?proxy-)+" + + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + + "\\.amazonaws\\.com\\.cn\\.?)$", + Pattern.CASE_INSENSITIVE); + + private static final Pattern RDS_PROXY_ENDPOINT_OLD_CHINA_DNS_PATTERN = + Pattern.compile( + "^(?.+)\\.endpoint\\." + + "(?proxy-)?" + + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" + + "\\.rds\\.amazonaws\\.com\\.cn\\.?)$", + Pattern.CASE_INSENSITIVE); + private static final Map cachedPatterns = new ConcurrentHashMap<>(); private static final Map cachedDnsPatterns = new ConcurrentHashMap<>(); @@ -225,6 +263,21 @@ public boolean isRdsProxyDns(final String host) { return dnsGroup != null && dnsGroup.startsWith("proxy-"); } + public boolean isRdsProxyEndpointDns(final String host) { + final String preparedHost = getPreparedHost(host); + if (StringUtils.isNullOrEmpty(preparedHost)) { + return false; + } + + final Matcher matcher = cacheMatcher(preparedHost, + RDS_PROXY_ENDPOINT_DNS_PATTERN, RDS_PROXY_ENDPOINT_CHINA_DNS_PATTERN, RDS_PROXY_ENDPOINT_OLD_CHINA_DNS_PATTERN); + if (getRegexGroup(matcher, DNS_GROUP) != null) { + return getRegexGroup(matcher, INSTANCE_GROUP) != null; + } + + return false; + } + public @Nullable String getRdsClusterId(final String host) { final String preparedHost = getPreparedHost(host); if (StringUtils.isNullOrEmpty(preparedHost)) { @@ -372,6 +425,8 @@ public RdsUrlType identifyRdsType(final String host) { return RdsUrlType.RDS_AURORA_LIMITLESS_DB_SHARD_GROUP; } else if (isRdsProxyDns(host)) { return RdsUrlType.RDS_PROXY; + } else if (isRdsProxyEndpointDns(host)) { + return RdsUrlType.RDS_PROXY_ENDPOINT; } else if (isRdsDns(host)) { return RdsUrlType.RDS_INSTANCE; } else { diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java index 05ce83b7b..9938dc2e6 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java @@ -37,6 +37,8 @@ public class RdsUtilsTests { "instance-test-name.XYZ.us-east-2.rds.amazonaws.com"; private static final String usEastRegionProxy = "proxy-test-name.proxy-XYZ.us-east-2.rds.amazonaws.com"; + private static final String usEastRegionProxyEndpoint = + "endpoint-test-name.endpoint.proxy-XYZ.us-east-2.rds.amazonaws.com"; private static final String usEastRegionCustomDomain = "custom-test-name.cluster-custom-XYZ.us-east-2.rds.amazonaws.com"; private static final String usEastRegionLimitlessDbShardGroup = @@ -132,6 +134,7 @@ public void testIsRdsDns() { assertTrue(target.isRdsDns(usEastRegionClusterReadOnly)); assertTrue(target.isRdsDns(usEastRegionInstance)); assertTrue(target.isRdsDns(usEastRegionProxy)); + assertTrue(target.isRdsDns(usEastRegionProxyEndpoint)); assertTrue(target.isRdsDns(usEastRegionCustomDomain)); assertFalse(target.isRdsDns(usEastRegionElbUrl)); assertFalse(target.isRdsDns(usEastRegionElbUrlTrailingDot)); @@ -221,6 +224,7 @@ public void testIsRdsClusterDns() { assertTrue(target.isRdsClusterDns(usEastRegionClusterReadOnly)); assertFalse(target.isRdsClusterDns(usEastRegionInstance)); assertFalse(target.isRdsClusterDns(usEastRegionProxy)); + assertFalse(target.isRdsClusterDns(usEastRegionProxyEndpoint)); assertFalse(target.isRdsClusterDns(usEastRegionCustomDomain)); assertFalse(target.isRdsClusterDns(usEastRegionElbUrl)); assertFalse(target.isRdsClusterDns(usEastRegionLimitlessDbShardGroup)); @@ -260,6 +264,7 @@ public void testIsWriterClusterDns() { assertFalse(target.isWriterClusterDns(usEastRegionClusterReadOnly)); assertFalse(target.isWriterClusterDns(usEastRegionInstance)); assertFalse(target.isWriterClusterDns(usEastRegionProxy)); + assertFalse(target.isWriterClusterDns(usEastRegionProxyEndpoint)); assertFalse(target.isWriterClusterDns(usEastRegionCustomDomain)); assertFalse(target.isWriterClusterDns(usEastRegionElbUrl)); assertFalse(target.isWriterClusterDns(usEastRegionLimitlessDbShardGroup)); @@ -299,6 +304,7 @@ public void testIsReaderClusterDns() { assertTrue(target.isReaderClusterDns(usEastRegionClusterReadOnly)); assertFalse(target.isReaderClusterDns(usEastRegionInstance)); assertFalse(target.isReaderClusterDns(usEastRegionProxy)); + assertFalse(target.isReaderClusterDns(usEastRegionProxyEndpoint)); assertFalse(target.isReaderClusterDns(usEastRegionCustomDomain)); assertFalse(target.isReaderClusterDns(usEastRegionElbUrl)); assertFalse(target.isReaderClusterDns(usEastRegionLimitlessDbShardGroup)); @@ -338,6 +344,7 @@ public void testIsLimitlessDbShardGroupDns() { assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionClusterReadOnly)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionInstance)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionProxy)); + assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionProxyEndpoint)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionCustomDomain)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionElbUrl)); assertTrue(target.isLimitlessDbShardGroupDns(usEastRegionLimitlessDbShardGroup)); @@ -378,6 +385,7 @@ public void testGetRdsRegion() { assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionClusterReadOnly)); assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionInstance)); assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionProxy)); + assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionProxyEndpoint)); assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionCustomDomain)); assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionElbUrl)); assertEquals(expectedHostPattern, target.getRdsRegion(usEastRegionLimitlessDbShardGroup)); @@ -423,6 +431,12 @@ public void testIsGlobalDbWriterClusterDns() { assertTrue(target.isGlobalDbWriterClusterDns(globalDbWriterCluster)); } + @Test + public void testisRdsProxyEndpointDns() { + assertFalse(target.isRdsProxyEndpointDns(usEastRegionProxy)); + assertTrue(target.isRdsProxyEndpointDns(usEastRegionProxyEndpoint)); + } + @Test public void testBrokenPathsHostPattern() { final String incorrectChinaHostPattern = "?.rds.cn-northwest-1.rds.amazonaws.com.cn"; From eec89ff9a6b0c9290e2387ff0bd22582ee756f0e Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:57:16 -0700 Subject: [PATCH 23/90] feat: pooled flag for connect (#1581) --- .../ConnectionPluginManagerBenchmarks.java | 3 +- .../jdbc/benchmarks/PluginBenchmarks.java | 3 +- .../jdbc/C3P0PooledConnectionProvider.java | 4 +- .../software/amazon/jdbc/ConnectionInfo.java | 41 +++++++++++++++++++ .../amazon/jdbc/ConnectionProvider.java | 4 +- .../jdbc/DataSourceConnectionProvider.java | 6 +-- .../amazon/jdbc/DriverConnectionProvider.java | 6 +-- .../jdbc/HikariPooledConnectionProvider.java | 4 +- .../amazon/jdbc/PartialPluginService.java | 21 ++++++++++ .../amazon/jdbc/PluginManagerService.java | 6 +++ .../software/amazon/jdbc/PluginService.java | 16 ++++++++ .../amazon/jdbc/PluginServiceImpl.java | 19 +++++++++ .../jdbc/plugin/DefaultConnectionPlugin.java | 16 +++++--- .../ReadWriteSplittingPlugin.java | 4 +- .../amazon/jdbc/util/WrapperUtils.java | 4 ++ .../jdbc/wrapper/ConnectionWrapper.java | 6 +++ .../jdbc/ConnectionPluginManagerTests.java | 11 ++++- .../HikariPooledConnectionProviderTest.java | 30 +++++++++++++- .../plugin/DefaultConnectionPluginTest.java | 5 ++- .../dev/DeveloperConnectionPluginTest.java | 4 +- .../ReadWriteSplittingPluginTest.java | 4 +- .../amazon/jdbc/util/WrapperUtilsTest.java | 9 ++++ 22 files changed, 197 insertions(+), 29 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/ConnectionInfo.java diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java index 413a37e03..eb4a8d3b2 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java @@ -50,6 +50,7 @@ import org.openjdk.jmh.runner.RunnerException; import org.openjdk.jmh.runner.options.Options; import org.openjdk.jmh.runner.options.OptionsBuilder; +import software.amazon.jdbc.ConnectionInfo; import software.amazon.jdbc.ConnectionPluginFactory; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; @@ -126,7 +127,7 @@ public void setUpIteration() throws Exception { any(Dialect.class), any(TargetDriverDialect.class), any(HostSpec.class), - any(Properties.class))).thenReturn(mockConnection); + any(Properties.class))).thenReturn(new ConnectionInfo(mockConnection, false)); when(mockTelemetryFactory.openTelemetryContext(anyString(), any())).thenReturn(mockTelemetryContext); when(mockTelemetryFactory.openTelemetryContext(eq(null), any())).thenReturn(mockTelemetryContext); when(mockTelemetryFactory.createCounter(anyString())).thenReturn(mockTelemetryCounter); diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java index a9c10b2f6..405b6fc00 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java @@ -48,6 +48,7 @@ import org.openjdk.jmh.runner.RunnerException; import org.openjdk.jmh.runner.options.Options; import org.openjdk.jmh.runner.options.OptionsBuilder; +import software.amazon.jdbc.ConnectionInfo; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; @@ -134,7 +135,7 @@ public void setUpIteration() throws Exception { any(Dialect.class), any(TargetDriverDialect.class), any(HostSpec.class), - any(Properties.class))).thenReturn(mockConnection); + any(Properties.class))).thenReturn(new ConnectionInfo(mockConnection, false)); when(mockConnection.createStatement()).thenReturn(mockStatement); when(mockStatement.executeQuery(anyString())).thenReturn(mockResultSet); when(mockResultSet.next()).thenReturn(true, true, false); diff --git a/wrapper/src/main/java/software/amazon/jdbc/C3P0PooledConnectionProvider.java b/wrapper/src/main/java/software/amazon/jdbc/C3P0PooledConnectionProvider.java index dc4aa70eb..0a2fb5841 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/C3P0PooledConnectionProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/C3P0PooledConnectionProvider.java @@ -79,7 +79,7 @@ public HostSpec getHostSpecByStrategy(@NonNull List hosts, @NonNull Ho } @Override - public Connection connect(@NonNull String protocol, @NonNull Dialect dialect, + public @NonNull ConnectionInfo connect(@NonNull String protocol, @NonNull Dialect dialect, @NonNull TargetDriverDialect targetDriverDialect, @NonNull HostSpec hostSpec, @NonNull Properties props) throws SQLException { final Properties copy = PropertyUtils.copyProperties(props); @@ -93,7 +93,7 @@ public Connection connect(@NonNull String protocol, @NonNull Dialect dialect, ds.setPassword(copy.getProperty(PropertyDefinition.PASSWORD.name)); - return ds.getConnection(); + return new ConnectionInfo(ds.getConnection(), true); } protected ComboPooledDataSource createDataSource( diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionInfo.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionInfo.java new file mode 100644 index 000000000..ca253e6da --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionInfo.java @@ -0,0 +1,41 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc; + +import java.sql.Connection; + +public class ConnectionInfo { + private final Connection connection; + private final boolean isPooled; + + public ConnectionInfo(Connection connection, boolean isPooled) { + this.connection = connection; + this.isPooled = isPooled; + } + + public ConnectionInfo(Connection connection) { + this(connection, false); + } + + public Connection getConnection() { + return connection; + } + + public boolean isPooled() { + return isPooled; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProvider.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProvider.java index 8fddcf269..6967a673c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionProvider.java @@ -78,10 +78,10 @@ HostSpec getHostSpecByStrategy( * @param targetDriverDialect the target driver dialect * @param hostSpec the HostSpec containing the host-port information for the host to connect to * @param props the Properties to use for the connection - * @return {@link Connection} resulting from the given connection information + * @return {@link ConnectionInfo} resulting from the given connection information * @throws SQLException if an error occurs */ - Connection connect( + @NonNull ConnectionInfo connect( @NonNull String protocol, @NonNull Dialect dialect, @NonNull TargetDriverDialect targetDriverDialect, diff --git a/wrapper/src/main/java/software/amazon/jdbc/DataSourceConnectionProvider.java b/wrapper/src/main/java/software/amazon/jdbc/DataSourceConnectionProvider.java index 6c5afcda3..d12eeefad 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/DataSourceConnectionProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/DataSourceConnectionProvider.java @@ -110,11 +110,11 @@ public HostSpec getHostSpecByStrategy( * @param protocol The connection protocol (example "jdbc:mysql://") * @param hostSpec The HostSpec containing the host-port information for the host to connect to * @param props The Properties to use for the connection - * @return {@link Connection} resulting from the given connection information + * @return {@link ConnectionInfo} resulting from the given connection information * @throws SQLException if an error occurs */ @Override - public Connection connect( + public @NonNull ConnectionInfo connect( final @NonNull String protocol, final @NonNull Dialect dialect, final @NonNull TargetDriverDialect targetDriverDialect, @@ -151,7 +151,7 @@ public Connection connect( throw new SQLLoginException(Messages.get("ConnectionProvider.noConnection")); } - return conn; + return new ConnectionInfo(conn, false); } protected Connection openConnection( diff --git a/wrapper/src/main/java/software/amazon/jdbc/DriverConnectionProvider.java b/wrapper/src/main/java/software/amazon/jdbc/DriverConnectionProvider.java index e2a04e399..1cd8891b3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/DriverConnectionProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/DriverConnectionProvider.java @@ -108,11 +108,11 @@ public HostSpec getHostSpecByStrategy( * @param targetDriverDialect The target driver dialect * @param hostSpec The HostSpec containing the host-port information for the host to connect to * @param props The Properties to use for the connection - * @return {@link Connection} resulting from the given connection information + * @return {@link ConnectionInfo} resulting from the given connection information * @throws SQLException if an error occurs */ @Override - public Connection connect( + public @NonNull ConnectionInfo connect( final @NonNull String protocol, final @NonNull Dialect dialect, final @NonNull TargetDriverDialect targetDriverDialect, @@ -197,7 +197,7 @@ public Connection connect( if (conn == null) { throw new SQLLoginException(Messages.get("ConnectionProvider.noConnection")); } - return conn; + return new ConnectionInfo(conn, false); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/HikariPooledConnectionProvider.java b/wrapper/src/main/java/software/amazon/jdbc/HikariPooledConnectionProvider.java index f0d58c841..25c608d31 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HikariPooledConnectionProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/HikariPooledConnectionProvider.java @@ -241,7 +241,7 @@ public HostSpec getHostSpecByStrategy( } @Override - public Connection connect( + public @NonNull ConnectionInfo connect( @NonNull String protocol, @NonNull Dialect dialect, @NonNull TargetDriverDialect targetDriverDialect, @@ -286,7 +286,7 @@ public Connection connect( ds.setPassword(copy.getProperty(PropertyDefinition.PASSWORD.name)); - return ds.getConnection(); + return new ConnectionInfo(ds.getConnection(), true); } // The pool key should always be retrieved using this method, because the username diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 7d5becc8a..50a1e3667 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -215,6 +215,7 @@ public ConnectionProvider getDefaultConnectionProvider() { return this.connectionProviderManager.getDefaultProvider(); } + @Deprecated public boolean isPooledConnectionProvider(HostSpec host, Properties props) { final ConnectionProvider connectionProvider = this.connectionProviderManager.getConnectionProvider(this.driverProtocol, host, props); @@ -652,6 +653,26 @@ public boolean isPluginInUse(final Class pluginClazz } } + @Override + public Boolean isPooledConnection() { + // This service implementation doesn't support call context. + throw new UnsupportedOperationException( + Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"getSessionStateService"})); + } + + @Override + public void setIsPooledConnection(Boolean pooledConnection) { + // This service implementation doesn't support call context. + // Do nothing. + } + + @Override + public void resetCallContext() { + // This service implementation doesn't support call context. + throw new UnsupportedOperationException( + Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"getSessionStateService"})); + } + @Override public T unwrap(Class iface) throws SQLException { if (iface == PluginService.class) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginManagerService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginManagerService.java index 79c9168da..2965fe821 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginManagerService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginManagerService.java @@ -16,7 +16,13 @@ package software.amazon.jdbc; +import org.checkerframework.checker.nullness.qual.Nullable; + public interface PluginManagerService { void setInTransaction(boolean inTransaction); + + void setIsPooledConnection(@Nullable Boolean pooledConnection); + + void resetCallContext(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index 1ed394c27..aae57d7f4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -233,6 +233,7 @@ Connection forceConnect( ConnectionProvider getDefaultConnectionProvider(); + @Deprecated boolean isPooledConnectionProvider(HostSpec host, Properties props); String getDriverProtocol(); @@ -248,4 +249,19 @@ Connection forceConnect( T getPlugin(final Class pluginClazz); boolean isPluginInUse(final Class pluginClazz); + + // JDBC call context functions + + /** + * Retrieves details about the most recent {@link PluginService#connect} or + * {@link PluginService#forceConnect} calls. Specifically indicates whether the + * returned connection was obtained from a connection pool or newly created. + * + *

Note: The {@link ConnectionPlugin} must process or store this information during + * the current JDBC call, as these details will be reset before the next JDBC call + * is processed, or another {@link PluginService#connect} or {@link PluginService#forceConnect} + * is made. + * + */ + @Nullable Boolean isPooledConnection(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 2288f946b..4518eff66 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -91,6 +91,9 @@ public class PluginServiceImpl implements PluginService, CanReleaseResources, protected final ReentrantLock connectionSwitchLock = new ReentrantLock(); + // JDBC call context members + protected Boolean pooledConnection = null; + public PluginServiceImpl( @NonNull final FullServicesContainer servicesContainer, @NonNull final Properties props, @@ -243,6 +246,7 @@ public ConnectionProvider getDefaultConnectionProvider() { return this.connectionProviderManager.getDefaultProvider(); } + @Deprecated public boolean isPooledConnectionProvider(HostSpec host, Properties props) { final ConnectionProvider connectionProvider = this.connectionProviderManager.getConnectionProvider(this.driverProtocol, host, props); @@ -789,6 +793,21 @@ public boolean isPluginInUse(final Class pluginClazz } } + @Override + public Boolean isPooledConnection() { + return this.pooledConnection; + } + + @Override + public void setIsPooledConnection(Boolean pooledConnection) { + this.pooledConnection = pooledConnection; + } + + @Override + public void resetCallContext() { + this.pooledConnection = null; + } + @Override public T unwrap(Class iface) throws SQLException { if (iface == PluginService.class) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java index 66277275b..2427cc816 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java @@ -31,6 +31,7 @@ import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.ConnectionInfo; import software.amazon.jdbc.ConnectionPlugin; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; @@ -190,9 +191,9 @@ private Connection connectInternal( TelemetryContext telemetryContext = telemetryFactory.openTelemetryContext( connProvider.getTargetName(), TelemetryTraceLevel.NESTED); - Connection conn; + ConnectionInfo connectionInfo; try { - conn = connProvider.connect( + connectionInfo = connProvider.connect( driverProtocol, this.pluginService.getDialect(), this.pluginService.getTargetDriverDialect(), @@ -204,14 +205,17 @@ private Connection connectInternal( } } - this.connProviderManager.initConnection(conn, driverProtocol, hostSpec, props); + this.pluginManagerService.setIsPooledConnection(connectionInfo.isPooled()); + this.connProviderManager.initConnection(connectionInfo.getConnection(), driverProtocol, hostSpec, props); - this.pluginService.setAvailability(hostSpec.asAliases(), HostAvailability.AVAILABLE); + if (connectionInfo.getConnection() != null) { + this.pluginService.setAvailability(hostSpec.asAliases(), HostAvailability.AVAILABLE); + } if (isInitialConnection) { - this.pluginService.updateDialect(conn); + this.pluginService.updateDialect(connectionInfo.getConnection()); } - return conn; + return connectionInfo.getConnection(); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 2d25675e2..5975936c0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -268,7 +268,7 @@ private boolean isReader(final @NonNull HostSpec hostSpec) { private void getNewWriterConnection(final HostSpec writerHostSpec) throws SQLException { final Connection conn = this.pluginService.connect(writerHostSpec, this.properties, this); - this.isWriterConnFromInternalPool = this.pluginService.isPooledConnectionProvider(writerHostSpec, this.properties); + this.isWriterConnFromInternalPool = Boolean.TRUE.equals(this.pluginService.isPooledConnection()); setWriterConnection(conn, writerHostSpec); switchCurrentConnectionTo(this.writerConnection, writerHostSpec); } @@ -492,7 +492,7 @@ private void getNewReaderConnection() throws SQLException { HostSpec hostSpec = this.pluginService.getHostSpecByStrategy(HostRole.READER, this.readerSelectorStrategy); try { conn = this.pluginService.connect(hostSpec, this.properties, this); - this.isReaderConnFromInternalPool = this.pluginService.isPooledConnectionProvider(hostSpec, this.properties); + this.isReaderConnFromInternalPool = Boolean.TRUE.equals(this.pluginService.isPooledConnection()); readerHost = hostSpec; break; } catch (final SQLException e) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/WrapperUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/WrapperUtils.java index 0037bdbd9..f4b0babb7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/WrapperUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/WrapperUtils.java @@ -217,6 +217,8 @@ public static T executeWithPlugins( context.setAttribute("jdbcCall", jdbcMethod.methodName); } + connectionWrapper.getServicesContainer().getPluginManagerService().resetCallContext(); + // The target driver may block on Statement.getConnection(). if (jdbcMethod.shouldLockConnection && jdbcMethod.checkBoundedConnection) { final Connection conn = WrapperUtils.getConnectionFromSqlObject(methodInvokeOn); @@ -286,6 +288,8 @@ public static T executeWithPlugins( context.setAttribute("jdbcCall", jdbcMethod.methodName); } + connectionWrapper.getServicesContainer().getPluginManagerService().resetCallContext(); + // The target driver may block on Statement.getConnection(). if (jdbcMethod.shouldLockConnection && jdbcMethod.checkBoundedConnection) { final Connection conn = WrapperUtils.getConnectionFromSqlObject(methodInvokeOn); diff --git a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java index c29f11c2a..b0e86574e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java @@ -63,6 +63,7 @@ public class ConnectionWrapper implements Connection, CanReleaseResources { protected final String originalUrl; protected @Nullable ConfigurationProfile configurationProfile; protected @Nullable Throwable openConnectionStacktrace; + protected FullServicesContainer servicesContainer; public ConnectionWrapper( @NonNull final FullServicesContainer servicesContainer, @@ -71,6 +72,7 @@ public ConnectionWrapper( @NonNull final String targetDriverProtocol, @Nullable final ConfigurationProfile configurationProfile) throws SQLException { + this.servicesContainer = servicesContainer; this.pluginManager = servicesContainer.getConnectionPluginManager(); this.pluginService = servicesContainer.getPluginService(); this.hostListProviderService = servicesContainer.getHostListProviderService(); @@ -105,6 +107,10 @@ protected ConnectionWrapper( init(props); } + public FullServicesContainer getServicesContainer() { + return this.servicesContainer; + } + protected void init(final Properties props) throws SQLException { if (this.pluginService.getCurrentConnection() == null) { final Connection conn = diff --git a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java index 8a880a39d..080fea20e 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java @@ -609,6 +609,11 @@ public void testTwoConnectionsDoNotBlockOneAnother() { final ConnectionProvider mockConnectionProvider1 = Mockito.mock(ConnectionProvider.class); final ConnectionWrapper mockConnectionWrapper1 = Mockito.mock(ConnectionWrapper.class); final PluginService mockPluginService1 = Mockito.mock(PluginService.class); + final PluginManagerService mockPluginManagerService1 = Mockito.mock(PluginManagerService.class); + final FullServicesContainer mockServicesContainer1 = Mockito.mock(FullServicesContainer.class); + when(mockConnectionWrapper1.getServicesContainer()).thenReturn(mockServicesContainer1); + when(mockServicesContainer1.getPluginService()).thenReturn(mockPluginService1); + when(mockServicesContainer1.getPluginManagerService()).thenReturn(mockPluginManagerService1); final TelemetryFactory mockTelemetryFactory1 = Mockito.mock(TelemetryFactory.class); final Object object1 = new Object(); when(mockPluginService1.getTelemetryFactory()).thenReturn(mockTelemetryFactory1); @@ -617,10 +622,14 @@ public void testTwoConnectionsDoNotBlockOneAnother() { final ConnectionPluginManager pluginManager1 = new ConnectionPluginManager( mockConnectionProvider1, null, testProperties, testPlugins, mockTelemetryFactory1); - final ConnectionProvider mockConnectionProvider2 = Mockito.mock(ConnectionProvider.class); final ConnectionWrapper mockConnectionWrapper2 = Mockito.mock(ConnectionWrapper.class); final PluginService mockPluginService2 = Mockito.mock(PluginService.class); + final PluginManagerService mockPluginManagerService2 = Mockito.mock(PluginManagerService.class); + final FullServicesContainer mockServicesContainer2 = Mockito.mock(FullServicesContainer.class); + when(mockConnectionWrapper2.getServicesContainer()).thenReturn(mockServicesContainer2); + when(mockServicesContainer2.getPluginService()).thenReturn(mockPluginService2); + when(mockServicesContainer2.getPluginManagerService()).thenReturn(mockPluginManagerService2); final TelemetryFactory mockTelemetryFactory2 = Mockito.mock(TelemetryFactory.class); final Object object2 = new Object(); when(mockPluginService2.getTelemetryFactory()).thenReturn(mockTelemetryFactory2); diff --git a/wrapper/src/test/java/software/amazon/jdbc/HikariPooledConnectionProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/HikariPooledConnectionProviderTest.java index 6e5844ccf..89f29acdd 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/HikariPooledConnectionProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/HikariPooledConnectionProviderTest.java @@ -141,13 +141,26 @@ void testConnectWithDefaultMapping() throws SQLException { Properties props = new Properties(); props.setProperty(PropertyDefinition.USER.name, user1); props.setProperty(PropertyDefinition.PASSWORD.name, password); - try (Connection conn = provider.connect(protocol, mockDialect, mockTargetDriverDialect, mockHostSpec, props)) { + + ConnectionInfo connectionInfo = null; + try { + connectionInfo = + provider.connect(protocol, mockDialect, mockTargetDriverDialect, mockHostSpec, props); + Connection conn = connectionInfo.getConnection(); assertEquals(mockConnection, conn); assertEquals(1, provider.getHostCount()); final Set hosts = provider.getHosts(); assertEquals(expectedUrls, hosts); final Set keys = provider.getKeys(); assertEquals(expectedKeys, keys); + } finally { + if (connectionInfo != null && connectionInfo.getConnection() != null) { + try { + connectionInfo.getConnection().close(); + } catch (Exception ex) { + // ignore + } + } } } @@ -166,11 +179,24 @@ void testConnectWithCustomMapping() throws SQLException { Properties props = new Properties(); props.setProperty(PropertyDefinition.USER.name, user1); props.setProperty(PropertyDefinition.PASSWORD.name, password); - try (Connection conn = provider.connect(protocol, mockDialect, mockTargetDriverDialect, mockHostSpec, props)) { + + ConnectionInfo connectionInfo = null; + try { + connectionInfo = + provider.connect(protocol, mockDialect, mockTargetDriverDialect, mockHostSpec, props); + Connection conn = connectionInfo.getConnection(); assertEquals(mockConnection, conn); assertEquals(1, provider.getHostCount()); final Set keys = provider.getKeys(); assertEquals(expectedKeys, keys); + } finally { + if (connectionInfo != null && connectionInfo.getConnection() != null) { + try { + connectionInfo.getConnection().close(); + } catch (Exception ex) { + // ignore + } + } } } diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/DefaultConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/DefaultConnectionPluginTest.java index 9893e7c95..eaf9d11f1 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/DefaultConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/DefaultConnectionPluginTest.java @@ -43,6 +43,7 @@ import org.junit.jupiter.params.provider.MethodSource; import org.mockito.Mock; import org.mockito.MockitoAnnotations; +import software.amazon.jdbc.ConnectionInfo; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; import software.amazon.jdbc.HostSpec; @@ -77,7 +78,7 @@ class DefaultConnectionPluginTest { private AutoCloseable closeable; @BeforeEach - void setUp() { + void setUp() throws SQLException { closeable = MockitoAnnotations.openMocks(this); when(pluginService.getTelemetryFactory()).thenReturn(mockTelemetryFactory); @@ -88,6 +89,8 @@ void setUp() { when(mockTelemetryFactory.createGauge(anyString(), any(GaugeCallable.class))).thenReturn(mockTelemetryGauge); when(mockConnectionProviderManager.getConnectionProvider(anyString(), any(), any())) .thenReturn(connectionProvider); + when(connectionProvider.connect(anyString(), any(), any(), any(), any())) + .thenReturn(new ConnectionInfo(conn, false)); plugin = new DefaultConnectionPlugin( pluginService, connectionProvider, pluginManagerService, mockConnectionProviderManager); diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/dev/DeveloperConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/dev/DeveloperConnectionPluginTest.java index dfd3ced1c..185c528e8 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/dev/DeveloperConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/dev/DeveloperConnectionPluginTest.java @@ -37,6 +37,7 @@ import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; +import software.amazon.jdbc.ConnectionInfo; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.HostSpec; @@ -88,7 +89,8 @@ void init() throws SQLException { mockPluginService, mockPluginService); - when(mockConnectionProvider.connect(any(), any(), any(), any(), any())).thenReturn(mockConnection); + when(mockConnectionProvider.connect(any(), any(), any(), any(), any())) + .thenReturn(new ConnectionInfo(mockConnection, false)); when(mockConnectCallback.getExceptionToRaise(any(), any(), any(), anyBoolean())).thenReturn(null); when(mockConnectionPluginManager.getTelemetryFactory()).thenReturn(mockTelemetryFactory); diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java index c7c7bdc1b..976fcf2ea 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java @@ -567,7 +567,7 @@ public void testClosePooledReaderConnectionAfterSetReadOnly() throws SQLExceptio .when(this.mockPluginService).getCurrentHostSpec(); doReturn(mockReaderConn1).when(mockPluginService).connect(readerHostSpec1, null); when(mockPluginService.getDriverProtocol()).thenReturn("jdbc:postgresql://"); - when(mockPluginService.isPooledConnectionProvider(any(), any())).thenReturn(true); + when(mockPluginService.isPooledConnection()).thenReturn(true); final ReadWriteSplittingPlugin plugin = new ReadWriteSplittingPlugin( mockPluginService, @@ -593,7 +593,7 @@ public void testClosePooledWriterConnectionAfterSetReadOnly() throws SQLExceptio .when(this.mockPluginService).getCurrentHostSpec(); doReturn(mockWriterConn).when(mockPluginService).connect(writerHostSpec, null); when(mockPluginService.getDriverProtocol()).thenReturn("jdbc:postgresql://"); - when(mockPluginService.isPooledConnectionProvider(any(), any())).thenReturn(true); + when(mockPluginService.isPooledConnection()).thenReturn(true); final ReadWriteSplittingPlugin plugin = new ReadWriteSplittingPlugin( mockPluginService, diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/WrapperUtilsTest.java b/wrapper/src/test/java/software/amazon/jdbc/util/WrapperUtilsTest.java index afcae7530..3a285939a 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/WrapperUtilsTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/WrapperUtilsTest.java @@ -45,6 +45,8 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.JdbcMethod; +import software.amazon.jdbc.PluginManagerService; +import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.telemetry.TelemetryContext; import software.amazon.jdbc.util.telemetry.TelemetryFactory; import software.amazon.jdbc.wrapper.CallableStatementWrapper; @@ -55,7 +57,10 @@ public class WrapperUtilsTest { @Mock ConnectionWrapper mockConnectionWrapper; + @Mock FullServicesContainer mockServicesContainer; @Mock ConnectionPluginManager mockPluginManager; + @Mock PluginService mockPluginService; + @Mock PluginManagerService mockPluginManagerService; @Mock TelemetryFactory mockTelemetryFactory; @Mock TelemetryContext mockTelemetryContext; @Mock Object object; @@ -73,6 +78,10 @@ void init() { when(mockPluginManager.getTelemetryFactory()).thenReturn(mockTelemetryFactory); when(mockTelemetryFactory.openTelemetryContext(anyString(), any())).thenReturn(mockTelemetryContext); when(mockTelemetryFactory.openTelemetryContext(eq(null), any())).thenReturn(mockTelemetryContext); + when(mockConnectionWrapper.getServicesContainer()).thenReturn(mockServicesContainer); + when(mockServicesContainer.getConnectionPluginManager()).thenReturn(mockPluginManager); + when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); + when(mockServicesContainer.getPluginManagerService()).thenReturn(mockPluginManagerService); } private void mockExecuteReturnValue(Object returnValue) { From c1ef2c016a67e5a97bf3343ad8fed126b4b5aed7 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 30 Oct 2025 17:02:02 -0700 Subject: [PATCH 24/90] Detailed cleanup --- .../jdbc/dialect/AuroraDialectUtils.java | 6 +- .../jdbc/dialect/AuroraMysqlDialect.java | 87 ++++++-------- .../amazon/jdbc/dialect/AuroraPgDialect.java | 107 ++++++------------ .../amazon/jdbc/dialect/BlueGreenDialect.java | 4 +- .../software/amazon/jdbc/dialect/Dialect.java | 15 +-- .../amazon/jdbc/dialect/MariaDbDialect.java | 83 ++++++-------- .../jdbc/dialect/MultiAzDialectUtils.java | 24 +++- .../amazon/jdbc/dialect/MysqlDialect.java | 81 ++++++------- .../amazon/jdbc/dialect/PgDialect.java | 85 ++++++-------- .../RdsMultiAzDbClusterMysqlDialect.java | 57 ++++------ .../dialect/RdsMultiAzDbClusterPgDialect.java | 74 +++++------- .../amazon/jdbc/dialect/RdsMysqlDialect.java | 75 +++++------- .../amazon/jdbc/dialect/RdsPgDialect.java | 55 +++------ .../amazon/jdbc/dialect/TopologyDialect.java | 9 +- .../hostlistprovider/RdsHostListProvider.java | 16 +-- .../MonitoringRdsHostListProvider.java | 7 +- .../amazon/jdbc/util/TopologyUtils.java | 8 +- 17 files changed, 316 insertions(+), 477 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java index 6d168153a..14d802eed 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -30,14 +30,16 @@ import software.amazon.jdbc.util.StringUtils; public class AuroraDialectUtils { - private static final Logger LOGGER = Logger.getLogger(AuroraDialectUtils.class.getName()); + protected final String writerIdQuery; + private static final Logger LOGGER = Logger.getLogger(AuroraDialectUtils.class.getName()); + public AuroraDialectUtils(String writerIdQuery) { this.writerIdQuery = writerIdQuery; } - public @Nullable List processQueryResults(ResultSet resultSet) + public @Nullable List processTopologyResults(ResultSet resultSet) throws SQLException { if (resultSet.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 7aa9e1d7c..5b0551296 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -30,58 +30,39 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { - private static final String TOPOLOGY_QUERY = + protected static final String AURORA_VERSION_EXISTS_QUERY = "SHOW VARIABLES LIKE 'aurora_version'"; + protected static final String TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, REPLICA_LAG_IN_MILLISECONDS, LAST_UPDATE_TIMESTAMP " + "FROM information_schema.replica_host_status " // filter out instances that haven't been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; - private static final String IS_WRITER_QUERY = + protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; + protected static final String IS_WRITER_QUERY = "SELECT SERVER_ID FROM information_schema.replica_host_status " - + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; + + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; + protected static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; - private static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; - private static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; - - private static final String BG_STATUS_QUERY = - "SELECT * FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String BG_TOPOLOGY_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; - private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); + protected final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery("SHOW VARIABLES LIKE 'aurora_version'"); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(AURORA_VERSION_EXISTS_QUERY)) { if (rs.next()) { // If variable with such name is presented then it means it's an Aurora cluster return true; } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } @@ -102,30 +83,19 @@ public HostListProviderSupplier getHostListProvider() { } @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; - } - - @Override - public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + public String getTopologyQuery() { + return TOPOLOGY_QUERY; } @Override - public String getTopologyQuery() { - return TOPOLOGY_QUERY; + public @Nullable List processTopologyResults(Connection conn, ResultSet rs) + throws SQLException { + return this.dialectUtils.processTopologyResults(rs); } @Override - public @Nullable List processQueryResults(Connection conn, ResultSet rs) throws SQLException { - return AuroraMysqlDialect.dialectUtils.processQueryResults(rs); + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; } @Override @@ -139,8 +109,19 @@ public String getIsReaderQuery() { } @Override - public String getInstanceIdQuery() { - return INSTANCE_ID_QUERY; + public boolean isBlueGreenStatusAvailable(final Connection connection) { + try { + try (Statement statement = connection.createStatement(); + ResultSet rs = statement.executeQuery(BG_TOPOLOGY_EXISTS_QUERY)) { + return rs.next(); + } + } catch (SQLException ex) { + return false; + } } -} + @Override + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 26dd11dc4..5f1452069 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -29,21 +29,14 @@ import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -/** - * Suitable for the following AWS PG configurations. - * - Regional Cluster - */ public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { - private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); - private static final String extensionsSql = + protected static final String AURORA_UTILS_EXIST_QUERY = "SELECT (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " + "FROM pg_catalog.pg_settings " + "WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'"; - - private static final String topologySql = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; - - private static final String TOPOLOGY_QUERY = + protected static final String TOPOLOGY_EXISTS_QUERY = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; + protected static final String TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, COALESCE(REPLICA_LAG_IN_MSEC, 0), LAST_UPDATE_TIMESTAMP " + "FROM pg_catalog.aurora_replica_status() " @@ -53,24 +46,25 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror + "OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "OR LAST_UPDATE_TIMESTAMP IS NULL"; - private static final String WRITER_ID_QUERY = + protected static final String INSTANCE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; + protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM pg_catalog.aurora_replica_status() " + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()"; + protected static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; - private static final String INSTANCE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; - private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; protected static final String LIMITLESS_ROUTER_ENDPOINT_QUERY = "select router_endpoint, load from pg_catalog.aurora_limitless_router_endpoints()"; - private static final String BG_STATUS_QUERY = + protected static final String BG_TOPOLOGY_EXISTS_QUERY = + "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM " + "pg_catalog.get_blue_green_fast_switchover_metadata('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - private static final String TOPOLOGY_TABLE_EXIST_QUERY = - "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; + private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); - private static final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); + protected final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); @Override public boolean isDialect(final Connection connection) { @@ -78,13 +72,9 @@ public boolean isDialect(final Connection connection) { return false; } - Statement stmt = null; - ResultSet rs = null; boolean hasExtensions = false; - boolean hasTopology = false; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(extensionsSql); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { if (rs.next()) { final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); @@ -93,53 +83,24 @@ public boolean isDialect(final Connection connection) { } } } catch (SQLException ex) { - // ignore - } finally { - // TODO: switch to try-with-resources here and check for any other places that can be cleaned up similarly - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + if (!hasExtensions) { return false; } - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(topologySql); + + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(TOPOLOGY_EXISTS_QUERY)) { if (rs.next()) { LOGGER.finest(() -> "hasTopology: true"); - hasTopology = true; + return true; } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } - return hasExtensions && hasTopology; + + return false; } @Override @@ -159,8 +120,9 @@ public String getTopologyQuery() { } @Override - public String getIsReaderQuery() { - return IS_READER_QUERY; + public @Nullable List processTopologyResults(Connection conn, ResultSet rs) + throws SQLException { + return this.dialectUtils.processTopologyResults(rs); } @Override @@ -170,13 +132,12 @@ public String getInstanceIdQuery() { @Override public boolean isWriterInstance(Connection connection) throws SQLException { - return AuroraPgDialect.dialectUtils.isWriterInstance(connection); + return this.dialectUtils.isWriterInstance(connection); } @Override - public @Nullable List processQueryResults(Connection conn, ResultSet rs) - throws SQLException { - return AuroraPgDialect.dialectUtils.processQueryResults(rs); + public String getIsReaderQuery() { + return IS_READER_QUERY; } @Override @@ -184,20 +145,20 @@ public String getLimitlessRouterEndpointQuery() { return LIMITLESS_ROUTER_ENDPOINT_QUERY; } - @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; - } - @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { try { try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { + ResultSet rs = statement.executeQuery(BG_TOPOLOGY_EXISTS_QUERY)) { return rs.next(); } } catch (SQLException ex) { return false; } } + + @Override + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java index ce1b678d3..a5e34f150 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java @@ -19,7 +19,7 @@ import java.sql.Connection; public interface BlueGreenDialect { - String getBlueGreenStatusQuery(); - boolean isBlueGreenStatusAvailable(final Connection connection); + + String getBlueGreenStatusQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java index 367db7d25..4fe1d7f8b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java @@ -26,22 +26,23 @@ import software.amazon.jdbc.plugin.failover.FailoverRestriction; public interface Dialect { - int getDefaultPort(); - - ExceptionHandler getExceptionHandler(); - - String getHostAliasQuery(); - - String getServerVersionQuery(); boolean isDialect(Connection connection); + int getDefaultPort(); + List getDialectUpdateCandidates(); + ExceptionHandler getExceptionHandler(); + HostListProviderSupplier getHostListProvider(); + String getHostAliasQuery(); + void prepareConnectProperties( final @NonNull Properties connectProperties, final @NonNull String protocol, final @NonNull HostSpec hostSpec); EnumSet getFailoverRestrictions(); + + String getServerVersionQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java index 3b368a8a1..fc017eb96 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java @@ -32,45 +32,23 @@ import software.amazon.jdbc.plugin.failover.FailoverRestriction; public class MariaDbDialect implements Dialect { + + protected static final String VERSION_QUERY = "SELECT VERSION()"; + protected static final String HOST_ALIAS_QUERY = "SELECT CONCAT(@@hostname, ':', @@port)"; + + private static MariaDBExceptionHandler mariaDBExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, DialectCodes.RDS_MYSQL, DialectCodes.MYSQL); - private static MariaDBExceptionHandler mariaDBExceptionHandler; - - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); - - @Override - public int getDefaultPort() { - return 3306; - } - - @Override - public ExceptionHandler getExceptionHandler() { - if (mariaDBExceptionHandler == null) { - mariaDBExceptionHandler = new MariaDBExceptionHandler(); - } - return mariaDBExceptionHandler; - } - - @Override - public String getHostAliasQuery() { - return "SELECT CONCAT(@@hostname, ':', @@port)"; - } - - @Override - public String getServerVersionQuery() { - return "SELECT VERSION()"; - } @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { while (rs.next()) { final String columnValue = rs.getString(1); if (columnValue != null && columnValue.toLowerCase().contains("mariadb")) { @@ -78,31 +56,30 @@ public boolean isDialect(final Connection connection) { } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } + @Override + public int getDefaultPort() { + return 3306; + } + @Override public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } + @Override + public ExceptionHandler getExceptionHandler() { + if (mariaDBExceptionHandler == null) { + mariaDBExceptionHandler = new MariaDBExceptionHandler(); + } + return mariaDBExceptionHandler; + } + public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); @@ -116,6 +93,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java index 5cdcb5e66..42d25a3ab 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java @@ -26,22 +26,26 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; public class MultiAzDialectUtils { private static final Logger LOGGER = Logger.getLogger(MultiAzDialectUtils.class.getName()); + private final String instanceIdQuery; private final String writerIdQuery; private final String writerIdQueryColumn; - private final String instanceIdQuery; - public MultiAzDialectUtils(String writerIdQuery, String writerIdQueryColumn, String instanceIdQuery) { + public MultiAzDialectUtils(String instanceIdQuery, String writerIdQuery, String writerIdQueryColumn) { + this.instanceIdQuery = instanceIdQuery; this.writerIdQuery = writerIdQuery; this.writerIdQueryColumn = writerIdQueryColumn; - this.instanceIdQuery = instanceIdQuery; } - public @Nullable List processQueryResults(Connection conn, ResultSet resultSet) + public @Nullable List processTopologyResults(Connection conn, ResultSet resultSet) throws SQLException { List hosts = new ArrayList<>(); while (resultSet.next()) { @@ -105,4 +109,16 @@ public boolean isWriterInstance(final Connection connection) throws SQLException } return false; } + + protected HostListProviderSupplier getHostListProviderSupplier(TopologyDialect dialect) { + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new MonitoringRdsHostListProvider(dialect, properties, initialUrl, servicesContainer); + + } else { + return new RdsHostListProvider(dialect, properties, initialUrl, servicesContainer); + } + }; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index de9f181d3..05b23aa37 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -33,45 +33,23 @@ public class MysqlDialect implements Dialect { + protected static final String VERSION_QUERY = "SHOW VARIABLES LIKE 'version_comment'"; + protected static final String HOST_ALIAS_QUERY = "SELECT CONCAT(@@hostname, ':', @@port)"; + + private static MySQLExceptionHandler mySQLExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MYSQL ); - private static MySQLExceptionHandler mySQLExceptionHandler; - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); - - @Override - public int getDefaultPort() { - return 3306; - } - - @Override - public ExceptionHandler getExceptionHandler() { - if (mySQLExceptionHandler == null) { - mySQLExceptionHandler = new MySQLExceptionHandler(); - } - return mySQLExceptionHandler; - } - - @Override - public String getHostAliasQuery() { - return "SELECT CONCAT(@@hostname, ':', @@port)"; - } - - @Override - public String getServerVersionQuery() { - return "SHOW VARIABLES LIKE 'version_comment'"; - } @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { while (rs.next()) { final String columnValue = rs.getString(2); if (columnValue != null && columnValue.toLowerCase().contains("mysql")) { @@ -79,31 +57,30 @@ public boolean isDialect(final Connection connection) { } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } + @Override + public int getDefaultPort() { + return 3306; + } + @Override public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } + @Override + public ExceptionHandler getExceptionHandler() { + if (mySQLExceptionHandler == null) { + mySQLExceptionHandler = new MySQLExceptionHandler(); + } + return mySQLExceptionHandler; + } + public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); @@ -117,6 +94,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 075cf242d..a612eb4e4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -36,74 +36,51 @@ */ public class PgDialect implements Dialect { + protected static final String PG_PROC_EXISTS_QUERY = "SELECT 1 FROM pg_catalog.pg_proc LIMIT 1"; + protected static final String VERSION_QUERY = "SELECT 'version', pg_catalog.VERSION()"; + protected static final String HOST_ALIAS_QUERY = + "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())"; + + private static PgExceptionHandler pgExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_PG, DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, DialectCodes.RDS_PG); - private static PgExceptionHandler pgExceptionHandler; - - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); - - @Override - public int getDefaultPort() { - return 5432; - } - - @Override - public ExceptionHandler getExceptionHandler() { - if (pgExceptionHandler == null) { - pgExceptionHandler = new PgExceptionHandler(); - } - return pgExceptionHandler; - } - - @Override - public String getHostAliasQuery() { - return "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())"; - } - - @Override - public String getServerVersionQuery() { - return "SELECT 'version', pg_catalog.VERSION()"; - } - @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery("SELECT 1 FROM pg_catalog.pg_proc LIMIT 1"); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(PG_PROC_EXISTS_QUERY)) { if (rs.next()) { return true; } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } + @Override + public int getDefaultPort() { + return 5432; + } + @Override public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } + @Override + public ExceptionHandler getExceptionHandler() { + if (pgExceptionHandler == null) { + pgExceptionHandler = new PgExceptionHandler(); + } + return pgExceptionHandler; + } + @Override public HostListProviderSupplier getHostListProvider() { return (properties, initialUrl, servicesContainer) -> @@ -118,6 +95,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java index c318b6b3d..493ccd5a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java @@ -24,45 +24,38 @@ import java.util.List; import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect implements TopologyDialect { - private static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" - + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; + protected static final String INSTANCE_ID_QUERY = "SELECT @@server_id"; // For reader instances, the query returns a writer instance ID. For a writer instance, the query returns no data. - private static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; - - private static final String WRITER_ID_QUERY_COLUMN = "Source_Server_Id"; + protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; + protected static final String WRITER_ID_QUERY_COLUMN = "Source_Server_Id"; + protected static final String IS_READER_QUERY = "SELECT @@read_only"; - private static final String INSTANCE_ID_QUERY = "SELECT @@server_id"; - private static final String IS_READER_QUERY = "SELECT @@read_only"; - - private static final EnumSet RDS_MULTI_AZ_RESTRICTIONS = + private static final EnumSet FAILOVER_RESTRICTIONS = EnumSet.of(FailoverRestriction.DISABLE_TASK_A, FailoverRestriction.ENABLE_WRITER_IN_TASK_B); protected final RdsUtils rdsUtils = new RdsUtils(); protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN, INSTANCE_ID_QUERY); + INSTANCE_ID_QUERY, WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN); @Override public boolean isDialect(final Connection connection) { try { try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { + ResultSet rs = stmt.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { if (!rs.next()) { return false; } @@ -76,7 +69,7 @@ public boolean isDialect(final Connection connection) { } try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery("SHOW VARIABLES LIKE 'report_host'")) { + ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { if (!rs.next()) { return false; } @@ -97,15 +90,7 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); - - } else { - return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); - } - }; + return this.dialectUtils.getHostListProviderSupplier(this); } @Override @@ -121,7 +106,7 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return RDS_MULTI_AZ_RESTRICTIONS; + return FAILOVER_RESTRICTIONS; } @Override @@ -130,9 +115,14 @@ public String getTopologyQuery() { } @Override - public List processQueryResults(Connection conn, ResultSet rs) + public List processTopologyResults(Connection conn, ResultSet rs) throws SQLException { - return dialectUtils.processQueryResults(conn, rs); + return dialectUtils.processTopologyResults(conn, rs); + } + + @Override + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; } @Override @@ -144,9 +134,4 @@ public boolean isWriterInstance(Connection connection) throws SQLException { public String getIsReaderQuery() { return IS_READER_QUERY; } - - @Override - public String getInstanceIdQuery() { - return INSTANCE_ID_QUERY; - } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java index fe60cb2e1..8e0ea82a0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java @@ -21,56 +21,37 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.List; -import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; public class RdsMultiAzDbClusterPgDialect extends PgDialect implements TopologyDialect { - private static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterPgDialect.class.getName()); - - private static MultiAzDbClusterPgExceptionHandler exceptionHandler; - - private static final String TOPOLOGY_QUERY = + protected static final String IS_RDS_CLUSTER_QUERY = + "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; + protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; + protected static final String INSTANCE_ID_QUERY = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()"; // For reader instances, the query should return a writer instance ID. // For a writer instance, the query should return no data. - private static final String WRITER_ID_QUERY = + protected static final String WRITER_ID_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" + " (SELECT dbi_resource_id FROM rds_tools.dbi_resource_id())"; + protected static final String WRITER_ID_QUERY_COLUMN = "multi_az_db_cluster_source_dbi_resource_id"; + protected static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; - private static final String IS_RDS_CLUSTER_QUERY = - "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; - - private static final String WRITER_ID_QUERY_COLUMN = "multi_az_db_cluster_source_dbi_resource_id"; - - private static final String INSTANCE_ID_QUERY = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()"; - - private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; + private static MultiAzDbClusterPgExceptionHandler exceptionHandler; protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN, INSTANCE_ID_QUERY); - - @Override - public ExceptionHandler getExceptionHandler() { - if (exceptionHandler == null) { - exceptionHandler = new MultiAzDbClusterPgExceptionHandler(); - } - return exceptionHandler; - } + INSTANCE_ID_QUERY, WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN); @Override public boolean isDialect(final Connection connection) { try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(IS_RDS_CLUSTER_QUERY)) { + ResultSet rs = stmt.executeQuery(IS_RDS_CLUSTER_QUERY)) { return rs.next() && rs.getString(1) != null; } catch (final SQLException ex) { // ignore @@ -83,16 +64,17 @@ public boolean isDialect(final Connection connection) { return null; } + @Override + public ExceptionHandler getExceptionHandler() { + if (exceptionHandler == null) { + exceptionHandler = new MultiAzDbClusterPgExceptionHandler(); + } + return exceptionHandler; + } + @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); - } else { - return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); - } - }; + return this.dialectUtils.getHostListProviderSupplier(this); } @Override @@ -101,23 +83,23 @@ public String getTopologyQuery() { } @Override - public boolean isWriterInstance(Connection connection) throws SQLException { - return dialectUtils.isWriterInstance(connection); + public @Nullable List processTopologyResults(Connection conn, ResultSet rs) + throws SQLException { + return this.dialectUtils.processTopologyResults(conn, rs); } @Override - public String getIsReaderQuery() { - return IS_READER_QUERY; + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; } @Override - public String getInstanceIdQuery() { - return INSTANCE_ID_QUERY; + public boolean isWriterInstance(Connection connection) throws SQLException { + return dialectUtils.isWriterInstance(connection); } @Override - public @Nullable List processQueryResults(Connection conn, ResultSet rs) - throws SQLException { - return this.dialectUtils.processQueryResults(conn, rs); + public String getIsReaderQuery() { + return IS_READER_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java index 22e010ea7..8fa19292e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java @@ -26,13 +26,14 @@ public class RdsMysqlDialect extends MysqlDialect implements BlueGreenDialect { - private static final String BG_STATUS_QUERY = - "SELECT * FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String BG_STATUS_QUERY = + "SELECT * FROM mysql.rds_topology"; + private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); @@ -53,50 +54,34 @@ public boolean isDialect(final Connection connection) { // | Variable_name | value | // |-----------------|---------------------| // | version_comment | Source distribution | - // If super.idDialect returns true there is no need to check for RdsMysqlDialect. + // If super.isDialect returns true there is no need to check for RdsMysqlDialect. return false; } - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); - if (!rs.next()) { - return false; - } - final String columnValue = rs.getString(2); - if (!"Source distribution".equalsIgnoreCase(columnValue)) { - return false; - } - - rs.close(); - rs = stmt.executeQuery("SHOW VARIABLES LIKE 'report_host'"); - if (!rs.next()) { - return false; - } - final String reportHost = rs.getString(2); // get variable value; expected empty value - return StringUtils.isNullOrEmpty(reportHost); + try (Statement stmt = connection.createStatement()) { + try (ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { + if (!rs.next()) { + return false; + } - } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore + final String columnValue = rs.getString(2); + if (!"Source distribution".equalsIgnoreCase(columnValue)) { + return false; } } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore + + try (ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } + + final String reportHost = rs.getString(2); // get variable value; expected empty value + return StringUtils.isNullOrEmpty(reportHost); } + + } catch (final SQLException ex) { + return false; } - return false; } @Override @@ -104,20 +89,20 @@ public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } - @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; - } - @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { try { try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { + ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { return rs.next(); } } catch (SQLException ex) { return false; } } + + @Override + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index d59b9f2eb..43cf1f5e9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -33,34 +33,29 @@ */ public class RdsPgDialect extends PgDialect implements BlueGreenDialect { - private static final Logger LOGGER = Logger.getLogger(RdsPgDialect.class.getName()); - - private static final List dialectUpdateCandidates = Arrays.asList( - DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, - DialectCodes.AURORA_PG); - - private static final String extensionsSql = "SELECT (setting LIKE '%rds_tools%') AS rds_tools, " + protected static final String EXTENSIONS_EXIST_SQL = "SELECT (setting LIKE '%rds_tools%') AS rds_tools, " + "(setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " + "FROM pg_catalog.pg_settings " + "WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = + "SELECT 'rds_tools.show_topology'::regproc"; - private static final String BG_STATUS_QUERY = + protected static final String BG_STATUS_QUERY = "SELECT * FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - private static final String TOPOLOGY_TABLE_EXIST_QUERY = - "SELECT 'rds_tools.show_topology'::regproc"; + private static final Logger LOGGER = Logger.getLogger(RdsPgDialect.class.getName()); + private static final List dialectUpdateCandidates = Arrays.asList( + DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, + DialectCodes.AURORA_PG); @Override public boolean isDialect(final Connection connection) { if (!super.isDialect(connection)) { return false; } - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(extensionsSql); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(EXTENSIONS_EXIST_SQL)) { while (rs.next()) { final boolean rdsTools = rs.getBoolean("rds_tools"); final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); @@ -70,23 +65,9 @@ public boolean isDialect(final Connection connection) { } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } @@ -95,20 +76,20 @@ public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } - @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; - } - @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { try { try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { + ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { return rs.next(); } } catch (SQLException ex) { return false; } } + + @Override + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index f7cd8a694..f3fb5a9ff 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -26,12 +26,13 @@ public interface TopologyDialect extends Dialect { String getTopologyQuery(); @Nullable - List processQueryResults(Connection conn, ResultSet rs) throws SQLException; + List processTopologyResults(Connection conn, ResultSet rs) throws SQLException; - // TODO: can we remove this and use getHostRole instead? + String getInstanceIdQuery(); + + // TODO: dialects have an isWriterInstance method (uses is_writer query) and a getHostRole method + // (uses is_reader query). Can we merge them into one getHostRole method? boolean isWriterInstance(final Connection connection) throws SQLException; String getIsReaderQuery(); - - String getInstanceIdQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 262f65f23..b58a0bc3c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -26,7 +26,6 @@ import java.util.Objects; import java.util.Properties; import java.util.UUID; -import java.util.concurrent.Executor; import java.util.concurrent.TimeUnit; import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; @@ -44,7 +43,6 @@ import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.SynchronousExecutor; import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; @@ -76,7 +74,6 @@ public class RdsHostListProvider implements DynamicHostListProvider { + "This pattern is required to be specified for IP address or custom domain connections to AWS RDS " + "clusters. Otherwise, if unspecified, the pattern will be automatically created for AWS RDS clusters."); - protected static final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); protected static final int defaultTopologyQueryTimeoutMs = 5000; @@ -347,17 +344,6 @@ protected List queryForTopology(final Connection conn) throws SQLExcep return this.topologyUtils.queryForTopology(conn); } - /** - * Build a host dns endpoint based on host/node name. - * - * @param nodeName A host name. - * @return Host dns endpoint - */ - protected String getHostEndpoint(final String nodeName) { - final String host = this.clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); - } - /** * Get cached topology. * @@ -473,7 +459,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { @Override public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { - // TODO: why do we return null in some unexpected scenarios and throw an exception in others? try { String instanceId = this.topologyUtils.getInstanceId(connection); if (instanceId == null) { @@ -488,6 +473,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { } if (topology == null) { + // TODO: above, we throw an exception, but here, we return null. Should we stick with just one? return null; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index be4aa66d9..df15a2b80 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -22,7 +22,6 @@ import java.util.Properties; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; -import java.util.logging.Logger; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.BlockingHostListProvider; import software.amazon.jdbc.HostSpec; @@ -36,10 +35,8 @@ import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; -public class MonitoringRdsHostListProvider extends RdsHostListProvider - implements BlockingHostListProvider, CanReleaseResources { - - private static final Logger LOGGER = Logger.getLogger(MonitoringRdsHostListProvider.class.getName()); +public class MonitoringRdsHostListProvider + extends RdsHostListProvider implements BlockingHostListProvider, CanReleaseResources { public static final AwsWrapperProperty CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS = new AwsWrapperProperty( diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java index 598dc73bb..83c5281d7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java @@ -25,7 +25,6 @@ import java.util.ArrayList; import java.util.Comparator; import java.util.List; -import java.util.Objects; import java.util.concurrent.Executor; import java.util.logging.Logger; import java.util.stream.Collectors; @@ -73,8 +72,8 @@ public TopologyUtils( try (final Statement stmt = conn.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - List queryHosts = this.dialect.processQueryResults(conn, resultSet); - return this.processQueryResults(queryHosts); + List queryHosts = this.dialect.processTopologyResults(conn, resultSet); + return this.processTopologyResults(queryHosts); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -84,7 +83,7 @@ public TopologyUtils( } } - protected @Nullable List processQueryResults(@Nullable List queryHosts) { + protected @Nullable List processTopologyResults(@Nullable List queryHosts) { if (queryHosts == null) { return null; } @@ -147,6 +146,7 @@ protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { } catch (SQLException ex) { // do nothing } + return null; } From 80981657eeaa77eedf712d0c24eb32c6a4a8d9cc Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 30 Oct 2025 17:06:02 -0700 Subject: [PATCH 25/90] getHostListProvider -> getHostListProviderSupplier, RdsMultiAzDb -> MultiAz --- ...ClusterMysqlDialect.java => MultiAzClusterMysqlDialect.java} | 2 +- ...tiAzDbClusterPgDialect.java => MultiAzClusterPgDialect.java} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename wrapper/src/main/java/software/amazon/jdbc/dialect/{RdsMultiAzDbClusterMysqlDialect.java => MultiAzClusterMysqlDialect.java} (98%) rename wrapper/src/main/java/software/amazon/jdbc/dialect/{RdsMultiAzDbClusterPgDialect.java => MultiAzClusterPgDialect.java} (98%) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java similarity index 98% rename from wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 493ccd5a1..96673630f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -89,7 +89,7 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return this.dialectUtils.getHostListProviderSupplier(this); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java similarity index 98% rename from wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 8e0ea82a0..af805cda7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -73,7 +73,7 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return this.dialectUtils.getHostListProviderSupplier(this); } From 983722cb83f9a068f207c7799762c1fd7194bcf6 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 30 Oct 2025 17:25:19 -0700 Subject: [PATCH 26/90] Checkstyle passing --- .../amazon/jdbc/PartialPluginService.java | 2 +- .../amazon/jdbc/PluginServiceImpl.java | 2 +- .../jdbc/dialect/AuroraMysqlDialect.java | 2 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 2 +- .../software/amazon/jdbc/dialect/Dialect.java | 2 +- .../amazon/jdbc/dialect/DialectManager.java | 4 ++-- .../amazon/jdbc/dialect/MariaDbDialect.java | 2 +- .../dialect/MultiAzClusterMysqlDialect.java | 2 +- .../jdbc/dialect/MultiAzClusterPgDialect.java | 2 +- .../amazon/jdbc/dialect/MysqlDialect.java | 2 +- .../amazon/jdbc/dialect/PgDialect.java | 2 +- .../amazon/jdbc/dialect/UnknownDialect.java | 2 +- .../jdbc/plugin/AbstractConnectionPlugin.java | 2 +- ...AuroraInitialConnectionStrategyPlugin.java | 2 +- .../jdbc/plugin/DefaultConnectionPlugin.java | 2 +- .../bluegreen/BlueGreenStatusMonitor.java | 4 ++-- .../failover/FailoverConnectionPlugin.java | 2 +- .../failover2/FailoverConnectionPlugin.java | 2 +- .../ReadWriteSplittingPlugin.java | 2 +- .../plugin/staledns/AuroraStaleDnsHelper.java | 2 +- .../plugin/staledns/AuroraStaleDnsPlugin.java | 2 +- .../HostResponseTimeServiceImpl.java | 1 - .../jdbc/util/FullServicesContainer.java | 2 +- .../jdbc/util/FullServicesContainerImpl.java | 2 +- .../amazon/jdbc/util/ServiceUtility.java | 4 ++-- .../jdbc/wrapper/ConnectionWrapper.java | 2 +- .../container/tests/PerformanceTest.java | 1 - .../amazon/jdbc/DialectDetectionTests.java | 8 ++++---- .../software/amazon/jdbc/DialectTests.java | 8 ++++---- .../jdbc/RoundRobinHostSelectorTest.java | 5 ----- .../amazon/jdbc/mock/TestPluginOne.java | 2 +- .../FailoverConnectionPluginTest.java | 2 +- .../LimitlessConnectionPluginTest.java | 2 +- .../LimitlessRouterServiceImplTest.java | 2 +- .../ReadWriteSplittingPluginTest.java | 2 +- .../hibernate_files/DataSourceTest.java | 7 +++---- ...stgreSQLCastingIntervalSecondJdbcType.java | 1 - .../PostgresIntervalSecondTest.java | 19 ++++++++---------- .../StructEmbeddableArrayTest.java | 20 ++++++++----------- 39 files changed, 60 insertions(+), 76 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 189c03c62..873d18b08 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -132,7 +132,7 @@ public PartialPluginService( ? this.configurationProfile.getExceptionHandler() : null; - HostListProviderSupplier supplier = this.dbDialect.getHostListProvider(); + HostListProviderSupplier supplier = this.dbDialect.getHostListProviderSupplier(); this.hostListProvider = supplier.getProvider(this.props, this.originalUrl, this.servicesContainer); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 69e4b6664..8d39ec768 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -729,7 +729,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } - final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); + final HostListProviderSupplier supplier = this.dialect.getHostListProviderSupplier(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); this.refreshHostList(connection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 5b0551296..b43129230 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -72,7 +72,7 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 5f1452069..62178449c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -104,7 +104,7 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java index 4fe1d7f8b..5f09aae0b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java @@ -35,7 +35,7 @@ public interface Dialect { ExceptionHandler getExceptionHandler(); - HostListProviderSupplier getHostListProvider(); + HostListProviderSupplier getHostListProviderSupplier(); String getHostAliasQuery(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index d29a1b3dd..23c39a7a5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -57,9 +57,9 @@ public class DialectManager implements DialectProvider { put(DialectCodes.PG, new PgDialect()); put(DialectCodes.MARIADB, new MariaDbDialect()); put(DialectCodes.RDS_MYSQL, new RdsMysqlDialect()); - put(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, new RdsMultiAzDbClusterMysqlDialect()); + put(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, new MultiAzClusterMysqlDialect()); put(DialectCodes.RDS_PG, new RdsPgDialect()); - put(DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, new RdsMultiAzDbClusterPgDialect()); + put(DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, new MultiAzClusterPgDialect()); put(DialectCodes.AURORA_MYSQL, new AuroraMysqlDialect()); put(DialectCodes.AURORA_PG, new AuroraPgDialect()); put(DialectCodes.UNKNOWN, new UnknownDialect()); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java index fc017eb96..58453f6fa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java @@ -80,7 +80,7 @@ public ExceptionHandler getExceptionHandler() { return mariaDBExceptionHandler; } - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 96673630f..85428a18a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -30,7 +30,7 @@ import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect implements TopologyDialect { +public class MultiAzClusterMysqlDialect extends MysqlDialect implements TopologyDialect { protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index af805cda7..50e3a495a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -26,7 +26,7 @@ import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; import software.amazon.jdbc.util.DriverInfo; -public class RdsMultiAzDbClusterPgDialect extends PgDialect implements TopologyDialect { +public class MultiAzClusterPgDialect extends PgDialect implements TopologyDialect { protected static final String IS_RDS_CLUSTER_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index 05b23aa37..ae07fc808 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -81,7 +81,7 @@ public ExceptionHandler getExceptionHandler() { return mySQLExceptionHandler; } - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index a612eb4e4..c136416e8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -82,7 +82,7 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java index 65b9eb544..05085bb3e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java @@ -80,7 +80,7 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java index 22c5b13aa..9cfb8de24 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java @@ -24,12 +24,12 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.OldConnectionSuggestedAction; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; public abstract class AbstractConnectionPlugin implements ConnectionPlugin { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index a828183e1..4464a56d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -27,13 +27,13 @@ import java.util.concurrent.TimeUnit; import java.util.logging.Logger; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java index b69c1cdad..adc955484 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java @@ -34,7 +34,6 @@ import software.amazon.jdbc.ConnectionPlugin; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -43,6 +42,7 @@ import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlMethodAnalyzer; import software.amazon.jdbc.util.WrapperUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 637791549..832e06056 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -43,12 +43,12 @@ import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.dialect.BlueGreenDialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.iam.IamAuthConnectionPlugin; import software.amazon.jdbc.util.ConnectionUrlParser; @@ -626,7 +626,7 @@ protected void initHostListProvider() { if (connectionHostSpecCopy != null) { String hostListProviderUrl = String.format("%s%s/", protocol, connectionHostSpecCopy.getHostAndPort()); this.hostListProvider = this.pluginService.getDialect() - .getHostListProvider() + .getHostListProviderSupplier() .getProvider( hostListProperties, hostListProviderUrl, diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 30fcb0701..88f68e72b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -33,7 +33,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -43,6 +42,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index c0b1a7660..57cfb80c7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -31,7 +31,6 @@ import java.util.logging.Logger; import java.util.stream.Collectors; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -40,6 +39,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverFailedSQLException; import software.amazon.jdbc.plugin.failover.FailoverMode; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 27263c19c..adeaa7365 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -28,7 +28,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -38,6 +37,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; import software.amazon.jdbc.util.Messages; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 6050df3ef..bdcb227a4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -25,12 +25,12 @@ import java.util.Map; import java.util.Properties; import java.util.logging.Logger; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index b3cea1d1d..936ee1233 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -25,12 +25,12 @@ import java.util.Properties; import java.util.Set; import java.util.logging.Logger; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.JdbcMethod; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java index 9915391ac..4d90f6d5d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java @@ -28,7 +28,6 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.storage.SlidingExpirationCacheWithCleanupThread; public class HostResponseTimeServiceImpl implements HostResponseTimeService { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java index cbe122ed8..4420bab7d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java @@ -18,9 +18,9 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java index 349239668..44cfda664 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java @@ -18,9 +18,9 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index e06261bcb..3e4b134a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -21,11 +21,11 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.PartialPluginService; import software.amazon.jdbc.PluginServiceImpl; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.HostListProviderSupplier; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.monitoring.MonitorService; @@ -73,7 +73,7 @@ public FullServicesContainer createStandardServiceContainer( servicesContainer.setPluginManagerService(pluginService); pluginManager.initPlugins(servicesContainer, configurationProfile); - final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProvider(); + final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProviderSupplier(); if (supplier != null) { final HostListProvider provider = supplier.getProvider(props, originalUrl, servicesContainer); pluginService.setHostListProvider(provider); diff --git a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java index a57d23183..dd37a2cd0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java @@ -39,12 +39,12 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.JdbcMethod; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; diff --git a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java index a1c1bcd72..cc264dfb4 100644 --- a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java @@ -62,7 +62,6 @@ import org.junit.jupiter.params.provider.Arguments; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.OpenedConnectionTracker; import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java index d86238214..49cde84b1 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java @@ -43,10 +43,10 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.DialectManager; import software.amazon.jdbc.dialect.MariaDbDialect; +import software.amazon.jdbc.dialect.MultiAzClusterMysqlDialect; +import software.amazon.jdbc.dialect.MultiAzClusterPgDialect; import software.amazon.jdbc.dialect.MysqlDialect; import software.amazon.jdbc.dialect.PgDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterMysqlDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterPgDialect; import software.amazon.jdbc.dialect.RdsMysqlDialect; import software.amazon.jdbc.dialect.RdsPgDialect; import software.amazon.jdbc.exceptions.ExceptionManager; @@ -220,7 +220,7 @@ void testUpdateDialectPgToTaz() throws SQLException { final PluginServiceImpl target = getPluginService(LOCALHOST, PG_PROTOCOL); target.setInitialConnectionHostSpec(mockHost); target.updateDialect(mockConnection); - assertEquals(RdsMultiAzDbClusterPgDialect.class, target.dialect.getClass()); + assertEquals(MultiAzClusterPgDialect.class, target.dialect.getClass()); } @Test @@ -273,7 +273,7 @@ void testUpdateDialectMariaToMysqlTaz() throws SQLException { final PluginServiceImpl target = getPluginService(LOCALHOST, MARIA_PROTOCOL); target.setInitialConnectionHostSpec(mockHost); target.updateDialect(mockConnection); - assertEquals(RdsMultiAzDbClusterMysqlDialect.class, target.dialect.getClass()); + assertEquals(MultiAzClusterMysqlDialect.class, target.dialect.getClass()); } @Test diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java index 4170f8556..e3c2df258 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java @@ -36,10 +36,10 @@ import software.amazon.jdbc.dialect.AuroraMysqlDialect; import software.amazon.jdbc.dialect.AuroraPgDialect; import software.amazon.jdbc.dialect.MariaDbDialect; +import software.amazon.jdbc.dialect.MultiAzClusterMysqlDialect; +import software.amazon.jdbc.dialect.MultiAzClusterPgDialect; import software.amazon.jdbc.dialect.MysqlDialect; import software.amazon.jdbc.dialect.PgDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterMysqlDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterPgDialect; import software.amazon.jdbc.dialect.RdsMysqlDialect; import software.amazon.jdbc.dialect.RdsPgDialect; @@ -51,11 +51,11 @@ public class DialectTests { @Mock private ResultSetMetaData mockResultSetMetaData; private final MysqlDialect mysqlDialect = new MysqlDialect(); private final RdsMysqlDialect rdsMysqlDialect = new RdsMysqlDialect(); - private final RdsMultiAzDbClusterMysqlDialect rdsTazMysqlDialect = new RdsMultiAzDbClusterMysqlDialect(); + private final MultiAzClusterMysqlDialect rdsTazMysqlDialect = new MultiAzClusterMysqlDialect(); private final AuroraMysqlDialect auroraMysqlDialect = new AuroraMysqlDialect(); private final PgDialect pgDialect = new PgDialect(); private final RdsPgDialect rdsPgDialect = new RdsPgDialect(); - private final RdsMultiAzDbClusterPgDialect rdsTazPgDialect = new RdsMultiAzDbClusterPgDialect(); + private final MultiAzClusterPgDialect rdsTazPgDialect = new MultiAzClusterPgDialect(); private final AuroraPgDialect auroraPgDialect = new AuroraPgDialect(); private final MariaDbDialect mariaDbDialect = new MariaDbDialect(); private AutoCloseable closeable; diff --git a/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java b/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java index 7a523a3e7..3f61a1ec8 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java @@ -27,12 +27,7 @@ import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.RoundRobinHostSelector; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.util.HostSelectorUtils; public class RoundRobinHostSelectorTest { private static final int TEST_PORT = 5432; diff --git a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java index 36f077f73..523d3be59 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java +++ b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java @@ -27,7 +27,6 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -35,6 +34,7 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.OldConnectionSuggestedAction; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; public class TestPluginOne implements ConnectionPlugin { diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java index 859472bb4..2c72ed243 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java @@ -49,7 +49,6 @@ import org.junit.jupiter.params.provider.ValueSource; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -58,6 +57,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java index 13de74a6b..e6e498a41 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java @@ -35,7 +35,6 @@ import org.mockito.MockitoAnnotations; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -45,6 +44,7 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.PgDialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; public class LimitlessConnectionPluginTest { diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java index 0b3e7c2a5..81559231c 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java @@ -39,7 +39,6 @@ import org.mockito.MockitoAnnotations; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.HighestWeightHostSelector; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -48,6 +47,7 @@ import software.amazon.jdbc.WeightedRandomHostSelector; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.FullServicesContainerImpl; import software.amazon.jdbc.util.events.EventPublisher; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java index 834e932d2..683346da3 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java @@ -45,7 +45,6 @@ import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -56,6 +55,7 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.util.SqlState; diff --git a/wrapper/src/test/resources/hibernate_files/DataSourceTest.java b/wrapper/src/test/resources/hibernate_files/DataSourceTest.java index 624114400..38a6b1c78 100644 --- a/wrapper/src/test/resources/hibernate_files/DataSourceTest.java +++ b/wrapper/src/test/resources/hibernate_files/DataSourceTest.java @@ -4,6 +4,9 @@ */ package org.hibernate.orm.test.datasource; +import static org.hibernate.internal.util.StringHelper.split; +import static org.junit.jupiter.api.Assertions.assertTrue; + import jakarta.persistence.Entity; import jakarta.persistence.Id; import org.hibernate.cfg.Environment; @@ -21,10 +24,6 @@ import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; - -import static org.hibernate.internal.util.StringHelper.split; -import static org.junit.jupiter.api.Assertions.assertTrue; - @Jpa(annotatedClasses = DataSourceTest.TestEntity.class, integrationSettings = @Setting(name = JdbcSettings.CONNECTION_PROVIDER, value = "org.hibernate.orm.test.datasource.TestDataSourceConnectionProvider")) diff --git a/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java b/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java index 7dcd98188..55f5386bf 100644 --- a/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java +++ b/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java @@ -9,7 +9,6 @@ import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; - import org.hibernate.dialect.Dialect; import org.hibernate.engine.spi.SessionFactoryImplementor; import org.hibernate.metamodel.mapping.JdbcMappingContainer; diff --git a/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java b/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java index f07faccac..065b83fb3 100644 --- a/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java +++ b/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java @@ -6,33 +6,30 @@ import static org.assertj.core.api.Assertions.assertThat; +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.Table; import java.time.Duration; - import org.hibernate.annotations.JdbcTypeCode; import org.hibernate.cfg.AvailableSettings; import org.hibernate.dialect.PostgreSQLDialect; import org.hibernate.dialect.type.PostgreSQLIntervalSecondJdbcType; import org.hibernate.metamodel.spi.MappingMetamodelImplementor; import org.hibernate.persister.entity.EntityPersister; -import org.hibernate.type.SqlTypes; -import org.hibernate.type.descriptor.jdbc.JdbcType; -import org.hibernate.type.descriptor.jdbc.NumericJdbcType; -import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry; - import org.hibernate.testing.orm.junit.DomainModel; import org.hibernate.testing.orm.junit.RequiresDialect; import org.hibernate.testing.orm.junit.ServiceRegistry; import org.hibernate.testing.orm.junit.SessionFactory; import org.hibernate.testing.orm.junit.SessionFactoryScope; import org.hibernate.testing.orm.junit.Setting; +import org.hibernate.type.SqlTypes; +import org.hibernate.type.descriptor.jdbc.JdbcType; +import org.hibernate.type.descriptor.jdbc.NumericJdbcType; +import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; -import jakarta.persistence.Column; -import jakarta.persistence.Entity; -import jakarta.persistence.Id; -import jakarta.persistence.Table; - /** * Test to see if using `@org.hibernate.annotations.JdbcTypeCode` or `@org.hibernate.annotations.JdbcType` * will override a default JdbcType set by a {@link AvailableSettings#PREFERRED_DURATION_JDBC_TYPE config property}. diff --git a/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java b/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java index c7c7faa20..46cc08277 100644 --- a/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java +++ b/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java @@ -4,6 +4,14 @@ */ package org.hibernate.orm.test.mapping.embeddable; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNull; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.ParameterMode; +import jakarta.persistence.Tuple; import java.net.URL; import java.sql.Time; import java.sql.Timestamp; @@ -18,7 +26,6 @@ import java.util.List; import java.util.Set; import java.util.UUID; - import org.hibernate.annotations.Struct; import org.hibernate.boot.ResourceStreamLocator; import org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl; @@ -35,7 +42,6 @@ import org.hibernate.dialect.PostgresPlusDialect; import org.hibernate.procedure.ProcedureCall; import org.hibernate.procedure.ProcedureParameter; - import org.hibernate.testing.jdbc.SharedDriverManagerTypeCacheClearingIntegrator; import org.hibernate.testing.orm.domain.gambit.EntityOfBasics; import org.hibernate.testing.orm.domain.gambit.MutableValue; @@ -54,16 +60,6 @@ import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; -import jakarta.persistence.Entity; -import jakarta.persistence.Id; -import jakarta.persistence.ParameterMode; -import jakarta.persistence.Tuple; - -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertInstanceOf; -import static org.junit.jupiter.api.Assertions.assertNull; - @BootstrapServiceRegistry( javaServices = @BootstrapServiceRegistry.JavaService( role = AdditionalMappingContributor.class, From 3608e73ff067e3db0b3edd506ce8f80a57c3d17d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 30 Oct 2025 17:45:25 -0700 Subject: [PATCH 27/90] wip unit tests failing --- .../hostlistprovider/RdsHostListProvider.java | 23 +++++++++++++++---- .../RdsHostListProviderTest.java | 9 ++++++-- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index b58a0bc3c..825125352 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -121,6 +121,17 @@ public RdsHostListProvider( this.hostListProviderService = servicesContainer.getHostListProviderService(); } + // For testing purposes only + public RdsHostListProvider( + final TopologyDialect dialect, + final Properties properties, + final String originalUrl, + final FullServicesContainer servicesContainer, + final TopologyUtils topologyUtils) { + this(dialect, properties, originalUrl, servicesContainer); + this.topologyUtils = topologyUtils; + } + protected void init() throws SQLException { if (this.isInitialized) { return; @@ -192,11 +203,13 @@ protected void init() throws SQLException { } } - this.topologyUtils = new TopologyUtils( - this.dialect, - this.clusterInstanceTemplate, - this.initialHostSpec, - this.servicesContainer.getPluginService().getHostSpecBuilder()); + if (this.topologyUtils == null) { + this.topologyUtils = new TopologyUtils( + this.dialect, + this.clusterInstanceTemplate, + this.initialHostSpec, + this.servicesContainer.getPluginService().getHostSpecBuilder()); + } this.isInitialized = true; } finally { diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index e5e00aeaf..778d1c16a 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -64,6 +64,7 @@ import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.events.EventPublisher; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.storage.TestStorageServiceImpl; @@ -78,7 +79,9 @@ class RdsHostListProviderTest { @Mock private FullServicesContainer mockServicesContainer; @Mock private PluginService mockPluginService; @Mock private HostListProviderService mockHostListProviderService; + @Mock private HostSpecBuilder mockHostSpecBuilder; @Mock private EventPublisher mockEventPublisher; + @Mock private TopologyUtils mockTopologyUtils; @Mock private TopologyDialect mockDialect; @Captor private ArgumentCaptor queryCaptor; @@ -95,9 +98,11 @@ void setUp() throws SQLException { storageService = new TestStorageServiceImpl(mockEventPublisher); when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); when(mockServicesContainer.getStorageService()).thenReturn(storageService); + when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); + when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); when(mockConnection.createStatement()).thenReturn(mockStatement); when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); @@ -114,8 +119,8 @@ void tearDown() throws Exception { } private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { - RdsHostListProvider provider = - new RdsHostListProvider(mockDialect, new Properties(), originalUrl, mockServicesContainer); + RdsHostListProvider provider = new RdsHostListProvider( + mockDialect, new Properties(), originalUrl, mockServicesContainer, mockTopologyUtils); provider.init(); return provider; } From 73a9b87a150863169df381cada72588c50c3a403 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 31 Oct 2025 09:51:33 -0700 Subject: [PATCH 28/90] Move TopologyUtils to hostlistprovider package --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 1 - .../jdbc/{util => hostlistprovider}/TopologyUtils.java | 6 ++++-- .../monitoring/ClusterTopologyMonitorImpl.java | 3 +-- .../jdbc/hostlistprovider/RdsHostListProviderTest.java | 1 - 4 files changed, 5 insertions(+), 6 deletions(-) rename wrapper/src/main/java/software/amazon/jdbc/{util => hostlistprovider}/TopologyUtils.java (97%) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 825125352..1adb1a6c4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -43,7 +43,6 @@ import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java similarity index 97% rename from wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index 83c5281d7..542783f5c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -15,7 +15,7 @@ */ -package software.amazon.jdbc.util; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; import java.sql.ResultSet; @@ -35,6 +35,8 @@ import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.dialect.TopologyQueryHostSpec; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.SynchronousExecutor; public class TopologyUtils { private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); @@ -144,7 +146,7 @@ protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { } } } catch (SQLException ex) { - // do nothing + return null; } return null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 7ab890ef5..ccb74f843 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -49,7 +49,7 @@ import software.amazon.jdbc.util.ServiceUtility; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; -import software.amazon.jdbc.util.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; @@ -614,7 +614,6 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { } return hosts; } catch (SQLException ex) { - // do nothing LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[]{ex})); } return null; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 778d1c16a..9ee39e1b5 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -64,7 +64,6 @@ import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.TopologyUtils; import software.amazon.jdbc.util.events.EventPublisher; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.storage.TestStorageServiceImpl; From da670816843f64827ab8531f82cf99bfaa4e8547 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 31 Oct 2025 14:15:28 -0700 Subject: [PATCH 29/90] RdsHostListProviderTest passing --- .../hostlistprovider/RdsHostListProvider.java | 2 +- .../RdsHostListProviderTest.java | 144 +----------------- 2 files changed, 7 insertions(+), 139 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 1adb1a6c4..ac48b6442 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -261,7 +261,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f } // fetch topology from the DB - final List hosts = this.topologyUtils.queryForTopology(conn); + final List hosts = this.queryForTopology(conn); if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 9ee39e1b5..ceadddb74 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -146,7 +146,7 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio final List newHosts = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(rdsHostListProvider).queryForTopology(mockConnection); + doReturn(newHosts).when(mockTopologyUtils).queryForTopology(mockConnection); final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); @@ -194,9 +194,7 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { final List expectedPostgres = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getBoolean(eq(2))).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("mysql"); + when(mockTopologyUtils.queryForTopology(mockConnection)).thenReturn(expectedMySQL).thenReturn(expectedPostgres); rdsHostListProvider = getRdsHostListProvider("mysql://url/"); @@ -204,24 +202,11 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { List hosts = rdsHostListProvider.queryForTopology(mockConnection); assertEquals(expectedMySQL, hosts); - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getString(eq(1))).thenReturn("postgresql"); - rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); hosts = rdsHostListProvider.queryForTopology(mockConnection); assertEquals(expectedPostgres, hosts); } - @Test - void testQueryForTopology_queryResultsInException() throws SQLException { - rdsHostListProvider = getRdsHostListProvider("protocol://url/"); - when(mockStatement.executeQuery(queryCaptor.capture())).thenThrow(new SQLSyntaxErrorException()); - - assertThrows( - SQLException.class, - () -> rdsHostListProvider.queryForTopology(mockConnection)); - } - @Test void testGetCachedTopology_returnStoredTopology() throws SQLException { rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); @@ -298,7 +283,7 @@ void testTopologyCache_SuggestedClusterIdForRds() throws SQLException { .role(HostRole.READER) .build()); - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); + doReturn(topologyClusterA).when(mockTopologyUtils).queryForTopology(any(Connection.class)); assertEquals(0, storageService.size(Topology.class)); @@ -441,8 +426,7 @@ void testIdentifyConnectionNullTopology() throws SQLException { rdsHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) .host("?.pattern").build(); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); doReturn(null).when(rdsHostListProvider).refresh(mockConnection); doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -459,8 +443,7 @@ void testIdentifyConnectionHostNotInTopology() throws SQLException { .build()); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -478,8 +461,7 @@ void testIdentifyConnectionHostInTopology() throws SQLException { final List cachedTopology = Collections.singletonList(expectedHost); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-a-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -488,123 +470,9 @@ void testIdentifyConnectionHostInTopology() throws SQLException { assertEquals("instance-a-1", actual.getHostId()); } - @Test - void testGetTopology_StaleRecord() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - final String hostName1 = "hostName1"; - final String hostName2 = "hostName2"; - final Double cpuUtilization = 11.1D; - final Double nodeLag = 0.123D; - final Timestamp firstTimestamp = Timestamp.from(Instant.now()); - final Timestamp secondTimestamp = new Timestamp(firstTimestamp.getTime() + 100); - when(mockResultSet.next()).thenReturn(true, true, false); - when(mockResultSet.getString(1)).thenReturn(hostName1).thenReturn(hostName2); - when(mockResultSet.getBoolean(2)).thenReturn(true).thenReturn(true); - when(mockResultSet.getDouble(3)).thenReturn(cpuUtilization).thenReturn(cpuUtilization); - when(mockResultSet.getDouble(4)).thenReturn(nodeLag).thenReturn(nodeLag); - when(mockResultSet.getTimestamp(5)).thenReturn(firstTimestamp).thenReturn(secondTimestamp); - long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - final HostSpec expectedWriter = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host(hostName2) - .port(-1) - .role(HostRole.WRITER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(secondTimestamp) - .build(); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(expectedWriter, result.hosts.get(0)); - } - - @Test - void testGetTopology_InvalidLastUpdatedTimestamp() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - final String hostName = "hostName"; - final Double cpuUtilization = 11.1D; - final Double nodeLag = 0.123D; - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getString(1)).thenReturn(hostName); - when(mockResultSet.getBoolean(2)).thenReturn(true); - when(mockResultSet.getDouble(3)).thenReturn(cpuUtilization); - when(mockResultSet.getDouble(4)).thenReturn(nodeLag); - when(mockResultSet.getTimestamp(5)).thenThrow(WrongArgumentException.class); - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - final String expectedLastUpdatedTimeStampRounded = Timestamp.from(Instant.now()).toString().substring(0, 16); - assertEquals(1, result.hosts.size()); - assertEquals( - expectedLastUpdatedTimeStampRounded, - result.hosts.get(0).getLastUpdateTime().toString().substring(0, 16)); - } - - @Test - void testGetTopology_returnsLatestWriter() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - HostSpec expectedWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("expectedWriterHost") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("3000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHost0 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHost0") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("1000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHost1 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHost1") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("2000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHostWithNullLastUpdateTime0 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHostWithNullLastUpdateTime0") - .role(HostRole.WRITER) - .lastUpdateTime(null) - .build(); - - HostSpec unexpectedWriterHostWithNullLastUpdateTime1 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHostWithNullLastUpdateTime1") - .role(HostRole.WRITER) - .lastUpdateTime(null) - .build(); - - when(mockResultSet.next()).thenReturn(true, true, true, true, true, false); - - when(mockResultSet.getString(1)).thenReturn( - unexpectedWriterHostWithNullLastUpdateTime0.getHost(), - unexpectedWriterHost0.getHost(), - expectedWriterHost.getHost(), - unexpectedWriterHost1.getHost(), - unexpectedWriterHostWithNullLastUpdateTime1.getHost()); - when(mockResultSet.getBoolean(2)).thenReturn(true, true, true, true, true); - when(mockResultSet.getFloat(3)).thenReturn((float) 0, (float) 0, (float) 0, (float) 0, (float) 0); - when(mockResultSet.getFloat(4)).thenReturn((float) 0, (float) 0, (float) 0, (float) 0, (float) 0); - when(mockResultSet.getTimestamp(5)).thenReturn( - unexpectedWriterHostWithNullLastUpdateTime0.getLastUpdateTime(), - unexpectedWriterHost0.getLastUpdateTime(), - expectedWriterHost.getLastUpdateTime(), - unexpectedWriterHost1.getLastUpdateTime(), - unexpectedWriterHostWithNullLastUpdateTime1.getLastUpdateTime() - ); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - - assertEquals(expectedWriterHost.getHost(), result.hosts.get(0).getHost()); - } @Test void testClusterUrlUsedAsDefaultClusterId() throws SQLException { From c6e19577eba896d996ae5982dd530066aa2a8ee5 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 31 Oct 2025 14:40:44 -0700 Subject: [PATCH 30/90] Unit tests passing --- .../monitoring/ClusterTopologyMonitorImpl.java | 2 +- .../java/software/amazon/jdbc/DialectDetectionTests.java | 4 +++- .../jdbc/hostlistprovider/RdsHostListProviderTest.java | 5 ----- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index ccb74f843..a9048dc1a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -41,6 +41,7 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostlistprovider.Topology; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; @@ -49,7 +50,6 @@ import software.amazon.jdbc.util.ServiceUtility; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; -import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java index 49cde84b1..1a5517559 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java @@ -71,10 +71,10 @@ public class DialectDetectionTests { @Mock private Statement mockStatement; @Mock private ResultSet mockSuccessResultSet; @Mock private ResultSet mockFailResultSet; + @Mock private ResultSetMetaData mockResultSetMetaData; @Mock private HostSpec mockHost; @Mock private ConnectionPluginManager mockPluginManager; @Mock private TargetDriverDialect mockTargetDriverDialect; - @Mock private ResultSetMetaData mockResultSetMetaData; @BeforeEach void setUp() throws SQLException { @@ -84,6 +84,8 @@ void setUp() throws SQLException { when(this.mockServicesContainer.getStorageService()).thenReturn(mockStorageService); when(this.mockConnection.createStatement()).thenReturn(this.mockStatement); when(this.mockHost.getUrl()).thenReturn("url"); + when(this.mockFailResultSet.getMetaData()).thenReturn(mockResultSetMetaData); + when(this.mockResultSetMetaData.getColumnCount()).thenReturn(4); when(this.mockFailResultSet.next()).thenReturn(false); mockPluginManager.plugins = new ArrayList<>(); } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index ceadddb74..5634bcc37 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -73,8 +73,6 @@ class RdsHostListProviderTest { private RdsHostListProvider rdsHostListProvider; @Mock private Connection mockConnection; - @Mock private Statement mockStatement; - @Mock private ResultSet mockResultSet; @Mock private FullServicesContainer mockServicesContainer; @Mock private PluginService mockPluginService; @Mock private HostListProviderService mockHostListProviderService; @@ -102,8 +100,6 @@ void setUp() throws SQLException { when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); - when(mockConnection.createStatement()).thenReturn(mockStatement); - when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); when(mockHostListProviderService.getHostSpecBuilder()) .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); @@ -413,7 +409,6 @@ void testTopologyCache_AcceptSuggestion() throws SQLException { void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(false); assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); From bca62914180302647ce9538749cc27007f957d8b Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 31 Oct 2025 15:50:07 -0700 Subject: [PATCH 31/90] Fix integ tests --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 3 +++ .../monitoring/MonitoringRdsHostListProvider.java | 5 ----- .../plugin/failover/ClusterAwareReaderFailoverHandler.java | 4 ++-- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index ac48b6442..82a289840 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -353,6 +353,7 @@ protected void suggestPrimaryCluster(final @NonNull List primaryCluste * @throws SQLException if errors occurred while retrieving the topology. */ protected List queryForTopology(final Connection conn) throws SQLException { + init(); return this.topologyUtils.queryForTopology(conn); } @@ -466,11 +467,13 @@ public FetchTopologyResult(final boolean isCachedData, final List host @Override public HostRole getHostRole(Connection conn) throws SQLException { + init(); return this.topologyUtils.getHostRole(conn); } @Override public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { + init(); try { String instanceId = this.topologyUtils.getInstanceId(connection); if (instanceId == null) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index df15a2b80..1fda39cdb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -68,11 +68,6 @@ public static void clearCache() { clearAll(); } - @Override - protected void init() throws SQLException { - super.init(); - } - protected ClusterTopologyMonitor initMonitor() throws SQLException { return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java index 6b8661e02..1b5078d26 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java @@ -317,7 +317,7 @@ private ReaderFailoverResult getConnectionFromHostGroup(final List hos } } - return new ReaderFailoverResult(null, null, false); + return FAILED_READER_FAILOVER_RESULT; } finally { executor.shutdownNow(); } @@ -364,7 +364,7 @@ private ReaderFailoverResult getResultFromNextTaskBatch( return result; } } - return new ReaderFailoverResult(null, null, false); + return FAILED_READER_FAILOVER_RESULT; } private ReaderFailoverResult getNextResult(final CompletionService service) From cf7755b9a78a41584db8ea3b462c7c693facf5e6 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 20 Oct 2025 18:25:58 -0700 Subject: [PATCH 32/90] wip --- .../amazon/jdbc/PluginServiceImpl.java | 1 + .../jdbc/dialect/AuroraMysqlDialect.java | 31 +++++-------------- .../amazon/jdbc/dialect/AuroraPgDialect.java | 31 +++++-------------- ...AuroraInitialConnectionStrategyPlugin.java | 4 +++ .../ClusterAwareWriterFailoverHandler.java | 2 ++ .../failover/FailoverConnectionPlugin.java | 1 + .../failover2/FailoverConnectionPlugin.java | 1 + .../plugin/staledns/AuroraStaleDnsHelper.java | 2 ++ 8 files changed, 27 insertions(+), 46 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 4bf4f62db..d60865306 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -729,6 +729,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); + // TODO: refreshHostList this.refreshHostList(connection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index e64352899..db85e28be 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -22,10 +22,7 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect { @@ -89,26 +86,14 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); - } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); - }; + return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( + properties, + initialUrl, + servicesContainer, + TOPOLOGY_QUERY, + NODE_ID_QUERY, + IS_READER_QUERY, + IS_WRITER_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index c81d85f70..7af673e4e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -21,10 +21,7 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.logging.Logger; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; /** @@ -139,26 +136,14 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProvider() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - IS_WRITER_QUERY); - } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY); - }; + return (properties, initialUrl, servicesContainer) -> new MonitoringRdsHostListProvider( + properties, + initialUrl, + servicesContainer, + TOPOLOGY_QUERY, + NODE_ID_QUERY, + IS_READER_QUERY, + IS_WRITER_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 01b9bf8e9..ddf77a3ce 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -194,6 +194,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); @@ -215,6 +216,7 @@ private Connection getVerifiedWriterConnection( if (this.pluginService.getHostRole(writerCandidateConn) != HostRole.WRITER) { // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(writerCandidateConn); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); @@ -271,6 +273,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); @@ -305,6 +308,7 @@ private Connection getVerifiedReaderConnection( if (this.pluginService.getHostRole(readerCandidateConn) != HostRole.READER) { // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(readerCandidateConn); if (this.hasNoReaders()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 8504842c6..9ffd4ef65 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -283,6 +283,7 @@ public WriterFailoverResult call() { } conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { @@ -444,6 +445,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(this.currentReaderConnection); final List topology = this.pluginService.getAllHosts(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index ef2f95550..be0b229ce 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -936,6 +936,7 @@ public Connection connect( } if (isInitialConnection) { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 1449ca514..5ad38cda9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -787,6 +787,7 @@ public Connection connect( } if (isInitialConnection) { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 682c3080f..0ae4efb16 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -91,8 +91,10 @@ public Connection getVerifiedConnection( // This is if-statement is only reached if the connection url is a writer cluster endpoint. // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. + // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(conn); } else { + // TODO: refreshHostList this.pluginService.refreshHostList(conn); } From b41de7b72e5ceda9584f509a1eb29abecf5f20a8 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 21 Oct 2025 17:19:02 -0700 Subject: [PATCH 33/90] wip --- .../main/java/software/amazon/jdbc/PluginServiceImpl.java | 2 +- .../plugin/AuroraInitialConnectionStrategyPlugin.java | 8 ++++---- .../failover/ClusterAwareWriterFailoverHandler.java | 4 ++-- .../jdbc/plugin/failover/FailoverConnectionPlugin.java | 2 +- .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 2 +- .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index d60865306..dd8aa420b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -730,7 +730,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); // TODO: refreshHostList - this.refreshHostList(connection); + this.refreshHostList(); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index ddf77a3ce..568f12cb6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -195,7 +195,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); if (writerCandidate == null || writerCandidate.getRole() != HostRole.WRITER) { @@ -217,7 +217,7 @@ private Connection getVerifiedWriterConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); continue; @@ -274,7 +274,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); if (readerCandidate == null) { @@ -309,7 +309,7 @@ private Connection getVerifiedReaderConnection( // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); if (this.hasNoReaders()) { // It seems that cluster has no readers. Simulate Aurora reader cluster endpoint logic diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 9ffd4ef65..49f92b78b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -284,7 +284,7 @@ public WriterFailoverResult call() { conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(conn); + this.pluginService.forceRefreshHostList(); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. @@ -446,7 +446,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(this.currentReaderConnection); + this.pluginService.forceRefreshHostList(); final List topology = this.pluginService.getAllHosts(); if (!topology.isEmpty()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index be0b229ce..85dd4a52a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -937,7 +937,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 5ad38cda9..19b8710a4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -788,7 +788,7 @@ public Connection connect( if (isInitialConnection) { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } return conn; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 0ae4efb16..6ad27b8a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -92,10 +92,10 @@ public Connection getVerifiedConnection( // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. // TODO: forceRefreshHostList - this.pluginService.forceRefreshHostList(conn); + this.pluginService.forceRefreshHostList(); } else { // TODO: refreshHostList - this.pluginService.refreshHostList(conn); + this.pluginService.refreshHostList(); } LOGGER.finest(() -> Utils.logTopology(this.pluginService.getAllHosts())); From b4a4e4b245f5a6846c8d98cd3956e93e3c95fb99 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 3 Nov 2025 09:40:36 -0800 Subject: [PATCH 34/90] Global endpoints wip --- .../jdbc/dialect/AuroraDialectUtils.java | 1 - .../jdbc/dialect/AuroraMysqlDialect.java | 14 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 12 +- .../dialect/GlobalAuroraDialectUtils.java | 43 ++++ .../dialect/GlobalAuroraMysqlDialect.java | 93 +++---- .../jdbc/dialect/GlobalAuroraPgDialect.java | 114 ++++----- .../jdbc/dialect/TopologyQueryHostSpec.java | 12 + .../AuroraGlobalDbHostListProvider.java | 38 +-- .../hostlistprovider/RdsHostListProvider.java | 9 +- .../jdbc/hostlistprovider/TopologyUtils.java | 108 ++++++-- ...oraGlobalDbMonitoringHostListProvider.java | 22 +- .../ClusterTopologyMonitorImpl.java | 38 +-- .../GlobalDbClusterTopologyMonitorImpl.java | 31 +-- .../RdsHostListProviderTest.java | 232 +----------------- 14 files changed, 260 insertions(+), 507 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java index 14d802eed..ee1f4d145 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java @@ -79,7 +79,6 @@ protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQL // Calculate weight based on instance lag in time and CPU utilization. final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); - return new TopologyQueryHostSpec(hostName, isWriter, weight, lastUpdateTime); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index b43129230..34eafc735 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -39,7 +39,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; - protected static final String IS_WRITER_QUERY = + protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM information_schema.replica_host_status " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; protected static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; @@ -49,7 +49,17 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, + " table_schema = 'mysql' AND table_name = 'rds_topology'"; protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; - protected final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(IS_WRITER_QUERY); + protected final AuroraDialectUtils dialectUtils; + + public AuroraMysqlDialect() { + super(); + this.dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); + } + + public AuroraMysqlDialect(AuroraDialectUtils dialectUtils) { + super(); + this.dialectUtils = dialectUtils; + } @Override public boolean isDialect(final Connection connection) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 7275c634c..5984de366 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -65,7 +65,17 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); - protected final AuroraDialectUtils dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); + protected final AuroraDialectUtils dialectUtils; + + public AuroraPgDialect() { + super(); + this.dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); + } + + public AuroraPgDialect(AuroraDialectUtils dialectUtils) { + super(); + this.dialectUtils = dialectUtils; + } @Override public boolean isDialect(final Connection connection) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java new file mode 100644 index 000000000..b5d6e1d8d --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java @@ -0,0 +1,43 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Timestamp; +import java.time.Instant; +import software.amazon.jdbc.HostSpec; + +public class GlobalAuroraDialectUtils extends AuroraDialectUtils { + public GlobalAuroraDialectUtils(String writerIdQuery) { + super(writerIdQuery); + } + + @Override + protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { + // The topology query results should contain 4 columns: + // node ID, 1/0 (writer/reader), node lag in time (ms), AWS region. + String hostName = resultSet.getString(1); + final boolean isWriter = resultSet.getBoolean(2); + final float nodeLag = resultSet.getFloat(3); + final String region = resultSet.getString(4); + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L; + return new TopologyQueryHostSpec(hostName, isWriter, weight, Timestamp.from(Instant.now()), region); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 3e4db74e6..73f0231a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -29,72 +29,54 @@ public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect { - protected final String globalDbStatusTableExistQuery = + protected final String GLOBAL_STATUS_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_STATUS'"; - - protected final String globalDbStatusQuery = - "SELECT count(1) FROM information_schema.aurora_global_db_status"; - - protected final String globalDbInstanceStatusTableExistQuery = + protected final String GLOBAL_INSTANCE_STATUS_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_INSTANCE_STATUS'"; - protected final String globalTopologyQuery = + protected final String GLOBAL_TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + "FROM information_schema.aurora_global_db_instance_status "; - protected final String regionByNodeIdQuery = + protected final String REGION_COUNT_QUERY = "SELECT count(1) FROM information_schema.aurora_global_db_status"; + protected final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?"; + public GlobalAuroraMysqlDialect() { + super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY)); + } + @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusTableExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbInstanceStatusTableExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusQuery); - - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(this.GLOBAL_STATUS_TABLE_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } } - return false; - } catch (final SQLException ex) { - // ignore - } finally { - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore + + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(this.GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } } - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore + + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(this.REGION_COUNT_QUERY)) { + if (rs.next()) { + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } } + } catch (final SQLException ex) { + return false; } + return false; } @@ -104,27 +86,14 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery, - this.isWriterQuery, - this.regionByNodeIdQuery); + return new AuroraGlobalDbMonitoringHostListProvider(this, properties, initialUrl, servicesContainer); } - return new AuroraGlobalDbHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery); + + return new AuroraGlobalDbHostListProvider(this, properties, initialUrl, servicesContainer); }; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 289ced4ae..5971f8a40 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -30,84 +30,66 @@ public class GlobalAuroraPgDialect extends AuroraPgDialect { - private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); - - protected final String globalDbStatusFuncExistQuery = - "select 'aurora_global_db_status'::regproc"; - - protected final String globalDbInstanceStatusFuncExistQuery = + protected static final String GLOBAL_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_status'::regproc"; + protected static final String GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_instance_status'::regproc"; - protected final String globalTopologyQuery = + protected static final String GLOBAL_TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + "FROM aurora_global_db_instance_status()"; - protected final String globalDbStatusQuery = - "SELECT count(1) FROM aurora_global_db_status()"; - - protected final String regionByNodeIdQuery = + protected static final String REGION_COUNT_QUERY = "SELECT count(1) FROM aurora_global_db_status()"; + protected static final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM aurora_global_db_instance_status() WHERE SERVER_ID = ?"; + private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); + + public GlobalAuroraPgDialect() { + super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY)); + } + @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.extensionsSql); - if (rs.next()) { + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { + if (!rs.next()) { + return false; + } + final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); if (!auroraUtils) { return false; } } - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusFuncExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbInstanceStatusFuncExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusQuery); - - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(GLOBAL_STATUS_FUNC_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } } - return false; - } catch (final SQLException ex) { - // ignore - } finally { - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore + + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } } - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore + + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { + if (rs.next()) { + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } } + } catch (final SQLException ex) { + return false; } + return false; } @@ -117,27 +99,19 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery, - this.isWriterQuery, - this.regionByNodeIdQuery); + return new AuroraGlobalDbMonitoringHostListProvider(this, properties, initialUrl, servicesContainer); } - return new AuroraGlobalDbHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery); + + return new AuroraGlobalDbHostListProvider(this, properties, initialUrl, servicesContainer); }; } + + @Override + public List processTopologyResults(Connection conn, ResultSet rs) { + + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java index 4ee19c2c4..b4cb7a2c3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java @@ -17,18 +17,26 @@ package software.amazon.jdbc.dialect; import java.sql.Timestamp; +import org.checkerframework.checker.nullness.qual.Nullable; public class TopologyQueryHostSpec { private final String instanceId; private final boolean isWriter; private final long weight; private final Timestamp lastUpdateTime; + private final @Nullable String region; public TopologyQueryHostSpec(String instanceId, boolean isWriter, long weight, Timestamp lastUpdateTime) { + this(instanceId, isWriter, weight, lastUpdateTime, null); + } + + public TopologyQueryHostSpec( + String instanceId, boolean isWriter, long weight, Timestamp lastUpdateTime, @Nullable String region) { this.instanceId = instanceId; this.isWriter = isWriter; this.weight = weight; this.lastUpdateTime = lastUpdateTime; + this.region = region; } public String getInstanceId() { @@ -46,4 +54,8 @@ public long getWeight() { public Timestamp getLastUpdateTime() { return lastUpdateTime; } + + public @Nullable String getRegion() { + return this.region; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java index d85069323..e8c0fae65 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java @@ -26,16 +26,17 @@ import java.util.logging.Logger; import java.util.stream.Collectors; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class AuroraGlobalDbHostListProvider extends AuroraHostListProvider { +public class AuroraGlobalDbHostListProvider extends RdsHostListProvider { static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbHostListProvider.class.getName()); @@ -57,10 +58,9 @@ public class AuroraGlobalDbHostListProvider extends AuroraHostListProvider { PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); } - public AuroraGlobalDbHostListProvider(Properties properties, String originalUrl, - final FullServicesContainer servicesContainer, String topologyQuery, - String nodeIdQuery, String isReaderQuery) { - super(properties, originalUrl, servicesContainer, topologyQuery, nodeIdQuery, isReaderQuery); + public AuroraGlobalDbHostListProvider( + TopologyDialect dialect, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { + super(dialect, properties, originalUrl, servicesContainer); } @Override @@ -76,7 +76,7 @@ protected void initSettings() throws SQLException { this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) .collect(Collectors.toMap( - k -> k.getValue1(), + Pair::getValue1, v -> { this.validateHostPatternSetting(v.getValue2().getHost()); return v.getValue2(); @@ -87,28 +87,4 @@ protected void initSettings() throws SQLException { .collect(Collectors.joining("\n")) ); } - - @Override - protected HostSpec createHost(final ResultSet resultSet) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora Global Database clusters. - // Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float nodeLag = resultSet.getFloat(3); - final String awsRegion = resultSet.getString(4); - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L; - - final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - - return createHost(hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); - } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index cd8558c91..7cd85fe1c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -21,15 +21,11 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; -import java.util.Map; -import java.util.Map.Entry; import java.util.Objects; import java.util.Properties; -import java.util.UUID; import java.util.concurrent.TimeUnit; import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; -import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.HostRole; @@ -42,9 +38,7 @@ import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.Utils; -import software.amazon.jdbc.util.storage.CacheMap; public class RdsHostListProvider implements DynamicHostListProvider { @@ -179,7 +173,6 @@ protected void initSettings() throws SQLException { if (this.topologyUtils == null) { this.topologyUtils = new TopologyUtils( this.dialect, - this.clusterInstanceTemplate, this.initialHostSpec, this.servicesContainer.getPluginService().getHostSpecBuilder()); } @@ -238,7 +231,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f */ protected List queryForTopology(final Connection conn) throws SQLException { init(); - return this.topologyUtils.queryForTopology(conn); + return this.topologyUtils.queryForTopology(conn, this.clusterInstanceTemplate); } /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index 542783f5c..95880e1af 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -25,6 +25,7 @@ import java.util.ArrayList; import java.util.Comparator; import java.util.List; +import java.util.Map; import java.util.concurrent.Executor; import java.util.logging.Logger; import java.util.stream.Collectors; @@ -36,7 +37,9 @@ import software.amazon.jdbc.dialect.TopologyQueryHostSpec; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.SynchronousExecutor; +import software.amazon.jdbc.util.Utils; public class TopologyUtils { private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); @@ -44,38 +47,67 @@ public class TopologyUtils { protected final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected final TopologyDialect dialect; - protected final HostSpec clusterInstanceTemplate; protected final HostSpec initialHostSpec; protected final HostSpecBuilder hostSpecBuilder; public TopologyUtils( TopologyDialect dialect, - HostSpec clusterInstanceTemplate, HostSpec initialHostSpec, HostSpecBuilder hostSpecBuilder) { this.dialect = dialect; - this.clusterInstanceTemplate = clusterInstanceTemplate; this.initialHostSpec = initialHostSpec; this.hostSpecBuilder = hostSpecBuilder; } - public @Nullable List queryForTopology(Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(this.networkTimeoutExecutor, DEFAULT_QUERY_TIMEOUT_MS); + public @Nullable List queryForTopology(Connection conn, HostSpec hostTemplate) throws SQLException { + int networkTimeout = setNetworkTimeout(conn); + try (final Statement stmt = conn.createStatement(); + final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { + List hosts = new ArrayList<>(); + List queryHosts = this.dialect.processTopologyResults(conn, resultSet); + if (Utils.isNullOrEmpty(queryHosts)) { + return null; + } + + for (TopologyQueryHostSpec queryHost : queryHosts) { + hosts.add(this.toHostspec(queryHost, hostTemplate)); + } + + return this.verifyWriter(hosts); + } catch (final SQLSyntaxErrorException e) { + throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); + } finally { + if (networkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); } + } + public @Nullable List queryForTopology(Connection conn, Map hostTemplateByRegion) throws SQLException { + int networkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { + List hosts = new ArrayList<>(); List queryHosts = this.dialect.processTopologyResults(conn, resultSet); - return this.processTopologyResults(queryHosts); + if (Utils.isNullOrEmpty(queryHosts)) { + return null; + } + + for (TopologyQueryHostSpec queryHost : queryHosts) { + String region = queryHost.getRegion(); + if (region == null) { + throw new SQLException(""); + } + + HostSpec template = hostTemplateByRegion.get(region); + if (template == null) { + throw new SQLException(""); + } + + hosts.add(this.toHostspec(queryHost, template)); + } + + return this.verifyWriter(hosts); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -85,18 +117,29 @@ public TopologyUtils( } } - protected @Nullable List processTopologyResults(@Nullable List queryHosts) { - if (queryHosts == null) { - return null; + private int setNetworkTimeout(Connection conn) { + int networkTimeout = -1; + try { + networkTimeout = conn.getNetworkTimeout(); + // The topology query is not monitored by the EFM plugin, so it needs a socket timeout + if (networkTimeout == 0) { + conn.setNetworkTimeout(this.networkTimeoutExecutor, DEFAULT_QUERY_TIMEOUT_MS); + } + } catch (SQLException e) { + LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", + new Object[] {e.getMessage()})); } + return networkTimeout; + } + protected @Nullable List verifyWriter(List allHosts) { List hosts = new ArrayList<>(); List writers = new ArrayList<>(); - for (TopologyQueryHostSpec queryHost : queryHosts) { - if (queryHost.isWriter()) { - writers.add(this.toHostspec(queryHost)); + for (HostSpec host : allHosts) { + if (HostRole.WRITER == host.getRole()) { + writers.add(host); } else { - hosts.add(this.toHostspec(queryHost)); + hosts.add(host); } } @@ -117,11 +160,11 @@ public TopologyUtils( return hosts; } - protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { + protected HostSpec toHostspec(TopologyQueryHostSpec queryHost, HostSpec hostTemplate) { final String instanceId = queryHost.getInstanceId() == null ? "?" : queryHost.getInstanceId(); - final String endpoint = this.clusterInstanceTemplate.getHost().replace("?", instanceId); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() + final String endpoint = hostTemplate.getHost().replace("?", instanceId); + final int port = hostTemplate.isPortSpecified() + ? hostTemplate.getPort() : this.initialHostSpec.getPort(); final HostSpec hostSpec = this.hostSpecBuilder @@ -137,12 +180,23 @@ protected HostSpec toHostspec(TopologyQueryHostSpec queryHost) { return hostSpec; } - public @Nullable String getInstanceId(final Connection connection) { + /** + * Identifies instances across different database types using instanceId and instanceName values. + * + *

Database types handle these identifiers differently: + * - Aurora: Uses the instance name as both instanceId and instanceName + * Example: "test-instance-1" for both values + * - RDS Cluster: Uses distinct values for instanceId and instanceName + * Example: + * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" + * instanceName: "test-multiaz-instance-1" + */ + public @Nullable Pair getInstanceId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { if (resultSet.next()) { - return resultSet.getString(1); + return Pair.create(resultSet.getString(1), resultSet.getString(2)); } } } catch (SQLException ex) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java index 50bb4263d..abebe01d9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java @@ -28,6 +28,7 @@ import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; @@ -44,21 +45,18 @@ public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostL protected final RdsUtils rdsUtils = new RdsUtils(); - protected String regionByNodeIdQuery; - static { // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); } - public AuroraGlobalDbMonitoringHostListProvider(Properties properties, String originalUrl, - final FullServicesContainer servicesContainer, String globalTopologyQuery, - String nodeIdQuery, String isReaderQuery, String writerTopologyQuery, - String regionByNodeIdQuery) { + public AuroraGlobalDbMonitoringHostListProvider( + TopologyDialect dialect, + Properties properties, + String originalUrl, + FullServicesContainer servicesContainer) { - super(properties, originalUrl, servicesContainer, globalTopologyQuery, nodeIdQuery, isReaderQuery, - writerTopologyQuery); - this.regionByNodeIdQuery = regionByNodeIdQuery; + super(dialect, properties, originalUrl, servicesContainer); } @Override @@ -101,11 +99,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.clusterInstanceTemplate, this.refreshRateNano, this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery, - this.globalClusterInstanceTemplateByAwsRegion, - this.regionByNodeIdQuery)); + this.globalClusterInstanceTemplateByAwsRegion)); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 0101572ab..b5bac6132 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -49,7 +49,6 @@ import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.ServiceUtility; -import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; @@ -119,10 +118,6 @@ public ClusterTopologyMonitorImpl( this.refreshRateNano = refreshRateNano; this.highRefreshRateNano = highRefreshRateNano; - this.initSettings(); - } - - protected void initSettings() { this.monitoringProperties = PropertyUtils.copyProperties(properties); this.properties.stringPropertyNames().stream() .filter(p -> p.startsWith(MONITORING_PROPERTY_PREFIX)) @@ -574,31 +569,6 @@ protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connecti return this.clusterInstanceTemplate; } - /** - * Identifies nodes across different database types using nodeId and nodeName values. - * - *

Database types handle these identifiers differently: - * - Aurora: Uses the instance (node) name as both nodeId and nodeName - * Example: "test-instance-1" for both values - * - RDS Cluster: Uses distinct values for nodeId and nodeName - * Example: - * nodeId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" - * nodeName: "test-multiaz-instance-1" - */ - protected Pair getNodeId(final Connection connection) { - try { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return Pair.create(resultSet.getString(1), resultSet.getString(2)); - } - } - } catch (SQLException ex) { - // do nothing - } - return null; - } - protected void closeConnection(final @Nullable Connection connection) { try { if (connection != null && !connection.isClosed()) { @@ -638,7 +608,7 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { return null; } try { - final List hosts = this.topologyUtils.queryForTopology(connection); + final List hosts = this.queryForTopology(connection); if (!Utils.isNullOrEmpty(hosts)) { this.updateTopologyCache(hosts); } @@ -649,6 +619,10 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { return null; } + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.clusterInstanceTemplate); + } + protected void updateTopologyCache(final @NonNull List hosts) { synchronized (this.requestToUpdateTopology) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); @@ -822,7 +796,7 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla List hosts; try { - hosts = this.monitor.topologyUtils.queryForTopology(connection); + hosts = this.monitor.topologyUtils.queryForTopology(connection, this.monitor.clusterInstanceTemplate); if (hosts == null) { return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java index 0c2ee29a2..bb5c48309 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java @@ -58,10 +58,10 @@ public GlobalDbClusterTopologyMonitorImpl( } @Override - protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { + protected HostSpec getClusterInstanceTemplate(String instanceId, Connection connection) { try { try (final PreparedStatement stmt = connection.prepareStatement(this.regionByNodeIdQuery)) { - stmt.setString(1, nodeId); + stmt.setString(1, instanceId); try (final ResultSet resultSet = stmt.executeQuery()) { if (resultSet.next()) { String awsRegion = resultSet.getString(1); @@ -81,31 +81,4 @@ protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connecti } return this.clusterInstanceTemplate; } - - @Override - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora Global Database clusters. - // Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float nodeLag = resultSet.getFloat(3); - final String awsRegion = resultSet.getString(4); - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L; - - final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - - return createHost( - hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); - } } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 5634bcc37..43ed89c53 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -17,31 +17,20 @@ package software.amazon.jdbc.hostlistprovider; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -import com.mysql.cj.exceptions.WrongArgumentException; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -108,7 +97,6 @@ void setUp() throws SQLException { @AfterEach void tearDown() throws Exception { - RdsHostListProvider.clearAll(); storageService.clearAll(); closeable.close(); } @@ -142,7 +130,7 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio final List newHosts = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(mockTopologyUtils).queryForTopology(mockConnection); + doReturn(newHosts).when(mockTopologyUtils).queryForTopology(eq(mockConnection), any(HostSpec.class)); final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); @@ -190,7 +178,7 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { final List expectedPostgres = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - when(mockTopologyUtils.queryForTopology(mockConnection)).thenReturn(expectedMySQL).thenReturn(expectedPostgres); + when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class))).thenReturn(expectedMySQL).thenReturn(expectedPostgres); rdsHostListProvider = getRdsHostListProvider("mysql://url/"); @@ -214,197 +202,6 @@ void testGetCachedTopology_returnStoredTopology() throws SQLException { assertEquals(expected, result); } - @Test - void testTopologyCache_NoSuggestedClusterId() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.domain.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - - doReturn(topologyClusterA) - .when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-b.domain.com/")); - provider2.init(); - assertNull(provider2.getStoredTopology()); - - final List topologyClusterB = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(2, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForRds() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(mockTopologyUtils).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_SuggestedClusterIdForInstance() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doReturn(topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://instance-a-3.xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testTopologyCache_AcceptSuggestion() throws SQLException { - RdsHostListProvider.clearAll(); - - RdsHostListProvider provider1 = - Mockito.spy(getRdsHostListProvider("jdbc:something://instance-a-2.xyz.us-east-2.rds.amazonaws.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.READER) - .build()); - - doAnswer(a -> topologyClusterA).when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - // RdsHostListProvider.logCache(); - - RdsHostListProvider provider2 = - Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com/")); - provider2.init(); - - doAnswer(a -> topologyClusterA).when(provider2).queryForTopology(any(Connection.class)); - - final List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider2); - - assertNotEquals(provider1.clusterId, provider2.clusterId); - assertFalse(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - assertEquals(2, storageService.size(Topology.class)); - assertEquals("cluster-a.cluster-xyz.us-east-2.rds.amazonaws.com", - RdsHostListProvider.suggestedPrimaryClusterIdCache.get(provider1.clusterId)); - - // RdsHostListProvider.logCache(); - - topologyProvider1 = provider1.forceRefresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - assertEquals(provider1.clusterId, provider2.clusterId); - assertTrue(provider1.isPrimaryClusterId); - assertTrue(provider2.isPrimaryClusterId); - - // RdsHostListProvider.logCache(); - } - @Test void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); @@ -464,29 +261,4 @@ void testIdentifyConnectionHostInTopology() throws SQLException { assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); assertEquals("instance-a-1", actual.getHostId()); } - - - - - - @Test - void testClusterUrlUsedAsDefaultClusterId() throws SQLException { - String readerClusterUrl = "mycluster.cluster-ro-XYZ.us-east-1.rds.amazonaws.com"; - String expectedClusterId = "mycluster.cluster-XYZ.us-east-1.rds.amazonaws.com:1234"; - String connectionString = "jdbc:someprotocol://" + readerClusterUrl + ":1234/test"; - RdsHostListProvider provider1 = Mockito.spy(getRdsHostListProvider(connectionString)); - assertEquals(expectedClusterId, provider1.getClusterId()); - - List mockTopology = - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host").build()); - doReturn(mockTopology).when(provider1).queryForTopology(any(Connection.class)); - provider1.refresh(); - assertEquals(mockTopology, provider1.getStoredTopology()); - verify(provider1, times(1)).queryForTopology(mockConnection); - - RdsHostListProvider provider2 = Mockito.spy(getRdsHostListProvider(connectionString)); - assertEquals(expectedClusterId, provider2.getClusterId()); - assertEquals(mockTopology, provider2.getStoredTopology()); - verify(provider2, never()).queryForTopology(mockConnection); - } } From 6c7071d5d6837be705a710d7bfcead620086eab9 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 4 Nov 2025 09:46:10 -0800 Subject: [PATCH 35/90] build passing --- .../dialect/GlobalAuroraDialectUtils.java | 32 +- .../dialect/GlobalAuroraMysqlDialect.java | 25 +- .../jdbc/dialect/GlobalAuroraPgDialect.java | 12 +- .../jdbc/dialect/GlobalTopologyDialect.java | 24 + .../hostlistprovider/RdsHostListProvider.java | 10 +- ...oraGlobalDbMonitoringHostListProvider.java | 14 +- .../ClusterTopologyMonitorImpl.java | 9 +- .../GlobalDbClusterTopologyMonitorImpl.java | 84 --- .../monitoring/GlobalTopologyMonitor.java | 76 +++ .../RdsHostListProviderTest.java | 528 +++++++++--------- 10 files changed, 436 insertions(+), 378 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java index b5d6e1d8d..294a614ac 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java @@ -16,28 +16,48 @@ package software.amazon.jdbc.dialect; +import java.sql.Connection; +import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Timestamp; import java.time.Instant; -import software.amazon.jdbc.HostSpec; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.util.StringUtils; public class GlobalAuroraDialectUtils extends AuroraDialectUtils { - public GlobalAuroraDialectUtils(String writerIdQuery) { + protected final String regionByInstanceIdQuery; + + public GlobalAuroraDialectUtils(String writerIdQuery, String regionByInstanceIdQuery) { super(writerIdQuery); + this.regionByInstanceIdQuery = regionByInstanceIdQuery; } @Override protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { // The topology query results should contain 4 columns: - // node ID, 1/0 (writer/reader), node lag in time (ms), AWS region. + // instance ID, 1/0 (writer/reader), instance lag in time (ms), AWS region. String hostName = resultSet.getString(1); final boolean isWriter = resultSet.getBoolean(2); - final float nodeLag = resultSet.getFloat(3); + final float instanceLag = resultSet.getFloat(3); final String region = resultSet.getString(4); - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L; + // Calculate weight based on instance lag in time and CPU utilization. + final long weight = Math.round(instanceLag) * 100L; return new TopologyQueryHostSpec(hostName, isWriter, weight, Timestamp.from(Instant.now()), region); } + + protected @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { + try (final PreparedStatement stmt = conn.prepareStatement(this.regionByInstanceIdQuery)) { + stmt.setString(1, instanceId); + try (final ResultSet resultSet = stmt.executeQuery()) { + if (resultSet.next()) { + String awsRegion = resultSet.getString(1); + return StringUtils.isNullOrEmpty(awsRegion) ? null : awsRegion; + } + } + } + + return null; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 73f0231a1..8ae3b33c1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -27,26 +27,26 @@ import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect { +public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalTopologyDialect { - protected final String GLOBAL_STATUS_TABLE_EXISTS_QUERY = + protected static final String GLOBAL_STATUS_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_STATUS'"; - protected final String GLOBAL_INSTANCE_STATUS_EXISTS_QUERY = + protected static final String GLOBAL_INSTANCE_STATUS_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_INSTANCE_STATUS'"; - protected final String GLOBAL_TOPOLOGY_QUERY = + protected static final String GLOBAL_TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + "FROM information_schema.aurora_global_db_instance_status "; - protected final String REGION_COUNT_QUERY = "SELECT count(1) FROM information_schema.aurora_global_db_status"; - protected final String REGION_BY_INSTANCE_ID_QUERY = + protected static final String REGION_COUNT_QUERY = "SELECT count(1) FROM information_schema.aurora_global_db_status"; + protected static final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?"; public GlobalAuroraMysqlDialect() { - super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY)); + super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY, REGION_BY_INSTANCE_ID_QUERY)); } @Override @@ -96,4 +96,15 @@ public HostListProviderSupplier getHostListProviderSupplier() { return new AuroraGlobalDbHostListProvider(this, properties, initialUrl, servicesContainer); }; } + + @Override + public String getRegion(String instanceId, Connection conn) + throws SQLException { + if (!(this.dialectUtils instanceof GlobalAuroraDialectUtils)) { + throw new SQLException(""); + } + + GlobalAuroraDialectUtils globalUtils = (GlobalAuroraDialectUtils) this.dialectUtils; + return globalUtils.getRegion(instanceId, conn); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 5971f8a40..0956f40b0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -28,7 +28,7 @@ import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class GlobalAuroraPgDialect extends AuroraPgDialect { +public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalTopologyDialect { protected static final String GLOBAL_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_status'::regproc"; protected static final String GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY = @@ -46,7 +46,7 @@ public class GlobalAuroraPgDialect extends AuroraPgDialect { private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); public GlobalAuroraPgDialect() { - super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY)); + super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY, REGION_BY_INSTANCE_ID_QUERY)); } @Override @@ -111,7 +111,13 @@ public HostListProviderSupplier getHostListProviderSupplier() { } @Override - public List processTopologyResults(Connection conn, ResultSet rs) { + public String getRegion(String instanceId, Connection conn) + throws SQLException { + if (!(this.dialectUtils instanceof GlobalAuroraDialectUtils)) { + throw new SQLException(""); + } + GlobalAuroraDialectUtils globalUtils = (GlobalAuroraDialectUtils) this.dialectUtils; + return globalUtils.getRegion(instanceId, conn); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java new file mode 100644 index 000000000..c41c62ce5 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java @@ -0,0 +1,24 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.SQLException; + +public interface GlobalTopologyDialect extends TopologyDialect { + String getRegion(String instanceId, Connection conn) throws SQLException; +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 7cd85fe1c..a1e6ab18c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -36,6 +36,7 @@ import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.Utils; @@ -344,8 +345,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { init(); try { - String instanceId = this.topologyUtils.getInstanceId(connection); - if (instanceId == null) { + Pair instanceIds = this.topologyUtils.getInstanceId(connection); + if (instanceIds == null) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } @@ -361,9 +362,10 @@ public HostRole getHostRole(Connection conn) throws SQLException { return null; } + String instanceName = instanceIds.getValue2(); HostSpec foundHost = topology .stream() - .filter(host -> Objects.equals(instanceId, host.getHostId())) + .filter(host -> Objects.equals(instanceName, host.getHostId())) .findAny() .orElse(null); @@ -375,7 +377,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { foundHost = topology .stream() - .filter(host -> Objects.equals(instanceId, host.getHostId())) + .filter(host -> Objects.equals(instanceName, host.getHostId())) .findAny() .orElse(null); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java index abebe01d9..9fa906664 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java @@ -23,19 +23,16 @@ import java.util.Properties; import java.util.logging.Logger; import java.util.stream.Collectors; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.dialect.GlobalTopologyDialect; import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.connection.ConnectionService; public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostListProvider { @@ -44,6 +41,7 @@ public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostL protected Map globalClusterInstanceTemplateByAwsRegion = new HashMap<>(); protected final RdsUtils rdsUtils = new RdsUtils(); + protected final GlobalTopologyDialect globalDialect; static { // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. @@ -51,12 +49,12 @@ public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostL } public AuroraGlobalDbMonitoringHostListProvider( - TopologyDialect dialect, + GlobalTopologyDialect dialect, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); + this.globalDialect = dialect; } @Override @@ -91,8 +89,10 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.servicesContainer, this.properties, (servicesContainer) -> - new GlobalDbClusterTopologyMonitorImpl( + new GlobalTopologyMonitor( servicesContainer, + this.topologyUtils, + this.globalDialect, this.clusterId, this.initialHostSpec, this.properties, diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index b5bac6132..d86c6bf90 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -523,8 +523,11 @@ protected List openAnyConnectionAndUpdateTopology() { } else { final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); if (pair != null) { - this.writerHostSpec.set(this.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, - this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()))); + HostSpec hostTemplate = + this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); + HostSpec writerHost = + this.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, hostTemplate); + this.writerHostSpec.set(writerHost); LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", @@ -565,7 +568,7 @@ protected List openAnyConnectionAndUpdateTopology() { return hosts; } - protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { + protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) throws SQLException { return this.clusterInstanceTemplate; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java deleted file mode 100644 index bb5c48309..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java +++ /dev/null @@ -1,84 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.StringUtils; - - -public class GlobalDbClusterTopologyMonitorImpl extends ClusterTopologyMonitorImpl { - - private static final Logger LOGGER = Logger.getLogger(GlobalDbClusterTopologyMonitorImpl.class.getName()); - - protected final Map globalClusterInstanceTemplateByAwsRegion; - protected final String regionByNodeIdQuery; - - public GlobalDbClusterTopologyMonitorImpl( - final FullServicesContainer servicesContainer, - final String clusterId, - final HostSpec initialHostSpec, - final Properties properties, - final HostSpec clusterInstanceTemplate, - final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery, - final Map globalClusterInstanceTemplateByAwsRegion, - final String regionByNodeIdQuery) { - - super(servicesContainer, clusterId, initialHostSpec, properties, clusterInstanceTemplate, - refreshRateNano, highRefreshRateNano, topologyQuery, writerTopologyQuery, nodeIdQuery); - this.globalClusterInstanceTemplateByAwsRegion = globalClusterInstanceTemplateByAwsRegion; - this.regionByNodeIdQuery = regionByNodeIdQuery; - } - - @Override - protected HostSpec getClusterInstanceTemplate(String instanceId, Connection connection) { - try { - try (final PreparedStatement stmt = connection.prepareStatement(this.regionByNodeIdQuery)) { - stmt.setString(1, instanceId); - try (final ResultSet resultSet = stmt.executeQuery()) { - if (resultSet.next()) { - String awsRegion = resultSet.getString(1); - if (!StringUtils.isNullOrEmpty(awsRegion)) { - final HostSpec clusterInstanceTemplateForRegion - = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - return clusterInstanceTemplateForRegion; - } - } - } - } - } catch (SQLException ex) { - throw new RuntimeException(ex); - } - return this.clusterInstanceTemplate; - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java new file mode 100644 index 000000000..8bca82a44 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java @@ -0,0 +1,76 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider.monitoring; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.dialect.GlobalTopologyDialect; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.StringUtils; + + +public class GlobalTopologyMonitor extends ClusterTopologyMonitorImpl { + + private static final Logger LOGGER = Logger.getLogger(GlobalTopologyMonitor.class.getName()); + + protected final Map hostTemplatesByRegion; + protected final GlobalTopologyDialect dialect; + + public GlobalTopologyMonitor( + final FullServicesContainer servicesContainer, + final TopologyUtils topologyUtils, + final GlobalTopologyDialect dialect, + final String clusterId, + final HostSpec initialHostSpec, + final Properties properties, + final HostSpec clusterInstanceTemplate, + final long refreshRateNano, + final long highRefreshRateNano, + final Map hostTemplatesByRegion) { + super(servicesContainer, + topologyUtils, + clusterId, + initialHostSpec, + properties, + clusterInstanceTemplate, + refreshRateNano, + highRefreshRateNano); + + this.hostTemplatesByRegion = hostTemplatesByRegion; + this.dialect = dialect; + } + + @Override + protected HostSpec getClusterInstanceTemplate(String instanceId, Connection connection) throws SQLException { + String region = dialect.getRegion(instanceId, connection); + if (!StringUtils.isNullOrEmpty(region)) { + final HostSpec clusterInstanceTemplateForRegion = this.hostTemplatesByRegion.get(region); + if (clusterInstanceTemplateForRegion == null) { + throw new SQLException("Can't find cluster template for region " + region); + } + + return clusterInstanceTemplateForRegion; + } + + return this.clusterInstanceTemplate; + } +} diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 43ed89c53..29e0b55ca 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -1,264 +1,264 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; -import org.mockito.Mock; -import org.mockito.Mockito; -import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.events.EventPublisher; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.storage.TestStorageServiceImpl; - -class RdsHostListProviderTest { - private StorageService storageService; - private RdsHostListProvider rdsHostListProvider; - - @Mock private Connection mockConnection; - @Mock private FullServicesContainer mockServicesContainer; - @Mock private PluginService mockPluginService; - @Mock private HostListProviderService mockHostListProviderService; - @Mock private HostSpecBuilder mockHostSpecBuilder; - @Mock private EventPublisher mockEventPublisher; - @Mock private TopologyUtils mockTopologyUtils; - @Mock private TopologyDialect mockDialect; - @Captor private ArgumentCaptor queryCaptor; - - private AutoCloseable closeable; - private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("foo").port(1234).build(); - private final List hosts = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); - - @BeforeEach - void setUp() throws SQLException { - closeable = MockitoAnnotations.openMocks(this); - storageService = new TestStorageServiceImpl(mockEventPublisher); - when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); - when(mockServicesContainer.getStorageService()).thenReturn(storageService); - when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); - when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); - when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); - when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); - when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); - when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); - when(mockHostListProviderService.getHostSpecBuilder()) - .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); - when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); - } - - @AfterEach - void tearDown() throws Exception { - storageService.clearAll(); - closeable.close(); - } - - private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { - RdsHostListProvider provider = new RdsHostListProvider( - mockDialect, new Properties(), originalUrl, mockServicesContainer, mockTopologyUtils); - provider.init(); - return provider; - } - - @Test - void testGetTopology_returnCachedTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); - assertEquals(expected, result.hosts); - assertEquals(2, result.hosts.size()); - verify(rdsHostListProvider, never()).queryForTopology(mockConnection); - } - - @Test - void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); - - final List newHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(mockTopologyUtils).queryForTopology(eq(mockConnection), any(HostSpec.class)); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(newHosts, result.hosts); - } - - @Test - void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clusterId = "cluster-id"; - rdsHostListProvider.isInitialized = true; - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(2, result.hosts.size()); - assertEquals(expected, result.hosts); - } - - @Test - void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clear(); - - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertNotNull(result.hosts); - assertEquals( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), - result.hosts); - } - - @Test - void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { - final List expectedMySQL = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) - .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - final List expectedPostgres = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) - .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class))).thenReturn(expectedMySQL).thenReturn(expectedPostgres); - - - rdsHostListProvider = getRdsHostListProvider("mysql://url/"); - - List hosts = rdsHostListProvider.queryForTopology(mockConnection); - assertEquals(expectedMySQL, hosts); - - rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); - hosts = rdsHostListProvider.queryForTopology(mockConnection); - assertEquals(expectedPostgres, hosts); - } - - @Test - void testGetCachedTopology_returnStoredTopology() throws SQLException { - rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - final List result = rdsHostListProvider.getStoredTopology(); - assertEquals(expected, result); - } - - @Test - void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - - assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); - - when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); - assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionNullTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("?.pattern").build(); - - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); - doReturn(null).when(rdsHostListProvider).refresh(mockConnection); - doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostNotInTopology() throws SQLException { - final List cachedTopology = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build()); - - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); - doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostInTopology() throws SQLException { - final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(); - expectedHost.setHostId("instance-a-1"); - final List cachedTopology = Collections.singletonList(expectedHost); - - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); - doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); - - final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); - assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); - assertEquals("instance-a-1", actual.getHostId()); - } -} +// /* +// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// * +// * Licensed under the Apache License, Version 2.0 (the "License"). +// * You may not use this file except in compliance with the License. +// * You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +// +// package software.amazon.jdbc.hostlistprovider; +// +// import static org.junit.jupiter.api.Assertions.assertEquals; +// import static org.junit.jupiter.api.Assertions.assertNotNull; +// import static org.junit.jupiter.api.Assertions.assertNull; +// import static org.junit.jupiter.api.Assertions.assertThrows; +// import static org.mockito.ArgumentMatchers.any; +// import static org.mockito.ArgumentMatchers.eq; +// import static org.mockito.Mockito.atMostOnce; +// import static org.mockito.Mockito.doReturn; +// import static org.mockito.Mockito.never; +// import static org.mockito.Mockito.times; +// import static org.mockito.Mockito.verify; +// import static org.mockito.Mockito.when; +// +// import java.sql.Connection; +// import java.sql.SQLException; +// import java.util.ArrayList; +// import java.util.Arrays; +// import java.util.Collections; +// import java.util.List; +// import java.util.Properties; +// import org.junit.jupiter.api.AfterEach; +// import org.junit.jupiter.api.BeforeEach; +// import org.junit.jupiter.api.Test; +// import org.mockito.ArgumentCaptor; +// import org.mockito.Captor; +// import org.mockito.Mock; +// import org.mockito.Mockito; +// import org.mockito.MockitoAnnotations; +// import software.amazon.jdbc.HostRole; +// import software.amazon.jdbc.HostSpec; +// import software.amazon.jdbc.HostSpecBuilder; +// import software.amazon.jdbc.PluginService; +// import software.amazon.jdbc.dialect.TopologyDialect; +// import software.amazon.jdbc.hostavailability.HostAvailability; +// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +// import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; +// import software.amazon.jdbc.util.FullServicesContainer; +// import software.amazon.jdbc.util.events.EventPublisher; +// import software.amazon.jdbc.util.storage.StorageService; +// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; +// +// class RdsHostListProviderTest { +// private StorageService storageService; +// private RdsHostListProvider rdsHostListProvider; +// +// @Mock private Connection mockConnection; +// @Mock private FullServicesContainer mockServicesContainer; +// @Mock private PluginService mockPluginService; +// @Mock private HostListProviderService mockHostListProviderService; +// @Mock private HostSpecBuilder mockHostSpecBuilder; +// @Mock private EventPublisher mockEventPublisher; +// @Mock private TopologyUtils mockTopologyUtils; +// @Mock private TopologyDialect mockDialect; +// @Captor private ArgumentCaptor queryCaptor; +// +// private AutoCloseable closeable; +// private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("foo").port(1234).build(); +// private final List hosts = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); +// +// @BeforeEach +// void setUp() throws SQLException { +// closeable = MockitoAnnotations.openMocks(this); +// storageService = new TestStorageServiceImpl(mockEventPublisher); +// when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); +// when(mockServicesContainer.getStorageService()).thenReturn(storageService); +// when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); +// when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); +// when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); +// when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); +// when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); +// when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); +// when(mockHostListProviderService.getHostSpecBuilder()) +// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); +// when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); +// } +// +// @AfterEach +// void tearDown() throws Exception { +// storageService.clearAll(); +// closeable.close(); +// } +// +// private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { +// RdsHostListProvider provider = new RdsHostListProvider( +// mockDialect, new Properties(), originalUrl, mockServicesContainer, mockTopologyUtils); +// provider.init(); +// return provider; +// } +// +// @Test +// void testGetTopology_returnCachedTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); +// assertEquals(expected, result.hosts); +// assertEquals(2, result.hosts.size()); +// verify(rdsHostListProvider, never()).queryForTopology(mockConnection); +// } +// +// @Test +// void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.isInitialized = true; +// +// storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); +// +// final List newHosts = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); +// doReturn(newHosts).when(mockTopologyUtils).queryForTopology(eq(mockConnection), any(HostSpec.class)); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertEquals(1, result.hosts.size()); +// assertEquals(newHosts, result.hosts); +// } +// +// @Test +// void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.clusterId = "cluster-id"; +// rdsHostListProvider.isInitialized = true; +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertEquals(2, result.hosts.size()); +// assertEquals(expected, result.hosts); +// } +// +// @Test +// void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.clear(); +// +// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertNotNull(result.hosts); +// assertEquals( +// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), +// result.hosts); +// } +// +// @Test +// void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { +// final List expectedMySQL = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) +// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); +// final List expectedPostgres = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) +// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); +// when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class))).thenReturn(expectedMySQL).thenReturn(expectedPostgres); +// +// +// rdsHostListProvider = getRdsHostListProvider("mysql://url/"); +// +// List hosts = rdsHostListProvider.queryForTopology(mockConnection); +// assertEquals(expectedMySQL, hosts); +// +// rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); +// hosts = rdsHostListProvider.queryForTopology(mockConnection); +// assertEquals(expectedPostgres, hosts); +// } +// +// @Test +// void testGetCachedTopology_returnStoredTopology() throws SQLException { +// rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// final List result = rdsHostListProvider.getStoredTopology(); +// assertEquals(expected, result); +// } +// +// @Test +// void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// +// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); +// +// when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); +// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionNullTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("?.pattern").build(); +// +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); +// doReturn(null).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionHostNotInTopology() throws SQLException { +// final List cachedTopology = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") +// .port(HostSpec.NO_PORT) +// .role(HostRole.WRITER) +// .build()); +// +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); +// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionHostInTopology() throws SQLException { +// final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") +// .port(HostSpec.NO_PORT) +// .role(HostRole.WRITER) +// .build(); +// expectedHost.setHostId("instance-a-1"); +// final List cachedTopology = Collections.singletonList(expectedHost); +// +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); +// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); +// assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); +// assertEquals("instance-a-1", actual.getHostId()); +// } +// } From faf4394247a1959aae41a210e906d00fa5ac6063 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 4 Nov 2025 15:42:23 -0800 Subject: [PATCH 36/90] Adjusting for Global wip --- .../hostlistprovider/AuroraTopologyUtils.java | 113 ++++++++++++++++++ .../MultiAzTopologyUtils.java | 40 +++++++ .../jdbc/hostlistprovider/TopologyUtils.java | 72 +---------- 3 files changed, 158 insertions(+), 67 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java new file mode 100644 index 000000000..548fdf03f --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -0,0 +1,113 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.util.Messages; + +public class AuroraTopologyUtils extends TopologyUtils { + private static final Logger LOGGER = Logger.getLogger(AuroraTopologyUtils.class.getName()); + + public AuroraTopologyUtils(TopologyDialect dialect, HostSpec initialHostSpec, + HostSpecBuilder hostSpecBuilder) { + super(dialect, initialHostSpec, hostSpecBuilder); + } + + @Override + protected @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) throws SQLException { + if (rs.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); + return null; + } + + // Data is result set is ordered by last updated time so the latest records go last. + // When adding hosts to a map, the newer records replace the older ones. + List hosts = new ArrayList<>(); + while (rs.next()) { + try { + hosts.add(createHost(rs, hostTemplate)); + } catch (Exception e) { + LOGGER.finest( + Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return hosts; + } + + protected HostSpec createHost(ResultSet rs, HostSpec hostTemplate) throws SQLException { + + // According to the topology query the result set + // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. + String hostName = rs.getString(1); + final boolean isWriter = rs.getBoolean(2); + final double cpuUtilization = rs.getDouble(3); + final double nodeLag = rs.getDouble(4); + Timestamp lastUpdateTime; + try { + lastUpdateTime = rs.getTimestamp(5); + } catch (Exception e) { + lastUpdateTime = Timestamp.from(Instant.now()); + } + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); + + return createHost(hostName, isWriter, weight, lastUpdateTime, hostTemplate); + } + + protected HostSpec createHost(String host, boolean isWriter, long weight, Timestamp lastUpdateTime, + HostSpec clusterInstanceTemplate) { + host = host == null ? "?" : host; + final String endpoint = getHostEndpoint(host, clusterInstanceTemplate); + final int port = clusterInstanceTemplate.isPortSpecified() + ? clusterInstanceTemplate.getPort() + : this.initialHostSpec.getPort(); + + final HostSpec hostSpec = this.hostSpecBuilder + .host(endpoint) + .port(port) + .role(isWriter ? HostRole.WRITER : HostRole.READER) + .availability(HostAvailability.AVAILABLE) + .weight(weight) + .lastUpdateTime(lastUpdateTime) + .build(); + hostSpec.addAlias(host); + hostSpec.setHostId(host); + return hostSpec; + } + + protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { + final String host = clusterInstanceTemplate.getHost(); + return host.replace("?", nodeName); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java new file mode 100644 index 000000000..76efd32b3 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -0,0 +1,40 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Collections; +import java.util.List; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.TopologyDialect; + +public class MultiAzTopologyUtils extends TopologyUtils { + public MultiAzTopologyUtils(TopologyDialect dialect, HostSpec initialHostSpec, + HostSpecBuilder hostSpecBuilder) { + super(dialect, initialHostSpec, hostSpecBuilder); + } + + @Override + protected @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) + throws SQLException { + + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index 95880e1af..af88b5761 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -41,7 +41,7 @@ import software.amazon.jdbc.util.SynchronousExecutor; import software.amazon.jdbc.util.Utils; -public class TopologyUtils { +public abstract class TopologyUtils { private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); protected static final int DEFAULT_QUERY_TIMEOUT_MS = 1000; @@ -63,17 +63,7 @@ public TopologyUtils( int networkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - List hosts = new ArrayList<>(); - List queryHosts = this.dialect.processTopologyResults(conn, resultSet); - if (Utils.isNullOrEmpty(queryHosts)) { - return null; - } - - for (TopologyQueryHostSpec queryHost : queryHosts) { - hosts.add(this.toHostspec(queryHost, hostTemplate)); - } - - return this.verifyWriter(hosts); + return this.verifyWriter(this.getHosts(conn, resultSet, hostTemplate)); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -83,41 +73,7 @@ public TopologyUtils( } } - public @Nullable List queryForTopology(Connection conn, Map hostTemplateByRegion) throws SQLException { - int networkTimeout = setNetworkTimeout(conn); - try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - List hosts = new ArrayList<>(); - List queryHosts = this.dialect.processTopologyResults(conn, resultSet); - if (Utils.isNullOrEmpty(queryHosts)) { - return null; - } - - for (TopologyQueryHostSpec queryHost : queryHosts) { - String region = queryHost.getRegion(); - if (region == null) { - throw new SQLException(""); - } - - HostSpec template = hostTemplateByRegion.get(region); - if (template == null) { - throw new SQLException(""); - } - - hosts.add(this.toHostspec(queryHost, template)); - } - - return this.verifyWriter(hosts); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - private int setNetworkTimeout(Connection conn) { + protected int setNetworkTimeout(Connection conn) { int networkTimeout = -1; try { networkTimeout = conn.getNetworkTimeout(); @@ -132,6 +88,8 @@ private int setNetworkTimeout(Connection conn) { return networkTimeout; } + protected abstract @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) throws SQLException; + protected @Nullable List verifyWriter(List allHosts) { List hosts = new ArrayList<>(); List writers = new ArrayList<>(); @@ -160,26 +118,6 @@ private int setNetworkTimeout(Connection conn) { return hosts; } - protected HostSpec toHostspec(TopologyQueryHostSpec queryHost, HostSpec hostTemplate) { - final String instanceId = queryHost.getInstanceId() == null ? "?" : queryHost.getInstanceId(); - final String endpoint = hostTemplate.getHost().replace("?", instanceId); - final int port = hostTemplate.isPortSpecified() - ? hostTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.hostSpecBuilder - .host(endpoint) - .port(port) - .role(queryHost.isWriter() ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(queryHost.getWeight()) - .lastUpdateTime(queryHost.getLastUpdateTime()) - .build(); - hostSpec.addAlias(instanceId); - hostSpec.setHostId(instanceId); - return hostSpec; - } - /** * Identifies instances across different database types using instanceId and instanceName values. * From 58a456f1dfbdfbbf513f6247e409e291d49a6fa0 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 4 Nov 2025 17:46:44 -0800 Subject: [PATCH 37/90] Build passing --- .../jdbc/dialect/AuroraDialectUtils.java | 96 -------------- .../jdbc/dialect/AuroraMysqlDialect.java | 29 +--- .../amazon/jdbc/dialect/AuroraPgDialect.java | 29 +--- .../dialect/GlobalAuroraDialectUtils.java | 63 --------- .../dialect/GlobalAuroraMysqlDialect.java | 36 +++-- .../jdbc/dialect/GlobalAuroraPgDialect.java | 31 ++--- ....java => GlobalAuroraTopologyDialect.java} | 4 +- .../jdbc/dialect/MultiAzClusterDialect.java | 23 ++++ .../dialect/MultiAzClusterMysqlDialect.java | 39 ++++-- .../jdbc/dialect/MultiAzClusterPgDialect.java | 39 +++--- .../jdbc/dialect/MultiAzDialectUtils.java | 124 ------------------ .../amazon/jdbc/dialect/TopologyDialect.java | 7 +- .../hostlistprovider/AuroraTopologyUtils.java | 61 ++++----- ...java => GlobalAuroraHostListProvider.java} | 32 +++-- .../GlobalAuroraTopologyUtils.java | 124 ++++++++++++++++++ .../MultiAzTopologyUtils.java | 89 ++++++++++++- .../hostlistprovider/RdsHostListProvider.java | 28 +--- .../jdbc/hostlistprovider/TopologyUtils.java | 50 +++++-- .../ClusterTopologyMonitorImpl.java | 44 +------ ....java => GlobalAuroraTopologyMonitor.java} | 33 ++--- ...nitoringGlobalAuroraHostListProvider.java} | 40 +++--- .../MonitoringRdsHostListProvider.java | 9 +- ..._advanced_jdbc_wrapper_messages.properties | 2 - 23 files changed, 463 insertions(+), 569 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java rename wrapper/src/main/java/software/amazon/jdbc/dialect/{GlobalTopologyDialect.java => GlobalAuroraTopologyDialect.java} (83%) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/{AuroraGlobalDbHostListProvider.java => GlobalAuroraHostListProvider.java} (73%) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/{GlobalTopologyMonitor.java => GlobalAuroraTopologyMonitor.java} (66%) rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/{AuroraGlobalDbMonitoringHostListProvider.java => MonitoringGlobalAuroraHostListProvider.java} (67%) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java deleted file mode 100644 index ee1f4d145..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraDialectUtils.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.dialect; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.ArrayList; -import java.util.List; -import java.util.logging.Logger; -import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.StringUtils; - -public class AuroraDialectUtils { - - protected final String writerIdQuery; - - private static final Logger LOGGER = Logger.getLogger(AuroraDialectUtils.class.getName()); - - public AuroraDialectUtils(String writerIdQuery) { - this.writerIdQuery = writerIdQuery; - } - - public @Nullable List processTopologyResults(ResultSet resultSet) - throws SQLException { - if (resultSet.getMetaData().getColumnCount() == 0) { - // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); - return null; - } - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - List hosts = new ArrayList<>(); - while (resultSet.next()) { - try { - hosts.add(createHost(resultSet)); - } catch (Exception e) { - LOGGER.finest( - Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); - return null; - } - } - - return hosts; - } - - protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { - // According to the topology query the result set should contain 4 columns: - // instance ID, 1/0 (writer/reader), CPU utilization, instance lag - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float cpuUtilization = resultSet.getFloat(3); - final float instanceLag = resultSet.getFloat(4); - Timestamp lastUpdateTime; - try { - lastUpdateTime = resultSet.getTimestamp(5); - } catch (Exception e) { - lastUpdateTime = Timestamp.from(Instant.now()); - } - - // Calculate weight based on instance lag in time and CPU utilization. - final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); - return new TopologyQueryHostSpec(hostName, isWriter, weight, lastUpdateTime); - } - - public boolean isWriterInstance(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { - if (resultSet.next()) { - return !StringUtils.isNullOrEmpty(resultSet.getString(1)); - } - } - } - - return false; - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 34eafc735..532c58343 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -24,7 +24,9 @@ import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; @@ -49,18 +51,6 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, + " table_schema = 'mysql' AND table_name = 'rds_topology'"; protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; - protected final AuroraDialectUtils dialectUtils; - - public AuroraMysqlDialect() { - super(); - this.dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); - } - - public AuroraMysqlDialect(AuroraDialectUtils dialectUtils) { - super(); - this.dialectUtils = dialectUtils; - } - @Override public boolean isDialect(final Connection connection) { try (Statement stmt = connection.createStatement(); @@ -85,10 +75,11 @@ public boolean isDialect(final Connection connection) { public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @@ -97,20 +88,14 @@ public String getTopologyQuery() { return TOPOLOGY_QUERY; } - @Override - public @Nullable List processTopologyResults(Connection conn, ResultSet rs) - throws SQLException { - return this.dialectUtils.processTopologyResults(rs); - } - @Override public String getInstanceIdQuery() { return INSTANCE_ID_QUERY; } @Override - public boolean isWriterInstance(Connection connection) throws SQLException { - return dialectUtils.isWriterInstance(connection); + public String getWriterIdQuery() { + return WRITER_ID_QUERY; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 5984de366..6c605ce16 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -25,7 +25,9 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; @@ -65,18 +67,6 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); - protected final AuroraDialectUtils dialectUtils; - - public AuroraPgDialect() { - super(); - this.dialectUtils = new AuroraDialectUtils(WRITER_ID_QUERY); - } - - public AuroraPgDialect(AuroraDialectUtils dialectUtils) { - super(); - this.dialectUtils = dialectUtils; - } - @Override public boolean isDialect(final Connection connection) { if (!super.isDialect(connection)) { @@ -125,10 +115,11 @@ public List getDialectUpdateCandidates() { public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(this, properties, initialUrl, servicesContainer); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new RdsHostListProvider(this, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @@ -137,20 +128,14 @@ public String getTopologyQuery() { return TOPOLOGY_QUERY; } - @Override - public @Nullable List processTopologyResults(Connection conn, ResultSet rs) - throws SQLException { - return this.dialectUtils.processTopologyResults(rs); - } - @Override public String getInstanceIdQuery() { return INSTANCE_ID_QUERY; } @Override - public boolean isWriterInstance(Connection connection) throws SQLException { - return this.dialectUtils.isWriterInstance(connection); + public String getWriterIdQuery() { + return WRITER_ID_QUERY; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java deleted file mode 100644 index 294a614ac..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraDialectUtils.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.dialect; - -import java.sql.Connection; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Timestamp; -import java.time.Instant; -import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.util.StringUtils; - -public class GlobalAuroraDialectUtils extends AuroraDialectUtils { - protected final String regionByInstanceIdQuery; - - public GlobalAuroraDialectUtils(String writerIdQuery, String regionByInstanceIdQuery) { - super(writerIdQuery); - this.regionByInstanceIdQuery = regionByInstanceIdQuery; - } - - @Override - protected TopologyQueryHostSpec createHost(final ResultSet resultSet) throws SQLException { - // The topology query results should contain 4 columns: - // instance ID, 1/0 (writer/reader), instance lag in time (ms), AWS region. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float instanceLag = resultSet.getFloat(3); - final String region = resultSet.getString(4); - - // Calculate weight based on instance lag in time and CPU utilization. - final long weight = Math.round(instanceLag) * 100L; - return new TopologyQueryHostSpec(hostName, isWriter, weight, Timestamp.from(Instant.now()), region); - } - - protected @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { - try (final PreparedStatement stmt = conn.prepareStatement(this.regionByInstanceIdQuery)) { - stmt.setString(1, instanceId); - try (final ResultSet resultSet = stmt.executeQuery()) { - if (resultSet.next()) { - String awsRegion = resultSet.getString(1); - return StringUtils.isNullOrEmpty(awsRegion) ? null : awsRegion; - } - } - } - - return null; - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 8ae3b33c1..44db2c5af 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -23,11 +23,12 @@ import java.util.Collections; import java.util.List; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalTopologyDialect { +public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalAuroraTopologyDialect { protected static final String GLOBAL_STATUS_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" @@ -45,29 +46,26 @@ public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements Glob protected static final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?"; - public GlobalAuroraMysqlDialect() { - super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY, REGION_BY_INSTANCE_ID_QUERY)); - } @Override public boolean isDialect(final Connection connection) { try { try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(this.GLOBAL_STATUS_TABLE_EXISTS_QUERY)) { + ResultSet rs = stmt.executeQuery(GLOBAL_STATUS_TABLE_EXISTS_QUERY)) { if (!rs.next()) { return false; } } try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(this.GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { + ResultSet rs = stmt.executeQuery(GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { if (!rs.next()) { return false; } } try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(this.REGION_COUNT_QUERY)) { + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { if (rs.next()) { int awsRegionCount = rs.getInt(1); return awsRegionCount > 1; @@ -89,22 +87,22 @@ public boolean isDialect(final Connection connection) { public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider(this, properties, initialUrl, servicesContainer); + return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - - return new AuroraGlobalDbHostListProvider(this, properties, initialUrl, servicesContainer); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @Override - public String getRegion(String instanceId, Connection conn) - throws SQLException { - if (!(this.dialectUtils instanceof GlobalAuroraDialectUtils)) { - throw new SQLException(""); - } + public String getTopologyQuery() { + return GLOBAL_TOPOLOGY_QUERY; + } - GlobalAuroraDialectUtils globalUtils = (GlobalAuroraDialectUtils) this.dialectUtils; - return globalUtils.getRegion(instanceId, conn); + @Override + public String getRegionByInstanceIdQuery() { + return REGION_BY_INSTANCE_ID_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 0956f40b0..5a623e714 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -24,11 +24,12 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalTopologyDialect { +public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { protected static final String GLOBAL_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_status'::regproc"; protected static final String GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY = @@ -45,10 +46,6 @@ public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalTopo private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); - public GlobalAuroraPgDialect() { - super(new GlobalAuroraDialectUtils(WRITER_ID_QUERY, REGION_BY_INSTANCE_ID_QUERY)); - } - @Override public boolean isDialect(final Connection connection) { try { @@ -102,22 +99,22 @@ public boolean isDialect(final Connection connection) { public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider(this, properties, initialUrl, servicesContainer); + return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - - return new AuroraGlobalDbHostListProvider(this, properties, initialUrl, servicesContainer); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @Override - public String getRegion(String instanceId, Connection conn) - throws SQLException { - if (!(this.dialectUtils instanceof GlobalAuroraDialectUtils)) { - throw new SQLException(""); - } + public String getTopologyQuery() { + return GLOBAL_TOPOLOGY_QUERY; + } - GlobalAuroraDialectUtils globalUtils = (GlobalAuroraDialectUtils) this.dialectUtils; - return globalUtils.getRegion(instanceId, conn); + @Override + public String getRegionByInstanceIdQuery() { + return REGION_BY_INSTANCE_ID_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java similarity index 83% rename from wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java index c41c62ce5..1febb80a7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalTopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java @@ -19,6 +19,6 @@ import java.sql.Connection; import java.sql.SQLException; -public interface GlobalTopologyDialect extends TopologyDialect { - String getRegion(String instanceId, Connection conn) throws SQLException; +public interface GlobalAuroraTopologyDialect extends TopologyDialect { + String getRegionByInstanceIdQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java new file mode 100644 index 000000000..4dc0a584d --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java @@ -0,0 +1,23 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +public interface MultiAzClusterDialect extends TopologyDialect { + String getWriterIdQuery(); + + String getWriterIdColumnName(); +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index f142e8ab1..2da87edba 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -25,12 +25,19 @@ import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class MultiAzClusterMysqlDialect extends MysqlDialect implements TopologyDialect { +public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzClusterDialect { protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = @@ -45,15 +52,13 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements Topology + " WHERE id = @@server_id"; // For reader instances, the query returns a writer instance ID. For a writer instance, the query returns no data. protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; - protected static final String WRITER_ID_QUERY_COLUMN = "Source_Server_Id"; + protected static final String WRITER_ID_QUERY_COLUMN_NAME = "Source_Server_Id"; protected static final String IS_READER_QUERY = "SELECT @@read_only"; private static final EnumSet FAILOVER_RESTRICTIONS = EnumSet.of(FailoverRestriction.DISABLE_TASK_A, FailoverRestriction.ENABLE_WRITER_IN_TASK_B); protected final RdsUtils rdsUtils = new RdsUtils(); - protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - INSTANCE_ID_QUERY, WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN); @Override public boolean isDialect(final Connection connection) { @@ -94,7 +99,14 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProviderSupplier() { - return this.dialectUtils.getHostListProviderSupplier(this); + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + } + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override @@ -119,23 +131,22 @@ public String getTopologyQuery() { } @Override - public List processTopologyResults(Connection conn, ResultSet rs) - throws SQLException { - return dialectUtils.processTopologyResults(conn, rs); + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; } @Override - public String getInstanceIdQuery() { - return INSTANCE_ID_QUERY; + public String getIsReaderQuery() { + return IS_READER_QUERY; } @Override - public boolean isWriterInstance(Connection connection) throws SQLException { - return dialectUtils.isWriterInstance(connection); + public String getWriterIdQuery() { + return WRITER_ID_QUERY; } @Override - public String getIsReaderQuery() { - return IS_READER_QUERY; + public String getWriterIdColumnName() { + return WRITER_ID_QUERY_COLUMN_NAME; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 7e31ba678..6547ea339 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -22,11 +22,17 @@ import java.sql.Statement; import java.util.List; import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; +import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; +import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -public class MultiAzClusterPgDialect extends PgDialect implements TopologyDialect { +public class MultiAzClusterPgDialect extends PgDialect implements MultiAzClusterDialect { protected static final String IS_RDS_CLUSTER_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; @@ -45,14 +51,11 @@ public class MultiAzClusterPgDialect extends PgDialect implements TopologyDialec "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" + " (SELECT dbi_resource_id FROM rds_tools.dbi_resource_id())"; - protected static final String WRITER_ID_QUERY_COLUMN = "multi_az_db_cluster_source_dbi_resource_id"; + protected static final String WRITER_ID_QUERY_COLUMN_NAME = "multi_az_db_cluster_source_dbi_resource_id"; protected static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; private static MultiAzDbClusterPgExceptionHandler exceptionHandler; - protected final MultiAzDialectUtils dialectUtils = new MultiAzDialectUtils( - INSTANCE_ID_QUERY, WRITER_ID_QUERY, WRITER_ID_QUERY_COLUMN); - @Override public boolean isDialect(final Connection connection) { try (Statement stmt = connection.createStatement(); @@ -79,7 +82,14 @@ public ExceptionHandler getExceptionHandler() { @Override public HostListProviderSupplier getHostListProviderSupplier() { - return this.dialectUtils.getHostListProviderSupplier(this); + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + } + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override @@ -88,23 +98,22 @@ public String getTopologyQuery() { } @Override - public @Nullable List processTopologyResults(Connection conn, ResultSet rs) - throws SQLException { - return this.dialectUtils.processTopologyResults(conn, rs); + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; } @Override - public String getInstanceIdQuery() { - return INSTANCE_ID_QUERY; + public String getIsReaderQuery() { + return IS_READER_QUERY; } @Override - public boolean isWriterInstance(Connection connection) throws SQLException { - return dialectUtils.isWriterInstance(connection); + public String getWriterIdQuery() { + return WRITER_ID_QUERY; } @Override - public String getIsReaderQuery() { - return IS_READER_QUERY; + public String getWriterIdColumnName() { + return WRITER_ID_QUERY_COLUMN_NAME; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java deleted file mode 100644 index 42d25a3ab..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzDialectUtils.java +++ /dev/null @@ -1,124 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.dialect; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.ArrayList; -import java.util.List; -import java.util.logging.Logger; -import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.StringUtils; - -public class MultiAzDialectUtils { - private static final Logger LOGGER = Logger.getLogger(MultiAzDialectUtils.class.getName()); - private final String instanceIdQuery; - private final String writerIdQuery; - private final String writerIdQueryColumn; - - public MultiAzDialectUtils(String instanceIdQuery, String writerIdQuery, String writerIdQueryColumn) { - this.instanceIdQuery = instanceIdQuery; - this.writerIdQuery = writerIdQuery; - this.writerIdQueryColumn = writerIdQueryColumn; - } - - public @Nullable List processTopologyResults(Connection conn, ResultSet resultSet) - throws SQLException { - List hosts = new ArrayList<>(); - while (resultSet.next()) { - try { - final TopologyQueryHostSpec host = createHost(resultSet, this.getWriterId(conn)); - hosts.add(host); - } catch (Exception e) { - LOGGER.finest( - Messages.get("MultiAzDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); - return null; - } - } - - return hosts; - } - - protected TopologyQueryHostSpec createHost( - final ResultSet resultSet, - final @Nullable String writerId) throws SQLException { - - String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" - String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - String hostId = resultSet.getString("id"); // "1034958454" - final boolean isWriter = hostId.equals(writerId); - - return new TopologyQueryHostSpec(instanceName, isWriter, 0, Timestamp.from(Instant.now())); - } - - protected @Nullable String getWriterId(Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { - if (resultSet.next()) { - String writerId = resultSet.getString(this.writerIdQueryColumn); - if (!StringUtils.isNullOrEmpty(writerId)) { - return writerId; - } - } - } - - // Replica status doesn't exist, which means that this instance is a writer. We execute instanceIdQuery to get the - // ID of this writer instance. - try (final ResultSet resultSet = stmt.executeQuery(this.instanceIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - public boolean isWriterInstance(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerIdQuery)) { - if (resultSet.next()) { - String instanceId = resultSet.getString(this.writerIdQueryColumn); - // The writer ID is only returned when connected to a reader, so if the query does not return a value, it - // means we are connected to a writer. - return StringUtils.isNullOrEmpty(instanceId); - } - } - } - return false; - } - - protected HostListProviderSupplier getHostListProviderSupplier(TopologyDialect dialect) { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(dialect, properties, initialUrl, servicesContainer); - - } else { - return new RdsHostListProvider(dialect, properties, initialUrl, servicesContainer); - } - }; - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index f3fb5a9ff..84ac7ae3a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -25,14 +25,9 @@ public interface TopologyDialect extends Dialect { String getTopologyQuery(); - @Nullable - List processTopologyResults(Connection conn, ResultSet rs) throws SQLException; - String getInstanceIdQuery(); - // TODO: dialects have an isWriterInstance method (uses is_writer query) and a getHostRole method - // (uses is_reader query). Can we merge them into one getHostRole method? - boolean isWriterInstance(final Connection connection) throws SQLException; + String getWriterIdQuery(); String getIsReaderQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java index 548fdf03f..79229e9cc 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -19,6 +19,7 @@ import java.sql.Connection; import java.sql.ResultSet; import java.sql.SQLException; +import java.sql.Statement; import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; @@ -31,29 +32,24 @@ import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; public class AuroraTopologyUtils extends TopologyUtils { private static final Logger LOGGER = Logger.getLogger(AuroraTopologyUtils.class.getName()); - public AuroraTopologyUtils(TopologyDialect dialect, HostSpec initialHostSpec, - HostSpecBuilder hostSpecBuilder) { - super(dialect, initialHostSpec, hostSpecBuilder); + public AuroraTopologyUtils(TopologyDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); } @Override - protected @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) throws SQLException { - if (rs.getMetaData().getColumnCount() == 0) { - // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); - return null; - } - + protected @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException { // Data is result set is ordered by last updated time so the latest records go last. // When adding hosts to a map, the newer records replace the older ones. List hosts = new ArrayList<>(); while (rs.next()) { try { - hosts.add(createHost(rs, hostTemplate)); + hosts.add(createHost(rs, initialHostSpec, hostTemplate)); } catch (Exception e) { LOGGER.finest( Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); @@ -64,7 +60,20 @@ public AuroraTopologyUtils(TopologyDialect dialect, HostSpec initialHostSpec, return hosts; } - protected HostSpec createHost(ResultSet rs, HostSpec hostTemplate) throws SQLException { + @Override + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (resultSet.next()) { + return !StringUtils.isNullOrEmpty(resultSet.getString(1)); + } + } + } + + return false; + } + + protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException { // According to the topology query the result set // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. @@ -82,32 +91,6 @@ protected HostSpec createHost(ResultSet rs, HostSpec hostTemplate) throws SQLExc // Calculate weight based on node lag in time and CPU utilization. final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, isWriter, weight, lastUpdateTime, hostTemplate); - } - - protected HostSpec createHost(String host, boolean isWriter, long weight, Timestamp lastUpdateTime, - HostSpec clusterInstanceTemplate) { - host = host == null ? "?" : host; - final String endpoint = getHostEndpoint(host, clusterInstanceTemplate); - final int port = clusterInstanceTemplate.isPortSpecified() - ? clusterInstanceTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.hostSpecBuilder - .host(endpoint) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(lastUpdateTime) - .build(); - hostSpec.addAlias(host); - hostSpec.setHostId(host); - return hostSpec; - } - - protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { - final String host = clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); + return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, hostTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java similarity index 73% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index e8c0fae65..d5f09dec6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -16,11 +16,10 @@ package software.amazon.jdbc.hostlistprovider; -import java.sql.ResultSet; +import java.sql.Connection; import java.sql.SQLException; -import java.sql.Timestamp; -import java.time.Instant; import java.util.Arrays; +import java.util.List; import java.util.Map; import java.util.Properties; import java.util.logging.Logger; @@ -29,16 +28,15 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class AuroraGlobalDbHostListProvider extends RdsHostListProvider { +public class GlobalAuroraHostListProvider extends RdsHostListProvider { - static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbHostListProvider.class.getName()); + static final Logger LOGGER = Logger.getLogger(GlobalAuroraHostListProvider.class.getName()); public static final AwsWrapperProperty GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS = new AwsWrapperProperty( @@ -51,16 +49,18 @@ public class AuroraGlobalDbHostListProvider extends RdsHostListProvider { + "Each region in the Global Aurora Database should be specified in the list."); protected final RdsUtils rdsUtils = new RdsUtils(); + protected final GlobalAuroraTopologyUtils topologyUtils; - protected Map globalClusterInstanceTemplateByAwsRegion; + protected Map instanceTemplatesByRegion; static { - PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); + PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); } - public AuroraGlobalDbHostListProvider( - TopologyDialect dialect, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); + public GlobalAuroraHostListProvider( + GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { + super(topologyUtils, properties, originalUrl, servicesContainer); + this.topologyUtils = topologyUtils; } @Override @@ -73,7 +73,7 @@ protected void initSettings() throws SQLException { } HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) + this.instanceTemplatesByRegion = Arrays.stream(templates.split(",")) .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) .collect(Collectors.toMap( Pair::getValue1, @@ -82,9 +82,15 @@ protected void initSettings() throws SQLException { return v.getValue2(); })); LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() + + this.instanceTemplatesByRegion.entrySet().stream() .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) .collect(Collectors.joining("\n")) ); } + + @Override + protected List queryForTopology(final Connection conn) throws SQLException { + init(); + return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplatesByRegion); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java new file mode 100644 index 000000000..528e8b94c --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -0,0 +1,124 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.SQLSyntaxErrorException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.GlobalAuroraTopologyDialect; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; + +public class GlobalAuroraTopologyUtils extends AuroraTopologyUtils { + private static final Logger LOGGER = Logger.getLogger(GlobalAuroraTopologyUtils.class.getName()); + + protected final GlobalAuroraTopologyDialect dialect; + + public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); + this.dialect = dialect; + } + + public @Nullable List queryForTopology( + Connection conn, HostSpec initialHostSpec, Map instanceTemplatesByRegion) + throws SQLException { + int networkTimeout = setNetworkTimeout(conn); + try (final Statement stmt = conn.createStatement(); + final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { + if (resultSet.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); + return null; + } + + return this.verifyWriter(this.getHosts(conn, resultSet, initialHostSpec, instanceTemplatesByRegion)); + } catch (final SQLSyntaxErrorException e) { + throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); + } finally { + if (networkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); + } + } + } + + protected @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) + throws SQLException { + // Data is result set is ordered by last updated time so the latest records go last. + // When adding hosts to a map, the newer records replace the older ones. + List hosts = new ArrayList<>(); + while (rs.next()) { + try { + hosts.add(createHost(rs, initialHostSpec, instanceTemplatesByRegion)); + } catch (Exception e) { + LOGGER.finest( + Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return hosts; + } + + protected HostSpec createHost( + ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) + throws SQLException { + // According to the topology query the result set + // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. + String hostName = rs.getString(1); + final boolean isWriter = rs.getBoolean(2); + final float nodeLag = rs.getFloat(3); + final String awsRegion = rs.getString(4); + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L; + + final HostSpec clusterInstanceTemplateForRegion = instanceTemplatesByRegion.get(awsRegion); + if (clusterInstanceTemplateForRegion == null) { + throw new SQLException("Can't find cluster template for region " + awsRegion); + } + + return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, clusterInstanceTemplateForRegion); + } + + public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { + try (final PreparedStatement stmt = conn.prepareStatement(this.dialect.getRegionByInstanceIdQuery())) { + stmt.setString(1, instanceId); + try (final ResultSet resultSet = stmt.executeQuery()) { + if (resultSet.next()) { + String awsRegion = resultSet.getString(1); + return StringUtils.isNullOrEmpty(awsRegion) ? null : awsRegion; + } + } + } + + return null; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 76efd32b3..1f0494fa7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -19,22 +19,103 @@ import java.sql.Connection; import java.sql.ResultSet; import java.sql.SQLException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; import java.util.Collections; import java.util.List; +import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.MultiAzClusterDialect; import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.dialect.TopologyQueryHostSpec; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; public class MultiAzTopologyUtils extends TopologyUtils { - public MultiAzTopologyUtils(TopologyDialect dialect, HostSpec initialHostSpec, - HostSpecBuilder hostSpecBuilder) { - super(dialect, initialHostSpec, hostSpecBuilder); + private static final Logger LOGGER = Logger.getLogger(MultiAzTopologyUtils.class.getName()); + + protected final MultiAzClusterDialect dialect; + + public MultiAzTopologyUtils(MultiAzClusterDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); + this.dialect = dialect; } @Override - protected @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) + protected @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException { + String writerId = this.getWriterId(conn); + + // Data is result set is ordered by last updated time so the latest records go last. + // When adding hosts to a map, the newer records replace the older ones. + List hosts = new ArrayList<>(); + while (rs.next()) { + try { + hosts.add(createHost(rs, initialHostSpec, hostTemplate, writerId)); + } catch (Exception e) { + LOGGER.finest( + Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return hosts; + } + + @Override + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (resultSet.next()) { + String instanceId = resultSet.getString(this.dialect.getWriterIdColumnName()); + // The writer ID is only returned when connected to a reader, so if the query does not return a value, it + // means we are connected to a writer. + return StringUtils.isNullOrEmpty(instanceId); + } + } + } + return false; + } + + + protected @Nullable String getWriterId(Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (resultSet.next()) { + String writerId = resultSet.getString(this.dialect.getWriterIdColumnName()); + if (!StringUtils.isNullOrEmpty(writerId)) { + return writerId; + } + } + } + + // Replica status doesn't exist, which means that this instance is a writer. We execute instanceIdQuery to get the + // ID of this writer instance. + try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (resultSet.next()) { + return resultSet.getString(1); + } + } + } + return null; + } + + protected HostSpec createHost( + final ResultSet resultSet, + final HostSpec initialHostSpec, + final HostSpec hostTemplate, + final @Nullable String writerId) throws SQLException { + + String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" + String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" + String hostId = resultSet.getString("id"); // "1034958454" + final boolean isWriter = hostId.equals(writerId); + return createHost(hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, hostTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index a1e6ab18c..6baf6ed01 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -32,7 +32,6 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; @@ -73,11 +72,11 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected static final int defaultTopologyQueryTimeoutMs = 5000; protected final ReentrantLock lock = new ReentrantLock(); - protected final TopologyDialect dialect; protected final Properties properties; protected final String originalUrl; protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; + protected final TopologyUtils topologyUtils; protected RdsUrlType rdsUrlType; protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null @@ -88,7 +87,6 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected HostSpec initialHostSpec; protected String clusterId; protected HostSpec clusterInstanceTemplate; - protected TopologyUtils topologyUtils; protected volatile boolean isInitialized = false; @@ -97,28 +95,17 @@ public class RdsHostListProvider implements DynamicHostListProvider { } public RdsHostListProvider( - final TopologyDialect dialect, + final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, final FullServicesContainer servicesContainer) { - this.dialect = dialect; + this.topologyUtils = topologyUtils; this.properties = properties; this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; this.hostListProviderService = servicesContainer.getHostListProviderService(); } - // For testing purposes only - public RdsHostListProvider( - final TopologyDialect dialect, - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer, - final TopologyUtils topologyUtils) { - this(dialect, properties, originalUrl, servicesContainer); - this.topologyUtils = topologyUtils; - } - protected void init() throws SQLException { if (this.isInitialized) { return; @@ -170,13 +157,6 @@ protected void initSettings() throws SQLException { validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); - - if (this.topologyUtils == null) { - this.topologyUtils = new TopologyUtils( - this.dialect, - this.initialHostSpec, - this.servicesContainer.getPluginService().getHostSpecBuilder()); - } } /** @@ -232,7 +212,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f */ protected List queryForTopology(final Connection conn) throws SQLException { init(); - return this.topologyUtils.queryForTopology(conn, this.clusterInstanceTemplate); + return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.clusterInstanceTemplate); } /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index af88b5761..8d24d3614 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -22,6 +22,7 @@ import java.sql.SQLException; import java.sql.SQLSyntaxErrorException; import java.sql.Statement; +import java.sql.Timestamp; import java.util.ArrayList; import java.util.Comparator; import java.util.List; @@ -47,23 +48,27 @@ public abstract class TopologyUtils { protected final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected final TopologyDialect dialect; - protected final HostSpec initialHostSpec; protected final HostSpecBuilder hostSpecBuilder; public TopologyUtils( TopologyDialect dialect, - HostSpec initialHostSpec, HostSpecBuilder hostSpecBuilder) { this.dialect = dialect; - this.initialHostSpec = initialHostSpec; this.hostSpecBuilder = hostSpecBuilder; } - public @Nullable List queryForTopology(Connection conn, HostSpec hostTemplate) throws SQLException { + public @Nullable List queryForTopology(Connection conn, HostSpec initialHostSpec, HostSpec hostTemplate) + throws SQLException { int networkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - return this.verifyWriter(this.getHosts(conn, resultSet, hostTemplate)); + if (resultSet.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); + return null; + } + + return this.verifyWriter(this.getHosts(conn, resultSet, initialHostSpec, hostTemplate)); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -88,7 +93,8 @@ protected int setNetworkTimeout(Connection conn) { return networkTimeout; } - protected abstract @Nullable List getHosts(Connection conn, ResultSet rs, HostSpec hostTemplate) throws SQLException; + protected abstract @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException; protected @Nullable List verifyWriter(List allHosts) { List hosts = new ArrayList<>(); @@ -118,6 +124,34 @@ protected int setNetworkTimeout(Connection conn) { return hosts; } + public HostSpec createHost( + String instanceId, + String instanceName, + final boolean isWriter, + final long weight, + final Timestamp lastUpdateTime, + final HostSpec initialHostSpec, + final HostSpec clusterInstanceTemplate) { + instanceName = instanceName == null ? "?" : instanceName; + final String endpoint = clusterInstanceTemplate.getHost().replace("?", instanceName); + final int port = clusterInstanceTemplate.isPortSpecified() + ? clusterInstanceTemplate.getPort() + : initialHostSpec.getPort(); + + final HostSpec hostSpec = this.hostSpecBuilder + .hostId(instanceId) + .host(endpoint) + .port(port) + .role(isWriter ? HostRole.WRITER : HostRole.READER) + .availability(HostAvailability.AVAILABLE) + .weight(weight) + .lastUpdateTime(lastUpdateTime) + .build(); + hostSpec.addAlias(instanceName); + hostSpec.setHostId(instanceName); + return hostSpec; + } + /** * Identifies instances across different database types using instanceId and instanceName values. * @@ -144,9 +178,7 @@ protected int setNetworkTimeout(Connection conn) { return null; } - public boolean isWriterInstance(Connection connection) throws SQLException { - return this.dialect.isWriterInstance(connection); - } + public abstract boolean isWriterInstance(Connection connection) throws SQLException; public HostRole getHostRole(Connection conn) throws SQLException { try (final Statement stmt = conn.createStatement(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index d86c6bf90..cea64fa52 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -19,7 +19,6 @@ import java.sql.Connection; import java.sql.SQLException; import java.sql.SQLSyntaxErrorException; -import java.sql.Timestamp; import java.util.ArrayList; import java.util.List; import java.util.Properties; @@ -39,7 +38,6 @@ import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.ExecutorFactory; @@ -174,7 +172,6 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long @Override public List forceRefresh(@Nullable Connection connection, final long timeoutMs) throws SQLException, TimeoutException { - if (this.isVerifiedWriterConnection) { // Push monitoring thread to refresh topology with a verified connection return this.waitTillTopologyGetsUpdated(timeoutMs); @@ -522,11 +519,12 @@ protected List openAnyConnectionAndUpdateTopology() { new Object[]{this.writerHostSpec.get().getHost()})); } else { final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); + // TODO: this code isn't quite right when compared to main-3.x if (pair != null) { HostSpec hostTemplate = this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); HostSpec writerHost = - this.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, hostTemplate); + this.topologyUtils.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, hostTemplate); this.writerHostSpec.set(writerHost); LOGGER.finest( Messages.get( @@ -623,7 +621,7 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { } protected List queryForTopology(Connection connection) throws SQLException { - return this.topologyUtils.queryForTopology(connection, this.clusterInstanceTemplate); + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.clusterInstanceTemplate); } protected void updateTopologyCache(final @NonNull List hosts) { @@ -638,39 +636,6 @@ protected void updateTopologyCache(final @NonNull List hosts) { } } - protected HostSpec createHost( - String nodeId, - String nodeName, - final boolean isWriter, - final long weight, - final Timestamp lastUpdateTime, - final HostSpec clusterInstanceTemplate) { - - nodeName = nodeName == null ? "?" : nodeName; - final String endpoint = getHostEndpoint(nodeName, clusterInstanceTemplate); - final int port = clusterInstanceTemplate.isPortSpecified() - ? clusterInstanceTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.servicesContainer.getHostListProviderService().getHostSpecBuilder() - .hostId(nodeId) - .host(endpoint) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(lastUpdateTime) - .build(); - hostSpec.addAlias(nodeName); - hostSpec.setHostId(nodeName); - return hostSpec; - } - - protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { - final String host = clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); - } - private static class NodeMonitoringWorker implements Runnable { private static final Logger LOGGER = Logger.getLogger(NodeMonitoringWorker.class.getName()); @@ -799,7 +764,8 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla List hosts; try { - hosts = this.monitor.topologyUtils.queryForTopology(connection, this.monitor.clusterInstanceTemplate); + hosts = this.monitor.topologyUtils.queryForTopology( + connection, this.monitor.initialHostSpec, this.monitor.clusterInstanceTemplate); if (hosts == null) { return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java similarity index 66% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java index 8bca82a44..fa8680060 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java @@ -18,34 +18,30 @@ import java.sql.Connection; import java.sql.SQLException; +import java.util.List; import java.util.Map; import java.util.Properties; import java.util.logging.Logger; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.dialect.GlobalTopologyDialect; -import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.StringUtils; -public class GlobalTopologyMonitor extends ClusterTopologyMonitorImpl { +public class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl { + protected final Map instanceTemplatesByRegion; + protected final GlobalAuroraTopologyUtils topologyUtils; - private static final Logger LOGGER = Logger.getLogger(GlobalTopologyMonitor.class.getName()); - - protected final Map hostTemplatesByRegion; - protected final GlobalTopologyDialect dialect; - - public GlobalTopologyMonitor( + public GlobalAuroraTopologyMonitor( final FullServicesContainer servicesContainer, - final TopologyUtils topologyUtils, - final GlobalTopologyDialect dialect, + final GlobalAuroraTopologyUtils topologyUtils, final String clusterId, final HostSpec initialHostSpec, final Properties properties, final HostSpec clusterInstanceTemplate, final long refreshRateNano, final long highRefreshRateNano, - final Map hostTemplatesByRegion) { + final Map instanceTemplatesByRegion) { super(servicesContainer, topologyUtils, clusterId, @@ -55,15 +51,15 @@ public GlobalTopologyMonitor( refreshRateNano, highRefreshRateNano); - this.hostTemplatesByRegion = hostTemplatesByRegion; - this.dialect = dialect; + this.instanceTemplatesByRegion = instanceTemplatesByRegion; + this.topologyUtils = topologyUtils; } @Override protected HostSpec getClusterInstanceTemplate(String instanceId, Connection connection) throws SQLException { - String region = dialect.getRegion(instanceId, connection); + String region = this.topologyUtils.getRegion(instanceId, connection); if (!StringUtils.isNullOrEmpty(region)) { - final HostSpec clusterInstanceTemplateForRegion = this.hostTemplatesByRegion.get(region); + final HostSpec clusterInstanceTemplateForRegion = this.instanceTemplatesByRegion.get(region); if (clusterInstanceTemplateForRegion == null) { throw new SQLException("Can't find cluster template for region " + region); } @@ -73,4 +69,9 @@ protected HostSpec getClusterInstanceTemplate(String instanceId, Connection conn return this.clusterInstanceTemplate; } + + @Override + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java similarity index 67% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java index 9fa906664..84395e0fc 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java @@ -16,9 +16,11 @@ package software.amazon.jdbc.hostlistprovider.monitoring; +import java.sql.Connection; import java.sql.SQLException; import java.util.Arrays; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.Properties; import java.util.logging.Logger; @@ -26,48 +28,49 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.dialect.GlobalTopologyDialect; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostListProvider { +public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostListProvider { - static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbMonitoringHostListProvider.class.getName()); + static final Logger LOGGER = Logger.getLogger(MonitoringGlobalAuroraHostListProvider.class.getName()); - protected Map globalClusterInstanceTemplateByAwsRegion = new HashMap<>(); + protected Map instanceTemplatesByRegion = new HashMap<>(); protected final RdsUtils rdsUtils = new RdsUtils(); - protected final GlobalTopologyDialect globalDialect; + protected final GlobalAuroraTopologyUtils topologyUtils; static { // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. - PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); + PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); } - public AuroraGlobalDbMonitoringHostListProvider( - GlobalTopologyDialect dialect, + public MonitoringGlobalAuroraHostListProvider( + GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); - this.globalDialect = dialect; + super(topologyUtils, properties, originalUrl, servicesContainer); + this.topologyUtils = topologyUtils; } @Override protected void initSettings() throws SQLException { super.initSettings(); - String templates = AuroraGlobalDbHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + // TODO: check if we have other places that parse into string-HostSpec maps, consider refactoring + String templates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); if (StringUtils.isNullOrEmpty(templates)) { throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); } HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) + this.instanceTemplatesByRegion = Arrays.stream(templates.split(",")) .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) .collect(Collectors.toMap( Pair::getValue1, @@ -76,7 +79,7 @@ protected void initSettings() throws SQLException { return v.getValue2(); })); LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() + + this.instanceTemplatesByRegion.entrySet().stream() .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) .collect(Collectors.joining("\n")) ); @@ -89,17 +92,20 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.servicesContainer, this.properties, (servicesContainer) -> - new GlobalTopologyMonitor( + new GlobalAuroraTopologyMonitor( servicesContainer, this.topologyUtils, - this.globalDialect, this.clusterId, this.initialHostSpec, this.properties, this.clusterInstanceTemplate, this.refreshRateNano, this.highRefreshRateNano, - this.globalClusterInstanceTemplateByAwsRegion)); + this.instanceTemplatesByRegion)); } + @Override + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 7578ee210..4f1a82080 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -28,12 +28,9 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; -import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.Topology; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.monitoring.MonitorService; -import software.amazon.jdbc.util.storage.StorageService; public class MonitoringRdsHostListProvider extends RdsHostListProvider implements BlockingHostListProvider, CanReleaseResources { @@ -53,11 +50,11 @@ public class MonitoringRdsHostListProvider protected final long highRefreshRateNano; public MonitoringRdsHostListProvider( - final TopologyDialect dialect, + final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, final FullServicesContainer servicesContainer) { - super(dialect, properties, originalUrl, servicesContainer); + super(topologyUtils, properties, originalUrl, servicesContainer); this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index 42efb7bd4..2cdc48935 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -269,8 +269,6 @@ MonitorServiceImpl.stopAndRemoveMissingMonitorType=The monitor service received MonitorServiceImpl.stopAndRemoveMonitorsMissingType=The monitor service received a request to stop all monitors with type ''{0}'', but the monitor service does not have any monitors registered under the given type. Please ensure monitors are registered under the correct type. MonitorServiceImpl.unexpectedMonitorClass=Monitor type mismatch - the monitor ''{0}'' was unexpectedly found under the ''{1}'' monitor class category. Please verify that monitors are submitted under their concrete class. -MultiAzDialectUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} - NodeMonitoringThread.detectedWriter=Writer detected by node monitoring thread: ''{0}''. NodeMonitoringThread.invalidWriterQuery=The writer topology query is invalid: {0} NodeMonitoringThread.threadCompleted=Node monitoring thread completed in {0} ms. From 66dc4fc7612ffb1a5187b780a1335eabf1a7755f Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 11:27:08 -0800 Subject: [PATCH 38/90] Fix formatting, error messages --- .../jdbc/dialect/AuroraMysqlDialect.java | 2 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 6 +- .../amazon/jdbc/dialect/DialectManager.java | 13 ++-- .../jdbc/dialect/GlobalAuroraPgDialect.java | 3 +- .../jdbc/dialect/MultiAzClusterPgDialect.java | 1 + .../amazon/jdbc/dialect/RdsPgDialect.java | 4 +- .../jdbc/dialect/TopologyQueryHostSpec.java | 61 ------------------- .../hostlistprovider/AuroraTopologyUtils.java | 4 +- .../GlobalAuroraHostListProvider.java | 18 +++--- .../GlobalAuroraTopologyUtils.java | 11 ++-- .../MultiAzTopologyUtils.java | 5 +- .../hostlistprovider/RdsHostListProvider.java | 4 +- .../jdbc/hostlistprovider/TopologyUtils.java | 13 ++-- .../ClusterTopologyMonitorImpl.java | 26 ++++---- .../GlobalAuroraTopologyMonitor.java | 4 +- ...onitoringGlobalAuroraHostListProvider.java | 15 +++-- ..._advanced_jdbc_wrapper_messages.properties | 17 +++++- 17 files changed, 83 insertions(+), 124 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 532c58343..a24862a4a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -49,7 +49,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, protected static final String BG_TOPOLOGY_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; - protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; @Override public boolean isDialect(final Connection connection) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 6c605ce16..41ff5d028 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -23,7 +23,6 @@ import java.util.Arrays; import java.util.List; import java.util.logging.Logger; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; @@ -31,6 +30,7 @@ import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.Messages; public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { @@ -63,7 +63,7 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; protected static final String BG_STATUS_QUERY = "SELECT * FROM " - + "pg_catalog.get_blue_green_fast_switchover_metadata('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; + + "pg_catalog.get_blue_green_fast_switchover_metadata('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); @@ -78,7 +78,7 @@ public boolean isDialect(final Connection connection) { ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { if (rs.next()) { final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); + LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); if (auroraUtils) { hasExtensions = true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index 73971216d..33869b784 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -140,7 +140,7 @@ public Dialect getDialect( String host = url; final List hosts = this.connectionUrlParser.getHostsFromConnectionUrl( - url, true, pluginService::getHostSpecBuilder); + url, true, pluginService::getHostSpecBuilder); if (!Utils.isNullOrEmpty(hosts)) { host = hosts.get(0).getHost(); } @@ -270,9 +270,12 @@ public Dialect getDialect( } private void logCurrentDialect() { - LOGGER.finest(() -> String.format("Current dialect: %s, %s, canUpdate: %b", - this.dialectCode, - this.dialect == null ? "" : this.dialect, - this.canUpdate)); + LOGGER.finest(Messages.get( + "DialectManager.currentDialect", + new Object[] { + this.dialectCode, + this.dialect == null ? "" : this.dialect, + this.canUpdate + })); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 5a623e714..3384461eb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -28,6 +28,7 @@ import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; +import software.amazon.jdbc.util.Messages; public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { @@ -56,7 +57,7 @@ public boolean isDialect(final Connection connection) { } final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); + LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); if (!auroraUtils) { return false; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 6547ea339..3716cefe0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -88,6 +88,7 @@ public HostListProviderSupplier getHostListProviderSupplier() { if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index ec9edb35d..79568d78f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -24,6 +24,7 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.Messages; /** * Suitable for the following AWS PG configurations. @@ -60,7 +61,8 @@ public boolean isDialect(final Connection connection) { while (rs.next()) { final boolean rdsTools = rs.getBoolean("rds_tools"); final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("rdsTools: %b, auroraUtils: %b", rdsTools, auroraUtils)); + LOGGER.finest( + Messages.get("RdsPgDialect.rdsToolsAuroraUtils", new Object[] {rdsTools, auroraUtils})); if (rdsTools && !auroraUtils) { return true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java deleted file mode 100644 index b4cb7a2c3..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyQueryHostSpec.java +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.dialect; - -import java.sql.Timestamp; -import org.checkerframework.checker.nullness.qual.Nullable; - -public class TopologyQueryHostSpec { - private final String instanceId; - private final boolean isWriter; - private final long weight; - private final Timestamp lastUpdateTime; - private final @Nullable String region; - - public TopologyQueryHostSpec(String instanceId, boolean isWriter, long weight, Timestamp lastUpdateTime) { - this(instanceId, isWriter, weight, lastUpdateTime, null); - } - - public TopologyQueryHostSpec( - String instanceId, boolean isWriter, long weight, Timestamp lastUpdateTime, @Nullable String region) { - this.instanceId = instanceId; - this.isWriter = isWriter; - this.weight = weight; - this.lastUpdateTime = lastUpdateTime; - this.region = region; - } - - public String getInstanceId() { - return instanceId; - } - - public boolean isWriter() { - return isWriter; - } - - public long getWeight() { - return weight; - } - - public Timestamp getLastUpdateTime() { - return lastUpdateTime; - } - - public @Nullable String getRegion() { - return this.region; - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java index 79229e9cc..c8f84126b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -26,11 +26,9 @@ import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; @@ -52,7 +50,7 @@ public AuroraTopologyUtils(TopologyDialect dialect, HostSpecBuilder hostSpecBuil hosts.add(createHost(rs, initialHostSpec, hostTemplate)); } catch (Exception e) { LOGGER.finest( - Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); return null; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index d5f09dec6..594a6fd2d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -30,6 +30,7 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; @@ -58,7 +59,8 @@ public class GlobalAuroraHostListProvider extends RdsHostListProvider { } public GlobalAuroraHostListProvider( - GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, FullServicesContainer servicesContainer) { + GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, + FullServicesContainer servicesContainer) { super(topologyUtils, properties, originalUrl, servicesContainer); this.topologyUtils = topologyUtils; } @@ -69,7 +71,7 @@ protected void initSettings() throws SQLException { String templates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); + throw new SQLException(Messages.get("GlobalAuroraHostListProvider.globalClusterInstanceHostPatternsRequired")); } HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); @@ -81,11 +83,13 @@ protected void initSettings() throws SQLException { this.validateHostPatternSetting(v.getValue2().getHost()); return v.getValue2(); })); - LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.instanceTemplatesByRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) - ); + + // TODO: utility to convert Map to log string + LOGGER.finest(Messages.get("GlobalAuroraHostListProvider.detectedGdbPatterns", new Object[] { + this.instanceTemplatesByRegion.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")) + })); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index 528e8b94c..003860cce 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -32,7 +32,6 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.GlobalAuroraTopologyDialect; -import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; @@ -54,7 +53,7 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { if (resultSet.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); + LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); return null; } @@ -79,7 +78,7 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu hosts.add(createHost(rs, initialHostSpec, instanceTemplatesByRegion)); } catch (Exception e) { LOGGER.finest( - Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); return null; } } @@ -102,10 +101,12 @@ protected HostSpec createHost( final HostSpec clusterInstanceTemplateForRegion = instanceTemplatesByRegion.get(awsRegion); if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); + throw new SQLException( + Messages.get("GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); } - return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, clusterInstanceTemplateForRegion); + return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, + clusterInstanceTemplateForRegion); } public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 1f0494fa7..715ddbf40 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -23,15 +23,12 @@ import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; -import java.util.Collections; import java.util.List; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.MultiAzClusterDialect; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.dialect.TopologyQueryHostSpec; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; @@ -59,7 +56,7 @@ public MultiAzTopologyUtils(MultiAzClusterDialect dialect, HostSpecBuilder hostS hosts.add(createHost(rs, initialHostSpec, hostTemplate, writerId)); } catch (Exception e) { LOGGER.finest( - Messages.get("AuroraDialectUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); return null; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 6baf6ed01..12b2c70a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -164,9 +164,9 @@ protected void initSettings() throws SQLException { * cached copy of topology is returned if it's not yet outdated (controlled by {@link * #refreshRateNano}). * - * @param conn A connection to database to fetch the latest topology, if needed. + * @param conn A connection to database to fetch the latest topology, if needed. * @param forceUpdate If true, it forces a service to ignore cached copy of topology and to fetch - * a fresh one. + * a fresh one. * @return a list of hosts that describes cluster topology. A writer is always at position 0. * Returns an empty list if isn't available or is invalid (doesn't contain a writer). * @throws SQLException if errors occurred while retrieving the topology. diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index 8d24d3614..b926cee6a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -26,7 +26,6 @@ import java.util.ArrayList; import java.util.Comparator; import java.util.List; -import java.util.Map; import java.util.concurrent.Executor; import java.util.logging.Logger; import java.util.stream.Collectors; @@ -35,12 +34,10 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.dialect.TopologyQueryHostSpec; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.SynchronousExecutor; -import software.amazon.jdbc.util.Utils; public abstract class TopologyUtils { private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); @@ -64,7 +61,7 @@ public TopologyUtils( final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { if (resultSet.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("AuroraDialectUtils.unexpectedTopologyQueryColumnCount")); + LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); return null; } @@ -157,11 +154,11 @@ public HostSpec createHost( * *

Database types handle these identifiers differently: * - Aurora: Uses the instance name as both instanceId and instanceName - * Example: "test-instance-1" for both values + * Example: "test-instance-1" for both values * - RDS Cluster: Uses distinct values for instanceId and instanceName - * Example: - * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" - * instanceName: "test-multiaz-instance-1" + * Example: + * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" + * instanceName: "test-multiaz-instance-1" */ public @Nullable Pair getInstanceId(final Connection connection) { try { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index cea64fa52..0271b2e1e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -216,9 +216,8 @@ protected List waitTillTopologyGetsUpdated(final long timeoutMs) throw } if (System.nanoTime() >= end) { - throw new TimeoutException(Messages.get( - "ClusterTopologyMonitorImpl.topologyNotUpdated", - new Object[]{timeoutMs})); + throw new TimeoutException( + Messages.get("ClusterTopologyMonitorImpl.topologyNotUpdated", new Object[] {timeoutMs})); } return latestHosts; @@ -255,7 +254,7 @@ public void monitor() throws Exception { try { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.startMonitoringThread", - new Object[]{this.clusterId, this.initialHostSpec.getHost()})); + new Object[] {this.clusterId, this.initialHostSpec.getHost()})); while (!this.stop.get() && !Thread.currentThread().isInterrupted()) { this.lastActivityTimestampNanos.set(System.nanoTime()); @@ -318,7 +317,7 @@ public void monitor() throws Exception { LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors", - new Object[]{writerConnectionHostSpec})); + new Object[] {writerConnectionHostSpec})); this.closeConnection(this.monitoringConnection.get()); this.monitoringConnection.set(writerConnection); @@ -418,7 +417,7 @@ public void monitor() throws Exception { Level.FINEST, Messages.get( "ClusterTopologyMonitorImpl.exceptionDuringMonitoringStop", - new Object[]{this.initialHostSpec.getHost()}), + new Object[] {this.initialHostSpec.getHost()}), ex); } @@ -433,7 +432,7 @@ public void monitor() throws Exception { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.stopMonitoringThread", - new Object[]{this.initialHostSpec.getHost()})); + new Object[] {this.initialHostSpec.getHost()})); } } @@ -504,7 +503,7 @@ protected List openAnyConnectionAndUpdateTopology() { if (this.monitoringConnection.compareAndSet(null, conn)) { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.openedMonitoringConnection", - new Object[]{this.initialHostSpec.getHost()})); + new Object[] {this.initialHostSpec.getHost()})); try { if (this.topologyUtils.isWriterInstance(this.monitoringConnection.get())) { @@ -516,7 +515,7 @@ protected List openAnyConnectionAndUpdateTopology() { LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[]{this.writerHostSpec.get().getHost()})); + new Object[] {this.writerHostSpec.get().getHost()})); } else { final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); // TODO: this code isn't quite right when compared to main-3.x @@ -524,12 +523,13 @@ protected List openAnyConnectionAndUpdateTopology() { HostSpec hostTemplate = this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); HostSpec writerHost = - this.topologyUtils.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, hostTemplate); + this.topologyUtils.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, + this.initialHostSpec, hostTemplate); this.writerHostSpec.set(writerHost); LOGGER.finest( Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[]{this.writerHostSpec.get().getHost()})); + new Object[] {this.writerHostSpec.get().getHost()})); } } } @@ -615,7 +615,7 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { } return hosts; } catch (SQLException ex) { - LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[]{ex})); + LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[] {ex})); } return null; } @@ -714,7 +714,7 @@ public void run() { } else { // writer connection is successfully set to writerConnection - LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[]{hostSpec.getUrl()})); + LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[] {hostSpec.getUrl()})); // When nodeThreadsWriterConnection and nodeThreadsWriterHostSpec are both set, the topology monitor may // set ignoreNewTopologyRequestsEndTimeNano, in which case other threads will use the cached topology // for the ignore duration, so we need to update the topology before setting nodeThreadsWriterHostSpec. diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java index fa8680060..9c135312e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java @@ -25,6 +25,7 @@ import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; @@ -61,7 +62,8 @@ protected HostSpec getClusterInstanceTemplate(String instanceId, Connection conn if (!StringUtils.isNullOrEmpty(region)) { final HostSpec clusterInstanceTemplateForRegion = this.instanceTemplatesByRegion.get(region); if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + region); + throw new SQLException( + Messages.get("GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {region})); } return clusterInstanceTemplateForRegion; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java index 84395e0fc..b42cf80f0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java @@ -32,6 +32,7 @@ import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; @@ -46,7 +47,7 @@ public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostLis protected final GlobalAuroraTopologyUtils topologyUtils; static { - // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. + // Intentionally register property definition in GlobalAuroraHostListProvider class. PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); } @@ -66,7 +67,7 @@ protected void initSettings() throws SQLException { // TODO: check if we have other places that parse into string-HostSpec maps, consider refactoring String templates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); + throw new SQLException(Messages.get("MonitoringGlobalAuroraHostListProvider.globalHostPatternsRequired")); } HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); @@ -78,10 +79,12 @@ protected void initSettings() throws SQLException { this.validateHostPatternSetting(v.getValue2().getHost()); return v.getValue2(); })); - LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.instanceTemplatesByRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) + LOGGER.finest(Messages.get( + "GlobalAuroraHostListProvider.detectedGdbPatterns", new Object[] { + this.instanceTemplatesByRegion.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")) + }) ); } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index 2cdc48935..5a0e509fe 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -27,8 +27,7 @@ AdfsCredentialsProviderFactory.signOnPagePostActionRequestFailed=ADFS SignOn Pag AdfsCredentialsProviderFactory.signOnPageRequestFailed=ADFS SignOn Page Request Failed with HTTP status ''{0}'', reason phrase ''{1}'', and response ''{2}'' AdfsCredentialsProviderFactory.signOnPageUrl=ADFS SignOn URL: ''{0}'' -AuroraDialectUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} -AuroraDialectUtils.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. +AuroraPgDialect.auroraUtils=auroraUtils: {0} AuthenticationToken.useCachedToken=Use cached authentication token = ''{0}'' AuthenticationToken.generatedNewToken=Generated new authentication token = ''{0}'' @@ -37,10 +36,11 @@ AuthenticationToken.javaSdkNotInClasspath=Required dependency 'AWS Java SDK RDS RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy=An RDS Proxy url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom=A custom RDS url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.invalidPattern=Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host pattern must contain a '?' character as a placeholder for the DB instance identifiers of the instances in the cluster. -RdsHostListProvider.suggestedClusterId=ClusterId ''{0}'' is suggested for url ''{1}''. RdsHostListProvider.parsedListEmpty=Can''t parse connection string: ''{0}'' RdsHostListProvider.errorIdentifyConnection=An error occurred while obtaining the connection's host ID. +RdsPgDialect.rdsToolsAuroraUtils=rdsTools: {0}, auroraUtils: {1} + AwsSdk.unsupportedRegion=Unsupported AWS region ''{0}''. For supported regions please read https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AwsSecretsManagerConnectionPlugin.endpointOverrideMisconfigured=The provided endpoint is invalid and could not be used to create a URI: `{0}`. @@ -134,6 +134,8 @@ DefaultConnectionPlugin.executingMethod=Executing method: ''{0}'' DefaultConnectionPlugin.noHostsAvailable=The default connection plugin received an empty host list from the plugin service. DefaultConnectionPlugin.unknownRoleRequested=A HostSpec with a role of HostRole.UNKNOWN was requested via getHostSpecByStrategy. The requested role must be either HostRole.WRITER or HostRole.READER +DialectManager.currentDialect=Current dialect: {0}, {1}, canUpdate: {2} + Driver.nullUrl=Url is null. Driver.alreadyRegistered=Driver is already registered. It can only be registered once. Driver.missingDriver=Can''t find the target driver for ''{0}''. Please ensure the target driver is in the classpath and is registered. Here is the list of registered drivers in the classpath: {1} @@ -183,6 +185,11 @@ Failover.skipFailoverOnInterruptedThread=Do not start failover since the current FederatedAuthPlugin.unableToDetermineRegion=Unable to determine connection region. If you are using a non-standard RDS URL, please set the ''{0}'' property. +GlobalAuroraHostListProvider.globalClusterInstanceHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. +GlobalAuroraHostListProvider.detectedGdbPatterns=Detected GDB instance template patterns:\n{0} + +GlobalAuroraTopologyMonitor.cannotFindRegionTemplate=Cannot find cluster template for region {0}. + HostAvailabilityStrategy.invalidMaxRetries=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyMaxRetries`. It must be an integer greater than 1. HostAvailabilityStrategy.invalidInitialBackoffTime=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyInitialBackoffTime`. It must be an integer greater than 1. @@ -258,6 +265,8 @@ HostMonitorServiceImpl.emptyAliasSet=Empty alias set passed for ''{0}''. Set sho HostResponseTimeServiceImpl.errorStartingMonitor=An error occurred while starting a response time monitor for ''{0}'': {1} +MonitoringGlobalAuroraHostListProvider.globalHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. + MonitorServiceImpl.checkingMonitors=Checking monitors for errors... MonitorServiceImpl.monitorClassMismatch=The monitor stored at ''{0}'' did not have the expected type. The expected type was ''{1}'', but the monitor ''{2}'' had a type of ''{3}''. MonitorServiceImpl.monitorStuck=Monitor ''{0}'' has not been updated within the inactive timeout of {1} milliseconds. The monitor will be stopped. @@ -359,8 +368,10 @@ MysqlConnectorJDriverHelper.canNotRegister=Can''t register driver com.mysql.cj. TopologyUtils.errorGettingHostRole=An error occurred while obtaining the connected host's role. This could occur if the connection is broken or if you are not connected to an Aurora database. TopologyUtils.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} +TopologyUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} TopologyUtils.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS cluster. TopologyUtils.invalidTopology=The topology query returned an invalid topology - no writer instance detected. +TopologyUtils.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. MariadbDriverHelper.canNotRegister=Can''t register driver org.mariadb.jdbc.Driver. From f283575c28bafdab4b71db1b4e3b4783a571002f Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:30:03 -0800 Subject: [PATCH 39/90] docs: deprecate auroraStaleDns plugin (#1590) --- .../CompatibilityCrossPlugins.md | 8 ++-- .../CompatibilityDatabaseTypes.md | 14 +++--- .../CompatibilityEndpoints.md | 24 +++++----- .../UsingTheJdbcDriver.md | 46 +++++++++---------- .../plugin/staledns/AuroraStaleDnsPlugin.java | 4 +- 5 files changed, 49 insertions(+), 47 deletions(-) diff --git a/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md b/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md index 0f20293f0..d40aee79d 100644 --- a/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md +++ b/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md @@ -14,7 +14,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -36,7 +36,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -54,7 +54,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✗ | | | | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✗ | ✗ | | | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✗ | ✗ | ✗ | | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -67,7 +67,7 @@
-| Plugin codes / Plugin codes | auroraStaleDns | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | +| Plugin codes / Plugin codes | ~~auroraStaleDns~~ | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | |---------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | | | | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | | | diff --git a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md index 733af5f34..0aeb66b9d 100644 --- a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md +++ b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md @@ -8,20 +8,20 @@ | customEndpoint | ✓ | ✓ | ✓ | | [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ | ✓ | ✓ | | [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ | ✓ | ✓ | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | ✓ | ✓ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | ✓ | ✓ | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | ✓ | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | ✓ | ✓ | | [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ | ✓ | ✓ | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | | connectTime | ✓ | ✓ | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | ✓ | ✓ | -| fastestResponseStrategy | ✓ | ✓ | ✓ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | ✓ | ✓ | +| fastestResponseStrategy | ✓ | ✓ | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | ✓ | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | ✓ (PostgreSQL only) | ✓ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | ✓ | ✓ |
@@ -41,7 +41,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✗ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✗ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✗ | -| auroraStaleDns | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✗ | ✗ | ✗ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✗ | ✗ | ✗ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | diff --git a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md index 81a17ce70..10c76cdce 100644 --- a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md +++ b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md @@ -23,22 +23,22 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | logQuery | ✓ | | dataCache | ✓ | | customEndpoint | ✗ | -| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ (requires `initialConnection` plugin) | -| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ (requires `initialConnection` plugin) | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | -| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires `initialConnection` plugin) | +| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ (requires `initialConnection` plugin) | +| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ (requires `initialConnection` plugin) | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | +| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires `initialConnection` plugin) | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | -| auroraStaleDns | ✓ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | +| ~~auroraStaleDns~~ | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | | connectTime | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | -| fastestResponseStrategy | ✓ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | +| fastestResponseStrategy | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | @@ -58,7 +58,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✓ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -85,7 +85,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✓ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✗ | ✗ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✗ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -113,7 +113,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | -| auroraStaleDns | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md index 67bc00ac9..ef1caf194 100644 --- a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md +++ b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md @@ -94,7 +94,7 @@ These parameters are applicable to any instance of the AWS JDBC Driver. | `resetSessionStateOnClose` | `Boolean` | No | Enables resetting the session state before closing connection. | `true` | | `rollbackOnSwitch` | `Boolean` | No | Enables rolling back a current transaction, if any in effect, before switching to a new connection. | `true` | | `awsProfile` | `String` | No | Allows users to specify a profile name for AWS credentials. This parameter is used by plugins that require AWS credentials, like the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md). | `null` | -| ~~`enableGreenNodeReplacement`~~ | `Boolean` | No | **Deprecated. Use `bg` plugin instead.** Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | +| ~~`enableGreenNodeReplacement`~~ | `Boolean` | No | **Deprecated. Use `bg` plugin instead.** Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | | `wrapperCaseSensitive`,
`wrappercasesensitive` | `Boolean` | No | Allows the driver to change case sensitivity for parameter names in the connection string and in connection properties. Set parameter to `false` to allow case-insensitive parameter names. | `true` | | `skipWrappingForPackages` | `String` | No | Register Java package names (separated by comma) which will be left unwrapped. This setting modifies all future connections established by the driver, not just a particular connection. | `com.pgvector` | @@ -194,28 +194,28 @@ Driver.setConnectionInitFunc((connection, protocol, hostSpec, props) -> { ### List of Available Plugins The AWS JDBC Driver has several built-in plugins that are available to use. Please visit the individual plugin page for more details. -| Plugin name | Plugin Code | Database Compatibility | Description | Additional Required Dependencies | -|-------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. | None | -| [Failover Connection Plugin v2](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. This plugin is enabled by default. It is functionally the same as the first version of the Failover Connection Plugin (`failover`) and uses similar configuration parameters. | None | -| [Host Monitoring Connection Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. | None | -| [Host Monitoring Connection Plugin v2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | `efm2` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. This plugin is an alternative implementation for host health status monitoring. It is functionally the same as the `efm` plugin and uses the same configuration parameters. | None | -| Data Cache Connection Plugin | `dataCache` | Any database | Caches results from SQL queries matching the regular expression specified in the `dataCacheTriggerCondition` configuration parameter. | None | -| Execution Time Connection Plugin | `executionTime` | Any database | Logs the time taken to execute any JDBC method. | None | -| Log Query Connection Plugin | `logQuery` | Any database | Tracks and logs the SQL statements to be executed. Sometimes SQL statements are not passed directly to the JDBC method as a parameter, such as [executeBatch()](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html#executeBatch--). Users can set `enhancedLogQueryEnabled` to `true`, allowing the JDBC Wrapper to obtain SQL statements via Java Reflection.

:warning:**Note:** Enabling Java Reflection may cause a performance degradation. | None | -| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora, RDS Multi-AZ DB Cluster | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | [AWS Java SDK RDS v2.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds) | -| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `awsSecretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Secrets Manager](https://central.sonatype.com/artifact/software.amazon.awssdk/secretsmanager) | -| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | -| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | -| Aurora Stale DNS Plugin | `auroraStaleDns` | Aurora | Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

:warning:**Note:** Contrary to `failover` plugin, `auroraStaleDns` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed.

:warning:**Note:** This logic is already included in `failover` plugin so you can omit using both plugins at the same time. | None | -| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `auroraConnectionTracker` | Aurora, RDS Multi-AZ DB Cluster | Tracks all the opened connections. In the event of a cluster failover, the plugin will close all the impacted connections to the node. This plugin is enabled by default. | None | -| [Driver Metadata Connection Plugin](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | `driverMetaData` | Any database | Allows user application to override the return value of `DatabaseMetaData#getDriverName` | None | -| [Read Write Splitting Plugin](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | `readWriteSplitting` | Aurora | Enables read write splitting functionality where users can switch between database reader and writer instances. | None | -| [Developer Plugin](./using-plugins/UsingTheDeveloperPlugin.md) | `dev` | Any database | Helps developers test various everyday scenarios including rare events like network outages and database cluster failover. The plugin allows injecting and raising an expected exception, then verifying how applications handle it. | None | -| [Aurora Initial Connection Strategy](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. | None | -| [Limitless Connection Plugin](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | `limitless` | Aurora | Enables client-side load-balancing of Transaction Routers on Amazon Aurora Limitless Databases . | None | -| Fastest Response Strategy Plugin | `fastestResponseStrategy` | Aurora | When read-write splitting is enabled, this plugin selects the reader to switch to based on the host with the fastest response time. The plugin achieves this by periodically monitoring the hosts' response times and storing the fastest host in a cache. **Note:** the `readerHostSelectorStrategy` parameter must be set to `fastestResponse` in the user-defined connection properties in order to enable this plugin. See [reader selection strategies](./ReaderSelectionStrategies.md). | None | -| [Blue/Green Deployment Plugin](./using-plugins/UsingTheBlueGreenPlugin.md) | `bg` | Aurora,
RDS Instance | Enables client-side Blue/Green Deployment support. | None | +| Plugin name | Plugin Code | Database Compatibility | Description | Additional Required Dependencies | +|-------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. | None | +| [Failover Connection Plugin v2](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. This plugin is enabled by default. It is functionally the same as the first version of the Failover Connection Plugin (`failover`) and uses similar configuration parameters. | None | +| [Host Monitoring Connection Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. | None | +| [Host Monitoring Connection Plugin v2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | `efm2` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. This plugin is an alternative implementation for host health status monitoring. It is functionally the same as the `efm` plugin and uses the same configuration parameters. | None | +| Data Cache Connection Plugin | `dataCache` | Any database | Caches results from SQL queries matching the regular expression specified in the `dataCacheTriggerCondition` configuration parameter. | None | +| Execution Time Connection Plugin | `executionTime` | Any database | Logs the time taken to execute any JDBC method. | None | +| Log Query Connection Plugin | `logQuery` | Any database | Tracks and logs the SQL statements to be executed. Sometimes SQL statements are not passed directly to the JDBC method as a parameter, such as [executeBatch()](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html#executeBatch--). Users can set `enhancedLogQueryEnabled` to `true`, allowing the JDBC Wrapper to obtain SQL statements via Java Reflection.

:warning:**Note:** Enabling Java Reflection may cause a performance degradation. | None | +| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora, RDS Multi-AZ DB Cluster | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | [AWS Java SDK RDS v2.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds) | +| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `awsSecretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Secrets Manager](https://central.sonatype.com/artifact/software.amazon.awssdk/secretsmanager) | +| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | +| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | +| ~~Aurora Stale DNS Plugin~~ | `auroraStaleDns` | Aurora | **Deprecated**. Use `initialConnection` plugin instead.

Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

:warning:**Note:** Contrary to `failover` plugin, `auroraStaleDns` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed.

:warning:**Note:** This logic is already included in `failover` plugin so you can omit using both plugins at the same time. | None | +| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `auroraConnectionTracker` | Aurora, RDS Multi-AZ DB Cluster | Tracks all the opened connections. In the event of a cluster failover, the plugin will close all the impacted connections to the node. This plugin is enabled by default. | None | +| [Driver Metadata Connection Plugin](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | `driverMetaData` | Any database | Allows user application to override the return value of `DatabaseMetaData#getDriverName` | None | +| [Read Write Splitting Plugin](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | `readWriteSplitting` | Aurora | Enables read write splitting functionality where users can switch between database reader and writer instances. | None | +| [Developer Plugin](./using-plugins/UsingTheDeveloperPlugin.md) | `dev` | Any database | Helps developers test various everyday scenarios including rare events like network outages and database cluster failover. The plugin allows injecting and raising an expected exception, then verifying how applications handle it. | None | +| [Aurora Initial Connection Strategy](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

This plugin is **strongly** suggested when using cluster writer endpoint, cluster reader endpoint or global database endpoint in the connection string.

:warning:**Note:** Contrary to `failover` and `failover2` plugins, `initialConnection` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed. | None | +| [Limitless Connection Plugin](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | `limitless` | Aurora | Enables client-side load-balancing of Transaction Routers on Amazon Aurora Limitless Databases . | None | +| Fastest Response Strategy Plugin | `fastestResponseStrategy` | Aurora | When read-write splitting is enabled, this plugin selects the reader to switch to based on the host with the fastest response time. The plugin achieves this by periodically monitoring the hosts' response times and storing the fastest host in a cache. **Note:** the `readerHostSelectorStrategy` parameter must be set to `fastestResponse` in the user-defined connection properties in order to enable this plugin. See [reader selection strategies](./ReaderSelectionStrategies.md). | None | +| [Blue/Green Deployment Plugin](./using-plugins/UsingTheBlueGreenPlugin.md) | `bg` | Aurora,
RDS Instance | Enables client-side Blue/Green Deployment support. | None | > [!NOTE]\ diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index a5babfc3c..6345c27fa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -34,7 +34,9 @@ import software.amazon.jdbc.plugin.AbstractConnectionPlugin; /** - * After Aurora DB cluster fail over is completed and a cluster has elected a new writer node, the corresponding + * Deprecated. Use 'initialConnection' plugin instead. + * + *

After Aurora DB cluster fail over is completed and a cluster has elected a new writer node, the corresponding * cluster (writer) endpoint contains stale data and points to an old writer node. That old writer node plays * a reader role after fail over and connecting with the cluster endpoint connects to it. In such case a user * application expects a writer connection but practically gets connected to a reader. Any DML statements fail From 820f155504080c5159dbb8059102039bcacca4a0 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:30:47 -0800 Subject: [PATCH 40/90] feat: add initialConnection plugin to default plugin list (#1592) --- docs/using-the-jdbc-driver/UsingTheJdbcDriver.md | 10 +++++----- .../amazon/jdbc/ConnectionPluginChainBuilder.java | 2 +- .../AuroraInitialConnectionStrategyPlugin.java | 3 --- .../aws_advanced_jdbc_wrapper_messages.properties | 1 - .../test/java/integration/host/TestEnvironment.java | 2 +- .../amazon/jdbc/ConnectionPluginManagerTests.java | 12 +++++++----- 6 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md index ef1caf194..b3ec4cc89 100644 --- a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md +++ b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md @@ -105,11 +105,11 @@ Plugins are loaded and managed through the Connection Plugin Manager and may be ### Connection Plugin Manager Parameters -| Parameter | Value | Required | Description | Default Value | -|-----------------------------------|-----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| -| `wrapperPlugins` | `String` | No | Comma separated list of connection plugin codes.

Example: `failover,efm2` | `auroraConnectionTracker,failover2,efm2` | -| `autoSortWrapperPluginOrder` | `Boolean` | No | Allows the AWS JDBC Driver to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` | -| `wrapperProfileName` | `String` | No | Driver configuration profile name. Instead of listing plugin codes with `wrapperPlugins`, the driver profile can be set with this parameter.

Example: See [below](#configuration-profiles). | `null` | +| Parameter | Value | Required | Description | Default Value | +|-----------------------------------|-----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| +| `wrapperPlugins` | `String` | No | Comma separated list of connection plugin codes.

Example: `failover,efm2` | `initialConnection,auroraConnectionTracker,failover2,efm2` | +| `autoSortWrapperPluginOrder` | `Boolean` | No | Allows the AWS JDBC Driver to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` | +| `wrapperProfileName` | `String` | No | Driver configuration profile name. Instead of listing plugin codes with `wrapperPlugins`, the driver profile can be set with this parameter.

Example: See [below](#configuration-profiles). | `null` | To use a built-in plugin, specify its relevant plugin code for the `wrapperPlugins`. The default value for `wrapperPlugins` is `auroraConnectionTracker,failover2,efm2`. These 3 plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section. diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java index 952b00936..3f1d89eac 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java @@ -126,7 +126,7 @@ public class ConnectionPluginChainBuilder { protected static final ConcurrentMap, ConnectionPluginFactory> pluginFactoriesByClass = new ConcurrentHashMap<>(); - protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover2,efm2"; + protected static final String DEFAULT_PLUGINS = "initialConnection,auroraConnectionTracker,failover2,efm2"; /* Internal class used for plugin factory sorting. It holds a reference to a plugin diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 361e9da77..1dbee4029 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -130,9 +130,6 @@ public void initHostProvider( final JdbcCallable initHostProviderFunc) throws SQLException { this.hostListProviderService = hostListProviderService; - if (hostListProviderService.isStaticHostListProvider()) { - throw new SQLException(Messages.get("AuroraInitialConnectionStrategyPlugin.requireDynamicProvider")); - } initHostProviderFunc.call(); } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index 2a53c0832..dbfc72a4b 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -361,7 +361,6 @@ MysqlConnectorJDriverHelper.canNotRegister=Can''t register driver com.mysql.cj. MariadbDriverHelper.canNotRegister=Can''t register driver org.mariadb.jdbc.Driver. AuroraInitialConnectionStrategyPlugin.unsupportedStrategy=Unsupported host selection strategy ''{0}''. -AuroraInitialConnectionStrategyPlugin.requireDynamicProvider=Dynamic host list provider is required. NodeResponseTimeMonitor.stopped=Stopped Response time thread for node ''{0}''. NodeResponseTimeMonitor.responseTime=Response time for ''{0}'': {1} ms diff --git a/wrapper/src/test/java/integration/host/TestEnvironment.java b/wrapper/src/test/java/integration/host/TestEnvironment.java index 99fcd2985..9fb6cac14 100644 --- a/wrapper/src/test/java/integration/host/TestEnvironment.java +++ b/wrapper/src/test/java/integration/host/TestEnvironment.java @@ -1251,7 +1251,7 @@ private static void createTelemetryOtlpContainer(TestEnvironment env) { private static String getContainerBaseImageName(TestEnvironmentRequest request) { switch (request.getTargetJvm()) { case OPENJDK8: - return "openjdk:8-jdk-alpine"; + return "amazoncorretto:8-alpine"; case OPENJDK11: return "amazoncorretto:11.0.19-alpine3.17"; case OPENJDK17: diff --git a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java index 080fea20e..735e83eac 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/ConnectionPluginManagerTests.java @@ -53,6 +53,7 @@ import software.amazon.jdbc.mock.TestPluginThrowException; import software.amazon.jdbc.mock.TestPluginTwo; import software.amazon.jdbc.plugin.AuroraConnectionTrackerPlugin; +import software.amazon.jdbc.plugin.AuroraInitialConnectionStrategyPlugin; import software.amazon.jdbc.plugin.DefaultConnectionPlugin; import software.amazon.jdbc.plugin.LogQueryConnectionPlugin; import software.amazon.jdbc.plugin.efm2.HostMonitoringConnectionPlugin; @@ -565,12 +566,13 @@ public void testDefaultPlugins() throws SQLException { testProperties, mockTelemetryFactory, mockConnectionProvider, null)); target.initPlugins(mockServicesContainer, configurationProfile); - assertEquals(4, target.plugins.size()); - assertEquals(AuroraConnectionTrackerPlugin.class, target.plugins.get(0).getClass()); + assertEquals(5, target.plugins.size()); + assertEquals(AuroraInitialConnectionStrategyPlugin.class, target.plugins.get(0).getClass()); + assertEquals(AuroraConnectionTrackerPlugin.class, target.plugins.get(1).getClass()); assertEquals(software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin.class, - target.plugins.get(1).getClass()); - assertEquals(HostMonitoringConnectionPlugin.class, target.plugins.get(2).getClass()); - assertEquals(DefaultConnectionPlugin.class, target.plugins.get(3).getClass()); + target.plugins.get(2).getClass()); + assertEquals(HostMonitoringConnectionPlugin.class, target.plugins.get(3).getClass()); + assertEquals(DefaultConnectionPlugin.class, target.plugins.get(4).getClass()); } @Test From 0a537b30e6101f5f960cf0e5ce00527fb3c05ed1 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 15:19:00 -0800 Subject: [PATCH 41/90] Cleanup comments --- .../amazon/jdbc/PartialPluginService.java | 2 +- .../amazon/jdbc/PluginServiceImpl.java | 2 +- .../jdbc/dialect/AuroraMysqlDialect.java | 4 +- .../amazon/jdbc/dialect/DialectManager.java | 16 +- .../dialect/GlobalAuroraTopologyDialect.java | 3 - .../dialect/MultiAzClusterMysqlDialect.java | 11 +- .../jdbc/dialect/MultiAzClusterPgDialect.java | 10 +- .../amazon/jdbc/dialect/RdsMysqlDialect.java | 2 +- .../amazon/jdbc/dialect/RdsPgDialect.java | 3 +- .../amazon/jdbc/dialect/TopologyDialect.java | 6 - .../hostlistprovider/AuroraTopologyUtils.java | 39 ++--- .../ConnectionStringHostListProvider.java | 4 +- .../DynamicHostListProvider.java | 6 +- .../GlobalAuroraHostListProvider.java | 33 +--- .../GlobalAuroraTopologyUtils.java | 71 +++++--- .../MultiAzTopologyUtils.java | 53 +++--- .../hostlistprovider/RdsHostListProvider.java | 48 ++---- .../StaticHostListProvider.java | 4 +- .../jdbc/hostlistprovider/TopologyUtils.java | 35 ++-- .../ClusterTopologyMonitorImpl.java | 153 ++++++++---------- .../GlobalAuroraTopologyMonitor.java | 15 +- ...onitoringGlobalAuroraHostListProvider.java | 35 +--- .../MonitoringRdsHostListProvider.java | 4 +- .../bluegreen/BlueGreenInterimStatus.java | 4 +- .../ClusterAwareWriterFailoverHandler.java | 2 +- .../failover/FailoverConnectionPlugin.java | 4 +- .../failover2/FailoverConnectionPlugin.java | 8 +- .../limitless/LimitlessRouterMonitor.java | 2 +- .../ReadWriteSplittingPlugin.java | 2 +- .../plugin/staledns/AuroraStaleDnsHelper.java | 4 +- .../software/amazon/jdbc/util/LogUtils.java | 55 +++++++ .../java/software/amazon/jdbc/util/Utils.java | 24 --- ..._advanced_jdbc_wrapper_messages.properties | 6 +- 33 files changed, 320 insertions(+), 350 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 56ff38406..9828a2d25 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -159,7 +159,7 @@ public HostSpec getCurrentHostSpec() { Messages.get("PluginServiceImpl.currentHostNotAllowed", new Object[] { currentHostSpec == null ? "" : currentHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 0428e1b12..cd6738b1a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -193,7 +193,7 @@ public HostSpec getCurrentHostSpec() { Messages.get("PluginServiceImpl.currentHostNotAllowed", new Object[] { currentHostSpec == null ? "" : currentHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index a24862a4a..deb6c7af8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -22,7 +22,6 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; @@ -37,7 +36,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, REPLICA_LAG_IN_MILLISECONDS, LAST_UPDATE_TIMESTAMP " + "FROM information_schema.replica_host_status " - // filter out instances that haven't been updated in the last 5 minutes + // filter out instances that have not been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; @@ -56,7 +55,6 @@ public boolean isDialect(final Connection connection) { try (Statement stmt = connection.createStatement(); ResultSet rs = stmt.executeQuery(AURORA_VERSION_EXISTS_QUERY)) { if (rs.next()) { - // If variable with such name is presented then it means it's an Aurora cluster return true; } } catch (final SQLException ex) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index 33869b784..ed7f4e71e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -75,7 +75,7 @@ public class DialectManager implements DialectProvider { */ protected static final long ENDPOINT_CACHE_EXPIRATION = TimeUnit.HOURS.toNanos(24); - // Map of host name, or url, by dialect code. + // Keys are host names or URLs, values are dialect codes. protected static final CacheMap knownEndpointDialects = new CacheMap<>(); private final RdsUtils rdsHelper = new RdsUtils(); @@ -129,8 +129,7 @@ public Dialect getDialect( this.logCurrentDialect(); return userDialect; } else { - throw new SQLException( - Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCode})); + throw new SQLException(Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCode})); } } @@ -238,9 +237,10 @@ public Dialect getDialect( for (String dialectCandidateCode : dialectCandidates) { Dialect dialectCandidate = knownDialectsByCode.get(dialectCandidateCode); if (dialectCandidate == null) { - throw new SQLException( - Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCandidateCode})); + throw new SQLException(Messages.get( + "DialectManager.unknownDialectCode", new Object[] {dialectCandidateCode})); } + boolean isDialect = dialectCandidate.isDialect(connection); if (isDialect) { this.canUpdate = false; @@ -272,10 +272,6 @@ public Dialect getDialect( private void logCurrentDialect() { LOGGER.finest(Messages.get( "DialectManager.currentDialect", - new Object[] { - this.dialectCode, - this.dialect == null ? "" : this.dialect, - this.canUpdate - })); + new Object[] {this.dialectCode, this.dialect == null ? "" : this.dialect, this.canUpdate})); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java index 1febb80a7..11db48dff 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java @@ -16,9 +16,6 @@ package software.amazon.jdbc.dialect; -import java.sql.Connection; -import java.sql.SQLException; - public interface GlobalAuroraTopologyDialect extends TopologyDialect { String getRegionByInstanceIdQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 2da87edba..6087a6ec7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -26,7 +26,6 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; @@ -45,12 +44,12 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzC + " table_schema = 'mysql' AND table_name = 'rds_topology'"; protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - // The query return nodeId and nodeName. + // This query returns both instanceId and instanceName. // For example: "1845128080", "test-multiaz-instance-1" private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + " FROM mysql.rds_topology" + " WHERE id = @@server_id"; - // For reader instances, the query returns a writer instance ID. For a writer instance, the query returns no data. + // For reader instances, this query returns a writer instance ID. For a writer instance, this query returns no data. protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; protected static final String WRITER_ID_QUERY_COLUMN_NAME = "Source_Server_Id"; protected static final String IS_READER_QUERY = "SELECT @@read_only"; @@ -82,14 +81,14 @@ public boolean isDialect(final Connection connection) { if (!rs.next()) { return false; } - final String reportHost = rs.getString(2); // get variable value; expected value is IP address + + final String reportHost = rs.getString(2); // Expected value is an IP address return !StringUtils.isNullOrEmpty(reportHost); } } catch (final SQLException ex) { - // ignore + return false; } - return false; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 3716cefe0..6750a3efd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -21,7 +21,6 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.List; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; @@ -39,14 +38,14 @@ public class MultiAzClusterPgDialect extends PgDialect implements MultiAzCluster protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - // The query return nodeId and nodeName. + // This query returns both instanceId and instanceName. // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; - // For reader instances, the query should return a writer instance ID. - // For a writer instance, the query should return no data. + // For reader instances, this query should return a writer instance ID. + // For a writer instance, this query should return no data. protected static final String WRITER_ID_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" @@ -62,9 +61,8 @@ public boolean isDialect(final Connection connection) { ResultSet rs = stmt.executeQuery(IS_RDS_CLUSTER_QUERY)) { return rs.next() && rs.getString(1) != null; } catch (final SQLException ex) { - // ignore + return false; } - return false; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java index 6b6e800b5..2a0b1ed29 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java @@ -76,7 +76,7 @@ public boolean isDialect(final Connection connection) { return false; } - final String reportHost = rs.getString(2); // get variable value; expected empty value + final String reportHost = rs.getString(2); // An empty value is expected return StringUtils.isNullOrEmpty(reportHost); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index 79568d78f..3ccad1a0f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -61,8 +61,7 @@ public boolean isDialect(final Connection connection) { while (rs.next()) { final boolean rdsTools = rs.getBoolean("rds_tools"); final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest( - Messages.get("RdsPgDialect.rdsToolsAuroraUtils", new Object[] {rdsTools, auroraUtils})); + LOGGER.finest(Messages.get("RdsPgDialect.rdsToolsAuroraUtils", new Object[] {rdsTools, auroraUtils})); if (rdsTools && !auroraUtils) { return true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java index 84ac7ae3a..e7aa0f4d2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -16,12 +16,6 @@ package software.amazon.jdbc.dialect; -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.util.List; -import org.checkerframework.checker.nullness.qual.Nullable; - public interface TopologyDialect extends Dialect { String getTopologyQuery(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java index c8f84126b..f62415ff9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -23,7 +23,9 @@ import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; @@ -41,29 +43,29 @@ public AuroraTopologyUtils(TopologyDialect dialect, HostSpecBuilder hostSpecBuil @Override protected @Nullable List getHosts( - Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException { - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - List hosts = new ArrayList<>(); + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); while (rs.next()) { try { - hosts.add(createHost(rs, initialHostSpec, hostTemplate)); + HostSpec host = createHost(rs, initialHostSpec, instanceTemplate); + hostsMap.put(host.getHost(), host); } catch (Exception e) { - LOGGER.finest( - Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); return null; } } - return hosts; + return new ArrayList<>(hostsMap.values()); } @Override public boolean isWriterInstance(final Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { - if (resultSet.next()) { - return !StringUtils.isNullOrEmpty(resultSet.getString(1)); + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (rs.next()) { + return !StringUtils.isNullOrEmpty(rs.getString(1)); } } } @@ -71,14 +73,13 @@ public boolean isWriterInstance(final Connection connection) throws SQLException return false; } - protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException { - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. + protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { + // According to the topology query the result set should contain 4 columns: + // instance ID, 1/0 (writer/reader), CPU utilization, instance lag in time. String hostName = rs.getString(1); final boolean isWriter = rs.getBoolean(2); final double cpuUtilization = rs.getDouble(3); - final double nodeLag = rs.getDouble(4); + final double instanceLag = rs.getDouble(4); Timestamp lastUpdateTime; try { lastUpdateTime = rs.getTimestamp(5); @@ -86,9 +87,9 @@ protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec h lastUpdateTime = Timestamp.from(Instant.now()); } - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); + // Calculate weight based on instance lag in time and CPU utilization. + final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, hostTemplate); + return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index bbf3209ed..426ea3963 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -35,7 +35,6 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider private static final Logger LOGGER = Logger.getLogger(ConnectionStringHostListProvider.class.getName()); final List hostList = new ArrayList<>(); - Properties properties; private boolean isInitialized = false; private final boolean isSingleWriterConnectionString; private final ConnectionUrlParser connectionUrlParser; @@ -74,11 +73,12 @@ private void init() throws SQLException { } this.hostList.addAll( this.connectionUrlParser.getHostsFromConnectionUrl(this.initialUrl, this.isSingleWriterConnectionString, - () -> this.hostListProviderService.getHostSpecBuilder())); + this.hostListProviderService::getHostSpecBuilder)); if (this.hostList.isEmpty()) { throw new SQLException(Messages.get("ConnectionStringHostListProvider.parsedListEmpty", new Object[] {this.initialUrl})); } + this.hostListProviderService.setInitialConnectionHostSpec(this.hostList.get(0)); this.isInitialized = true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index c4ef01aae..09d321c41 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,7 +16,7 @@ package software.amazon.jdbc.hostlistprovider; -// A marker interface for providers that can fetch a host list, and it changes depending on database status -// A good example of such provider would be DB cluster provider (Aurora DB clusters, patroni DB clusters, etc.) -// where cluster topology (nodes, their roles, their statuses) changes over time. +// A marker interface for providers that can fetch a host list reflecting the current database topology. +// Examples include providers for Aurora or Multi-AZ clusters, where the cluster topology, status, and instance roles +// change over time. public interface DynamicHostListProvider extends HostListProvider { } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index 594a6fd2d..682ebb31f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -18,27 +18,18 @@ import java.sql.Connection; import java.sql.SQLException; -import java.util.Arrays; import java.util.List; import java.util.Map; import java.util.Properties; import java.util.logging.Logger; -import java.util.stream.Collectors; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; public class GlobalAuroraHostListProvider extends RdsHostListProvider { - static final Logger LOGGER = Logger.getLogger(GlobalAuroraHostListProvider.class.getName()); - public static final AwsWrapperProperty GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS = new AwsWrapperProperty( "globalClusterInstanceHostPatterns", @@ -69,27 +60,9 @@ public GlobalAuroraHostListProvider( protected void initSettings() throws SQLException { super.initSettings(); - String templates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException(Messages.get("GlobalAuroraHostListProvider.globalClusterInstanceHostPatternsRequired")); - } - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.instanceTemplatesByRegion = Arrays.stream(templates.split(",")) - .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) - .collect(Collectors.toMap( - Pair::getValue1, - v -> { - this.validateHostPatternSetting(v.getValue2().getHost()); - return v.getValue2(); - })); - - // TODO: utility to convert Map to log string - LOGGER.finest(Messages.get("GlobalAuroraHostListProvider.detectedGdbPatterns", new Object[] { - this.instanceTemplatesByRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) - })); + String instanceTemplates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + this.instanceTemplatesByRegion = + this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index 003860cce..e08d5877a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -25,14 +25,21 @@ import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.function.Consumer; import java.util.logging.Logger; +import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.GlobalAuroraTopologyDialect; +import software.amazon.jdbc.util.ConnectionUrlParser; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.StringUtils; public class GlobalAuroraTopologyUtils extends AuroraTopologyUtils { @@ -50,14 +57,14 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu throws SQLException { int networkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - if (resultSet.getMetaData().getColumnCount() == 0) { + final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { + if (rs.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); return null; } - return this.verifyWriter(this.getHosts(conn, resultSet, initialHostSpec, instanceTemplatesByRegion)); + return this.verifyWriter(this.getHosts(rs, initialHostSpec, instanceTemplatesByRegion)); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -68,29 +75,28 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu } protected @Nullable List getHosts( - Connection conn, ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) - throws SQLException { - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - List hosts = new ArrayList<>(); + ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) throws SQLException { + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); while (rs.next()) { try { - hosts.add(createHost(rs, initialHostSpec, instanceTemplatesByRegion)); + HostSpec host = createHost(rs, initialHostSpec, instanceTemplatesByRegion); + hostsMap.put(host.getHost(), host); } catch (Exception e) { - LOGGER.finest( - Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); return null; } } - return hosts; + return new ArrayList<>(hostsMap.values()); } protected HostSpec createHost( ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) throws SQLException { - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. + // According to the topology query the result set should contain 4 columns: + // instance ID, 1/0 (writer/reader), node lag in time (msec), AWS region. String hostName = rs.getString(1); final boolean isWriter = rs.getBoolean(2); final float nodeLag = rs.getFloat(3); @@ -99,22 +105,22 @@ protected HostSpec createHost( // Calculate weight based on node lag in time and CPU utilization. final long weight = Math.round(nodeLag) * 100L; - final HostSpec clusterInstanceTemplateForRegion = instanceTemplatesByRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException( - Messages.get("GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); + final HostSpec instanceTemplate = instanceTemplatesByRegion.get(awsRegion); + if (instanceTemplate == null) { + throw new SQLException(Messages.get( + "GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); } return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, - clusterInstanceTemplateForRegion); + instanceTemplate); } public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { try (final PreparedStatement stmt = conn.prepareStatement(this.dialect.getRegionByInstanceIdQuery())) { stmt.setString(1, instanceId); - try (final ResultSet resultSet = stmt.executeQuery()) { - if (resultSet.next()) { - String awsRegion = resultSet.getString(1); + try (final ResultSet rs = stmt.executeQuery()) { + if (rs.next()) { + String awsRegion = rs.getString(1); return StringUtils.isNullOrEmpty(awsRegion) ? null : awsRegion; } } @@ -122,4 +128,25 @@ protected HostSpec createHost( return null; } + + public Map parseInstanceTemplates(String instanceTemplatesString, Consumer hostValidator) + throws SQLException { + if (StringUtils.isNullOrEmpty(instanceTemplatesString)) { + throw new SQLException(Messages.get("GlobalAuroraTopologyUtils.globalClusterInstanceHostPatternsRequired")); + } + + Map instanceTemplates = Arrays.stream(instanceTemplatesString.split(",")) + .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) + .collect(Collectors.toMap( + Pair::getValue1, + v -> { + hostValidator.accept(v.getValue2().getHost()); + return v.getValue2(); + })); + LOGGER.finest(Messages.get( + "GlobalAuroraTopologyUtils.detectedGdbPatterns", + new Object[] {LogUtils.toLogString(instanceTemplates)})); + + return instanceTemplates; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 715ddbf40..2ba81b980 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -23,7 +23,9 @@ import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; @@ -44,75 +46,78 @@ public MultiAzTopologyUtils(MultiAzClusterDialect dialect, HostSpecBuilder hostS @Override protected @Nullable List getHosts( - Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { String writerId = this.getWriterId(conn); - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - List hosts = new ArrayList<>(); + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); while (rs.next()) { try { - hosts.add(createHost(rs, initialHostSpec, hostTemplate, writerId)); + HostSpec host = createHost(rs, initialHostSpec, instanceTemplate, writerId); + hostsMap.put(host.getHost(), host); } catch (Exception e) { - LOGGER.finest( - Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); return null; } } - return hosts; + return new ArrayList<>(hostsMap.values()); } @Override public boolean isWriterInstance(final Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { - if (resultSet.next()) { - String instanceId = resultSet.getString(this.dialect.getWriterIdColumnName()); + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (rs.next()) { + String instanceId = rs.getString(this.dialect.getWriterIdColumnName()); // The writer ID is only returned when connected to a reader, so if the query does not return a value, it // means we are connected to a writer. return StringUtils.isNullOrEmpty(instanceId); } } } + return false; } protected @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getWriterIdQuery())) { - if (resultSet.next()) { - String writerId = resultSet.getString(this.dialect.getWriterIdColumnName()); + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (rs.next()) { + String writerId = rs.getString(this.dialect.getWriterIdColumnName()); if (!StringUtils.isNullOrEmpty(writerId)) { return writerId; } } } - // Replica status doesn't exist, which means that this instance is a writer. We execute instanceIdQuery to get the - // ID of this writer instance. - try (final ResultSet resultSet = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { - if (resultSet.next()) { - return resultSet.getString(1); + // The writer ID is only returned when connected to a reader, so if the query does not return a value, it + // means we are connected to a writer + try (final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (rs.next()) { + return rs.getString(1); } } } + return null; } protected HostSpec createHost( - final ResultSet resultSet, + final ResultSet rs, final HostSpec initialHostSpec, - final HostSpec hostTemplate, + final HostSpec instanceTemplate, final @Nullable String writerId) throws SQLException { - String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" + String endpoint = rs.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - String hostId = resultSet.getString("id"); // "1034958454" + String hostId = rs.getString("id"); // "1034958454" final boolean isWriter = hostId.equals(writerId); - return createHost(hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, hostTemplate); + return createHost( + hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 12b2c70a1..4bd523e39 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -34,6 +34,7 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUrlType; @@ -86,7 +87,7 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected List initialHostList = new ArrayList<>(); protected HostSpec initialHostSpec; protected String clusterId; - protected HostSpec clusterInstanceTemplate; + protected HostSpec instanceTemplate; protected volatile boolean isInitialized = false; @@ -124,14 +125,12 @@ protected void init() throws SQLException { } protected void initSettings() throws SQLException { - - // initial topology is based on connection string + // The initial topology is based on the connection string. this.initialHostList = connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, this.hostListProviderService::getHostSpecBuilder); if (this.initialHostList == null || this.initialHostList.isEmpty()) { - throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", - new Object[] {this.originalUrl})); + throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); } this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); @@ -143,10 +142,10 @@ protected void initSettings() throws SQLException { HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); if (clusterInstancePattern != null) { - this.clusterInstanceTemplate = + this.instanceTemplate = ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); } else { - this.clusterInstanceTemplate = + this.instanceTemplate = hostSpecBuilder .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) .hostId(this.initialHostSpec.getHostId()) @@ -154,8 +153,7 @@ protected void initSettings() throws SQLException { .build(); } - validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); - + validateHostPatternSetting(this.instanceTemplate.getHost()); this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); } @@ -175,20 +173,15 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f init(); final List storedHosts = this.getStoredTopology(); - if (storedHosts == null || forceUpdate) { - - // need to re-fetch topology - + // We need to re-fetch topology. if (conn == null) { - // can't fetch the latest topology since no connection - // return original hosts parsed from connection string + // We cannot fetch the latest topology since we do not have access to a connection, so we return the original + // hosts parsed from the connection string. return new FetchTopologyResult(false, this.initialHostList); } - // fetch topology from the DB final List hosts = this.queryForTopology(conn); - if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); return new FetchTopologyResult(false, hosts); @@ -198,7 +191,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f if (storedHosts == null) { return new FetchTopologyResult(false, this.initialHostList); } else { - // use cached data + // Return the cached data. return new FetchTopologyResult(true, storedHosts); } } @@ -212,7 +205,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f */ protected List queryForTopology(final Connection conn) throws SQLException { init(); - return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.clusterInstanceTemplate); + return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplate); } /** @@ -246,7 +239,7 @@ public List refresh(final Connection connection) throws SQLException { : this.hostListProviderService.getCurrentConnection(); final FetchTopologyResult results = getTopology(currentConnection, false); - LOGGER.finest(() -> Utils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); + LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); this.hostList = results.hosts; return Collections.unmodifiableList(hostList); @@ -265,7 +258,7 @@ public List forceRefresh(final Connection connection) throws SQLExcept : this.hostListProviderService.getCurrentConnection(); final FetchTopologyResult results = getTopology(currentConnection, true); - LOGGER.finest(() -> Utils.logTopology(results.hosts)); + LOGGER.finest(() -> LogUtils.logTopology(results.hosts)); this.hostList = results.hosts; return Collections.unmodifiableList(this.hostList); } @@ -277,9 +270,6 @@ public RdsUrlType getRdsUrlType() throws SQLException { protected void validateHostPatternSetting(final String hostPattern) { if (!rdsHelper.isDnsPatternValid(hostPattern)) { - // "Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host - // pattern must contain a '?' - // character as a placeholder for the DB instance identifiers of the instances in the cluster" final String message = Messages.get("RdsHostListProvider.invalidPattern"); LOGGER.severe(message); throw new RuntimeException(message); @@ -287,18 +277,13 @@ protected void validateHostPatternSetting(final String hostPattern) { final RdsUrlType rdsUrlType = rdsHelper.identifyRdsType(hostPattern); if (rdsUrlType == RdsUrlType.RDS_PROXY || rdsUrlType == RdsUrlType.RDS_PROXY_ENDPOINT) { - // "An RDS Proxy url can't be used as the 'clusterInstanceHostPattern' configuration setting." - final String message = - Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy"); + final String message = Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy"); LOGGER.severe(message); throw new RuntimeException(message); } if (rdsUrlType == RdsUrlType.RDS_CUSTOM_CLUSTER) { - // "An RDS Custom Cluster endpoint can't be used as the 'clusterInstanceHostPattern' - // configuration setting." - final String message = - Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom"); + final String message = Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom"); LOGGER.severe(message); throw new RuntimeException(message); } @@ -338,7 +323,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { } if (topology == null) { - // TODO: above, we throw an exception, but here, we return null. Should we stick with just one? return null; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java index 8229e2cd3..13e646a03 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java @@ -16,6 +16,6 @@ package software.amazon.jdbc.hostlistprovider; -// A marker interface for providers that fetch node lists, and it never changes since after. -// An example of such provider is a provider that use connection string as a source. +// A marker interface for providers that fetch host lists that do not change over time. +// An example is a provider that uses a connection string to determine the host list. public interface StaticHostListProvider extends HostListProvider {} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index b926cee6a..b5a838bd1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -54,18 +54,18 @@ public TopologyUtils( this.hostSpecBuilder = hostSpecBuilder; } - public @Nullable List queryForTopology(Connection conn, HostSpec initialHostSpec, HostSpec hostTemplate) + public @Nullable List queryForTopology(Connection conn, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { int networkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.dialect.getTopologyQuery())) { - if (resultSet.getMetaData().getColumnCount() == 0) { + final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { + if (rs.getMetaData().getColumnCount() == 0) { // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); return null; } - return this.verifyWriter(this.getHosts(conn, resultSet, initialHostSpec, hostTemplate)); + return this.verifyWriter(this.getHosts(conn, rs, initialHostSpec, instanceTemplate)); } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { @@ -79,21 +79,24 @@ protected int setNetworkTimeout(Connection conn) { int networkTimeout = -1; try { networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout + // The topology query is not monitored by the EFM plugin, so it needs a socket timeout. if (networkTimeout == 0) { conn.setNetworkTimeout(this.networkTimeoutExecutor, DEFAULT_QUERY_TIMEOUT_MS); } } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); + LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", new Object[] {e.getMessage()})); } return networkTimeout; } protected abstract @Nullable List getHosts( - Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec hostTemplate) throws SQLException; + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException; + + protected @Nullable List verifyWriter(@Nullable List allHosts) { + if (allHosts == null) { + return null; + } - protected @Nullable List verifyWriter(List allHosts) { List hosts = new ArrayList<>(); List writers = new ArrayList<>(); for (HostSpec host : allHosts) { @@ -128,11 +131,11 @@ public HostSpec createHost( final long weight, final Timestamp lastUpdateTime, final HostSpec initialHostSpec, - final HostSpec clusterInstanceTemplate) { + final HostSpec instanceTemplate) { instanceName = instanceName == null ? "?" : instanceName; - final String endpoint = clusterInstanceTemplate.getHost().replace("?", instanceName); - final int port = clusterInstanceTemplate.isPortSpecified() - ? clusterInstanceTemplate.getPort() + final String endpoint = instanceTemplate.getHost().replace("?", instanceName); + final int port = instanceTemplate.isPortSpecified() + ? instanceTemplate.getPort() : initialHostSpec.getPort(); final HostSpec hostSpec = this.hostSpecBuilder @@ -163,9 +166,9 @@ public HostSpec createHost( public @Nullable Pair getInstanceId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { - if (resultSet.next()) { - return Pair.create(resultSet.getString(1), resultSet.getString(2)); + final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (rs.next()) { + return Pair.create(rs.getString(1), rs.getString(2)); } } } catch (SQLException ex) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 0271b2e1e..1c0f481f6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -42,6 +42,7 @@ import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.PropertyUtils; @@ -63,7 +64,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected static final int defaultConnectionTimeoutMs = 5000; protected static final int defaultSocketTimeoutMs = 5000; - // Keep monitoring topology with a high rate for 30s after failover. + // Keep monitoring topology at a high rate for 30s after failover. protected static final long highRefreshPeriodAfterPanicNano = TimeUnit.SECONDS.toNanos(30); protected static final long ignoreTopologyRequestNano = TimeUnit.SECONDS.toNanos(10); @@ -89,7 +90,7 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final Properties properties; protected final Properties monitoringProperties; protected final HostSpec initialHostSpec; - protected final HostSpec clusterInstanceTemplate; + protected final HostSpec instanceTemplate; protected ExecutorService nodeExecutorService = null; protected boolean isVerifiedWriterConnection = false; @@ -102,7 +103,7 @@ public ClusterTopologyMonitorImpl( final String clusterId, final HostSpec initialHostSpec, final Properties properties, - final HostSpec clusterInstanceTemplate, + final HostSpec instanceTemplate, final long refreshRateNano, final long highRefreshRateNano) { super(monitorTerminationTimeoutSec); @@ -111,7 +112,7 @@ public ClusterTopologyMonitorImpl( this.topologyUtils = topologyUtils; this.clusterId = clusterId; this.initialHostSpec = initialHostSpec; - this.clusterInstanceTemplate = clusterInstanceTemplate; + this.instanceTemplate = instanceTemplate; this.properties = properties; this.refreshRateNano = refreshRateNano; this.highRefreshRateNano = highRefreshRateNano; @@ -150,10 +151,11 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long if (this.ignoreNewTopologyRequestsEndTimeNano.get() > 0 && System.nanoTime() < this.ignoreNewTopologyRequestsEndTimeNano.get()) { - // Previous failover has just completed. We can use results of it without triggering a new topology update. + // A previous failover event has completed recently. + // We can use the results of it without triggering a new topology update. List currentHosts = getStoredHosts(); LOGGER.finest( - Utils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.ignoringTopologyRequest"))); + LogUtils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.ignoringTopologyRequest"))); if (currentHosts != null) { return currentHosts; } @@ -173,11 +175,11 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long public List forceRefresh(@Nullable Connection connection, final long timeoutMs) throws SQLException, TimeoutException { if (this.isVerifiedWriterConnection) { - // Push monitoring thread to refresh topology with a verified connection + // Get the monitoring thread to refresh the topology using a verified connection. return this.waitTillTopologyGetsUpdated(timeoutMs); } - // Otherwise use provided unverified connection to update topology + // Otherwise, use the provided unverified connection to update the topology. return this.fetchTopologyAndUpdateCache(connection); } @@ -188,12 +190,12 @@ protected List waitTillTopologyGetsUpdated(final long timeoutMs) throw synchronized (this.requestToUpdateTopology) { this.requestToUpdateTopology.set(true); - // Notify monitoring thread (that might be sleeping) that topology should be refreshed immediately. + // Notify the monitoring thread, which may be sleeping, that topology should be refreshed immediately. this.requestToUpdateTopology.notifyAll(); } if (timeoutMs == 0) { - LOGGER.finest(Utils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.timeoutSetToZero"))); + LOGGER.finest(LogUtils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.timeoutSetToZero"))); return currentHosts; } @@ -233,7 +235,7 @@ public void stop() { this.nodeThreadsStop.set(true); this.shutdownNodeExecutorService(); - // It breaks a waiting/sleeping cycles in monitoring thread + // This code interrupts the waiting/sleeping cycle in the monitoring thread. synchronized (this.requestToUpdateTopology) { this.requestToUpdateTopology.set(true); this.requestToUpdateTopology.notifyAll(); @@ -264,7 +266,7 @@ public void monitor() throws Exception { if (this.submittedNodes.isEmpty()) { LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.startingNodeMonitoringThreads")); - // start node threads + // Start node monitors. this.nodeThreadsStop.set(false); this.nodeThreadsWriterConnection.set(null); this.nodeThreadsReaderConnection.set(null); @@ -273,7 +275,7 @@ public void monitor() throws Exception { List hosts = getStoredHosts(); if (hosts == null) { - // need any connection to get topology + // Use any available connection to get the topology. hosts = this.openAnyConnectionAndUpdateTopology(); } @@ -304,20 +306,17 @@ public void monitor() throws Exception { throw exceptionList.get(0); } } - // It's not possible to call shutdown() on this.nodeExecutorService since more node may be added later. + // We do not call nodeExecutorService.shutdown() here since more node monitors may be submitted later. } - // otherwise let's try it again the next round - + // We will try again in the next iteration. } else { - // node threads are running - // check if writer is already detected + // The node monitors are running, so we check if the writer has been detected. final Connection writerConnection = this.nodeThreadsWriterConnection.get(); final HostSpec writerConnectionHostSpec = this.nodeThreadsWriterHostSpec.get(); if (writerConnection != null && writerConnectionHostSpec != null) { - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors", - new Object[] {writerConnectionHostSpec})); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors", + new Object[] {writerConnectionHostSpec})); this.closeConnection(this.monitoringConnection.get()); this.monitoringConnection.set(writerConnection); @@ -339,7 +338,7 @@ public void monitor() throws Exception { continue; } else { - // update node threads with new nodes in the topology + // Update node monitors with the new instances in the topology List hosts = this.nodeThreadsLatestTopology.get(); if (hosts != null && !this.nodeThreadsStop.get()) { for (HostSpec hostSpec : hosts) { @@ -363,7 +362,7 @@ public void monitor() throws Exception { throw exceptionList.get(0); } } - // It's not possible to call shutdown() on this.nodeExecutorService since more node may be added later. + // We do not call nodeExecutorService.shutdown() here since more node monitors may be submitted later. } } } @@ -371,8 +370,7 @@ public void monitor() throws Exception { this.delay(true); } else { - // regular mode (not panic mode) - + // We are in regular mode (not panic mode). if (!this.submittedNodes.isEmpty()) { this.shutdownNodeExecutorService(); this.submittedNodes.clear(); @@ -380,8 +378,7 @@ public void monitor() throws Exception { final List hosts = this.fetchTopologyAndUpdateCache(this.monitoringConnection.get()); if (hosts == null) { - // can't get topology - // let's switch to panic mode + // Attempt to fetch topology failed, so we switch to panic mode. Connection conn = this.monitoringConnection.get(); this.monitoringConnection.set(null); this.isVerifiedWriterConnection = false; @@ -393,9 +390,9 @@ public void monitor() throws Exception { this.highRefreshRateEndTimeNano = 0; } - // Do not log topology while in high refresh rate. It's noisy! + // We avoid logging the topology while using the high refresh rate because it is too noisy. if (this.highRefreshRateEndTimeNano == 0) { - LOGGER.finest(Utils.logTopology(getStoredHosts())); + LOGGER.finest(LogUtils.logTopology(getStoredHosts())); } this.delay(false); @@ -410,9 +407,9 @@ public void monitor() throws Exception { } catch (final InterruptedException intEx) { Thread.currentThread().interrupt(); } catch (final Exception ex) { - // this should not be reached; log and exit thread + // This should not be reached. if (LOGGER.isLoggable(Level.FINEST)) { - // We want to print full trace stack of the exception. + // We want to print the full trace stack of the exception. LOGGER.log( Level.FINEST, Messages.get( @@ -455,7 +452,7 @@ protected void shutdownNodeExecutorService() { this.nodeExecutorService.shutdownNow(); } } catch (InterruptedException e) { - // do nothing + // Do nothing. } this.nodeExecutorService = null; @@ -492,11 +489,10 @@ protected List openAnyConnectionAndUpdateTopology() { Connection conn; - // open a new connection + // Open a new connection. try { conn = this.servicesContainer.getPluginService().forceConnect(this.initialHostSpec, this.monitoringProperties); } catch (SQLException ex) { - // can't connect return null; } @@ -512,34 +508,29 @@ protected List openAnyConnectionAndUpdateTopology() { if (rdsHelper.isRdsInstance(this.initialHostSpec.getHost())) { this.writerHostSpec.set(this.initialHostSpec); - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[] {this.writerHostSpec.get().getHost()})); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerMonitoringConnection", + new Object[] {this.writerHostSpec.get().getHost()})); } else { final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); - // TODO: this code isn't quite right when compared to main-3.x if (pair != null) { - HostSpec hostTemplate = - this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); - HostSpec writerHost = - this.topologyUtils.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, - this.initialHostSpec, hostTemplate); + HostSpec instanceTemplate = this.getinstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); + HostSpec writerHost = this.topologyUtils.createHost( + pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, instanceTemplate); this.writerHostSpec.set(writerHost); - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[] {this.writerHostSpec.get().getHost()})); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerMonitoringConnection", + new Object[] {this.writerHostSpec.get().getHost()})); } } } } catch (SQLException ex) { - // do nothing + // Do nothing. } } else { - // monitoring connection has already been set by other thread - // close new connection as we don't need it + // The monitoring connection has already been detected by another thread. We close the new connection since it + // is not needed anymore. this.closeConnection(conn); } } @@ -555,8 +546,7 @@ protected List openAnyConnectionAndUpdateTopology() { } if (hosts == null) { - // can't get topology; it might be something's wrong with a connection - // close connection + // Attempt to fetch topology failed. There might be something wrong with the connection, so we close it here. Connection connToClose = this.monitoringConnection.get(); this.monitoringConnection.set(null); this.closeConnection(connToClose); @@ -566,8 +556,8 @@ protected List openAnyConnectionAndUpdateTopology() { return hosts; } - protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) throws SQLException { - return this.clusterInstanceTemplate; + protected HostSpec getinstanceTemplate(String nodeId, Connection connection) throws SQLException { + return this.instanceTemplate; } protected void closeConnection(final @Nullable Connection connection) { @@ -576,16 +566,16 @@ protected void closeConnection(final @Nullable Connection connection) { try { connection.setNetworkTimeout(networkTimeoutExecutor, closeConnectionNetworkTimeoutMs); } catch (SQLException ex) { - // do nothing + // Do nothing. } connection.close(); } } catch (final SQLException ex) { - // ignore + // Do nothing. } } - // Sleep that can be easily interrupted + // Sleep method that can be easily interrupted. protected void delay(boolean useHighRefreshRate) throws InterruptedException { if (this.highRefreshRateEndTimeNano > 0 && System.nanoTime() < this.highRefreshRateEndTimeNano) { useHighRefreshRate = true; @@ -617,11 +607,12 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { } catch (SQLException ex) { LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[] {ex})); } + return null; } protected List queryForTopology(Connection connection) throws SQLException { - return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.clusterInstanceTemplate); + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplate); } protected void updateTopologyCache(final @NonNull List hosts) { @@ -685,7 +676,8 @@ public void run() { try { isWriter = this.monitor.topologyUtils.isWriterInstance(connection); } catch (SQLSyntaxErrorException ex) { - LOGGER.severe(() -> Messages.get("NodeMonitoringThread.invalidWriterQuery", + LOGGER.severe(() -> Messages.get( + "NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); throw new RuntimeException(ex); @@ -707,13 +699,12 @@ public void run() { } if (isWriter) { - // this prevents closing connection in finally block + // This prevents us from closing the connection in the finally block. if (!this.monitor.nodeThreadsWriterConnection.compareAndSet(null, connection)) { - // writer connection is already setup + // The writer connection is already set up, probably by another node monitor. this.monitor.closeConnection(connection); - } else { - // writer connection is successfully set to writerConnection + // Successfully updated the node monitor writer connection. LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[] {hostSpec.getUrl()})); // When nodeThreadsWriterConnection and nodeThreadsWriterHostSpec are both set, the topology monitor may // set ignoreNewTopologyRequestsEndTimeNano, in which case other threads will use the cached topology @@ -721,23 +712,22 @@ public void run() { this.monitor.fetchTopologyAndUpdateCache(connection); this.monitor.nodeThreadsWriterHostSpec.set(hostSpec); this.monitor.nodeThreadsStop.set(true); - LOGGER.fine(Utils.logTopology(this.monitor.getStoredHosts())); + LOGGER.fine(LogUtils.logTopology(this.monitor.getStoredHosts())); } - // Setting the connection to null here prevents the final block - // from closing nodeThreadsWriterConnection. + // We set the connection to null to prevent the finally block from closing nodeThreadsWriterConnection. connection = null; return; - } else if (connection != null) { - // this connection is a reader connection + // This connection is a reader connection. if (this.monitor.nodeThreadsWriterConnection.get() == null) { - // while writer connection isn't yet established this reader connection may update topology + // We can use this reader connection to update the topology while we wait for the writer connection to + // be established. if (updateTopology) { this.readerThreadFetchTopology(connection, this.writerHostSpec); } else if (this.monitor.nodeThreadsReaderConnection.get() == null) { if (this.monitor.nodeThreadsReaderConnection.compareAndSet(null, connection)) { - // let's use this connection to update topology + // Use this connection to update the topology. updateTopology = true; this.readerThreadFetchTopology(connection, this.writerHostSpec); } @@ -752,7 +742,8 @@ public void run() { } finally { this.monitor.closeConnection(connection); final long end = System.nanoTime(); - LOGGER.finest(() -> Messages.get("NodeMonitoringThread.threadCompleted", + LOGGER.finest(() -> Messages.get( + "NodeMonitoringThread.threadCompleted", new Object[] {TimeUnit.NANOSECONDS.toMillis(end - start)})); } } @@ -765,7 +756,7 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla List hosts; try { hosts = this.monitor.topologyUtils.queryForTopology( - connection, this.monitor.initialHostSpec, this.monitor.clusterInstanceTemplate); + connection, this.monitor.initialHostSpec, this.monitor.instanceTemplate); if (hosts == null) { return; } @@ -773,12 +764,12 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla return; } - // share this topology so the main monitoring thread be able to adjust node monitoring threads + // Share this topology so that the main monitoring thread can adjust the node monitoring threads. this.monitor.nodeThreadsLatestTopology.set(hosts); if (this.writerChanged) { this.monitor.updateTopologyCache(hosts); - LOGGER.finest(Utils.logTopology(hosts)); + LOGGER.finest(LogUtils.logTopology(hosts)); return; } @@ -789,16 +780,14 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla if (latestWriterHostSpec != null && writerHostSpec != null && !latestWriterHostSpec.getHostAndPort().equals(writerHostSpec.getHostAndPort())) { - - // writer node has changed this.writerChanged = true; - - LOGGER.fine(() -> Messages.get("NodeMonitoringThread.writerNodeChanged", + LOGGER.fine(() -> Messages.get( + "NodeMonitoringThread.writerNodeChanged", new Object[] {writerHostSpec.getHost(), latestWriterHostSpec.getHost()})); - // we can update topology cache and notify all waiting threads + // Update the topology cache and notify all waiting threads. this.monitor.updateTopologyCache(hosts); - LOGGER.fine(Utils.logTopology(hosts)); + LOGGER.fine(LogUtils.logTopology(hosts)); } } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java index 9c135312e..cf5e20a7d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java @@ -21,7 +21,6 @@ import java.util.List; import java.util.Map; import java.util.Properties; -import java.util.logging.Logger; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; @@ -39,7 +38,7 @@ public GlobalAuroraTopologyMonitor( final String clusterId, final HostSpec initialHostSpec, final Properties properties, - final HostSpec clusterInstanceTemplate, + final HostSpec instanceTemplate, final long refreshRateNano, final long highRefreshRateNano, final Map instanceTemplatesByRegion) { @@ -48,7 +47,7 @@ public GlobalAuroraTopologyMonitor( clusterId, initialHostSpec, properties, - clusterInstanceTemplate, + instanceTemplate, refreshRateNano, highRefreshRateNano); @@ -57,19 +56,19 @@ public GlobalAuroraTopologyMonitor( } @Override - protected HostSpec getClusterInstanceTemplate(String instanceId, Connection connection) throws SQLException { + protected HostSpec getinstanceTemplate(String instanceId, Connection connection) throws SQLException { String region = this.topologyUtils.getRegion(instanceId, connection); if (!StringUtils.isNullOrEmpty(region)) { - final HostSpec clusterInstanceTemplateForRegion = this.instanceTemplatesByRegion.get(region); - if (clusterInstanceTemplateForRegion == null) { + final HostSpec instanceTemplate = this.instanceTemplatesByRegion.get(region); + if (instanceTemplate == null) { throw new SQLException( Messages.get("GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {region})); } - return clusterInstanceTemplateForRegion; + return instanceTemplate; } - return this.clusterInstanceTemplate; + return this.instanceTemplate; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java index b42cf80f0..b258c223d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java @@ -18,22 +18,18 @@ import java.sql.Connection; import java.sql.SQLException; -import java.util.Arrays; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Properties; import java.util.logging.Logger; -import java.util.stream.Collectors; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; @@ -47,7 +43,7 @@ public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostLis protected final GlobalAuroraTopologyUtils topologyUtils; static { - // Intentionally register property definition in GlobalAuroraHostListProvider class. + // Intentionally register property definition using the GlobalAuroraHostListProvider class. PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); } @@ -64,28 +60,9 @@ public MonitoringGlobalAuroraHostListProvider( protected void initSettings() throws SQLException { super.initSettings(); - // TODO: check if we have other places that parse into string-HostSpec maps, consider refactoring - String templates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException(Messages.get("MonitoringGlobalAuroraHostListProvider.globalHostPatternsRequired")); - } - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.instanceTemplatesByRegion = Arrays.stream(templates.split(",")) - .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) - .collect(Collectors.toMap( - Pair::getValue1, - v -> { - this.validateHostPatternSetting(v.getValue2().getHost()); - return v.getValue2(); - })); - LOGGER.finest(Messages.get( - "GlobalAuroraHostListProvider.detectedGdbPatterns", new Object[] { - this.instanceTemplatesByRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) - }) - ); + String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + this.instanceTemplatesByRegion = + this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); } protected ClusterTopologyMonitor initMonitor() throws SQLException { @@ -101,7 +78,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.clusterId, this.initialHostSpec, this.properties, - this.clusterInstanceTemplate, + this.instanceTemplate, this.refreshRateNano, this.highRefreshRateNano, this.instanceTemplatesByRegion)); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index 4f1a82080..a1ab3490c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -73,7 +73,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.clusterId, this.initialHostSpec, this.properties, - this.clusterInstanceTemplate, + this.instanceTemplate, this.refreshRateNano, this.highRefreshRateNano)); } @@ -108,6 +108,6 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long @Override public void releaseResources() { - // do nothing + // Do nothing. } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java index 63a2cef2a..622bc2eb0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java @@ -74,8 +74,8 @@ public String toString() { .map(x -> String.format("%s -> %s", x.getKey(), x.getValue())) .collect(Collectors.joining("\n ")); String allHostNamesStr = String.join("\n ", this.hostNames); - String startTopologyStr = Utils.logTopology(this.startTopology); - String currentTopologyStr = Utils.logTopology(this.currentTopology); + String startTopologyStr = LogUtils.logTopology(this.startTopology); + String currentTopologyStr = LogUtils.logTopology(this.currentTopology); return String.format("%s [\n" + " phase %s, \n" + " version '%s', \n" diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 8504842c6..1412d47e1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -465,7 +465,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti if (allowOldWriter || !isSame(writerCandidate, this.originalWriterHost)) { // new writer is available, and it's different from the previous writer - LOGGER.finest(() -> Utils.logTopology(this.currentTopology, "[TaskB] Topology:")); + LOGGER.finest(() -> LogUtils.logTopology(this.currentTopology, "[TaskB] Topology:")); if (connectToWriter(writerCandidate)) { return true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 731e46b90..3c830d75d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -757,7 +757,7 @@ protected void failoverWriter() throws SQLException { throwFailoverFailedException( Messages.get( "Failover.noWriterHostAfterReconnecting", - new Object[]{Utils.logTopology(hosts, "")})); + new Object[]{LogUtils.logTopology(hosts, "")})); return; } @@ -765,7 +765,7 @@ protected void failoverWriter() throws SQLException { if (!Utils.containsHostAndPort(allowedHosts, writerHostSpec.getHostAndPort())) { throwFailoverFailedException( Messages.get("Failover.newWriterNotAllowed", - new Object[] {writerHostSpec.getUrl(), Utils.logTopology(allowedHosts, "")})); + new Object[] {writerHostSpec.getUrl(), LogUtils.logTopology(allowedHosts, "")})); return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 1ca39eb6a..9e78c82e9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -430,7 +430,7 @@ protected ReaderFailoverResult getReaderFailoverConnection(long failoverEndTimeN this.failoverReaderHostSelectorStrategySetting); } catch (UnsupportedOperationException | SQLException ex) { LOGGER.finest( - Utils.logTopology( + LogUtils.logTopology( new ArrayList<>(remainingReaders), Messages.get("Failover.errorSelectingReaderHost", new Object[]{ex.getMessage()}))); break; @@ -438,7 +438,7 @@ protected ReaderFailoverResult getReaderFailoverConnection(long failoverEndTimeN if (readerCandidate == null) { LOGGER.finest( - Utils.logTopology(new ArrayList<>(remainingReaders), Messages.get("Failover.readerCandidateNull"))); + LogUtils.logTopology(new ArrayList<>(remainingReaders), Messages.get("Failover.readerCandidateNull"))); break; } @@ -559,7 +559,7 @@ protected void failoverWriter() throws SQLException { if (this.failoverWriterFailedCounter != null) { this.failoverWriterFailedCounter.inc(); } - String message = Utils.logTopology(updatedHosts, Messages.get("Failover.noWriterHost")); + String message = LogUtils.logTopology(updatedHosts, Messages.get("Failover.noWriterHost")); LOGGER.severe(message); throw new FailoverFailedSQLException(message); } @@ -569,7 +569,7 @@ protected void failoverWriter() throws SQLException { if (this.failoverWriterFailedCounter != null) { this.failoverWriterFailedCounter.inc(); } - String topologyString = Utils.logTopology(allowedHosts, ""); + String topologyString = LogUtils.logTopology(allowedHosts, ""); LOGGER.severe(Messages.get("Failover.newWriterNotAllowed", new Object[] {writerCandidate.getUrl(), topologyString})); throw new FailoverFailedSQLException( diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java index f4075a285..ec350aab6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java @@ -116,7 +116,7 @@ public void monitor() { List newLimitlessRouters = queryHelper.queryForLimitlessRouters(this.monitoringConn, this.hostSpec.getPort()); this.storageService.set(this.limitlessRouterCacheKey, new LimitlessRouters(newLimitlessRouters)); - LOGGER.finest(Utils.logTopology(newLimitlessRouters, "[limitlessRouterMonitor] Topology:")); + LOGGER.finest(LogUtils.logTopology(newLimitlessRouters, "[limitlessRouterMonitor] Topology:")); TimeUnit.MILLISECONDS.sleep(this.intervalMs); // do not include this in the telemetry } catch (final Exception ex) { if (telemetryContext != null) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index d03d6530d..b44a2c927 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -425,7 +425,7 @@ private void switchToReaderConnection(final List hosts) LOGGER.finest( Messages.get( "ReadWriteSplittingPlugin.previousReaderNotAllowed", - new Object[] {this.readerHostSpec, Utils.logTopology(hosts, "")})); + new Object[] {this.readerHostSpec, LogUtils.logTopology(hosts, "")})); closeConnectionIfIdle(this.readerConnection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index c1d095581..f1d7b9114 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -101,7 +101,7 @@ public Connection getVerifiedConnection( this.pluginService.refreshHostList(conn); } - LOGGER.finest(() -> Utils.logTopology(this.pluginService.getAllHosts())); + LOGGER.finest(() -> LogUtils.logTopology(this.pluginService.getAllHosts())); if (this.writerHostSpec == null) { final HostSpec writerCandidate = Utils.getWriter(this.pluginService.getAllHosts()); @@ -149,7 +149,7 @@ public Connection getVerifiedConnection( Messages.get("AuroraStaleDnsHelper.currentWriterNotAllowed", new Object[] { this.writerHostSpec == null ? "" : this.writerHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java new file mode 100644 index 000000000..932e4a21e --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java @@ -0,0 +1,55 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.util; + +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; + +public class LogUtils { + public static String logTopology(final @Nullable List hosts) { + return logTopology(hosts, null); + } + + public static String logTopology( + final @Nullable List hosts, + final @Nullable String messagePrefix) { + + final StringBuilder msg = new StringBuilder(); + if (hosts == null) { + msg.append(""); + } else { + for (final HostSpec host : hosts) { + if (msg.length() > 0) { + msg.append("\n"); + } + msg.append(" ").append(host == null ? "" : host); + } + } + + return Messages.get("Utils.topology", + new Object[] {messagePrefix == null ? "Topology:" : messagePrefix, msg.toString()}); + } + + public static String toLogString(Map map) { + return map.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java b/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java index 4d02e9224..8bfe5ca1b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java @@ -53,28 +53,4 @@ public static boolean containsHostAndPort(final Collection hosts, Stri } return null; } - - public static String logTopology(final @Nullable List hosts) { - return logTopology(hosts, null); - } - - public static String logTopology( - final @Nullable List hosts, - final @Nullable String messagePrefix) { - - final StringBuilder msg = new StringBuilder(); - if (hosts == null) { - msg.append(""); - } else { - for (final HostSpec host : hosts) { - if (msg.length() > 0) { - msg.append("\n"); - } - msg.append(" ").append(host == null ? "" : host); - } - } - - return Messages.get("Utils.topology", - new Object[] {messagePrefix == null ? "Topology:" : messagePrefix, msg.toString()}); - } } diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index 5a0e509fe..5b6c7971e 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -185,11 +185,11 @@ Failover.skipFailoverOnInterruptedThread=Do not start failover since the current FederatedAuthPlugin.unableToDetermineRegion=Unable to determine connection region. If you are using a non-standard RDS URL, please set the ''{0}'' property. -GlobalAuroraHostListProvider.globalClusterInstanceHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. -GlobalAuroraHostListProvider.detectedGdbPatterns=Detected GDB instance template patterns:\n{0} - GlobalAuroraTopologyMonitor.cannotFindRegionTemplate=Cannot find cluster template for region {0}. +GlobalAuroraTopologyUtils.globalClusterInstanceHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. +GlobalAuroraTopologyUtils.detectedGdbPatterns=Detected GDB instance template patterns:\n{0} + HostAvailabilityStrategy.invalidMaxRetries=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyMaxRetries`. It must be an integer greater than 1. HostAvailabilityStrategy.invalidInitialBackoffTime=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyInitialBackoffTime`. It must be an integer greater than 1. From 29057d8a86afbc4884407b667f48d745d5925f5c Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 15:49:28 -0800 Subject: [PATCH 42/90] Add DialectUtils#checkExistenceQueries --- .../jdbc/dialect/AuroraMysqlDialect.java | 23 +---------- .../amazon/jdbc/dialect/AuroraPgDialect.java | 35 +++++------------ .../amazon/jdbc/dialect/DialectUtils.java | 38 +++++++++++++++++++ .../dialect/GlobalAuroraMysqlDialect.java | 31 +++++---------- .../jdbc/dialect/GlobalAuroraPgDialect.java | 21 +++------- .../dialect/MultiAzClusterMysqlDialect.java | 31 +++++---------- .../amazon/jdbc/dialect/MysqlDialect.java | 2 + .../amazon/jdbc/dialect/PgDialect.java | 13 ++----- .../amazon/jdbc/dialect/RdsMysqlDialect.java | 12 +----- .../amazon/jdbc/dialect/RdsPgDialect.java | 9 +---- 10 files changed, 83 insertions(+), 132 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index deb6c7af8..7197d915a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -17,9 +17,6 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; import java.util.Collections; import java.util.List; import software.amazon.jdbc.PluginService; @@ -52,16 +49,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, @Override public boolean isDialect(final Connection connection) { - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(AURORA_VERSION_EXISTS_QUERY)) { - if (rs.next()) { - return true; - } - } catch (final SQLException ex) { - return false; - } - - return false; + return dialectUtils.checkExistenceQueries(connection, AURORA_VERSION_EXISTS_QUERY); } @Override @@ -103,14 +91,7 @@ public String getIsReaderQuery() { @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(BG_TOPOLOGY_EXISTS_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + return dialectUtils.checkExistenceQueries(connection, BG_TOPOLOGY_EXISTS_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 41ff5d028..db71e9b62 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -76,12 +76,14 @@ public boolean isDialect(final Connection connection) { boolean hasExtensions = false; try (Statement stmt = connection.createStatement(); ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { - if (rs.next()) { - final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); - if (auroraUtils) { - hasExtensions = true; - } + if (!rs.next()) { + return false; + } + + final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); + LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); + if (auroraUtils) { + hasExtensions = true; } } catch (SQLException ex) { return false; @@ -91,17 +93,7 @@ public boolean isDialect(final Connection connection) { return false; } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_EXISTS_QUERY)) { - if (rs.next()) { - LOGGER.finest(() -> "hasTopology: true"); - return true; - } - } catch (final SQLException ex) { - return false; - } - - return false; + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_EXISTS_QUERY); } @Override @@ -150,14 +142,7 @@ public String getLimitlessRouterEndpointQuery() { @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(BG_TOPOLOGY_EXISTS_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + return dialectUtils.checkExistenceQueries(connection, BG_TOPOLOGY_EXISTS_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java new file mode 100644 index 000000000..79f3473b3 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java @@ -0,0 +1,38 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; + +public class DialectUtils { + public boolean checkExistenceQueries(Connection conn, String... existenceQueries) { + for (String existenceQuery : existenceQueries) { + try (Statement stmt = conn.createStatement(); ResultSet rs = stmt.executeQuery(existenceQuery)) { + if (!rs.next()) { + return false; + } + } catch (SQLException e) { + return false; + } + } + + return true; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 44db2c5af..334757af9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -49,33 +49,22 @@ public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements Glob @Override public boolean isDialect(final Connection connection) { - try { - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(GLOBAL_STATUS_TABLE_EXISTS_QUERY)) { - if (!rs.next()) { - return false; - } - } + if (!dialectUtils.checkExistenceQueries( + connection, GLOBAL_STATUS_TABLE_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { + return false; + } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { - if (!rs.next()) { - return false; - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { + if (!rs.next()) { + return false; } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } - } + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } catch (final SQLException ex) { return false; } - - return false; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 3384461eb..7c060c800 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -63,32 +63,23 @@ public boolean isDialect(final Connection connection) { } } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(GLOBAL_STATUS_FUNC_EXISTS_QUERY)) { - if (!rs.next()) { - return false; - } + if (!dialectUtils.checkExistenceQueries( + connection, GLOBAL_STATUS_FUNC_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY)) { + return false; } try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY)) { + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { if (!rs.next()) { return false; } - } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } } catch (final SQLException ex) { return false; } - - return false; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 6087a6ec7..7ac08fc61 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -61,31 +61,18 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzC @Override public boolean isDialect(final Connection connection) { - try { - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { - if (!rs.next()) { - return false; - } - } - - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_QUERY)) { - if (!rs.next()) { - return false; - } - } - - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { - if (!rs.next()) { - return false; - } + if (!dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY, TOPOLOGY_QUERY)) { + return false; + } - final String reportHost = rs.getString(2); // Expected value is an IP address - return !StringUtils.isNullOrEmpty(reportHost); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } + final String reportHost = rs.getString(2); // Expected value is an IP address + return !StringUtils.isNullOrEmpty(reportHost); } catch (final SQLException ex) { return false; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index 6d218f703..f24ad1de8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -36,6 +36,8 @@ public class MysqlDialect implements Dialect { protected static final String VERSION_QUERY = "SHOW VARIABLES LIKE 'version_comment'"; protected static final String HOST_ALIAS_QUERY = "SELECT CONCAT(@@hostname, ':', @@port)"; + protected static final DialectUtils dialectUtils = new DialectUtils(); + private static MySQLExceptionHandler mySQLExceptionHandler; private static final EnumSet NO_FAILOVER_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 855e968e7..13031f012 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -41,6 +41,8 @@ public class PgDialect implements Dialect { protected static final String HOST_ALIAS_QUERY = "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())"; + protected static final DialectUtils dialectUtils = new DialectUtils(); + private static PgExceptionHandler pgExceptionHandler; private static final EnumSet NO_FAILOVER_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); @@ -52,16 +54,7 @@ public class PgDialect implements Dialect { @Override public boolean isDialect(final Connection connection) { - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(PG_PROC_EXISTS_QUERY)) { - if (rs.next()) { - return true; - } - } catch (final SQLException ex) { - return false; - } - - return false; + return dialectUtils.checkExistenceQueries(connection, PG_PROC_EXISTS_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java index 2a0b1ed29..1e173c772 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java @@ -31,8 +31,7 @@ public class RdsMysqlDialect extends MysqlDialect implements BlueGreenDialect { "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; - protected static final String BG_STATUS_QUERY = - "SELECT * FROM mysql.rds_topology"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, @@ -92,14 +91,7 @@ public List getDialectUpdateCandidates() { @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index 3ccad1a0f..62a52d019 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -80,14 +80,7 @@ public List getDialectUpdateCandidates() { @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXISTS_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY); } @Override From e57bf03435ef2fb037f5ba93e5615dd1633dc7a1 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 16:25:40 -0800 Subject: [PATCH 43/90] Change getInstanceId return value from Pair to String --- .../amazon/jdbc/PartialPluginService.java | 1 + .../amazon/jdbc/PluginServiceImpl.java | 1 + .../dialect/MultiAzClusterMysqlDialect.java | 7 ++---- .../jdbc/dialect/MultiAzClusterPgDialect.java | 4 +--- .../hostlistprovider/AuroraTopologyUtils.java | 2 +- .../GlobalAuroraTopologyUtils.java | 4 ++-- .../MultiAzTopologyUtils.java | 7 ++---- .../hostlistprovider/RdsHostListProvider.java | 9 ++++--- .../jdbc/hostlistprovider/TopologyUtils.java | 24 +++++-------------- .../ClusterTopologyMonitorImpl.java | 13 ++++------ .../bluegreen/BlueGreenInterimStatus.java | 1 + .../ClusterAwareWriterFailoverHandler.java | 1 + .../failover/FailoverConnectionPlugin.java | 1 + .../failover2/FailoverConnectionPlugin.java | 1 + .../limitless/LimitlessRouterMonitor.java | 1 + .../ReadWriteSplittingPlugin.java | 1 + .../plugin/staledns/AuroraStaleDnsHelper.java | 1 + 17 files changed, 32 insertions(+), 47 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 9828a2d25..078626d5b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -48,6 +48,7 @@ import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index cd6738b1a..025818cfd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -54,6 +54,7 @@ import software.amazon.jdbc.states.SessionStateServiceImpl; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 7ac08fc61..15ac76ad1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -44,11 +44,8 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzC + " table_schema = 'mysql' AND table_name = 'rds_topology'"; protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - // This query returns both instanceId and instanceName. - // For example: "1845128080", "test-multiaz-instance-1" - private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" - + " FROM mysql.rds_topology" - + " WHERE id = @@server_id"; + protected static final String INSTANCE_ID_QUERY = + "SELECT SUBSTRING_INDEX(endpoint, '.', 1) FROM mysql.rds_topology WHERE id = @@server_id"; // For reader instances, this query returns a writer instance ID. For a writer instance, this query returns no data. protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; protected static final String WRITER_ID_QUERY_COLUMN_NAME = "Source_Server_Id"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 6750a3efd..958240032 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -38,9 +38,7 @@ public class MultiAzClusterPgDialect extends PgDialect implements MultiAzCluster protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - // This query returns both instanceId and instanceName. - // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" - private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + protected static final String INSTANCE_ID_QUERY = "SELECT SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java index f62415ff9..6661a997f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -90,6 +90,6 @@ protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec i // Calculate weight based on instance lag in time and CPU utilization. final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); + return createHost(hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index e08d5877a..3e64e19fe 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -111,8 +111,8 @@ protected HostSpec createHost( "GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); } - return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, - instanceTemplate); + return createHost( + hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); } public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 2ba81b980..6170b391c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -82,7 +82,6 @@ public boolean isWriterInstance(final Connection connection) throws SQLException return false; } - protected @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { @@ -114,10 +113,8 @@ protected HostSpec createHost( String endpoint = rs.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - String hostId = rs.getString("id"); // "1034958454" - final boolean isWriter = hostId.equals(writerId); + final boolean isWriter = instanceName.equals(writerId); - return createHost( - hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); + return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 4bd523e39..2b09f5acd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -310,8 +310,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { init(); try { - Pair instanceIds = this.topologyUtils.getInstanceId(connection); - if (instanceIds == null) { + String instanceId = this.topologyUtils.getInstanceId(connection); + if (instanceId == null) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } @@ -326,10 +326,9 @@ public HostRole getHostRole(Connection conn) throws SQLException { return null; } - String instanceName = instanceIds.getValue2(); HostSpec foundHost = topology .stream() - .filter(host -> Objects.equals(instanceName, host.getHostId())) + .filter(host -> Objects.equals(instanceId, host.getHostId())) .findAny() .orElse(null); @@ -341,7 +340,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { foundHost = topology .stream() - .filter(host -> Objects.equals(instanceName, host.getHostId())) + .filter(host -> Objects.equals(instanceId, host.getHostId())) .findAny() .orElse(null); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index b5a838bd1..a7053c2fe 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -126,14 +126,13 @@ protected int setNetworkTimeout(Connection conn) { public HostSpec createHost( String instanceId, - String instanceName, final boolean isWriter, final long weight, final Timestamp lastUpdateTime, final HostSpec initialHostSpec, final HostSpec instanceTemplate) { - instanceName = instanceName == null ? "?" : instanceName; - final String endpoint = instanceTemplate.getHost().replace("?", instanceName); + instanceId = instanceId == null ? "?" : instanceId; + final String endpoint = instanceTemplate.getHost().replace("?", instanceId); final int port = instanceTemplate.isPortSpecified() ? instanceTemplate.getPort() : initialHostSpec.getPort(); @@ -147,28 +146,17 @@ public HostSpec createHost( .weight(weight) .lastUpdateTime(lastUpdateTime) .build(); - hostSpec.addAlias(instanceName); - hostSpec.setHostId(instanceName); + hostSpec.addAlias(instanceId); + hostSpec.setHostId(instanceId); return hostSpec; } - /** - * Identifies instances across different database types using instanceId and instanceName values. - * - *

Database types handle these identifiers differently: - * - Aurora: Uses the instance name as both instanceId and instanceName - * Example: "test-instance-1" for both values - * - RDS Cluster: Uses distinct values for instanceId and instanceName - * Example: - * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" - * instanceName: "test-multiaz-instance-1" - */ - public @Nullable Pair getInstanceId(final Connection connection) { + public @Nullable String getInstanceId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { if (rs.next()) { - return Pair.create(rs.getString(1), rs.getString(2)); + return rs.getString(1); } } } catch (SQLException ex) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 1c0f481f6..169aaa058 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -44,7 +44,6 @@ import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.ServiceUtility; @@ -512,11 +511,11 @@ protected List openAnyConnectionAndUpdateTopology() { "ClusterTopologyMonitorImpl.writerMonitoringConnection", new Object[] {this.writerHostSpec.get().getHost()})); } else { - final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); - if (pair != null) { - HostSpec instanceTemplate = this.getinstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); - HostSpec writerHost = this.topologyUtils.createHost( - pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, instanceTemplate); + final String instanceId = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); + if (instanceId != null) { + HostSpec instanceTemplate = this.getinstanceTemplate(instanceId, this.monitoringConnection.get()); + HostSpec writerHost = + this.topologyUtils.createHost(instanceId, true, 0, null, this.initialHostSpec, instanceTemplate); this.writerHostSpec.set(writerHost); LOGGER.finest(Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", @@ -671,7 +670,6 @@ public void run() { } if (connection != null) { - boolean isWriter = false; try { isWriter = this.monitor.topologyUtils.isWriterInstance(connection); @@ -680,7 +678,6 @@ public void run() { "NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); throw new RuntimeException(ex); - } catch (SQLException ex) { this.monitor.closeConnection(connection); connection = null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java index 622bc2eb0..3e2558839 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java @@ -23,6 +23,7 @@ import java.util.Set; import java.util.stream.Collectors; import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 1412d47e1..a6eafd1d3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -37,6 +37,7 @@ import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.ServiceUtility; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 3c830d75d..0eb2d9baa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -47,6 +47,7 @@ import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 9e78c82e9..3c4e109a8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -47,6 +47,7 @@ import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java index ec350aab6..8c28b97b6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java @@ -26,6 +26,7 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index b44a2c927..6fff83f53 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -40,6 +40,7 @@ import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlState; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index f1d7b9114..a54e345d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -31,6 +31,7 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.HostListProviderService; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; From 9ca3948d5d3cc774d3f69f87cb817a928af14534 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 16:41:21 -0800 Subject: [PATCH 44/90] Unit tests passing --- .../RdsHostListProviderTest.java | 526 +++++++++--------- 1 file changed, 262 insertions(+), 264 deletions(-) diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 29e0b55ca..a5b9f2fcb 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -1,264 +1,262 @@ -// /* -// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// * -// * Licensed under the Apache License, Version 2.0 (the "License"). -// * You may not use this file except in compliance with the License. -// * You may obtain a copy of the License at -// * -// * http://www.apache.org/licenses/LICENSE-2.0 -// * -// * Unless required by applicable law or agreed to in writing, software -// * distributed under the License is distributed on an "AS IS" BASIS, -// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// * See the License for the specific language governing permissions and -// * limitations under the License. -// */ -// -// package software.amazon.jdbc.hostlistprovider; -// -// import static org.junit.jupiter.api.Assertions.assertEquals; -// import static org.junit.jupiter.api.Assertions.assertNotNull; -// import static org.junit.jupiter.api.Assertions.assertNull; -// import static org.junit.jupiter.api.Assertions.assertThrows; -// import static org.mockito.ArgumentMatchers.any; -// import static org.mockito.ArgumentMatchers.eq; -// import static org.mockito.Mockito.atMostOnce; -// import static org.mockito.Mockito.doReturn; -// import static org.mockito.Mockito.never; -// import static org.mockito.Mockito.times; -// import static org.mockito.Mockito.verify; -// import static org.mockito.Mockito.when; -// -// import java.sql.Connection; -// import java.sql.SQLException; -// import java.util.ArrayList; -// import java.util.Arrays; -// import java.util.Collections; -// import java.util.List; -// import java.util.Properties; -// import org.junit.jupiter.api.AfterEach; -// import org.junit.jupiter.api.BeforeEach; -// import org.junit.jupiter.api.Test; -// import org.mockito.ArgumentCaptor; -// import org.mockito.Captor; -// import org.mockito.Mock; -// import org.mockito.Mockito; -// import org.mockito.MockitoAnnotations; -// import software.amazon.jdbc.HostRole; -// import software.amazon.jdbc.HostSpec; -// import software.amazon.jdbc.HostSpecBuilder; -// import software.amazon.jdbc.PluginService; -// import software.amazon.jdbc.dialect.TopologyDialect; -// import software.amazon.jdbc.hostavailability.HostAvailability; -// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -// import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -// import software.amazon.jdbc.util.FullServicesContainer; -// import software.amazon.jdbc.util.events.EventPublisher; -// import software.amazon.jdbc.util.storage.StorageService; -// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; -// -// class RdsHostListProviderTest { -// private StorageService storageService; -// private RdsHostListProvider rdsHostListProvider; -// -// @Mock private Connection mockConnection; -// @Mock private FullServicesContainer mockServicesContainer; -// @Mock private PluginService mockPluginService; -// @Mock private HostListProviderService mockHostListProviderService; -// @Mock private HostSpecBuilder mockHostSpecBuilder; -// @Mock private EventPublisher mockEventPublisher; -// @Mock private TopologyUtils mockTopologyUtils; -// @Mock private TopologyDialect mockDialect; -// @Captor private ArgumentCaptor queryCaptor; -// -// private AutoCloseable closeable; -// private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("foo").port(1234).build(); -// private final List hosts = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); -// -// @BeforeEach -// void setUp() throws SQLException { -// closeable = MockitoAnnotations.openMocks(this); -// storageService = new TestStorageServiceImpl(mockEventPublisher); -// when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); -// when(mockServicesContainer.getStorageService()).thenReturn(storageService); -// when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); -// when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); -// when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); -// when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); -// when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); -// when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); -// when(mockHostListProviderService.getHostSpecBuilder()) -// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); -// when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); -// } -// -// @AfterEach -// void tearDown() throws Exception { -// storageService.clearAll(); -// closeable.close(); -// } -// -// private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { -// RdsHostListProvider provider = new RdsHostListProvider( -// mockDialect, new Properties(), originalUrl, mockServicesContainer, mockTopologyUtils); -// provider.init(); -// return provider; -// } -// -// @Test -// void testGetTopology_returnCachedTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); -// assertEquals(expected, result.hosts); -// assertEquals(2, result.hosts.size()); -// verify(rdsHostListProvider, never()).queryForTopology(mockConnection); -// } -// -// @Test -// void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.isInitialized = true; -// -// storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); -// -// final List newHosts = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); -// doReturn(newHosts).when(mockTopologyUtils).queryForTopology(eq(mockConnection), any(HostSpec.class)); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertEquals(1, result.hosts.size()); -// assertEquals(newHosts, result.hosts); -// } -// -// @Test -// void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.clusterId = "cluster-id"; -// rdsHostListProvider.isInitialized = true; -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertEquals(2, result.hosts.size()); -// assertEquals(expected, result.hosts); -// } -// -// @Test -// void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.clear(); -// -// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertNotNull(result.hosts); -// assertEquals( -// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), -// result.hosts); -// } -// -// @Test -// void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { -// final List expectedMySQL = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) -// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); -// final List expectedPostgres = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) -// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); -// when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class))).thenReturn(expectedMySQL).thenReturn(expectedPostgres); -// -// -// rdsHostListProvider = getRdsHostListProvider("mysql://url/"); -// -// List hosts = rdsHostListProvider.queryForTopology(mockConnection); -// assertEquals(expectedMySQL, hosts); -// -// rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); -// hosts = rdsHostListProvider.queryForTopology(mockConnection); -// assertEquals(expectedPostgres, hosts); -// } -// -// @Test -// void testGetCachedTopology_returnStoredTopology() throws SQLException { -// rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// final List result = rdsHostListProvider.getStoredTopology(); -// assertEquals(expected, result); -// } -// -// @Test -// void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// -// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); -// -// when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); -// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionNullTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("?.pattern").build(); -// -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); -// doReturn(null).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionHostNotInTopology() throws SQLException { -// final List cachedTopology = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") -// .port(HostSpec.NO_PORT) -// .role(HostRole.WRITER) -// .build()); -// -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); -// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionHostInTopology() throws SQLException { -// final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") -// .port(HostSpec.NO_PORT) -// .role(HostRole.WRITER) -// .build(); -// expectedHost.setHostId("instance-a-1"); -// final List cachedTopology = Collections.singletonList(expectedHost); -// -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); -// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); -// assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); -// assertEquals("instance-a-1", actual.getHostId()); -// } -// } +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.atMostOnce; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.events.EventPublisher; +import software.amazon.jdbc.util.storage.StorageService; +import software.amazon.jdbc.util.storage.TestStorageServiceImpl; + +class RdsHostListProviderTest { + private StorageService storageService; + private RdsHostListProvider rdsHostListProvider; + + @Mock private Connection mockConnection; + @Mock private FullServicesContainer mockServicesContainer; + @Mock private PluginService mockPluginService; + @Mock private HostListProviderService mockHostListProviderService; + @Mock private HostSpecBuilder mockHostSpecBuilder; + @Mock private EventPublisher mockEventPublisher; + @Mock private TopologyUtils mockTopologyUtils; + @Mock private TopologyDialect mockDialect; + + private AutoCloseable closeable; + private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("foo").port(1234).build(); + private final List hosts = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); + + @BeforeEach + void setUp() throws SQLException { + closeable = MockitoAnnotations.openMocks(this); + storageService = new TestStorageServiceImpl(mockEventPublisher); + when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); + when(mockServicesContainer.getStorageService()).thenReturn(storageService); + when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); + when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); + when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); + when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); + when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); + when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); + when(mockHostListProviderService.getHostSpecBuilder()) + .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); + } + + @AfterEach + void tearDown() throws Exception { + storageService.clearAll(); + closeable.close(); + } + + private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { + RdsHostListProvider provider = new RdsHostListProvider( + mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); + provider.init(); + return provider; + } + + @Test + void testGetTopology_returnCachedTopology() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); + assertEquals(expected, result.hosts); + assertEquals(2, result.hosts.size()); + verify(rdsHostListProvider, never()).queryForTopology(mockConnection); + } + + @Test + void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + rdsHostListProvider.isInitialized = true; + + storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); + + final List newHosts = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); + doReturn(newHosts).when(mockTopologyUtils).queryForTopology( + eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); + assertEquals(1, result.hosts.size()); + assertEquals(newHosts, result.hosts); + } + + @Test + void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + rdsHostListProvider.clusterId = "cluster-id"; + rdsHostListProvider.isInitialized = true; + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); + assertEquals(2, result.hosts.size()); + assertEquals(expected, result.hosts); + } + + @Test + void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + rdsHostListProvider.clear(); + + doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); + assertNotNull(result.hosts); + assertEquals( + Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), + result.hosts); + } + + @Test + void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { + final List expectedMySQL = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) + .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); + final List expectedPostgres = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) + .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); + when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class), any(HostSpec.class))) + .thenReturn(expectedMySQL).thenReturn(expectedPostgres); + + + rdsHostListProvider = getRdsHostListProvider("mysql://url/"); + + List hosts = rdsHostListProvider.queryForTopology(mockConnection); + assertEquals(expectedMySQL, hosts); + + rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); + hosts = rdsHostListProvider.queryForTopology(mockConnection); + assertEquals(expectedPostgres, hosts); + } + + @Test + void testGetCachedTopology_returnStoredTopology() throws SQLException { + rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + final List result = rdsHostListProvider.getStoredTopology(); + assertEquals(expected, result); + } + + @Test + void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + + assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); + + when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); + assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionNullTopology() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + rdsHostListProvider.instanceTemplate = + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); + + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); + doReturn(null).when(rdsHostListProvider).refresh(mockConnection); + doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); + + assertNull(rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionHostNotInTopology() throws SQLException { + final List cachedTopology = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") + .port(HostSpec.NO_PORT) + .role(HostRole.WRITER) + .build()); + + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); + doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); + doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); + + assertNull(rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionHostInTopology() throws SQLException { + final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") + .port(HostSpec.NO_PORT) + .role(HostRole.WRITER) + .build(); + expectedHost.setHostId("instance-a-1"); + final List cachedTopology = Collections.singletonList(expectedHost); + + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); + doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); + doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); + + final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); + assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); + assertEquals("instance-a-1", actual.getHostId()); + } +} From 2e154f8af4ff11bae4667a252403364bd0f050ed Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 17:11:10 -0800 Subject: [PATCH 45/90] Cleanup --- docs/development-guide/IntegrationTests.md | 12 ----------- .../software/amazon/jdbc/util/RdsUtils.java | 21 +++++++++---------- 2 files changed, 10 insertions(+), 23 deletions(-) diff --git a/docs/development-guide/IntegrationTests.md b/docs/development-guide/IntegrationTests.md index 2dec6b0b1..62cf5168f 100644 --- a/docs/development-guide/IntegrationTests.md +++ b/docs/development-guide/IntegrationTests.md @@ -69,15 +69,3 @@ cmd /c ./gradlew --no-parallel --no-daemon test-all-environments ``` Test results can be found at `wrapper/build/report/index.html`. - -If you encounter unexplained build issues/errors, or after major project structure changes, try running the following to perform a clean build: - -macOS: -```bash -./gradlew clean -``` - -Windows: -```bash -cmd /c ./gradlew clean -``` diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java index c1eec6545..1331e6dc4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java @@ -93,7 +93,7 @@ public class RdsUtils { "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.(rds|rds-fips)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", + + "\\.rds\\.amazonaws\\.com\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_CLUSTER_PATTERN = @@ -101,21 +101,20 @@ public class RdsUtils { "^(?.+)\\." + "(?cluster-|cluster-ro-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.(rds|rds-fips)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", + + "\\.rds\\.amazonaws\\.com\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_LIMITLESS_CLUSTER_PATTERN = Pattern.compile( "(?.+)\\." + "(?shardgrp-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.(rds|rds-fips)\\.(amazonaws\\.com\\.?|amazonaws\\.eu\\.?|amazonaws\\.au\\.?|amazonaws\\.uk\\.?" - + "|amazonaws\\.com\\.cn\\.?|sc2s\\.sgov\\.gov\\.?|c2s\\.ic\\.gov\\.?))$", + + "\\.rds\\.(amazonaws\\.com\\.?|amazonaws\\.com\\.cn\\.?|sc2s\\.sgov\\.gov\\.?|c2s\\.ic\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_CHINA_DNS_PATTERN = Pattern.compile( "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" - + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + "\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); @@ -123,7 +122,7 @@ public class RdsUtils { Pattern.compile( "^(?.+)\\." + "(?cluster-|cluster-ro-)+" - + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + "\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); @@ -132,7 +131,7 @@ public class RdsUtils { "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.(rds|rds-fips)\\.amazonaws\\.com\\.cn\\.?)$", + + "\\.rds\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_OLD_CHINA_CLUSTER_PATTERN = @@ -140,14 +139,14 @@ public class RdsUtils { "^(?.+)\\." + "(?cluster-|cluster-ro-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.(rds|rds-fips)\\.amazonaws\\.com\\.cn\\.?)$", + + "\\.rds\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_GOV_DNS_PATTERN = Pattern.compile( "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" - + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + "\\.(amazonaws\\.com\\.?|c2s\\.ic\\.gov\\.?|sc2s\\.sgov\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); @@ -155,14 +154,14 @@ public class RdsUtils { Pattern.compile( "^(?.+)\\." + "(?cluster-|cluster-ro-)+" - + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + "\\.(amazonaws\\.com\\.?|c2s\\.ic\\.gov\\.?|sc2s\\.sgov\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); private static final Pattern ELB_PATTERN = Pattern.compile( "^(?.+)\\.elb\\." - + "((?[a-zA-Z0-9\\-]+)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", + + "((?[a-zA-Z0-9\\-]+)\\.amazonaws\\.com\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern IP_V4 = From f89056911c1071bd68bf68d5692f9fa53915b8bb Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 5 Nov 2025 18:27:05 -0800 Subject: [PATCH 46/90] Update javadocs --- .../amazon/jdbc/dialect/DialectUtils.java | 8 +++ .../GlobalAuroraTopologyUtils.java | 6 +-- .../jdbc/hostlistprovider/TopologyUtils.java | 52 +++++++++++++++++-- 3 files changed, 60 insertions(+), 6 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java index 79f3473b3..a09480cd7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java @@ -22,6 +22,14 @@ import java.sql.Statement; public class DialectUtils { + /** + * Given a series of existence queries, returns true if they all execute successfully and contain at least one record. + * Otherwise, returns false. + * + * @param conn the connection to use for executing the queries. + * @param existenceQueries the queries to check for existing records. + * @return true if all queries execute successfully and return at least one record, false otherwise. + */ public boolean checkExistenceQueries(Connection conn, String... existenceQueries) { for (String existenceQuery : existenceQueries) { try (Statement stmt = conn.createStatement(); ResultSet rs = stmt.executeQuery(existenceQuery)) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index 3e64e19fe..6dcd54b85 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -55,7 +55,7 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu public @Nullable List queryForTopology( Connection conn, HostSpec initialHostSpec, Map instanceTemplatesByRegion) throws SQLException { - int networkTimeout = setNetworkTimeout(conn); + int originalNetworkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { if (rs.getMetaData().getColumnCount() == 0) { @@ -68,8 +68,8 @@ public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBu } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); + if (originalNetworkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, originalNetworkTimeout); } } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index a7053c2fe..6208c3b9a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -39,6 +39,11 @@ import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.SynchronousExecutor; +/** + * An abstract class defining utility methods that can be used to retrieve and process a variety of database topology + * information. This class can be overridden to define logic specific to various database engine deployments + * (e.g. Aurora, Multi-AZ, Global Aurora etc.). + */ public abstract class TopologyUtils { private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); protected static final int DEFAULT_QUERY_TIMEOUT_MS = 1000; @@ -54,9 +59,19 @@ public TopologyUtils( this.hostSpecBuilder = hostSpecBuilder; } + /** + * Query the database for information for each instance in the database topology. + * + * @param conn the connection to use to query the database. + * @param initialHostSpec the {@link HostSpec} that was used to initially connect. + * @param instanceTemplate the template {@link HostSpec} to use when constructing new {@link HostSpec} objects from + * the data returned by the topology query. + * @return a list of {@link HostSpec} objects representing the results of the topology query. + * @throws SQLException if an error occurs when executing the topology or processing the results. + */ public @Nullable List queryForTopology(Connection conn, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { - int networkTimeout = setNetworkTimeout(conn); + int originalNetworkTimeout = setNetworkTimeout(conn); try (final Statement stmt = conn.createStatement(); final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { if (rs.getMetaData().getColumnCount() == 0) { @@ -69,8 +84,8 @@ public TopologyUtils( } catch (final SQLSyntaxErrorException e) { throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); + if (originalNetworkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, originalNetworkTimeout); } } } @@ -124,6 +139,17 @@ protected int setNetworkTimeout(Connection conn) { return hosts; } + /** + * Creates a {@link HostSpec} from the given topology information. + * + * @param instanceId the database instance identifier, e.g. "mydb-instance-1". + * @param isWriter true if this is a writer instance, false for reader. + * @param weight the instance weight for load balancing. + * @param lastUpdateTime the timestamp of the last update to this instance's information. + * @param initialHostSpec the original host specification used for connecting. + * @param instanceTemplate the template used to construct the new {@link HostSpec}. + * @return a {@link HostSpec} representing the given information. + */ public HostSpec createHost( String instanceId, final boolean isWriter, @@ -151,6 +177,12 @@ public HostSpec createHost( return hostSpec; } + /** + * Get the instance ID of the current connection. + * + * @param connection the connection to use to query the database. + * @return the instance ID of the current connection. + */ public @Nullable String getInstanceId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); @@ -166,8 +198,22 @@ public HostSpec createHost( return null; } + /** + * Evaluate whether the given connection is to a writer instance. + * + * @param connection the connection to evaluate. + * @return true if the connection is to a writer instance, false otherwise. + * @throws SQLException if an exception occurs when querying the database or processing the database response. + */ public abstract boolean isWriterInstance(Connection connection) throws SQLException; + /** + * Evaluate the database role of the given connection, either {@link HostRole#WRITER} or {@link HostRole#READER}. + * + * @param conn the connection to evaluate. + * @return the database role of the given connection. + * @throws SQLException if an exception occurs when querying the database or processing the database response. + */ public HostRole getHostRole(Connection conn) throws SQLException { try (final Statement stmt = conn.createStatement(); final ResultSet rs = stmt.executeQuery(this.dialect.getIsReaderQuery())) { From 56aa05919f6904b7c907a9cd9e25355bb30e914d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:03:03 -0800 Subject: [PATCH 47/90] Revert "Change getInstanceId return value from Pair to String" This reverts commit e57bf03435ef2fb037f5ba93e5615dd1633dc7a1. --- .../amazon/jdbc/PartialPluginService.java | 1 - .../amazon/jdbc/PluginServiceImpl.java | 1 - .../dialect/MultiAzClusterMysqlDialect.java | 7 ++++-- .../jdbc/dialect/MultiAzClusterPgDialect.java | 4 +++- .../hostlistprovider/AuroraTopologyUtils.java | 2 +- .../GlobalAuroraTopologyUtils.java | 4 ++-- .../MultiAzTopologyUtils.java | 7 ++++-- .../hostlistprovider/RdsHostListProvider.java | 9 +++---- .../jdbc/hostlistprovider/TopologyUtils.java | 24 ++++++++++++------- .../ClusterTopologyMonitorImpl.java | 13 ++++++---- .../bluegreen/BlueGreenInterimStatus.java | 1 - .../ClusterAwareWriterFailoverHandler.java | 1 - .../failover/FailoverConnectionPlugin.java | 1 - .../failover2/FailoverConnectionPlugin.java | 1 - .../limitless/LimitlessRouterMonitor.java | 1 - .../ReadWriteSplittingPlugin.java | 1 - .../plugin/staledns/AuroraStaleDnsHelper.java | 1 - 17 files changed, 44 insertions(+), 35 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 078626d5b..9828a2d25 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -48,7 +48,6 @@ import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 025818cfd..cd6738b1a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -54,7 +54,6 @@ import software.amazon.jdbc.states.SessionStateServiceImpl; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 15ac76ad1..7ac08fc61 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -44,8 +44,11 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzC + " table_schema = 'mysql' AND table_name = 'rds_topology'"; protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - protected static final String INSTANCE_ID_QUERY = - "SELECT SUBSTRING_INDEX(endpoint, '.', 1) FROM mysql.rds_topology WHERE id = @@server_id"; + // This query returns both instanceId and instanceName. + // For example: "1845128080", "test-multiaz-instance-1" + private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + + " FROM mysql.rds_topology" + + " WHERE id = @@server_id"; // For reader instances, this query returns a writer instance ID. For a writer instance, this query returns no data. protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; protected static final String WRITER_ID_QUERY_COLUMN_NAME = "Source_Server_Id"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 958240032..6750a3efd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -38,7 +38,9 @@ public class MultiAzClusterPgDialect extends PgDialect implements MultiAzCluster protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - protected static final String INSTANCE_ID_QUERY = "SELECT SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + // This query returns both instanceId and instanceName. + // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" + private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java index 6661a997f..f62415ff9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -90,6 +90,6 @@ protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec i // Calculate weight based on instance lag in time and CPU utilization. final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); - return createHost(hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); + return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index 6dcd54b85..1f8675339 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -111,8 +111,8 @@ protected HostSpec createHost( "GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); } - return createHost( - hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); + return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, + instanceTemplate); } public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 6170b391c..2ba81b980 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -82,6 +82,7 @@ public boolean isWriterInstance(final Connection connection) throws SQLException return false; } + protected @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { @@ -113,8 +114,10 @@ protected HostSpec createHost( String endpoint = rs.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - final boolean isWriter = instanceName.equals(writerId); + String hostId = rs.getString("id"); // "1034958454" + final boolean isWriter = hostId.equals(writerId); - return createHost(instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); + return createHost( + hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 2b09f5acd..4bd523e39 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -310,8 +310,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { init(); try { - String instanceId = this.topologyUtils.getInstanceId(connection); - if (instanceId == null) { + Pair instanceIds = this.topologyUtils.getInstanceId(connection); + if (instanceIds == null) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } @@ -326,9 +326,10 @@ public HostRole getHostRole(Connection conn) throws SQLException { return null; } + String instanceName = instanceIds.getValue2(); HostSpec foundHost = topology .stream() - .filter(host -> Objects.equals(instanceId, host.getHostId())) + .filter(host -> Objects.equals(instanceName, host.getHostId())) .findAny() .orElse(null); @@ -340,7 +341,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { foundHost = topology .stream() - .filter(host -> Objects.equals(instanceId, host.getHostId())) + .filter(host -> Objects.equals(instanceName, host.getHostId())) .findAny() .orElse(null); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index 6208c3b9a..d24f291b6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -152,13 +152,14 @@ protected int setNetworkTimeout(Connection conn) { */ public HostSpec createHost( String instanceId, + String instanceName, final boolean isWriter, final long weight, final Timestamp lastUpdateTime, final HostSpec initialHostSpec, final HostSpec instanceTemplate) { - instanceId = instanceId == null ? "?" : instanceId; - final String endpoint = instanceTemplate.getHost().replace("?", instanceId); + instanceName = instanceName == null ? "?" : instanceName; + final String endpoint = instanceTemplate.getHost().replace("?", instanceName); final int port = instanceTemplate.isPortSpecified() ? instanceTemplate.getPort() : initialHostSpec.getPort(); @@ -172,23 +173,28 @@ public HostSpec createHost( .weight(weight) .lastUpdateTime(lastUpdateTime) .build(); - hostSpec.addAlias(instanceId); - hostSpec.setHostId(instanceId); + hostSpec.addAlias(instanceName); + hostSpec.setHostId(instanceName); return hostSpec; } /** - * Get the instance ID of the current connection. + * Identifies instances across different database types using instanceId and instanceName values. * - * @param connection the connection to use to query the database. - * @return the instance ID of the current connection. + *

Database types handle these identifiers differently: + * - Aurora: Uses the instance name as both instanceId and instanceName + * Example: "test-instance-1" for both values + * - RDS Cluster: Uses distinct values for instanceId and instanceName + * Example: + * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" + * instanceName: "test-multiaz-instance-1" */ - public @Nullable String getInstanceId(final Connection connection) { + public @Nullable Pair getInstanceId(final Connection connection) { try { try (final Statement stmt = connection.createStatement(); final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { if (rs.next()) { - return rs.getString(1); + return Pair.create(rs.getString(1), rs.getString(2)); } } } catch (SQLException ex) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 169aaa058..1c0f481f6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -44,6 +44,7 @@ import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.ServiceUtility; @@ -511,11 +512,11 @@ protected List openAnyConnectionAndUpdateTopology() { "ClusterTopologyMonitorImpl.writerMonitoringConnection", new Object[] {this.writerHostSpec.get().getHost()})); } else { - final String instanceId = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); - if (instanceId != null) { - HostSpec instanceTemplate = this.getinstanceTemplate(instanceId, this.monitoringConnection.get()); - HostSpec writerHost = - this.topologyUtils.createHost(instanceId, true, 0, null, this.initialHostSpec, instanceTemplate); + final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); + if (pair != null) { + HostSpec instanceTemplate = this.getinstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); + HostSpec writerHost = this.topologyUtils.createHost( + pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, instanceTemplate); this.writerHostSpec.set(writerHost); LOGGER.finest(Messages.get( "ClusterTopologyMonitorImpl.writerMonitoringConnection", @@ -670,6 +671,7 @@ public void run() { } if (connection != null) { + boolean isWriter = false; try { isWriter = this.monitor.topologyUtils.isWriterInstance(connection); @@ -678,6 +680,7 @@ public void run() { "NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); throw new RuntimeException(ex); + } catch (SQLException ex) { this.monitor.closeConnection(connection); connection = null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java index 3e2558839..622bc2eb0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java @@ -23,7 +23,6 @@ import java.util.Set; import java.util.stream.Collectors; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index a6eafd1d3..1412d47e1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -37,7 +37,6 @@ import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.ServiceUtility; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 0eb2d9baa..3c830d75d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -47,7 +47,6 @@ import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 3c4e109a8..9e78c82e9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -47,7 +47,6 @@ import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java index 8c28b97b6..ec350aab6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java @@ -26,7 +26,6 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 6fff83f53..b44a2c927 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -40,7 +40,6 @@ import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlState; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index a54e345d5..f1d7b9114 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -31,7 +31,6 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.HostListProviderService; -import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; From cd09a2d229b910d2ff6754b8ca020317966bced3 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:14:07 -0800 Subject: [PATCH 48/90] cleanup --- .../java/software/amazon/jdbc/PartialPluginService.java | 1 + .../main/java/software/amazon/jdbc/PluginServiceImpl.java | 1 + .../amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java | 2 +- .../amazon/jdbc/dialect/MultiAzClusterPgDialect.java | 3 +-- .../jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java | 4 ++-- .../amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java | 1 - .../monitoring/ClusterTopologyMonitorImpl.java | 2 -- .../jdbc/plugin/bluegreen/BlueGreenInterimStatus.java | 2 +- .../plugin/failover/ClusterAwareWriterFailoverHandler.java | 1 + .../jdbc/plugin/failover/FailoverConnectionPlugin.java | 1 + .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 1 + .../jdbc/plugin/limitless/LimitlessRouterMonitor.java | 2 +- .../readwritesplitting/ReadWriteSplittingPlugin.java | 1 + .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 1 + .../jdbc/hostlistprovider/RdsHostListProviderTest.java | 7 ++++--- 15 files changed, 17 insertions(+), 13 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 9828a2d25..078626d5b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -48,6 +48,7 @@ import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index cd6738b1a..025818cfd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -54,6 +54,7 @@ import software.amazon.jdbc.states.SessionStateServiceImpl; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 7ac08fc61..9fe7d3b03 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -46,7 +46,7 @@ public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzC // This query returns both instanceId and instanceName. // For example: "1845128080", "test-multiaz-instance-1" - private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + protected static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + " FROM mysql.rds_topology" + " WHERE id = @@server_id"; // For reader instances, this query returns a writer instance ID. For a writer instance, this query returns no data. diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 6750a3efd..ece40baf8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -40,10 +40,9 @@ public class MultiAzClusterPgDialect extends PgDialect implements MultiAzCluster // This query returns both instanceId and instanceName. // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" - private static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + protected static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; - // For reader instances, this query should return a writer instance ID. // For a writer instance, this query should return no data. protected static final String WRITER_ID_QUERY = diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java index 1f8675339..4a5d5eeea 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -111,8 +111,8 @@ protected HostSpec createHost( "GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); } - return createHost(hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, - instanceTemplate); + return createHost( + hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); } public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 2ba81b980..1c3cc80b1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -82,7 +82,6 @@ public boolean isWriterInstance(final Connection connection) throws SQLException return false; } - protected @Nullable String getWriterId(Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 1c0f481f6..590d6d451 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -671,7 +671,6 @@ public void run() { } if (connection != null) { - boolean isWriter = false; try { isWriter = this.monitor.topologyUtils.isWriterInstance(connection); @@ -680,7 +679,6 @@ public void run() { "NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); throw new RuntimeException(ex); - } catch (SQLException ex) { this.monitor.closeConnection(connection); connection = null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java index 622bc2eb0..4a49d57a6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java @@ -23,8 +23,8 @@ import java.util.Set; import java.util.stream.Collectors; import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.Utils; public class BlueGreenInterimStatus { public BlueGreenPhase blueGreenPhase; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 1412d47e1..a6eafd1d3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -37,6 +37,7 @@ import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.ServiceUtility; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 3c830d75d..0eb2d9baa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -47,6 +47,7 @@ import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 9e78c82e9..3c4e109a8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -47,6 +47,7 @@ import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java index ec350aab6..9264e1603 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java @@ -26,9 +26,9 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; -import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryContext; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index b44a2c927..6fff83f53 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -40,6 +40,7 @@ import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlState; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index f1d7b9114..a54e345d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -31,6 +31,7 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.HostListProviderService; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index a5b9f2fcb..7c15bc872 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -50,6 +50,7 @@ import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.events.EventPublisher; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.storage.TestStorageServiceImpl; @@ -216,7 +217,7 @@ void testIdentifyConnectionNullTopology() throws SQLException { rdsHostListProvider.instanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); doReturn(null).when(rdsHostListProvider).refresh(mockConnection); doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -233,7 +234,7 @@ void testIdentifyConnectionHostNotInTopology() throws SQLException { .build()); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -251,7 +252,7 @@ void testIdentifyConnectionHostInTopology() throws SQLException { final List cachedTopology = Collections.singletonList(expectedHost); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn("instance-a-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); From d0d49fe4bff105cd47c771dbccf6cc2a7269e0c7 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:50:03 -0800 Subject: [PATCH 49/90] Fix unit test --- .../software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java | 3 ++- .../amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index ece40baf8..ba3600710 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -40,7 +40,8 @@ public class MultiAzClusterPgDialect extends PgDialect implements MultiAzCluster // This query returns both instanceId and instanceName. // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" - protected static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + protected static final String INSTANCE_ID_QUERY = + "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; // For reader instances, this query should return a writer instance ID. diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 7c15bc872..991c0734b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -252,7 +252,7 @@ void testIdentifyConnectionHostInTopology() throws SQLException { final List cachedTopology = Collections.singletonList(expectedHost); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); From 274ca5557db208327e66c7ca4342be0f21e8c57f Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:50:17 -0800 Subject: [PATCH 50/90] Revert "ci: scope down GitHub Token permissions (#1571)" This reverts commit 8babd96b234c9538b88d3a75b35cbf915a19f0a3. --- .github/workflows/main.yml | 3 --- .github/workflows/maven_release.yml | 3 --- .github/workflows/maven_snapshot.yml | 3 --- .github/workflows/remove-old-artifacts.yml | 3 --- .github/workflows/run-hibernate-orm-tests.yml | 3 --- .github/workflows/run-standard-integration-tests.yml | 3 --- 6 files changed, 18 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 5d780649a..d0325b382 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -16,9 +16,6 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true -permissions: - contents: read - jobs: markdown-link-check: runs-on: ubuntu-latest diff --git a/.github/workflows/maven_release.yml b/.github/workflows/maven_release.yml index fa4d699a0..c5ad886ff 100644 --- a/.github/workflows/maven_release.yml +++ b/.github/workflows/maven_release.yml @@ -5,9 +5,6 @@ on: types: - published -permissions: - contents: read - jobs: ubuntu-latest-jdbc-wrapper-release-to-maven: name: 'Build And Release to Maven' diff --git a/.github/workflows/maven_snapshot.yml b/.github/workflows/maven_snapshot.yml index cde9b6337..fda0edcd3 100644 --- a/.github/workflows/maven_snapshot.yml +++ b/.github/workflows/maven_snapshot.yml @@ -6,9 +6,6 @@ on: - main workflow_dispatch: -permissions: - contents: read - jobs: ubuntu-latest-jdbc-wrapper-snapshot-to-maven: name: 'Build And Upload Snapshot to Maven' diff --git a/.github/workflows/remove-old-artifacts.yml b/.github/workflows/remove-old-artifacts.yml index 0a1d96058..60e2408d3 100644 --- a/.github/workflows/remove-old-artifacts.yml +++ b/.github/workflows/remove-old-artifacts.yml @@ -5,9 +5,6 @@ on: # Every day at 1am - cron: '0 1 * * *' -permissions: - actions: write - jobs: remove-old-artifacts: runs-on: ubuntu-latest diff --git a/.github/workflows/run-hibernate-orm-tests.yml b/.github/workflows/run-hibernate-orm-tests.yml index e1138a27f..c6fc6d948 100644 --- a/.github/workflows/run-hibernate-orm-tests.yml +++ b/.github/workflows/run-hibernate-orm-tests.yml @@ -6,9 +6,6 @@ on: branches: - main -permissions: - contents: read - jobs: hibernate-integration-tests: name: 'Run Hibernate ORM integration tests' diff --git a/.github/workflows/run-standard-integration-tests.yml b/.github/workflows/run-standard-integration-tests.yml index 43309463f..1471e55da 100644 --- a/.github/workflows/run-standard-integration-tests.yml +++ b/.github/workflows/run-standard-integration-tests.yml @@ -12,9 +12,6 @@ on: - '**/release_draft.yml' - '**/maven*.yml' -permissions: - contents: read - jobs: standard-integration-tests: name: 'Run standard container integration tests' From 5b748ade9e1027fbdd4c5236006e7fbdc3656b19 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:51:07 -0800 Subject: [PATCH 51/90] Revert "add support of the following domains: eu, au, uk (#1587)" This reverts commit 54aa6324a2373e745e1a41823b20ad2109fdcb4e. --- .../software/amazon/jdbc/util/RdsUtilsTests.java | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java index a0b5090ab..9938dc2e6 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java @@ -44,9 +44,6 @@ public class RdsUtilsTests { private static final String usEastRegionLimitlessDbShardGroup = "database-test-name.shardgrp-XYZ.us-east-2.rds.amazonaws.com"; - private static final String euRedshift = - "redshift-test-name.XYZ.eusc-de-east-1.rds.amazonaws.eu"; - private static final String chinaRegionCluster = "database-test-name.cluster-XYZ.rds.cn-northwest-1.amazonaws.com.cn"; private static final String chinaRegionClusterTrailingDot = @@ -142,7 +139,6 @@ public void testIsRdsDns() { assertFalse(target.isRdsDns(usEastRegionElbUrl)); assertFalse(target.isRdsDns(usEastRegionElbUrlTrailingDot)); assertTrue(target.isRdsDns(usEastRegionLimitlessDbShardGroup)); - assertTrue(target.isRdsDns(euRedshift)); assertTrue(target.isRdsDns(chinaRegionCluster)); assertTrue(target.isRdsDns(chinaRegionClusterTrailingDot)); @@ -220,9 +216,6 @@ public void testGetRdsInstanceHostPattern() { assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionProxy)); assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionCustomDomain)); assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionLimitlessDbShardGroup)); - - final String euRedshiftExpectedHostPattern = "?.XYZ.eusc-de-east-1.rds.amazonaws.eu"; - assertEquals(euRedshiftExpectedHostPattern, target.getRdsInstanceHostPattern(euRedshift)); } @Test @@ -235,7 +228,6 @@ public void testIsRdsClusterDns() { assertFalse(target.isRdsClusterDns(usEastRegionCustomDomain)); assertFalse(target.isRdsClusterDns(usEastRegionElbUrl)); assertFalse(target.isRdsClusterDns(usEastRegionLimitlessDbShardGroup)); - assertFalse(target.isRdsClusterDns(euRedshift)); assertTrue(target.isRdsClusterDns(usIsobEastRegionCluster)); assertTrue(target.isRdsClusterDns(usIsobEastRegionClusterReadOnly)); @@ -276,7 +268,6 @@ public void testIsWriterClusterDns() { assertFalse(target.isWriterClusterDns(usEastRegionCustomDomain)); assertFalse(target.isWriterClusterDns(usEastRegionElbUrl)); assertFalse(target.isWriterClusterDns(usEastRegionLimitlessDbShardGroup)); - assertFalse(target.isWriterClusterDns(euRedshift)); assertTrue(target.isWriterClusterDns(usIsobEastRegionCluster)); assertFalse(target.isWriterClusterDns(usIsobEastRegionClusterReadOnly)); @@ -317,7 +308,6 @@ public void testIsReaderClusterDns() { assertFalse(target.isReaderClusterDns(usEastRegionCustomDomain)); assertFalse(target.isReaderClusterDns(usEastRegionElbUrl)); assertFalse(target.isReaderClusterDns(usEastRegionLimitlessDbShardGroup)); - assertFalse(target.isReaderClusterDns(euRedshift)); assertFalse(target.isReaderClusterDns(usIsobEastRegionCluster)); assertTrue(target.isReaderClusterDns(usIsobEastRegionClusterReadOnly)); @@ -358,7 +348,6 @@ public void testIsLimitlessDbShardGroupDns() { assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionCustomDomain)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionElbUrl)); assertTrue(target.isLimitlessDbShardGroupDns(usEastRegionLimitlessDbShardGroup)); - assertFalse(target.isLimitlessDbShardGroupDns(euRedshift)); assertFalse(target.isLimitlessDbShardGroupDns(usIsobEastRegionCluster)); assertFalse(target.isLimitlessDbShardGroupDns(usIsobEastRegionClusterReadOnly)); @@ -434,9 +423,6 @@ public void testGetRdsRegion() { assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionProxy)); assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionCustomDomain)); assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionLimitlessDbShardGroup)); - - final String euRedshiftExpectedHostPattern = "eusc-de-east-1"; - assertEquals(euRedshiftExpectedHostPattern, target.getRdsRegion(euRedshift)); } @Test From b238463e7e65eb704ecd37c8110ebdfb3378b540 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 12:51:26 -0800 Subject: [PATCH 52/90] Revert "chore: fix standard integration tests (#1594)" This reverts commit 56b4476ce0ff67496b027ae2cd306f3f62a63659. --- wrapper/src/test/java/integration/host/TestEnvironment.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wrapper/src/test/java/integration/host/TestEnvironment.java b/wrapper/src/test/java/integration/host/TestEnvironment.java index 9fb6cac14..99fcd2985 100644 --- a/wrapper/src/test/java/integration/host/TestEnvironment.java +++ b/wrapper/src/test/java/integration/host/TestEnvironment.java @@ -1251,7 +1251,7 @@ private static void createTelemetryOtlpContainer(TestEnvironment env) { private static String getContainerBaseImageName(TestEnvironmentRequest request) { switch (request.getTargetJvm()) { case OPENJDK8: - return "amazoncorretto:8-alpine"; + return "openjdk:8-jdk-alpine"; case OPENJDK11: return "amazoncorretto:11.0.19-alpine3.17"; case OPENJDK17: From a460ec6dfcc80f800b7d02c57276dd5fe0b77ae6 Mon Sep 17 00:00:00 2001 From: Adnan Khan Date: Tue, 21 Oct 2025 18:20:12 -0400 Subject: [PATCH 53/90] ci: scope down GitHub Token permissions (#1571) --- .github/workflows/main.yml | 3 +++ .github/workflows/maven_release.yml | 3 +++ .github/workflows/maven_snapshot.yml | 3 +++ .github/workflows/remove-old-artifacts.yml | 3 +++ .github/workflows/run-hibernate-orm-tests.yml | 3 +++ .github/workflows/run-standard-integration-tests.yml | 3 +++ 6 files changed, 18 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d0325b382..5d780649a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -16,6 +16,9 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true +permissions: + contents: read + jobs: markdown-link-check: runs-on: ubuntu-latest diff --git a/.github/workflows/maven_release.yml b/.github/workflows/maven_release.yml index c5ad886ff..fa4d699a0 100644 --- a/.github/workflows/maven_release.yml +++ b/.github/workflows/maven_release.yml @@ -5,6 +5,9 @@ on: types: - published +permissions: + contents: read + jobs: ubuntu-latest-jdbc-wrapper-release-to-maven: name: 'Build And Release to Maven' diff --git a/.github/workflows/maven_snapshot.yml b/.github/workflows/maven_snapshot.yml index fda0edcd3..cde9b6337 100644 --- a/.github/workflows/maven_snapshot.yml +++ b/.github/workflows/maven_snapshot.yml @@ -6,6 +6,9 @@ on: - main workflow_dispatch: +permissions: + contents: read + jobs: ubuntu-latest-jdbc-wrapper-snapshot-to-maven: name: 'Build And Upload Snapshot to Maven' diff --git a/.github/workflows/remove-old-artifacts.yml b/.github/workflows/remove-old-artifacts.yml index 60e2408d3..0a1d96058 100644 --- a/.github/workflows/remove-old-artifacts.yml +++ b/.github/workflows/remove-old-artifacts.yml @@ -5,6 +5,9 @@ on: # Every day at 1am - cron: '0 1 * * *' +permissions: + actions: write + jobs: remove-old-artifacts: runs-on: ubuntu-latest diff --git a/.github/workflows/run-hibernate-orm-tests.yml b/.github/workflows/run-hibernate-orm-tests.yml index c6fc6d948..e1138a27f 100644 --- a/.github/workflows/run-hibernate-orm-tests.yml +++ b/.github/workflows/run-hibernate-orm-tests.yml @@ -6,6 +6,9 @@ on: branches: - main +permissions: + contents: read + jobs: hibernate-integration-tests: name: 'Run Hibernate ORM integration tests' diff --git a/.github/workflows/run-standard-integration-tests.yml b/.github/workflows/run-standard-integration-tests.yml index 1471e55da..43309463f 100644 --- a/.github/workflows/run-standard-integration-tests.yml +++ b/.github/workflows/run-standard-integration-tests.yml @@ -12,6 +12,9 @@ on: - '**/release_draft.yml' - '**/maven*.yml' +permissions: + contents: read + jobs: standard-integration-tests: name: 'Run standard container integration tests' From c0b3bd3383d6cad6b113f4020ff4baa2c02bdfe1 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:25:39 -0800 Subject: [PATCH 54/90] chore: fix standard integration tests (#1594) --- wrapper/src/test/java/integration/host/TestEnvironment.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wrapper/src/test/java/integration/host/TestEnvironment.java b/wrapper/src/test/java/integration/host/TestEnvironment.java index 99fcd2985..9fb6cac14 100644 --- a/wrapper/src/test/java/integration/host/TestEnvironment.java +++ b/wrapper/src/test/java/integration/host/TestEnvironment.java @@ -1251,7 +1251,7 @@ private static void createTelemetryOtlpContainer(TestEnvironment env) { private static String getContainerBaseImageName(TestEnvironmentRequest request) { switch (request.getTargetJvm()) { case OPENJDK8: - return "openjdk:8-jdk-alpine"; + return "amazoncorretto:8-alpine"; case OPENJDK11: return "amazoncorretto:11.0.19-alpine3.17"; case OPENJDK17: From fd26cd3fe0207e7cb3434c427ed4ae66ef3e21ed Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 14:18:29 -0800 Subject: [PATCH 55/90] Remove remaining calls to refresh/forceRefresh(Connection) --- .../java/software/amazon/jdbc/PartialPluginService.java | 6 ++++-- .../java/software/amazon/jdbc/PluginServiceImpl.java | 6 ++++-- .../jdbc/hostlistprovider/RdsHostListProvider.java | 9 ++++++--- .../monitoring/ClusterTopologyMonitorImpl.java | 3 +++ .../jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java | 3 ++- 5 files changed, 19 insertions(+), 8 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 078626d5b..027c75058 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -380,7 +380,8 @@ public void refreshHostList() throws SQLException { @Override public void refreshHostList(final Connection connection) throws SQLException { - final List updatedHostList = this.getHostListProvider().refresh(connection); + // TODO: refresh + final List updatedHostList = this.getHostListProvider().refresh(); if (!Objects.equals(updatedHostList, this.allHosts)) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); @@ -398,7 +399,8 @@ public void forceRefreshHostList() throws SQLException { @Override public void forceRefreshHostList(final Connection connection) throws SQLException { - final List updatedHostList = this.getHostListProvider().forceRefresh(connection); + // TODO: forceRefresh + final List updatedHostList = this.getHostListProvider().forceRefresh(); if (updatedHostList != null) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 4e2500013..f06578cab 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -497,7 +497,8 @@ public void refreshHostList() throws SQLException { @Override public void refreshHostList(final Connection connection) throws SQLException { - final List updatedHostList = this.getHostListProvider().refresh(connection); + // TODO: refresh + final List updatedHostList = this.getHostListProvider().refresh(); if (!Objects.equals(updatedHostList, this.allHosts)) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); @@ -515,7 +516,8 @@ public void forceRefreshHostList() throws SQLException { @Override public void forceRefreshHostList(final Connection connection) throws SQLException { - final List updatedHostList = this.getHostListProvider().forceRefresh(connection); + // TODO: forceRefresh + final List updatedHostList = this.getHostListProvider().forceRefresh(); if (updatedHostList != null) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 4bd523e39..74ddeede8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -315,10 +315,12 @@ public HostRole getHostRole(Connection conn) throws SQLException { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } - List topology = this.refresh(connection); + // TODO: refresh + List topology = this.refresh(); boolean isForcedRefresh = false; if (topology == null) { - topology = this.forceRefresh(connection); + // TODO: forceRefresh + topology = this.forceRefresh(); isForcedRefresh = true; } @@ -334,7 +336,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { .orElse(null); if (foundHost == null && !isForcedRefresh) { - topology = this.forceRefresh(connection); + // TODO: forceRefresh + topology = this.forceRefresh(); if (topology == null) { return null; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 590d6d451..99c8a8be2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -180,6 +180,8 @@ public List forceRefresh(@Nullable Connection connection, final long t } // Otherwise, use the provided unverified connection to update the topology. + // TODO: might need to get rid of this since we don't want to use unverified connections. Could wait for a verified + // connection if it isn't verified yet. return this.fetchTopologyAndUpdateCache(connection); } @@ -598,6 +600,7 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { if (connection == null) { return null; } + try { final List hosts = this.queryForTopology(connection); if (!Utils.isNullOrEmpty(hosts)) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 832e06056..db72b6391 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -332,7 +332,8 @@ protected void collectTopology() throws SQLException { if (conn == null || conn.isClosed()) { return; } - this.currentTopology.set(this.hostListProvider.forceRefresh(conn)); + // TODO: forceRefresh + this.currentTopology.set(this.hostListProvider.forceRefresh()); if (this.collectTopology.get()) { this.startTopology = this.currentTopology.get(); From fc7a868d7cb9d616fd7ed947c24d6c9c6aa611ce Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 14:34:58 -0800 Subject: [PATCH 56/90] wip --- .../ConnectionStringHostListProvider.java | 6 ---- .../hostlistprovider/HostListProvider.java | 2 -- .../hostlistprovider/RdsHostListProvider.java | 35 +++++++++---------- .../monitoring/ClusterTopologyMonitor.java | 5 --- .../ClusterTopologyMonitorImpl.java | 14 -------- 5 files changed, 17 insertions(+), 45 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 426ea3963..136fabd41 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -89,12 +89,6 @@ public List refresh() throws SQLException { return Collections.unmodifiableList(hostList); } - @Override - public List refresh(final Connection connection) throws SQLException { - init(); - return this.refresh(); - } - @Override public List forceRefresh() throws SQLException { init(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index 206a35415..8d9fdf5b5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -27,8 +27,6 @@ public interface HostListProvider { List refresh() throws SQLException; - List refresh(Connection connection) throws SQLException; - List forceRefresh() throws SQLException; List forceRefresh(Connection connection) throws SQLException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 74ddeede8..1b69efb20 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -162,26 +162,19 @@ protected void initSettings() throws SQLException { * cached copy of topology is returned if it's not yet outdated (controlled by {@link * #refreshRateNano}). * - * @param conn A connection to database to fetch the latest topology, if needed. * @param forceUpdate If true, it forces a service to ignore cached copy of topology and to fetch * a fresh one. * @return a list of hosts that describes cluster topology. A writer is always at position 0. * Returns an empty list if isn't available or is invalid (doesn't contain a writer). * @throws SQLException if errors occurred while retrieving the topology. */ - protected FetchTopologyResult getTopology(final Connection conn, final boolean forceUpdate) throws SQLException { + protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLException { init(); final List storedHosts = this.getStoredTopology(); if (storedHosts == null || forceUpdate) { // We need to re-fetch topology. - if (conn == null) { - // We cannot fetch the latest topology since we do not have access to a connection, so we return the original - // hosts parsed from the connection string. - return new FetchTopologyResult(false, this.initialHostList); - } - - final List hosts = this.queryForTopology(conn); + final List hosts = this.queryForTopology(); if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); return new FetchTopologyResult(false, hosts); @@ -228,23 +221,29 @@ public void clear() { @Override public List refresh() throws SQLException { - return this.refresh(null); - } - - @Override - public List refresh(final Connection connection) throws SQLException { init(); - final Connection currentConnection = connection != null - ? connection - : this.hostListProviderService.getCurrentConnection(); - final FetchTopologyResult results = getTopology(currentConnection, false); + final FetchTopologyResult results = getTopology(false); LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); this.hostList = results.hosts; return Collections.unmodifiableList(hostList); } + // @Override + // public List refresh(final Connection connection) throws SQLException { + // init(); + // final Connection currentConnection = connection != null + // ? connection + // : this.hostListProviderService.getCurrentConnection(); + // + // final FetchTopologyResult results = getTopology(currentConnection, false); + // LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); + // + // this.hostList = results.hosts; + // return Collections.unmodifiableList(hostList); + // } + @Override public List forceRefresh() throws SQLException { return this.forceRefresh(null); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java index 3ec9a9a87..deb5d3c31 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java @@ -16,11 +16,9 @@ package software.amazon.jdbc.hostlistprovider.monitoring; -import java.sql.Connection; import java.sql.SQLException; import java.util.List; import java.util.concurrent.TimeoutException; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.monitoring.Monitor; @@ -30,7 +28,4 @@ public interface ClusterTopologyMonitor extends Monitor { List forceRefresh(final boolean writerImportant, final long timeoutMs) throws SQLException, TimeoutException; - - List forceRefresh(final @Nullable Connection connection, final long timeoutMs) - throws SQLException, TimeoutException; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 99c8a8be2..e179f171b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -171,20 +171,6 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long return this.waitTillTopologyGetsUpdated(timeoutMs); } - @Override - public List forceRefresh(@Nullable Connection connection, final long timeoutMs) - throws SQLException, TimeoutException { - if (this.isVerifiedWriterConnection) { - // Get the monitoring thread to refresh the topology using a verified connection. - return this.waitTillTopologyGetsUpdated(timeoutMs); - } - - // Otherwise, use the provided unverified connection to update the topology. - // TODO: might need to get rid of this since we don't want to use unverified connections. Could wait for a verified - // connection if it isn't verified yet. - return this.fetchTopologyAndUpdateCache(connection); - } - protected List waitTillTopologyGetsUpdated(final long timeoutMs) throws TimeoutException { List currentHosts = getStoredHosts(); List latestHosts; From e88543817cbbddb13495970319178ca7bf7c3ae3 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 15:44:16 -0800 Subject: [PATCH 57/90] Fix Aurora dialect instance ID queries --- .../java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java | 2 +- .../java/software/amazon/jdbc/dialect/AuroraPgDialect.java | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 7197d915a..8ae253cbd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -36,7 +36,7 @@ public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, // filter out instances that have not been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; - protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id"; + protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id, @@aurora_server_id"; protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM information_schema.replica_host_status " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index db71e9b62..e43f30cb8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -49,7 +49,8 @@ public class AuroraPgDialect extends PgDialect implements TopologyDialect, Auror + "OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "OR LAST_UPDATE_TIMESTAMP IS NULL"; - protected static final String INSTANCE_ID_QUERY = "SELECT pg_catalog.aurora_db_instance_identifier()"; + protected static final String INSTANCE_ID_QUERY = + "SELECT pg_catalog.aurora_db_instance_identifier(), pg_catalog.aurora_db_instance_identifier()"; protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM pg_catalog.aurora_replica_status() " + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " From 2fab544d496c2de73bcda6be93535b7a122d9998 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 6 Nov 2025 17:21:52 -0800 Subject: [PATCH 58/90] Fix bug where isWriterInstance didn't work properly --- .../jdbc/hostlistprovider/MultiAzTopologyUtils.java | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java index 1c3cc80b1..1e1045002 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -69,17 +69,12 @@ public MultiAzTopologyUtils(MultiAzClusterDialect dialect, HostSpecBuilder hostS @Override public boolean isWriterInstance(final Connection connection) throws SQLException { try (final Statement stmt = connection.createStatement()) { + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { - if (rs.next()) { - String instanceId = rs.getString(this.dialect.getWriterIdColumnName()); - // The writer ID is only returned when connected to a reader, so if the query does not return a value, it - // means we are connected to a writer. - return StringUtils.isNullOrEmpty(instanceId); - } + // When connected to a writer, the result is empty, otherwise it contains a single row. + return !rs.next(); } } - - return false; } protected @Nullable String getWriterId(Connection connection) throws SQLException { From 3c2287cef547afaa73500591c2e27fc81018a23b Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 7 Nov 2025 14:25:01 -0800 Subject: [PATCH 59/90] forceRefresh changes compiling --- .../amazon/jdbc/BlockingHostListProvider.java | 42 -- .../java/software/amazon/jdbc/Driver.java | 2 - .../amazon/jdbc/PartialPluginService.java | 26 +- .../software/amazon/jdbc/PluginService.java | 2 - .../amazon/jdbc/PluginServiceImpl.java | 31 +- .../jdbc/dialect/AuroraMysqlDialect.java | 4 +- .../amazon/jdbc/dialect/AuroraPgDialect.java | 4 +- .../dialect/GlobalAuroraMysqlDialect.java | 9 +- .../jdbc/dialect/GlobalAuroraPgDialect.java | 9 +- .../dialect/MultiAzClusterMysqlDialect.java | 3 +- .../jdbc/dialect/MultiAzClusterPgDialect.java | 3 +- .../ConnectionStringHostListProvider.java | 5 +- .../GlobalAuroraHostListProvider.java | 29 +- .../hostlistprovider/HostListProvider.java | 30 +- .../hostlistprovider/RdsHostListProvider.java | 131 +++-- .../jdbc/hostlistprovider/TopologyUtils.java | 1 - ...onitoringGlobalAuroraHostListProvider.java | 91 --- .../MonitoringRdsHostListProvider.java | 113 ---- .../bluegreen/BlueGreenStatusMonitor.java | 10 +- ..._advanced_jdbc_wrapper_messages.properties | 3 +- .../amazon/jdbc/PluginServiceImplTests.java | 9 +- .../RdsHostListProviderTest.java | 526 +++++++++--------- ...ClusterAwareWriterFailoverHandlerTest.java | 4 +- 23 files changed, 426 insertions(+), 661 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java deleted file mode 100644 index 31f3d1182..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc; - -import java.sql.SQLException; -import java.util.List; -import java.util.concurrent.TimeoutException; -import software.amazon.jdbc.hostlistprovider.HostListProvider; - -public interface BlockingHostListProvider extends HostListProvider { - - /** - * Force a host list provider to update its topology information. Results will be returned when the topology is - * updated or the writer is verified, unless the timeout is hit. - * - * @param shouldVerifyWriter a flag indicating that the provider should verify the writer before - * returning the updated topology. - * @param timeoutMs timeout in msec to wait until topology is updated or the writer is verified. - * If a timeout of 0 is provided, a topology update will be initiated but cached topology - * will be returned. If a non-zero timeout is provided and the timeout is hit, - * a TimeoutException will be thrown. - * @return a list of host details representing a cluster topology - * @throws SQLException if there's errors updating topology - * @throws TimeoutException if topology update takes longer time than expected - */ - List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) - throws SQLException, TimeoutException; -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/Driver.java b/wrapper/src/main/java/software/amazon/jdbc/Driver.java index 8616e0ae7..13f3e3585 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/Driver.java +++ b/wrapper/src/main/java/software/amazon/jdbc/Driver.java @@ -37,8 +37,6 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.DialectManager; import software.amazon.jdbc.exceptions.ExceptionHandler; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.AwsSecretsManagerCacheHolder; import software.amazon.jdbc.plugin.DataCacheConnectionPlugin; import software.amazon.jdbc.plugin.OpenedConnectionTracker; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 027c75058..fe69c8ca0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -65,6 +65,7 @@ public class PartialPluginService implements PluginService, CanReleaseResources, private static final Logger LOGGER = Logger.getLogger(PluginServiceImpl.class.getName()); protected static final long DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO = TimeUnit.MINUTES.toNanos(5); + protected static final int DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS = 5000; protected static final CacheMap hostAvailabilityExpiringCache = new CacheMap<>(); protected final FullServicesContainer servicesContainer; @@ -390,21 +391,7 @@ public void refreshHostList(final Connection connection) throws SQLException { @Override public void forceRefreshHostList() throws SQLException { - final List updatedHostList = this.getHostListProvider().forceRefresh(); - if (updatedHostList != null) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } - } - - @Override - public void forceRefreshHostList(final Connection connection) throws SQLException { - // TODO: forceRefresh - final List updatedHostList = this.getHostListProvider().forceRefresh(); - if (updatedHostList != null) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } + this.forceRefreshHostList(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); } @Override @@ -412,15 +399,8 @@ public boolean forceRefreshHostList(final boolean shouldVerifyWriter, final long throws SQLException { final HostListProvider hostListProvider = this.getHostListProvider(); - if (!(hostListProvider instanceof BlockingHostListProvider)) { - throw new UnsupportedOperationException( - Messages.get("PluginServiceImpl.requiredBlockingHostListProvider", - new Object[] {hostListProvider.getClass().getName()})); - } - try { - final List updatedHostList = - ((BlockingHostListProvider) hostListProvider).forceRefresh(shouldVerifyWriter, timeoutMs); + final List updatedHostList = hostListProvider.forceRefresh(shouldVerifyWriter, timeoutMs); if (updatedHostList != null) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index bc1e232f2..ed4b32cb9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -164,8 +164,6 @@ HostSpec getHostSpecByStrategy(List hosts, HostRole role, String strat void forceRefreshHostList() throws SQLException; - void forceRefreshHostList(Connection connection) throws SQLException; - /** * Initiates a topology update. * diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index f06578cab..259b248c6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -65,13 +65,11 @@ public class PluginServiceImpl implements PluginService, CanReleaseResources, private static final Logger LOGGER = Logger.getLogger(PluginServiceImpl.class.getName()); protected static final long DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO = TimeUnit.MINUTES.toNanos(5); + protected static final int DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS = 5000; protected static final CacheMap hostAvailabilityExpiringCache = new CacheMap<>(); protected final FullServicesContainer servicesContainer; - protected static final CacheMap statusesExpiringCache = new CacheMap<>(); - protected static final long DEFAULT_STATUS_CACHE_EXPIRE_NANO = TimeUnit.MINUTES.toNanos(60); - protected final ConnectionPluginManager pluginManager; private final Properties props; private final String originalUrl; @@ -507,21 +505,7 @@ public void refreshHostList(final Connection connection) throws SQLException { @Override public void forceRefreshHostList() throws SQLException { - final List updatedHostList = this.getHostListProvider().forceRefresh(); - if (updatedHostList != null) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } - } - - @Override - public void forceRefreshHostList(final Connection connection) throws SQLException { - // TODO: forceRefresh - final List updatedHostList = this.getHostListProvider().forceRefresh(); - if (updatedHostList != null) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } + this.forceRefreshHostList(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); } @Override @@ -529,15 +513,8 @@ public boolean forceRefreshHostList(final boolean shouldVerifyWriter, final long throws SQLException { final HostListProvider hostListProvider = this.getHostListProvider(); - if (!(hostListProvider instanceof BlockingHostListProvider)) { - throw new UnsupportedOperationException( - Messages.get("PluginServiceImpl.requiredBlockingHostListProvider", - new Object[]{hostListProvider.getClass().getName()})); - } - try { - final List updatedHostList = - ((BlockingHostListProvider) hostListProvider).forceRefresh(shouldVerifyWriter, timeoutMs); + final List updatedHostList = hostListProvider.forceRefresh(shouldVerifyWriter, timeoutMs); if (updatedHostList != null) { updateHostAvailability(updatedHostList); setNodeList(this.allHosts, updatedHostList); @@ -545,7 +522,7 @@ public boolean forceRefreshHostList(final boolean shouldVerifyWriter, final long } } catch (TimeoutException ex) { // do nothing. - LOGGER.finest(Messages.get("PluginServiceImpl.forceRefreshTimeout", new Object[]{timeoutMs})); + LOGGER.finest(Messages.get("PluginServiceImpl.forceRefreshTimeout", new Object[] {timeoutMs})); } return false; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 6fcd72eec..4402a1ed3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -20,8 +20,8 @@ import java.util.Collections; import java.util.List; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -59,7 +59,7 @@ public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index d111bdccb..df1df5ee4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -24,8 +24,8 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.util.DriverInfo; import software.amazon.jdbc.util.Messages; @@ -106,7 +106,7 @@ public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 334757af9..655123cd2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -22,11 +22,8 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalAuroraTopologyDialect { @@ -75,12 +72,8 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); final GlobalAuroraTopologyUtils topologyUtils = - new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - } + new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 7c060c800..2efd96b2c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -23,11 +23,8 @@ import java.util.Collections; import java.util.List; import java.util.logging.Logger; -import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; -import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.Messages; public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { @@ -90,12 +87,8 @@ public boolean isDialect(final Connection connection) { @Override public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); final GlobalAuroraTopologyUtils topologyUtils = - new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - } + new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 9fe7d3b03..5075a1393 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -29,7 +29,6 @@ import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; @@ -89,7 +88,7 @@ public HostListProviderSupplier getHostListProviderSupplier() { final PluginService pluginService = servicesContainer.getPluginService(); final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index ba3600710..6e6ad013d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -27,7 +27,6 @@ import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; @@ -84,7 +83,7 @@ public HostListProviderSupplier getHostListProviderSupplier() { final PluginService pluginService = servicesContainer.getPluginService(); final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 136fabd41..d811309a0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -22,6 +22,7 @@ import java.util.Collections; import java.util.List; import java.util.Properties; +import java.util.concurrent.TimeoutException; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; @@ -96,8 +97,8 @@ public List forceRefresh() throws SQLException { } @Override - public List forceRefresh(final Connection connection) throws SQLException { - init(); + public List forceRefresh(boolean shouldVerifyWriter, long timeoutMs) + throws SQLException, TimeoutException { return this.forceRefresh(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index 682ebb31f..3bcb97e29 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -16,15 +16,15 @@ package software.amazon.jdbc.hostlistprovider; -import java.sql.Connection; import java.sql.SQLException; -import java.util.List; import java.util.Map; import java.util.Properties; -import java.util.logging.Logger; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitor; +import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; +import software.amazon.jdbc.hostlistprovider.monitoring.GlobalAuroraTopologyMonitor; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUtils; @@ -60,14 +60,27 @@ public GlobalAuroraHostListProvider( protected void initSettings() throws SQLException { super.initSettings(); - String instanceTemplates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); this.instanceTemplatesByRegion = this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); } - @Override - protected List queryForTopology(final Connection conn) throws SQLException { - init(); - return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplatesByRegion); + protected ClusterTopologyMonitor initMonitor() throws SQLException { + return this.servicesContainer.getMonitorService().runIfAbsent( + ClusterTopologyMonitorImpl.class, + this.clusterId, + this.servicesContainer, + this.properties, + (servicesContainer) -> + new GlobalAuroraTopologyMonitor( + servicesContainer, + this.topologyUtils, + this.clusterId, + this.initialHostSpec, + this.properties, + this.instanceTemplate, + this.refreshRateNano, + this.highRefreshRateNano, + this.instanceTemplatesByRegion)); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index 8d9fdf5b5..e84859699 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -19,6 +19,7 @@ import java.sql.Connection; import java.sql.SQLException; import java.util.List; +import java.util.concurrent.TimeoutException; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; @@ -27,9 +28,34 @@ public interface HostListProvider { List refresh() throws SQLException; - List forceRefresh() throws SQLException; + /** + * Force a host list provider to update its topology information. Results will be returned when the topology is + * updated or the writer is verified, unless the default timeout is hit. It the caller needs topology from a verified + * writer or with a different timeout value, they should call {@link #forceRefresh(boolean, long)} instead. + * + * @return a list of host details representing a cluster topology + * @throws SQLException if there's errors updating topology + * @throws TimeoutException if topology update takes longer time than expected + */ + List forceRefresh() throws SQLException, TimeoutException; + + /** + * Force a host list provider to update its topology information. Results will be returned when the topology is + * updated or the writer is verified, unless the timeout is hit. + * + * @param shouldVerifyWriter a flag indicating that the provider should verify the writer before + * returning the updated topology. + * @param timeoutMs timeout in msec to wait until topology is updated or the writer is verified. + * If a timeout of 0 is provided, a topology update will be initiated but cached topology + * will be returned. If a non-zero timeout is provided and the timeout is hit, + * a TimeoutException will be thrown. + * @return a list of host details representing a cluster topology + * @throws SQLException if there's errors updating topology + * @throws TimeoutException if topology update takes longer time than expected + */ + List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) + throws SQLException, TimeoutException; - List forceRefresh(Connection connection) throws SQLException; /** * Evaluates the host role of the given connection - either a writer or a reader. diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 1b69efb20..9dbcfb696 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -24,6 +24,7 @@ import java.util.Objects; import java.util.Properties; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; @@ -31,7 +32,11 @@ import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitor; +import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; @@ -41,7 +46,7 @@ import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.Utils; -public class RdsHostListProvider implements DynamicHostListProvider { +public class RdsHostListProvider implements DynamicHostListProvider, CanReleaseResources { private static final Logger LOGGER = Logger.getLogger(RdsHostListProvider.class.getName()); @@ -68,16 +73,28 @@ public class RdsHostListProvider implements DynamicHostListProvider { + "This pattern is required to be specified for IP address or custom domain connections to AWS RDS " + "clusters. Otherwise, if unspecified, the pattern will be automatically created for AWS RDS clusters."); + public static final AwsWrapperProperty CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS = + new AwsWrapperProperty( + "clusterTopologyHighRefreshRateMs", + "100", + "Cluster topology high refresh rate in millis."); + protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); - protected static final int defaultTopologyQueryTimeoutMs = 5000; - + protected static final int DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS = 5000; protected final ReentrantLock lock = new ReentrantLock(); + + static { + PropertyDefinition.registerPluginProperties(RdsHostListProvider.class); + } + protected final Properties properties; protected final String originalUrl; protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; protected final TopologyUtils topologyUtils; + protected final PluginService pluginService; + protected final long highRefreshRateNano; protected RdsUrlType rdsUrlType; protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null @@ -91,10 +108,6 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected volatile boolean isInitialized = false; - static { - PropertyDefinition.registerPluginProperties(RdsHostListProvider.class); - } - public RdsHostListProvider( final TopologyUtils topologyUtils, final Properties properties, @@ -105,6 +118,41 @@ public RdsHostListProvider( this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; this.hostListProviderService = servicesContainer.getHostListProviderService(); + this.pluginService = servicesContainer.getPluginService(); + this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( + CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); + } + + protected ClusterTopologyMonitor initMonitor() throws SQLException { + return this.servicesContainer.getMonitorService().runIfAbsent( + ClusterTopologyMonitorImpl.class, + this.clusterId, + this.servicesContainer, + this.properties, + (servicesContainer) -> new ClusterTopologyMonitorImpl( + this.servicesContainer, + this.topologyUtils, + this.clusterId, + this.initialHostSpec, + this.properties, + this.instanceTemplate, + this.refreshRateNano, + this.highRefreshRateNano)); + } + + protected List queryForTopology() throws SQLException { + init(); + ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() + .get(ClusterTopologyMonitorImpl.class, this.clusterId); + if (monitor == null) { + monitor = this.initMonitor(); + } + + try { + return monitor.forceRefresh(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); + } catch (TimeoutException ex) { + return null; + } } protected void init() throws SQLException { @@ -189,18 +237,6 @@ protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLE } } - /** - * Obtain a cluster topology from database. - * - * @param conn A connection to database to fetch the latest topology. - * @return a list of {@link HostSpec} objects representing the topology - * @throws SQLException if errors occurred while retrieving the topology. - */ - protected List queryForTopology(final Connection conn) throws SQLException { - init(); - return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplate); - } - /** * Get cached topology. * @@ -230,38 +266,6 @@ public List refresh() throws SQLException { return Collections.unmodifiableList(hostList); } - // @Override - // public List refresh(final Connection connection) throws SQLException { - // init(); - // final Connection currentConnection = connection != null - // ? connection - // : this.hostListProviderService.getCurrentConnection(); - // - // final FetchTopologyResult results = getTopology(currentConnection, false); - // LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); - // - // this.hostList = results.hosts; - // return Collections.unmodifiableList(hostList); - // } - - @Override - public List forceRefresh() throws SQLException { - return this.forceRefresh(null); - } - - @Override - public List forceRefresh(final Connection connection) throws SQLException { - init(); - final Connection currentConnection = connection != null - ? connection - : this.hostListProviderService.getCurrentConnection(); - - final FetchTopologyResult results = getTopology(currentConnection, true); - LOGGER.finest(() -> LogUtils.logTopology(results.hosts)); - this.hostList = results.hosts; - return Collections.unmodifiableList(this.hostList); - } - public RdsUrlType getRdsUrlType() throws SQLException { init(); return this.rdsUrlType; @@ -299,6 +303,29 @@ public FetchTopologyResult(final boolean isCachedData, final List host } } + @Override + public List forceRefresh() throws SQLException, TimeoutException { + return this.forceRefresh(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); + } + + @Override + public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) + throws SQLException, TimeoutException { + + ClusterTopologyMonitor monitor = + this.servicesContainer.getMonitorService().get(ClusterTopologyMonitorImpl.class, this.clusterId); + if (monitor == null) { + monitor = this.initMonitor(); + } + assert monitor != null; + return monitor.forceRefresh(shouldVerifyWriter, timeoutMs); + } + + @Override + public void releaseResources() { + // Do nothing. + } + @Override public HostRole getHostRole(Connection conn) throws SQLException { init(); @@ -349,7 +376,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { } return foundHost; - } catch (final SQLException e) { + } catch (final SQLException | TimeoutException e) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection"), e); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java index d24f291b6..8467694f3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -62,7 +62,6 @@ public TopologyUtils( /** * Query the database for information for each instance in the database topology. * - * @param conn the connection to use to query the database. * @param initialHostSpec the {@link HostSpec} that was used to initially connect. * @param instanceTemplate the template {@link HostSpec} to use when constructing new {@link HostSpec} objects from * the data returned by the topology query. diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java deleted file mode 100644 index b258c223d..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; -import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; - -public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostListProvider { - - static final Logger LOGGER = Logger.getLogger(MonitoringGlobalAuroraHostListProvider.class.getName()); - - protected Map instanceTemplatesByRegion = new HashMap<>(); - - protected final RdsUtils rdsUtils = new RdsUtils(); - protected final GlobalAuroraTopologyUtils topologyUtils; - - static { - // Intentionally register property definition using the GlobalAuroraHostListProvider class. - PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); - } - - public MonitoringGlobalAuroraHostListProvider( - GlobalAuroraTopologyUtils topologyUtils, - Properties properties, - String originalUrl, - FullServicesContainer servicesContainer) { - super(topologyUtils, properties, originalUrl, servicesContainer); - this.topologyUtils = topologyUtils; - } - - @Override - protected void initSettings() throws SQLException { - super.initSettings(); - - String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - this.instanceTemplatesByRegion = - this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); - } - - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent( - ClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> - new GlobalAuroraTopologyMonitor( - servicesContainer, - this.topologyUtils, - this.clusterId, - this.initialHostSpec, - this.properties, - this.instanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano, - this.instanceTemplatesByRegion)); - } - - @Override - protected List queryForTopology(Connection connection) throws SQLException { - return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java deleted file mode 100644 index a1ab3490c..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.List; -import java.util.Properties; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.BlockingHostListProvider; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.cleanup.CanReleaseResources; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.util.FullServicesContainer; - -public class MonitoringRdsHostListProvider - extends RdsHostListProvider implements BlockingHostListProvider, CanReleaseResources { - - public static final AwsWrapperProperty CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS = - new AwsWrapperProperty( - "clusterTopologyHighRefreshRateMs", - "100", - "Cluster topology high refresh rate in millis."); - - static { - PropertyDefinition.registerPluginProperties(MonitoringRdsHostListProvider.class); - } - - protected final FullServicesContainer servicesContainer; - protected final PluginService pluginService; - protected final long highRefreshRateNano; - - public MonitoringRdsHostListProvider( - final TopologyUtils topologyUtils, - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer) { - super(topologyUtils, properties, originalUrl, servicesContainer); - this.servicesContainer = servicesContainer; - this.pluginService = servicesContainer.getPluginService(); - this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( - CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); - } - - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent( - ClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> new ClusterTopologyMonitorImpl( - this.servicesContainer, - this.topologyUtils, - this.clusterId, - this.initialHostSpec, - this.properties, - this.instanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano)); - } - - @Override - protected List queryForTopology(final Connection conn) throws SQLException { - ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() - .get(ClusterTopologyMonitorImpl.class, this.clusterId); - if (monitor == null) { - monitor = this.initMonitor(); - } - - try { - return monitor.forceRefresh(conn, defaultTopologyQueryTimeoutMs); - } catch (TimeoutException ex) { - return null; - } - } - - @Override - public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) - throws SQLException, TimeoutException { - - ClusterTopologyMonitor monitor = - this.servicesContainer.getMonitorService().get(ClusterTopologyMonitorImpl.class, this.clusterId); - if (monitor == null) { - monitor = this.initMonitor(); - } - assert monitor != null; - return monitor.forceRefresh(shouldVerifyWriter, timeoutMs); - } - - @Override - public void releaseResources() { - // Do nothing. - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index db72b6391..c084b7e00 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -36,6 +36,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.logging.Level; @@ -332,8 +333,13 @@ protected void collectTopology() throws SQLException { if (conn == null || conn.isClosed()) { return; } - // TODO: forceRefresh - this.currentTopology.set(this.hostListProvider.forceRefresh()); + + try { + this.currentTopology.set(this.hostListProvider.forceRefresh()); + } catch (TimeoutException e) { + LOGGER.finest("bgd.forceRefreshTimeout"); + return; + } if (this.collectTopology.get()) { this.startTopology = this.currentTopology.get(); diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index 441188f6f..4f26989bf 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -298,7 +298,6 @@ PluginServiceImpl.forceRefreshTimeout=A timeout exception occurred after waiting PluginServiceImpl.hostsChangelistEmpty=There are no changes in the hosts' availability. PluginServiceImpl.failedToRetrieveHostPort=Could not retrieve Host:Port for connection. PluginServiceImpl.nonEmptyAliases=fillAliases called when HostSpec already contains the following aliases: ''{0}''. -PluginServiceImpl.requiredBlockingHostListProvider=The detected host list provider is not a BlockingHostListProvider. A BlockingHostListProvider is required to force refresh the host list. Detected host list provider: {0} PropertyUtils.setMethodDoesNotExistOnTarget=Set method for property ''{0}'' does not exist on target ''{1}''. PropertyUtils.failedToSetProperty=Failed to set property ''{0}'' on target ''{1}''. @@ -397,6 +396,8 @@ ClusterTopologyMonitorImpl.writerMonitoringConnection=The monitoring connection ClusterTopologyMonitorImpl.errorFetchingTopology=An error occurred while querying for topology: {0} # Blue/Green Deployment + +bgd.forceRefreshTimeout=Timed out while waiting for forceRefresh to return new topology info. bgd.inProgressConnectionClosed=Connection has been closed since Blue/Green switchover is in progress. bgd.inProgressHoldConnect=Blue/Green Deployment switchover is in progress. The ''connect'' call will be delayed until switchover is completed. bgd.inProgressTryConnectLater=Blue/Green Deployment switchover is still in progress after {0} ms. Try to connect again later. diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index 5ef1235ad..c39fee62a 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -757,7 +757,7 @@ void testRefreshHostList_withCachedHostAvailability() throws SQLException { PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); when(hostListProvider.refresh()).thenReturn(newHostSpecs); - when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); + // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); PluginServiceImpl target = spy( new PluginServiceImpl( @@ -813,8 +813,8 @@ void testForceRefreshHostList_withCachedHostAvailability() throws SQLException { PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - when(hostListProvider.forceRefresh()).thenReturn(newHostSpecs); - when(hostListProvider.forceRefresh(newConnection)).thenReturn(newHostSpecs); + // when(hostListProvider.forceRefresh()).thenReturn(newHostSpecs); + // when(hostListProvider.forceRefresh(newConnection)).thenReturn(newHostSpecs); PluginServiceImpl target = spy( new PluginServiceImpl( @@ -835,7 +835,8 @@ void testForceRefreshHostList_withCachedHostAvailability() throws SQLException { PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - target.forceRefreshHostList(newConnection); + target.forceRefreshHostList(); + // target.forceRefreshHostList(newConnection); assertEquals(expectedHostSpecs2, newHostSpecs); } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index 991c0734b..ed6d27a72 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -1,263 +1,263 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.Mock; -import org.mockito.Mockito; -import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.TopologyDialect; -import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Pair; -import software.amazon.jdbc.util.events.EventPublisher; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.storage.TestStorageServiceImpl; - -class RdsHostListProviderTest { - private StorageService storageService; - private RdsHostListProvider rdsHostListProvider; - - @Mock private Connection mockConnection; - @Mock private FullServicesContainer mockServicesContainer; - @Mock private PluginService mockPluginService; - @Mock private HostListProviderService mockHostListProviderService; - @Mock private HostSpecBuilder mockHostSpecBuilder; - @Mock private EventPublisher mockEventPublisher; - @Mock private TopologyUtils mockTopologyUtils; - @Mock private TopologyDialect mockDialect; - - private AutoCloseable closeable; - private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("foo").port(1234).build(); - private final List hosts = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); - - @BeforeEach - void setUp() throws SQLException { - closeable = MockitoAnnotations.openMocks(this); - storageService = new TestStorageServiceImpl(mockEventPublisher); - when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); - when(mockServicesContainer.getStorageService()).thenReturn(storageService); - when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); - when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); - when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); - when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); - when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); - when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); - when(mockHostListProviderService.getHostSpecBuilder()) - .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); - when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); - } - - @AfterEach - void tearDown() throws Exception { - storageService.clearAll(); - closeable.close(); - } - - private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { - RdsHostListProvider provider = new RdsHostListProvider( - mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); - provider.init(); - return provider; - } - - @Test - void testGetTopology_returnCachedTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); - assertEquals(expected, result.hosts); - assertEquals(2, result.hosts.size()); - verify(rdsHostListProvider, never()).queryForTopology(mockConnection); - } - - @Test - void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); - - final List newHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(mockTopologyUtils).queryForTopology( - eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(newHosts, result.hosts); - } - - @Test - void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clusterId = "cluster-id"; - rdsHostListProvider.isInitialized = true; - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(2, result.hosts.size()); - assertEquals(expected, result.hosts); - } - - @Test - void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clear(); - - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertNotNull(result.hosts); - assertEquals( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), - result.hosts); - } - - @Test - void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { - final List expectedMySQL = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) - .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - final List expectedPostgres = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) - .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class), any(HostSpec.class))) - .thenReturn(expectedMySQL).thenReturn(expectedPostgres); - - - rdsHostListProvider = getRdsHostListProvider("mysql://url/"); - - List hosts = rdsHostListProvider.queryForTopology(mockConnection); - assertEquals(expectedMySQL, hosts); - - rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); - hosts = rdsHostListProvider.queryForTopology(mockConnection); - assertEquals(expectedPostgres, hosts); - } - - @Test - void testGetCachedTopology_returnStoredTopology() throws SQLException { - rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); - - final List expected = hosts; - storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - - final List result = rdsHostListProvider.getStoredTopology(); - assertEquals(expected, result); - } - - @Test - void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - - assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); - - when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); - assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionNullTopology() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.instanceTemplate = - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); - - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); - doReturn(null).when(rdsHostListProvider).refresh(mockConnection); - doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostNotInTopology() throws SQLException { - final List cachedTopology = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build()); - - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); - doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostInTopology() throws SQLException { - final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(); - expectedHost.setHostId("instance-a-1"); - final List cachedTopology = Collections.singletonList(expectedHost); - - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); - doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); - - final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); - assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); - assertEquals("instance-a-1", actual.getHostId()); - } -} +// /* +// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// * +// * Licensed under the Apache License, Version 2.0 (the "License"). +// * You may not use this file except in compliance with the License. +// * You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +// +// package software.amazon.jdbc.hostlistprovider; +// +// import static org.junit.jupiter.api.Assertions.assertEquals; +// import static org.junit.jupiter.api.Assertions.assertNotNull; +// import static org.junit.jupiter.api.Assertions.assertNull; +// import static org.junit.jupiter.api.Assertions.assertThrows; +// import static org.mockito.ArgumentMatchers.any; +// import static org.mockito.ArgumentMatchers.eq; +// import static org.mockito.Mockito.atMostOnce; +// import static org.mockito.Mockito.doReturn; +// import static org.mockito.Mockito.never; +// import static org.mockito.Mockito.verify; +// import static org.mockito.Mockito.when; +// +// import java.sql.Connection; +// import java.sql.SQLException; +// import java.util.ArrayList; +// import java.util.Arrays; +// import java.util.Collections; +// import java.util.List; +// import java.util.Properties; +// import org.junit.jupiter.api.AfterEach; +// import org.junit.jupiter.api.BeforeEach; +// import org.junit.jupiter.api.Test; +// import org.mockito.Mock; +// import org.mockito.Mockito; +// import org.mockito.MockitoAnnotations; +// import software.amazon.jdbc.HostRole; +// import software.amazon.jdbc.HostSpec; +// import software.amazon.jdbc.HostSpecBuilder; +// import software.amazon.jdbc.PluginService; +// import software.amazon.jdbc.dialect.TopologyDialect; +// import software.amazon.jdbc.hostavailability.HostAvailability; +// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +// import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; +// import software.amazon.jdbc.util.FullServicesContainer; +// import software.amazon.jdbc.util.Pair; +// import software.amazon.jdbc.util.events.EventPublisher; +// import software.amazon.jdbc.util.storage.StorageService; +// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; +// +// class RdsHostListProviderTest { +// private StorageService storageService; +// private RdsHostListProvider rdsHostListProvider; +// +// @Mock private Connection mockConnection; +// @Mock private FullServicesContainer mockServicesContainer; +// @Mock private PluginService mockPluginService; +// @Mock private HostListProviderService mockHostListProviderService; +// @Mock private HostSpecBuilder mockHostSpecBuilder; +// @Mock private EventPublisher mockEventPublisher; +// @Mock private TopologyUtils mockTopologyUtils; +// @Mock private TopologyDialect mockDialect; +// +// private AutoCloseable closeable; +// private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("foo").port(1234).build(); +// private final List hosts = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); +// +// @BeforeEach +// void setUp() throws SQLException { +// closeable = MockitoAnnotations.openMocks(this); +// storageService = new TestStorageServiceImpl(mockEventPublisher); +// when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); +// when(mockServicesContainer.getStorageService()).thenReturn(storageService); +// when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); +// when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); +// when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); +// when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); +// when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); +// when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); +// when(mockHostListProviderService.getHostSpecBuilder()) +// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); +// when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); +// } +// +// @AfterEach +// void tearDown() throws Exception { +// storageService.clearAll(); +// closeable.close(); +// } +// +// private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { +// RdsHostListProvider provider = new RdsHostListProvider( +// mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); +// provider.init(); +// return provider; +// } +// +// @Test +// void testGetTopology_returnCachedTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); +// assertEquals(expected, result.hosts); +// assertEquals(2, result.hosts.size()); +// verify(rdsHostListProvider, never()).queryForTopology(mockConnection); +// } +// +// @Test +// void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.isInitialized = true; +// +// storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); +// +// final List newHosts = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); +// doReturn(newHosts).when(mockTopologyUtils).queryForTopology( +// eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertEquals(1, result.hosts.size()); +// assertEquals(newHosts, result.hosts); +// } +// +// @Test +// void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.clusterId = "cluster-id"; +// rdsHostListProvider.isInitialized = true; +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertEquals(2, result.hosts.size()); +// assertEquals(expected, result.hosts); +// } +// +// @Test +// void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.clear(); +// +// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); +// +// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); +// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); +// assertNotNull(result.hosts); +// assertEquals( +// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), +// result.hosts); +// } +// +// @Test +// void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { +// final List expectedMySQL = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) +// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); +// final List expectedPostgres = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) +// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); +// when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class), any(HostSpec.class))) +// .thenReturn(expectedMySQL).thenReturn(expectedPostgres); +// +// +// rdsHostListProvider = getRdsHostListProvider("mysql://url/"); +// +// List hosts = rdsHostListProvider.queryForTopology(mockConnection); +// assertEquals(expectedMySQL, hosts); +// +// rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); +// hosts = rdsHostListProvider.queryForTopology(mockConnection); +// assertEquals(expectedPostgres, hosts); +// } +// +// @Test +// void testGetCachedTopology_returnStoredTopology() throws SQLException { +// rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); +// +// final List expected = hosts; +// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); +// +// final List result = rdsHostListProvider.getStoredTopology(); +// assertEquals(expected, result); +// } +// +// @Test +// void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// +// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); +// +// when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); +// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionNullTopology() throws SQLException { +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// rdsHostListProvider.instanceTemplate = +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); +// +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); +// doReturn(null).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionHostNotInTopology() throws SQLException { +// final List cachedTopology = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") +// .port(HostSpec.NO_PORT) +// .role(HostRole.WRITER) +// .build()); +// +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); +// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); +// } +// +// @Test +// void testIdentifyConnectionHostInTopology() throws SQLException { +// final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") +// .port(HostSpec.NO_PORT) +// .role(HostRole.WRITER) +// .build(); +// expectedHost.setHostId("instance-a-1"); +// final List cachedTopology = Collections.singletonList(expectedHost); +// +// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); +// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); +// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); +// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); +// +// final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); +// assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); +// assertEquals("instance-a-1", actual.getHostId()); +// } +// } diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java index cfcfb137e..c41e7ebf3 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java @@ -285,7 +285,7 @@ public void testConnectToReaderA_taskADefers() throws SQLException { assertEquals(4, result.getTopology().size()); assertEquals("new-writer-host", result.getTopology().get(0).getHost()); - verify(mockPluginService, atLeastOnce()).forceRefreshHostList(any(Connection.class)); + verify(mockPluginService, atLeastOnce()).forceRefreshHostList(); assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); } @@ -332,7 +332,7 @@ public void testFailedToConnect_failoverTimeout() throws SQLException { assertFalse(result.isConnected()); assertFalse(result.isNewHost()); - verify(mockPluginService, atLeastOnce()).forceRefreshHostList(any(Connection.class)); + verify(mockPluginService, atLeastOnce()).forceRefreshHostList(); // 5s is a max allowed failover timeout; add 1s for inaccurate measurements assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); From 890f5c7671921484f3cfc39cdd4c9f4a83a8b5d6 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 7 Nov 2025 14:32:25 -0800 Subject: [PATCH 60/90] refresh changes compiling --- .../amazon/jdbc/PartialPluginService.java | 10 - .../software/amazon/jdbc/PluginService.java | 2 - .../amazon/jdbc/PluginServiceImpl.java | 10 - .../amazon/jdbc/PluginServiceImplTests.java | 1896 ++++++++--------- 4 files changed, 948 insertions(+), 970 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index fe69c8ca0..8cba1f33d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -379,16 +379,6 @@ public void refreshHostList() throws SQLException { } } - @Override - public void refreshHostList(final Connection connection) throws SQLException { - // TODO: refresh - final List updatedHostList = this.getHostListProvider().refresh(); - if (!Objects.equals(updatedHostList, this.allHosts)) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } - } - @Override public void forceRefreshHostList() throws SQLException { this.forceRefreshHostList(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index ed4b32cb9..e921a7335 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -160,8 +160,6 @@ HostSpec getHostSpecByStrategy(List hosts, HostRole role, String strat void refreshHostList() throws SQLException; - void refreshHostList(Connection connection) throws SQLException; - void forceRefreshHostList() throws SQLException; /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 259b248c6..0bd7a4a60 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -493,16 +493,6 @@ public void refreshHostList() throws SQLException { } } - @Override - public void refreshHostList(final Connection connection) throws SQLException { - // TODO: refresh - final List updatedHostList = this.getHostListProvider().refresh(); - if (!Objects.equals(updatedHostList, this.allHosts)) { - updateHostAvailability(updatedHostList); - setNodeList(this.allHosts, updatedHostList); - } - } - @Override public void forceRefreshHostList() throws SQLException { this.forceRefreshHostList(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index c39fee62a..6b1fa58e6 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -1,948 +1,948 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc; - -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotEquals; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertTrue; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doNothing; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.spy; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.EnumSet; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Properties; -import java.util.Set; -import java.util.stream.Stream; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.Arguments; -import org.junit.jupiter.params.provider.MethodSource; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.dialect.AuroraPgDialect; -import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.dialect.DialectManager; -import software.amazon.jdbc.dialect.MysqlDialect; -import software.amazon.jdbc.exceptions.ExceptionManager; -import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.HostListProvider; -import software.amazon.jdbc.profile.ConfigurationProfile; -import software.amazon.jdbc.profile.ConfigurationProfileBuilder; -import software.amazon.jdbc.states.SessionStateService; -import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.events.EventPublisher; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.storage.TestStorageServiceImpl; - -public class PluginServiceImplTests { - - private static final Properties PROPERTIES = new Properties(); - private static final String URL = "url"; - private static final String DRIVER_PROTOCOL = "driverProtocol"; - private StorageService storageService; - private AutoCloseable closeable; - - @Mock FullServicesContainer servicesContainer; - @Mock EventPublisher mockEventPublisher; - @Mock ConnectionPluginManager pluginManager; - @Mock Connection newConnection; - @Mock Connection oldConnection; - @Mock HostListProvider hostListProvider; - @Mock DialectManager dialectManager; - @Mock TargetDriverDialect mockTargetDriverDialect; - @Mock Statement statement; - @Mock ResultSet resultSet; - ConfigurationProfile configurationProfile = ConfigurationProfileBuilder.get().withName("test").build(); - @Mock SessionStateService sessionStateService; - - @Captor ArgumentCaptor> argumentChanges; - @Captor ArgumentCaptor>> argumentChangesMap; - @Captor ArgumentCaptor argumentSkipPlugin; - - @BeforeEach - void setUp() throws SQLException { - closeable = MockitoAnnotations.openMocks(this); - when(oldConnection.isClosed()).thenReturn(false); - when(newConnection.createStatement()).thenReturn(statement); - when(statement.executeQuery(any())).thenReturn(resultSet); - when(servicesContainer.getConnectionPluginManager()).thenReturn(pluginManager); - when(servicesContainer.getStorageService()).thenReturn(storageService); - storageService = new TestStorageServiceImpl(mockEventPublisher); - PluginServiceImpl.hostAvailabilityExpiringCache.clear(); - } - - @AfterEach - void cleanUp() throws Exception { - closeable.close(); - storageService.clearAll(); - PluginServiceImpl.hostAvailabilityExpiringCache.clear(); - } - - @Test - public void testOldConnectionNoSuggestion() throws SQLException { - when(pluginManager.notifyConnectionChanged(any(), any())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") - .build(); - - target.setCurrentConnection(newConnection, - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); - - assertNotEquals(oldConnection, target.currentConnection); - assertEquals(newConnection, target.currentConnection); - assertEquals("new-host", target.currentHostSpec.getHost()); - verify(oldConnection, times(1)).close(); - } - - @Test - public void testOldConnectionDisposeSuggestion() throws SQLException { - when(pluginManager.notifyConnectionChanged(any(), any())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.DISPOSE)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") - .build(); - - target.setCurrentConnection(newConnection, - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); - - assertNotEquals(oldConnection, target.currentConnection); - assertEquals(newConnection, target.currentConnection); - assertEquals("new-host", target.currentHostSpec.getHost()); - verify(oldConnection, times(1)).close(); - } - - @Test - public void testOldConnectionPreserveSuggestion() throws SQLException { - when(pluginManager.notifyConnectionChanged(any(), any())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.PRESERVE)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") - .build(); - - target.setCurrentConnection(newConnection, - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); - - assertNotEquals(oldConnection, target.currentConnection); - assertEquals(newConnection, target.currentConnection); - assertEquals("new-host", target.currentHostSpec.getHost()); - verify(oldConnection, times(0)).close(); - } - - @Test - public void testOldConnectionMixedSuggestion() throws SQLException { - when(pluginManager.notifyConnectionChanged(any(), any())) - .thenReturn( - EnumSet.of( - OldConnectionSuggestedAction.NO_OPINION, - OldConnectionSuggestedAction.PRESERVE, - OldConnectionSuggestedAction.DISPOSE)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") - .build(); - - target.setCurrentConnection(newConnection, - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); - - assertNotEquals(oldConnection, target.currentConnection); - assertEquals(newConnection, target.currentConnection); - assertEquals("new-host", target.currentHostSpec.getHost()); - verify(oldConnection, times(0)).close(); - } - - @Test - public void testChangesNewConnectionNewHostNewPortNewRoleNewAvailability() throws SQLException { - when(pluginManager.notifyConnectionChanged( - argumentChanges.capture(), argumentSkipPlugin.capture())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).build(); - - target.setCurrentConnection( - newConnection, - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("new-host").port(2000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build()); - - assertNull(argumentSkipPlugin.getValue()); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); - } - - @Test - public void testChangesNewConnectionNewRoleNewAvailability() throws SQLException { - when(pluginManager.notifyConnectionChanged( - argumentChanges.capture(), argumentSkipPlugin.capture())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build(); - - target.setCurrentConnection(newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE) - .build()); - - assertNull(argumentSkipPlugin.getValue()); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); - } - - @Test - public void testChangesNewConnection() throws SQLException { - when(pluginManager.notifyConnectionChanged( - argumentChanges.capture(), argumentSkipPlugin.capture())) - .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) - .build(); - - target.setCurrentConnection( - newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) - .build()); - - assertNull(argumentSkipPlugin.getValue()); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); - assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); - assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); - } - - @Test - public void testChangesNoChanges() throws SQLException { - when(pluginManager.notifyConnectionChanged(any(), any())).thenReturn( - EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); - - PluginServiceImpl target = - spy(new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.currentConnection = oldConnection; - target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(); - - target.setCurrentConnection( - oldConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) - .build()); - - verify(pluginManager, times(0)).notifyConnectionChanged(any(), any()); - } - - @Test - public void testSetNodeListAdded() throws SQLException { - - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - when(hostListProvider.refresh()).thenReturn(Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build())); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = new ArrayList<>(); - target.hostListProvider = hostListProvider; - - target.refreshHostList(); - - assertEquals(1, target.getAllHosts().size()); - assertEquals("hostA", target.getAllHosts().get(0).getHost()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(1, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_ADDED)); - } - - @Test - public void testSetNodeListDeleted() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - when(hostListProvider.refresh()).thenReturn(Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build())); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build()); - target.hostListProvider = hostListProvider; - - target.refreshHostList(); - - assertEquals(1, target.getAllHosts().size()); - assertEquals("hostB", target.getAllHosts().get(0).getHost()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(1, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_DELETED)); - } - - @Test - public void testSetNodeListChanged() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - when(hostListProvider.refresh()).thenReturn( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA") - .port(HostSpec.NO_PORT).role(HostRole.READER).build())); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.WRITER).build()); - target.hostListProvider = hostListProvider; - - target.refreshHostList(); - - assertEquals(1, target.getAllHosts().size()); - assertEquals("hostA", target.getAllHosts().get(0).getHost()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(2, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostAChanges.contains(NodeChangeOptions.PROMOTED_TO_READER)); - } - - @Test - public void testSetNodeListNoChanges() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(any()); - - when(hostListProvider.refresh()).thenReturn( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build())); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - target.hostListProvider = hostListProvider; - - target.refreshHostList(); - - assertEquals(1, target.getAllHosts().size()); - assertEquals("hostA", target.getAllHosts().get(0).getHost()); - verify(pluginManager, times(0)).notifyNodeListChanged(any()); - } - - @Test - public void testNodeAvailabilityNotChanged() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) - .build()); - - Set aliases = new HashSet<>(); - aliases.add("hostA"); - target.setAvailability(aliases, HostAvailability.AVAILABLE); - - assertEquals(1, target.getAllHosts().size()); - assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); - verify(pluginManager, never()).notifyNodeListChanged(any()); - } - - @Test - public void testNodeAvailabilityChanged_WentDown() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) - .build()); - - Set aliases = new HashSet<>(); - aliases.add("hostA"); - target.setAvailability(aliases, HostAvailability.NOT_AVAILABLE); - - assertEquals(1, target.getAllHosts().size()); - assertEquals(HostAvailability.NOT_AVAILABLE, target.getAllHosts().get(0).getAvailability()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(2, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_DOWN)); - } - - @Test - public void testNodeAvailabilityChanged_WentUp() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.allHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build()); - - Set aliases = new HashSet<>(); - aliases.add("hostA"); - target.setAvailability(aliases, HostAvailability.AVAILABLE); - - assertEquals(1, target.getAllHosts().size()); - assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(2, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); - } - - @Test - public void testNodeAvailabilityChanged_WentUp_ByAlias() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build(); - hostA.addAlias("ip-10-10-10-10"); - hostA.addAlias("hostA.custom.domain.com"); - final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build(); - hostB.addAlias("ip-10-10-10-10"); - hostB.addAlias("hostB.custom.domain.com"); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - - target.allHosts = Arrays.asList(hostA, hostB); - - Set aliases = new HashSet<>(); - aliases.add("hostA.custom.domain.com"); - target.setAvailability(aliases, HostAvailability.AVAILABLE); - - assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); - assertEquals(HostAvailability.NOT_AVAILABLE, hostB.getAvailability()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(2, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); - } - - @Test - public void testNodeAvailabilityChanged_WentUp_MultipleHostsByAlias() throws SQLException { - doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); - - final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build(); - hostA.addAlias("ip-10-10-10-10"); - hostA.addAlias("hostA.custom.domain.com"); - final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) - .build(); - hostB.addAlias("ip-10-10-10-10"); - hostB.addAlias("hostB.custom.domain.com"); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - - target.allHosts = Arrays.asList(hostA, hostB); - - Set aliases = new HashSet<>(); - aliases.add("ip-10-10-10-10"); - target.setAvailability(aliases, HostAvailability.AVAILABLE); - - assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); - assertEquals(HostAvailability.AVAILABLE, hostB.getAvailability()); - verify(pluginManager, times(1)).notifyNodeListChanged(any()); - - Map> notifiedChanges = argumentChangesMap.getValue(); - assertTrue(notifiedChanges.containsKey("hostA/")); - EnumSet hostAChanges = notifiedChanges.get("hostA/"); - assertEquals(2, hostAChanges.size()); - assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); - - assertTrue(notifiedChanges.containsKey("hostB/")); - EnumSet hostBChanges = notifiedChanges.get("hostB/"); - assertEquals(2, hostBChanges.size()); - assertTrue(hostBChanges.contains(NodeChangeOptions.NODE_CHANGED)); - assertTrue(hostBChanges.contains(NodeChangeOptions.WENT_UP)); - } - - @Test - void testRefreshHostList_withCachedHostAvailability() throws SQLException { - final List newHostSpecs = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - final List newHostSpecs2 = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - final List expectedHostSpecs = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - final List expectedHostSpecs2 = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - when(hostListProvider.refresh()).thenReturn(newHostSpecs); - // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - when(target.getHostListProvider()).thenReturn(hostListProvider); - - assertNotEquals(expectedHostSpecs, newHostSpecs); - target.refreshHostList(); - assertEquals(expectedHostSpecs, newHostSpecs); - - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - target.refreshHostList(newConnection); - assertEquals(expectedHostSpecs2, newHostSpecs); - } - - @Test - void testForceRefreshHostList_withCachedHostAvailability() throws SQLException { - final List newHostSpecs = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - final List expectedHostSpecs = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - final List expectedHostSpecs2 = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) - .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() - ); - - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - // when(hostListProvider.forceRefresh()).thenReturn(newHostSpecs); - // when(hostListProvider.forceRefresh(newConnection)).thenReturn(newHostSpecs); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - when(target.getHostListProvider()).thenReturn(hostListProvider); - - assertNotEquals(expectedHostSpecs, newHostSpecs); - target.forceRefreshHostList(); - assertEquals(expectedHostSpecs, newHostSpecs); - - PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, - PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - target.forceRefreshHostList(); - // target.forceRefreshHostList(newConnection); - assertEquals(expectedHostSpecs2, newHostSpecs); - } - - @Test - void testIdentifyConnectionWithNoAliases() throws SQLException { - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - when(target.getHostListProvider()).thenReturn(hostListProvider); - - when(target.getDialect()).thenReturn(new MysqlDialect()); - assertNull(target.identifyConnection(newConnection)); - } - - @Test - void testIdentifyConnectionWithAliases() throws SQLException { - final HostSpec expected = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("test") - .build(); - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.hostListProvider = hostListProvider; - when(target.getHostListProvider()).thenReturn(hostListProvider); - when(hostListProvider.identifyConnection(eq(newConnection))).thenReturn(expected); - - when(target.getDialect()).thenReturn(new AuroraPgDialect()); - final HostSpec actual = target.identifyConnection(newConnection); - verify(target, never()).getCurrentHostSpec(); - verify(hostListProvider).identifyConnection(newConnection); - assertEquals(expected, actual); - } - - @Test - void testFillAliasesNonEmptyAliases() throws SQLException { - final HostSpec oneAlias = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo") - .build(); - oneAlias.addAlias(oneAlias.asAlias()); - - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - - assertEquals(1, oneAlias.getAliases().size()); - target.fillAliases(newConnection, oneAlias); - // Fill aliases should return directly and no additional aliases should be added. - assertEquals(1, oneAlias.getAliases().size()); - } - - @ParameterizedTest - @MethodSource("fillAliasesDialects") - void testFillAliasesWithInstanceEndpoint(Dialect dialect, String[] expectedInstanceAliases) throws SQLException { - final HostSpec empty = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo").build(); - PluginServiceImpl target = spy( - new PluginServiceImpl( - servicesContainer, - new ExceptionManager(), - PROPERTIES, - URL, - DRIVER_PROTOCOL, - dialectManager, - mockTargetDriverDialect, - configurationProfile, - sessionStateService)); - target.hostListProvider = hostListProvider; - when(target.getDialect()).thenReturn(dialect); - when(resultSet.next()).thenReturn(true, false); // Result set contains 1 row. - when(resultSet.getString(eq(1))).thenReturn("ip"); - if (dialect instanceof AuroraPgDialect) { - when(hostListProvider.identifyConnection(eq(newConnection))) - .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("instance").build()); - } - - target.fillAliases(newConnection, empty); - - final String[] aliases = empty.getAliases().toArray(new String[] {}); - assertArrayEquals(expectedInstanceAliases, aliases); - } - - private static Stream fillAliasesDialects() { - return Stream.of( - Arguments.of(new AuroraPgDialect(), new String[]{"instance", "foo", "ip"}), - Arguments.of(new MysqlDialect(), new String[]{"foo", "ip"}) - ); - } -} +// /* +// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// * +// * Licensed under the Apache License, Version 2.0 (the "License"). +// * You may not use this file except in compliance with the License. +// * You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +// +// package software.amazon.jdbc; +// +// import static org.junit.jupiter.api.Assertions.assertArrayEquals; +// import static org.junit.jupiter.api.Assertions.assertEquals; +// import static org.junit.jupiter.api.Assertions.assertFalse; +// import static org.junit.jupiter.api.Assertions.assertNotEquals; +// import static org.junit.jupiter.api.Assertions.assertNull; +// import static org.junit.jupiter.api.Assertions.assertTrue; +// import static org.mockito.ArgumentMatchers.any; +// import static org.mockito.ArgumentMatchers.eq; +// import static org.mockito.Mockito.doNothing; +// import static org.mockito.Mockito.never; +// import static org.mockito.Mockito.spy; +// import static org.mockito.Mockito.times; +// import static org.mockito.Mockito.verify; +// import static org.mockito.Mockito.when; +// +// import java.sql.Connection; +// import java.sql.ResultSet; +// import java.sql.SQLException; +// import java.sql.Statement; +// import java.util.ArrayList; +// import java.util.Arrays; +// import java.util.Collections; +// import java.util.EnumSet; +// import java.util.HashSet; +// import java.util.List; +// import java.util.Map; +// import java.util.Properties; +// import java.util.Set; +// import java.util.stream.Stream; +// import org.junit.jupiter.api.AfterEach; +// import org.junit.jupiter.api.BeforeEach; +// import org.junit.jupiter.api.Test; +// import org.junit.jupiter.params.ParameterizedTest; +// import org.junit.jupiter.params.provider.Arguments; +// import org.junit.jupiter.params.provider.MethodSource; +// import org.mockito.ArgumentCaptor; +// import org.mockito.Captor; +// import org.mockito.Mock; +// import org.mockito.MockitoAnnotations; +// import software.amazon.jdbc.dialect.AuroraPgDialect; +// import software.amazon.jdbc.dialect.Dialect; +// import software.amazon.jdbc.dialect.DialectManager; +// import software.amazon.jdbc.dialect.MysqlDialect; +// import software.amazon.jdbc.exceptions.ExceptionManager; +// import software.amazon.jdbc.hostavailability.HostAvailability; +// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +// import software.amazon.jdbc.hostlistprovider.HostListProvider; +// import software.amazon.jdbc.profile.ConfigurationProfile; +// import software.amazon.jdbc.profile.ConfigurationProfileBuilder; +// import software.amazon.jdbc.states.SessionStateService; +// import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; +// import software.amazon.jdbc.util.FullServicesContainer; +// import software.amazon.jdbc.util.events.EventPublisher; +// import software.amazon.jdbc.util.storage.StorageService; +// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; +// +// public class PluginServiceImplTests { +// +// private static final Properties PROPERTIES = new Properties(); +// private static final String URL = "url"; +// private static final String DRIVER_PROTOCOL = "driverProtocol"; +// private StorageService storageService; +// private AutoCloseable closeable; +// +// @Mock FullServicesContainer servicesContainer; +// @Mock EventPublisher mockEventPublisher; +// @Mock ConnectionPluginManager pluginManager; +// @Mock Connection newConnection; +// @Mock Connection oldConnection; +// @Mock HostListProvider hostListProvider; +// @Mock DialectManager dialectManager; +// @Mock TargetDriverDialect mockTargetDriverDialect; +// @Mock Statement statement; +// @Mock ResultSet resultSet; +// ConfigurationProfile configurationProfile = ConfigurationProfileBuilder.get().withName("test").build(); +// @Mock SessionStateService sessionStateService; +// +// @Captor ArgumentCaptor> argumentChanges; +// @Captor ArgumentCaptor>> argumentChangesMap; +// @Captor ArgumentCaptor argumentSkipPlugin; +// +// @BeforeEach +// void setUp() throws SQLException { +// closeable = MockitoAnnotations.openMocks(this); +// when(oldConnection.isClosed()).thenReturn(false); +// when(newConnection.createStatement()).thenReturn(statement); +// when(statement.executeQuery(any())).thenReturn(resultSet); +// when(servicesContainer.getConnectionPluginManager()).thenReturn(pluginManager); +// when(servicesContainer.getStorageService()).thenReturn(storageService); +// storageService = new TestStorageServiceImpl(mockEventPublisher); +// PluginServiceImpl.hostAvailabilityExpiringCache.clear(); +// } +// +// @AfterEach +// void cleanUp() throws Exception { +// closeable.close(); +// storageService.clearAll(); +// PluginServiceImpl.hostAvailabilityExpiringCache.clear(); +// } +// +// @Test +// public void testOldConnectionNoSuggestion() throws SQLException { +// when(pluginManager.notifyConnectionChanged(any(), any())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") +// .build(); +// +// target.setCurrentConnection(newConnection, +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); +// +// assertNotEquals(oldConnection, target.currentConnection); +// assertEquals(newConnection, target.currentConnection); +// assertEquals("new-host", target.currentHostSpec.getHost()); +// verify(oldConnection, times(1)).close(); +// } +// +// @Test +// public void testOldConnectionDisposeSuggestion() throws SQLException { +// when(pluginManager.notifyConnectionChanged(any(), any())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.DISPOSE)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") +// .build(); +// +// target.setCurrentConnection(newConnection, +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); +// +// assertNotEquals(oldConnection, target.currentConnection); +// assertEquals(newConnection, target.currentConnection); +// assertEquals("new-host", target.currentHostSpec.getHost()); +// verify(oldConnection, times(1)).close(); +// } +// +// @Test +// public void testOldConnectionPreserveSuggestion() throws SQLException { +// when(pluginManager.notifyConnectionChanged(any(), any())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.PRESERVE)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") +// .build(); +// +// target.setCurrentConnection(newConnection, +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); +// +// assertNotEquals(oldConnection, target.currentConnection); +// assertEquals(newConnection, target.currentConnection); +// assertEquals("new-host", target.currentHostSpec.getHost()); +// verify(oldConnection, times(0)).close(); +// } +// +// @Test +// public void testOldConnectionMixedSuggestion() throws SQLException { +// when(pluginManager.notifyConnectionChanged(any(), any())) +// .thenReturn( +// EnumSet.of( +// OldConnectionSuggestedAction.NO_OPINION, +// OldConnectionSuggestedAction.PRESERVE, +// OldConnectionSuggestedAction.DISPOSE)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") +// .build(); +// +// target.setCurrentConnection(newConnection, +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); +// +// assertNotEquals(oldConnection, target.currentConnection); +// assertEquals(newConnection, target.currentConnection); +// assertEquals("new-host", target.currentHostSpec.getHost()); +// verify(oldConnection, times(0)).close(); +// } +// +// @Test +// public void testChangesNewConnectionNewHostNewPortNewRoleNewAvailability() throws SQLException { +// when(pluginManager.notifyConnectionChanged( +// argumentChanges.capture(), argumentSkipPlugin.capture())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).build(); +// +// target.setCurrentConnection( +// newConnection, +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("new-host").port(2000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build()); +// +// assertNull(argumentSkipPlugin.getValue()); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// public void testChangesNewConnectionNewRoleNewAvailability() throws SQLException { +// when(pluginManager.notifyConnectionChanged( +// argumentChanges.capture(), argumentSkipPlugin.capture())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build(); +// +// target.setCurrentConnection(newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE) +// .build()); +// +// assertNull(argumentSkipPlugin.getValue()); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// public void testChangesNewConnection() throws SQLException { +// when(pluginManager.notifyConnectionChanged( +// argumentChanges.capture(), argumentSkipPlugin.capture())) +// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) +// .build(); +// +// target.setCurrentConnection( +// newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) +// .build()); +// +// assertNull(argumentSkipPlugin.getValue()); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); +// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); +// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// public void testChangesNoChanges() throws SQLException { +// when(pluginManager.notifyConnectionChanged(any(), any())).thenReturn( +// EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); +// +// PluginServiceImpl target = +// spy(new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.currentConnection = oldConnection; +// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(); +// +// target.setCurrentConnection( +// oldConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) +// .build()); +// +// verify(pluginManager, times(0)).notifyConnectionChanged(any(), any()); +// } +// +// @Test +// public void testSetNodeListAdded() throws SQLException { +// +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// when(hostListProvider.refresh()).thenReturn(Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build())); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = new ArrayList<>(); +// target.hostListProvider = hostListProvider; +// +// target.refreshHostList(); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals("hostA", target.getAllHosts().get(0).getHost()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(1, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_ADDED)); +// } +// +// @Test +// public void testSetNodeListDeleted() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// when(hostListProvider.refresh()).thenReturn(Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build())); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build()); +// target.hostListProvider = hostListProvider; +// +// target.refreshHostList(); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals("hostB", target.getAllHosts().get(0).getHost()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(1, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_DELETED)); +// } +// +// @Test +// public void testSetNodeListChanged() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// when(hostListProvider.refresh()).thenReturn( +// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA") +// .port(HostSpec.NO_PORT).role(HostRole.READER).build())); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.WRITER).build()); +// target.hostListProvider = hostListProvider; +// +// target.refreshHostList(); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals("hostA", target.getAllHosts().get(0).getHost()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(2, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostAChanges.contains(NodeChangeOptions.PROMOTED_TO_READER)); +// } +// +// @Test +// public void testSetNodeListNoChanges() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(any()); +// +// when(hostListProvider.refresh()).thenReturn( +// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build())); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build()); +// target.hostListProvider = hostListProvider; +// +// target.refreshHostList(); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals("hostA", target.getAllHosts().get(0).getHost()); +// verify(pluginManager, times(0)).notifyNodeListChanged(any()); +// } +// +// @Test +// public void testNodeAvailabilityNotChanged() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) +// .build()); +// +// Set aliases = new HashSet<>(); +// aliases.add("hostA"); +// target.setAvailability(aliases, HostAvailability.AVAILABLE); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); +// verify(pluginManager, never()).notifyNodeListChanged(any()); +// } +// +// @Test +// public void testNodeAvailabilityChanged_WentDown() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) +// .build()); +// +// Set aliases = new HashSet<>(); +// aliases.add("hostA"); +// target.setAvailability(aliases, HostAvailability.NOT_AVAILABLE); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals(HostAvailability.NOT_AVAILABLE, target.getAllHosts().get(0).getAvailability()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(2, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_DOWN)); +// } +// +// @Test +// public void testNodeAvailabilityChanged_WentUp() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.allHosts = Collections.singletonList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build()); +// +// Set aliases = new HashSet<>(); +// aliases.add("hostA"); +// target.setAvailability(aliases, HostAvailability.AVAILABLE); +// +// assertEquals(1, target.getAllHosts().size()); +// assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(2, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// public void testNodeAvailabilityChanged_WentUp_ByAlias() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build(); +// hostA.addAlias("ip-10-10-10-10"); +// hostA.addAlias("hostA.custom.domain.com"); +// final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build(); +// hostB.addAlias("ip-10-10-10-10"); +// hostB.addAlias("hostB.custom.domain.com"); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// +// target.allHosts = Arrays.asList(hostA, hostB); +// +// Set aliases = new HashSet<>(); +// aliases.add("hostA.custom.domain.com"); +// target.setAvailability(aliases, HostAvailability.AVAILABLE); +// +// assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); +// assertEquals(HostAvailability.NOT_AVAILABLE, hostB.getAvailability()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(2, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// public void testNodeAvailabilityChanged_WentUp_MultipleHostsByAlias() throws SQLException { +// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); +// +// final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build(); +// hostA.addAlias("ip-10-10-10-10"); +// hostA.addAlias("hostA.custom.domain.com"); +// final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) +// .build(); +// hostB.addAlias("ip-10-10-10-10"); +// hostB.addAlias("hostB.custom.domain.com"); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// +// target.allHosts = Arrays.asList(hostA, hostB); +// +// Set aliases = new HashSet<>(); +// aliases.add("ip-10-10-10-10"); +// target.setAvailability(aliases, HostAvailability.AVAILABLE); +// +// assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); +// assertEquals(HostAvailability.AVAILABLE, hostB.getAvailability()); +// verify(pluginManager, times(1)).notifyNodeListChanged(any()); +// +// Map> notifiedChanges = argumentChangesMap.getValue(); +// assertTrue(notifiedChanges.containsKey("hostA/")); +// EnumSet hostAChanges = notifiedChanges.get("hostA/"); +// assertEquals(2, hostAChanges.size()); +// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); +// +// assertTrue(notifiedChanges.containsKey("hostB/")); +// EnumSet hostBChanges = notifiedChanges.get("hostB/"); +// assertEquals(2, hostBChanges.size()); +// assertTrue(hostBChanges.contains(NodeChangeOptions.NODE_CHANGED)); +// assertTrue(hostBChanges.contains(NodeChangeOptions.WENT_UP)); +// } +// +// @Test +// void testRefreshHostList_withCachedHostAvailability() throws SQLException { +// final List newHostSpecs = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// final List newHostSpecs2 = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// final List expectedHostSpecs = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// final List expectedHostSpecs2 = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// when(hostListProvider.refresh()).thenReturn(newHostSpecs); +// // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// when(target.getHostListProvider()).thenReturn(hostListProvider); +// +// assertNotEquals(expectedHostSpecs, newHostSpecs); +// target.refreshHostList(); +// assertEquals(expectedHostSpecs, newHostSpecs); +// +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// target.refreshHostList(newConnection); +// assertEquals(expectedHostSpecs2, newHostSpecs); +// } +// +// @Test +// void testForceRefreshHostList_withCachedHostAvailability() throws SQLException { +// final List newHostSpecs = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// final List expectedHostSpecs = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// final List expectedHostSpecs2 = Arrays.asList( +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), +// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) +// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() +// ); +// +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// // when(hostListProvider.forceRefresh()).thenReturn(newHostSpecs); +// // when(hostListProvider.forceRefresh(newConnection)).thenReturn(newHostSpecs); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// when(target.getHostListProvider()).thenReturn(hostListProvider); +// +// assertNotEquals(expectedHostSpecs, newHostSpecs); +// target.forceRefreshHostList(); +// assertEquals(expectedHostSpecs, newHostSpecs); +// +// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, +// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); +// target.forceRefreshHostList(); +// // target.forceRefreshHostList(newConnection); +// assertEquals(expectedHostSpecs2, newHostSpecs); +// } +// +// @Test +// void testIdentifyConnectionWithNoAliases() throws SQLException { +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// when(target.getHostListProvider()).thenReturn(hostListProvider); +// +// when(target.getDialect()).thenReturn(new MysqlDialect()); +// assertNull(target.identifyConnection(newConnection)); +// } +// +// @Test +// void testIdentifyConnectionWithAliases() throws SQLException { +// final HostSpec expected = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("test") +// .build(); +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.hostListProvider = hostListProvider; +// when(target.getHostListProvider()).thenReturn(hostListProvider); +// when(hostListProvider.identifyConnection(eq(newConnection))).thenReturn(expected); +// +// when(target.getDialect()).thenReturn(new AuroraPgDialect()); +// final HostSpec actual = target.identifyConnection(newConnection); +// verify(target, never()).getCurrentHostSpec(); +// verify(hostListProvider).identifyConnection(newConnection); +// assertEquals(expected, actual); +// } +// +// @Test +// void testFillAliasesNonEmptyAliases() throws SQLException { +// final HostSpec oneAlias = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo") +// .build(); +// oneAlias.addAlias(oneAlias.asAlias()); +// +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// +// assertEquals(1, oneAlias.getAliases().size()); +// target.fillAliases(newConnection, oneAlias); +// // Fill aliases should return directly and no additional aliases should be added. +// assertEquals(1, oneAlias.getAliases().size()); +// } +// +// @ParameterizedTest +// @MethodSource("fillAliasesDialects") +// void testFillAliasesWithInstanceEndpoint(Dialect dialect, String[] expectedInstanceAliases) throws SQLException { +// final HostSpec empty = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo").build(); +// PluginServiceImpl target = spy( +// new PluginServiceImpl( +// servicesContainer, +// new ExceptionManager(), +// PROPERTIES, +// URL, +// DRIVER_PROTOCOL, +// dialectManager, +// mockTargetDriverDialect, +// configurationProfile, +// sessionStateService)); +// target.hostListProvider = hostListProvider; +// when(target.getDialect()).thenReturn(dialect); +// when(resultSet.next()).thenReturn(true, false); // Result set contains 1 row. +// when(resultSet.getString(eq(1))).thenReturn("ip"); +// if (dialect instanceof AuroraPgDialect) { +// when(hostListProvider.identifyConnection(eq(newConnection))) +// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("instance").build()); +// } +// +// target.fillAliases(newConnection, empty); +// +// final String[] aliases = empty.getAliases().toArray(new String[] {}); +// assertArrayEquals(expectedInstanceAliases, aliases); +// } +// +// private static Stream fillAliasesDialects() { +// return Stream.of( +// Arguments.of(new AuroraPgDialect(), new String[]{"instance", "foo", "ip"}), +// Arguments.of(new MysqlDialect(), new String[]{"foo", "ip"}) +// ); +// } +// } From bcca2fe75c44c61d6ff9e1501e4c67df321eb006 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 7 Nov 2025 16:01:47 -0800 Subject: [PATCH 61/90] Fix failing integ test --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 6 +++--- .../amazon/jdbc/util/monitoring/MonitorService.java | 3 ++- .../amazon/jdbc/util/monitoring/MonitorServiceImpl.java | 3 ++- .../software/amazon/jdbc/util/storage/StorageService.java | 3 ++- .../amazon/jdbc/util/storage/StorageServiceImpl.java | 3 ++- .../test/java/integration/container/tests/FailoverTest.java | 2 -- 6 files changed, 11 insertions(+), 9 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 9dbcfb696..f8b7bb258 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -121,6 +121,8 @@ public RdsHostListProvider( this.pluginService = servicesContainer.getPluginService(); this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); + + this.clusterId = CLUSTER_ID.getString(this.properties); } protected ClusterTopologyMonitor initMonitor() throws SQLException { @@ -182,8 +184,6 @@ protected void initSettings() throws SQLException { } this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); - - this.clusterId = CLUSTER_ID.getString(this.properties); this.refreshRateNano = TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); @@ -311,7 +311,7 @@ public List forceRefresh() throws SQLException, TimeoutException { @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { - + init(); ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService().get(ClusterTopologyMonitorImpl.class, this.clusterId); if (monitor == null) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java index bf4c9496a..35bbf7014 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java @@ -19,6 +19,7 @@ import java.sql.SQLException; import java.util.EnumSet; import java.util.Properties; +import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; @@ -117,7 +118,7 @@ T runIfAbsent( * @return the monitor stored at the given key. */ @Nullable - T get(Class monitorClass, Object key); + T get(Class monitorClass, @NonNull Object key); /** * Removes the monitor stored at the given key. If the expected monitor class does not match the actual monitor class diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index 509b3c8fd..3fcf03cf7 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -32,6 +32,7 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +import org.jetbrains.annotations.NotNull; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostlistprovider.Topology; @@ -278,7 +279,7 @@ protected FullServicesContainer newServicesContainer( } @Override - public @Nullable T get(Class monitorClass, Object key) { + public @Nullable T get(Class monitorClass, @NotNull Object key) { CacheContainer cacheContainer = monitorCaches.get(monitorClass); if (cacheContainer == null) { return null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java index 35770f691..8b18e5ddd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java @@ -17,6 +17,7 @@ package software.amazon.jdbc.util.storage; import java.util.Map; +import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; public interface StorageService { @@ -59,7 +60,7 @@ void registerItemClassIfAbsent( * @param the type of the item being retrieved. * @return the item stored at the given key for the given item class. */ - @Nullable V get(Class itemClass, Object key); + @Nullable V get(Class itemClass, @NonNull Object key); /** * Indicates whether an item exists under the given item class and key. diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java index e59e8d72e..10897f4cd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java @@ -25,6 +25,7 @@ import java.util.function.Supplier; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; +import org.jetbrains.annotations.NotNull; import software.amazon.jdbc.AllowedAndBlockedHosts; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.plugin.bluegreen.BlueGreenStatus; @@ -113,7 +114,7 @@ public void set(Object key, V value) { } @Override - public @Nullable V get(Class itemClass, Object key) { + public @Nullable V get(Class itemClass, @NotNull Object key) { final ExpirationCache cache = caches.get(itemClass); if (cache == null) { return null; diff --git a/wrapper/src/test/java/integration/container/tests/FailoverTest.java b/wrapper/src/test/java/integration/container/tests/FailoverTest.java index 241499f63..77bb3264d 100644 --- a/wrapper/src/test/java/integration/container/tests/FailoverTest.java +++ b/wrapper/src/test/java/integration/container/tests/FailoverTest.java @@ -571,8 +571,6 @@ public void test_failFromWriter() throws SQLException { @TestTemplate @EnableOnTestFeature(TestEnvironmentFeatures.NETWORK_OUTAGES_ENABLED) @EnableOnNumOfInstances(min = 2) - // Multi-AZ tests already simulate this in other tests instead of sending server failover requests. - @EnableOnDatabaseEngineDeployment(DatabaseEngineDeployment.AURORA) public void test_writerFailover_writerReelected() throws SQLException { final String initialWriterId = this.currentWriter; TestInstanceInfo initialWriterInstanceInfo = From f5185b7c552dbe518eec68015af7a1af7655959b Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 10 Nov 2025 16:30:15 -0800 Subject: [PATCH 62/90] fix bug wip --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index f8b7bb258..737f43706 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -182,6 +182,7 @@ protected void initSettings() throws SQLException { if (this.initialHostList == null || this.initialHostList.isEmpty()) { throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); } + this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); this.refreshRateNano = @@ -221,6 +222,10 @@ protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLE final List storedHosts = this.getStoredTopology(); if (storedHosts == null || forceUpdate) { + if (this.pluginService.getCurrentConnection() == null) { + return new FetchTopologyResult(false, this.initialHostList); + } + // We need to re-fetch topology. final List hosts = this.queryForTopology(); if (!Utils.isNullOrEmpty(hosts)) { From 709e5ac4d00ccad3de9b2f75d2f04225f48897cf Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 10 Nov 2025 17:26:23 -0800 Subject: [PATCH 63/90] Fix integ test --- .../amazon/jdbc/PartialPluginService.java | 4 +- .../dialect/HostListProviderSupplier.java | 3 +- .../GlobalAuroraHostListProvider.java | 8 +- .../hostlistprovider/RdsHostListProvider.java | 127 ++++++------------ .../bluegreen/BlueGreenStatusMonitor.java | 2 +- .../failover/FailoverConnectionPlugin.java | 5 +- .../failover2/FailoverConnectionPlugin.java | 8 +- .../plugin/staledns/AuroraStaleDnsHelper.java | 1 - .../plugin/staledns/AuroraStaleDnsPlugin.java | 7 +- .../amazon/jdbc/util/ServiceUtility.java | 2 - 10 files changed, 55 insertions(+), 112 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 8cba1f33d..16f7b09f8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -91,7 +91,7 @@ public PartialPluginService( @NonNull final String originalUrl, @NonNull final String targetDriverProtocol, @NonNull final TargetDriverDialect targetDriverDialect, - @NonNull final Dialect dbDialect) { + @NonNull final Dialect dbDialect) throws SQLException { this( servicesContainer, new ExceptionManager(), @@ -111,7 +111,7 @@ public PartialPluginService( @NonNull final String targetDriverProtocol, @NonNull final TargetDriverDialect targetDriverDialect, @NonNull final Dialect dbDialect, - @Nullable final ConfigurationProfile configurationProfile) { + @Nullable final ConfigurationProfile configurationProfile) throws SQLException { this.servicesContainer = servicesContainer; this.servicesContainer.setHostListProviderService(this); this.servicesContainer.setPluginService(this); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java index bee378f9f..d1e23e475 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java @@ -16,6 +16,7 @@ package software.amazon.jdbc.dialect; +import java.sql.SQLException; import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.hostlistprovider.HostListProvider; @@ -26,5 +27,5 @@ public interface HostListProviderSupplier { @NonNull HostListProvider getProvider( final @NonNull Properties properties, final String initialUrl, - final @NonNull FullServicesContainer servicesContainer); + final @NonNull FullServicesContainer servicesContainer) throws SQLException; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index 3bcb97e29..11267b5e3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -51,15 +51,9 @@ public class GlobalAuroraHostListProvider extends RdsHostListProvider { public GlobalAuroraHostListProvider( GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, - FullServicesContainer servicesContainer) { + FullServicesContainer servicesContainer) throws SQLException { super(topologyUtils, properties, originalUrl, servicesContainer); this.topologyUtils = topologyUtils; - } - - @Override - protected void initSettings() throws SQLException { - super.initSettings(); - String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); this.instanceTemplatesByRegion = this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 737f43706..d8c05639b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -18,14 +18,12 @@ import java.sql.Connection; import java.sql.SQLException; -import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Objects; import java.util.Properties; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; -import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; @@ -82,37 +80,30 @@ public class RdsHostListProvider implements DynamicHostListProvider, CanReleaseR protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); protected static final int DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS = 5000; - protected final ReentrantLock lock = new ReentrantLock(); static { PropertyDefinition.registerPluginProperties(RdsHostListProvider.class); } - protected final Properties properties; - protected final String originalUrl; protected final FullServicesContainer servicesContainer; + protected final PluginService pluginService; protected final HostListProviderService hostListProviderService; protected final TopologyUtils topologyUtils; - protected final PluginService pluginService; + protected final String originalUrl; + protected final Properties properties; + protected final RdsUrlType rdsUrlType; + protected final List initialHostList; + protected final HostSpec initialHostSpec; + protected final String clusterId; + protected final HostSpec instanceTemplate; + protected final long refreshRateNano; protected final long highRefreshRateNano; - protected RdsUrlType rdsUrlType; - protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null - ? TimeUnit.MILLISECONDS.toNanos(Long.parseLong(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue)) - : TimeUnit.MILLISECONDS.toNanos(30000); - protected List hostList = new ArrayList<>(); - protected List initialHostList = new ArrayList<>(); - protected HostSpec initialHostSpec; - protected String clusterId; - protected HostSpec instanceTemplate; - - protected volatile boolean isInitialized = false; - public RdsHostListProvider( final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer) { + final FullServicesContainer servicesContainer) throws SQLException { this.topologyUtils = topologyUtils; this.properties = properties; this.originalUrl = originalUrl; @@ -123,6 +114,35 @@ public RdsHostListProvider( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); this.clusterId = CLUSTER_ID.getString(this.properties); + // The initial topology is based on the connection string. + this.initialHostList = + connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, + this.hostListProviderService::getHostSpecBuilder); + if (this.initialHostList == null || this.initialHostList.isEmpty()) { + throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); + } + + this.initialHostSpec = this.initialHostList.get(0); + this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); + this.refreshRateNano = + TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); + + HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); + String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); + if (clusterInstancePattern != null) { + this.instanceTemplate = + ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); + } else { + this.instanceTemplate = + hostSpecBuilder + .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) + .hostId(this.initialHostSpec.getHostId()) + .port(this.initialHostSpec.getPort()) + .build(); + } + + validateHostPatternSetting(this.instanceTemplate.getHost()); + this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); } protected ClusterTopologyMonitor initMonitor() throws SQLException { @@ -143,7 +163,6 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { } protected List queryForTopology() throws SQLException { - init(); ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() .get(ClusterTopologyMonitorImpl.class, this.clusterId); if (monitor == null) { @@ -157,55 +176,6 @@ protected List queryForTopology() throws SQLException { } } - protected void init() throws SQLException { - if (this.isInitialized) { - return; - } - - lock.lock(); - try { - if (this.isInitialized) { - return; - } - this.initSettings(); - this.isInitialized = true; - } finally { - lock.unlock(); - } - } - - protected void initSettings() throws SQLException { - // The initial topology is based on the connection string. - this.initialHostList = - connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, - this.hostListProviderService::getHostSpecBuilder); - if (this.initialHostList == null || this.initialHostList.isEmpty()) { - throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); - } - - this.initialHostSpec = this.initialHostList.get(0); - this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); - this.refreshRateNano = - TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); - if (clusterInstancePattern != null) { - this.instanceTemplate = - ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); - } else { - this.instanceTemplate = - hostSpecBuilder - .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) - .hostId(this.initialHostSpec.getHostId()) - .port(this.initialHostSpec.getPort()) - .build(); - } - - validateHostPatternSetting(this.instanceTemplate.getHost()); - this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); - } - /** * Get cluster topology. It may require an extra call to database to fetch the latest topology. A * cached copy of topology is returned if it's not yet outdated (controlled by {@link @@ -218,14 +188,8 @@ protected void initSettings() throws SQLException { * @throws SQLException if errors occurred while retrieving the topology. */ protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLException { - init(); - final List storedHosts = this.getStoredTopology(); if (storedHosts == null || forceUpdate) { - if (this.pluginService.getCurrentConnection() == null) { - return new FetchTopologyResult(false, this.initialHostList); - } - // We need to re-fetch topology. final List hosts = this.queryForTopology(); if (!Utils.isNullOrEmpty(hosts)) { @@ -262,17 +226,12 @@ public void clear() { @Override public List refresh() throws SQLException { - init(); - final FetchTopologyResult results = getTopology(false); LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); - - this.hostList = results.hosts; - return Collections.unmodifiableList(hostList); + return Collections.unmodifiableList(results.hosts); } - public RdsUrlType getRdsUrlType() throws SQLException { - init(); + public RdsUrlType getRdsUrlType() { return this.rdsUrlType; } @@ -316,7 +275,6 @@ public List forceRefresh() throws SQLException, TimeoutException { @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { - init(); ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService().get(ClusterTopologyMonitorImpl.class, this.clusterId); if (monitor == null) { @@ -333,13 +291,11 @@ public void releaseResources() { @Override public HostRole getHostRole(Connection conn) throws SQLException { - init(); return this.topologyUtils.getHostRole(conn); } @Override public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { - init(); try { Pair instanceIds = this.topologyUtils.getInstanceId(connection); if (instanceIds == null) { @@ -388,7 +344,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { @Override public String getClusterId() throws UnsupportedOperationException, SQLException { - init(); return this.clusterId; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index c084b7e00..55f5c7e6c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -611,7 +611,7 @@ protected void notifyChanges() { } } - protected void initHostListProvider() { + protected void initHostListProvider() throws SQLException { if (this.hostListProvider != null || !this.connectionHostSpecCorrect.get()) { return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 445da8705..0eeec824a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -917,9 +917,8 @@ public Connection connect( Connection conn = null; try { - conn = - this.staleDnsHelper.getVerifiedConnection(isInitialConnection, this.hostListProviderService, - driverProtocol, hostSpec, props, connectFunc); + conn = this.staleDnsHelper.getVerifiedConnection( + isInitialConnection, this.hostListProviderService, hostSpec, props, connectFunc); } catch (final SQLException e) { if (!this.enableConnectFailover || !shouldExceptionTriggerConnectionSwitch(e)) { throw e; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 4fa30596c..3907bbc11 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -746,8 +746,8 @@ public Connection connect( Connection conn = null; if (!ENABLE_CONNECT_FAILOVER.getBoolean(props)) { - return this.staleDnsHelper.getVerifiedConnection(isInitialConnection, this.hostListProviderService, - driverProtocol, hostSpec, props, connectFunc); + return this.staleDnsHelper.getVerifiedConnection( + isInitialConnection, this.hostListProviderService, hostSpec, props, connectFunc); } final HostSpec hostSpecWithAvailability = this.pluginService.getHosts().stream() @@ -759,8 +759,8 @@ public Connection connect( || hostSpecWithAvailability.getAvailability() != HostAvailability.NOT_AVAILABLE) { try { - conn = this.staleDnsHelper.getVerifiedConnection(isInitialConnection, this.hostListProviderService, - driverProtocol, hostSpec, props, connectFunc); + conn = this.staleDnsHelper.getVerifiedConnection( + isInitialConnection, this.hostListProviderService, hostSpec, props, connectFunc); } catch (final SQLException e) { if (!this.shouldExceptionTriggerConnectionSwitch(e)) { throw e; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 4646ed999..37f92f781 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -63,7 +63,6 @@ public AuroraStaleDnsHelper(final PluginService pluginService) { public Connection getVerifiedConnection( final boolean isInitialConnection, final HostListProviderService hostListProviderService, - final String driverProtocol, final HostSpec hostSpec, final Properties props, final JdbcCallable connectFunc) throws SQLException { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index 080d19990..d980e51e3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -50,10 +50,7 @@ */ public class AuroraStaleDnsPlugin extends AbstractConnectionPlugin { - private static final Logger LOGGER = Logger.getLogger(AuroraStaleDnsPlugin.class.getName()); - private final Set subscribedMethods; - private final PluginService pluginService; private final AuroraStaleDnsHelper helper; private HostListProviderService hostListProviderService; @@ -83,8 +80,8 @@ public Connection connect( final boolean isInitialConnection, final JdbcCallable connectFunc) throws SQLException { - return this.helper.getVerifiedConnection(isInitialConnection, this.hostListProviderService, - driverProtocol, hostSpec, props, connectFunc); + return this.helper.getVerifiedConnection( + isInitialConnection, this.hostListProviderService, hostSpec, props, connectFunc); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index 3e4b134a1..9326960e6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -80,8 +80,6 @@ public FullServicesContainer createStandardServiceContainer( } pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); - pluginService.refreshHostList(); - return servicesContainer; } From 438ab145732a4cb06c0f956eb470068a45a1968c Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Mon, 10 Nov 2025 18:10:52 -0800 Subject: [PATCH 64/90] getHostListProviderSupplier -> createHostListProvider --- .../amazon/jdbc/PartialPluginService.java | 4 --- .../amazon/jdbc/PluginServiceImpl.java | 6 ++-- .../jdbc/dialect/AuroraMysqlDialect.java | 15 +++++---- .../amazon/jdbc/dialect/AuroraPgDialect.java | 12 ++++--- .../software/amazon/jdbc/dialect/Dialect.java | 6 +++- .../dialect/GlobalAuroraMysqlDialect.java | 12 ++++--- .../jdbc/dialect/GlobalAuroraPgDialect.java | 14 +++++---- .../dialect/HostListProviderSupplier.java | 31 ------------------- .../amazon/jdbc/dialect/MariaDbDialect.java | 9 ++++-- .../dialect/MultiAzClusterMysqlDialect.java | 16 +++++----- .../jdbc/dialect/MultiAzClusterPgDialect.java | 18 +++++------ .../amazon/jdbc/dialect/MysqlDialect.java | 9 ++++-- .../amazon/jdbc/dialect/PgDialect.java | 8 +++-- .../amazon/jdbc/dialect/UnknownDialect.java | 9 ++++-- .../bluegreen/BlueGreenStatusMonitor.java | 8 ++--- .../plugin/efm2/HostMonitorServiceImpl.java | 1 + .../amazon/jdbc/util/ServiceUtility.java | 30 +++++++++--------- 17 files changed, 96 insertions(+), 112 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 16f7b09f8..50685c66e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -36,7 +36,6 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.cleanup.CanReleaseResources; import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; @@ -133,9 +132,6 @@ public PartialPluginService( this.exceptionHandler = this.configurationProfile != null && this.configurationProfile.getExceptionHandler() != null ? this.configurationProfile.getExceptionHandler() : null; - - HostListProviderSupplier supplier = this.dbDialect.getHostListProviderSupplier(); - this.hostListProvider = supplier.getProvider(this.props, this.originalUrl, this.servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 0bd7a4a60..111199a46 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -41,7 +41,6 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.DialectManager; import software.amazon.jdbc.dialect.DialectProvider; -import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; @@ -679,8 +678,9 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } - final HostListProviderSupplier supplier = this.dialect.getHostListProviderSupplier(); - this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); + final HostListProvider provider = + this.dialect.createHostListProvider(this.servicesContainer, this.props, this.originalUrl); + this.setHostListProvider(provider); // TODO: refreshHostList this.refreshHostList(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 4402a1ed3..5456e4565 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -17,11 +17,15 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; +import java.sql.SQLException; import java.util.Collections; import java.util.List; +import java.util.Properties; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.util.FullServicesContainer; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -55,12 +59,11 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final TopologyUtils topologyUtils = - new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final TopologyUtils topologyUtils = + new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); + return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index df1df5ee4..2337eebb8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -22,11 +22,14 @@ import java.sql.Statement; import java.util.Arrays; import java.util.List; +import java.util.Properties; import java.util.logging.Logger; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { @@ -102,12 +105,11 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final TopologyUtils topologyUtils = + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java index 5f09aae0b..50ffdba98 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java @@ -17,13 +17,16 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; +import java.sql.SQLException; import java.util.EnumSet; import java.util.List; import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.exceptions.ExceptionHandler; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.util.FullServicesContainer; public interface Dialect { @@ -35,7 +38,8 @@ public interface Dialect { ExceptionHandler getExceptionHandler(); - HostListProviderSupplier getHostListProviderSupplier(); + HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException; String getHostAliasQuery(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 655123cd2..aabc7822e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -22,8 +22,11 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; +import java.util.Properties; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.util.FullServicesContainer; public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalAuroraTopologyDialect { @@ -70,12 +73,11 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final GlobalAuroraTopologyUtils topologyUtils = + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final GlobalAuroraTopologyUtils topologyUtils = new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + return new GlobalAuroraHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 2efd96b2c..df5d1dc07 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -22,9 +22,12 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; +import java.util.Properties; import java.util.logging.Logger; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { @@ -85,12 +88,11 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final GlobalAuroraTopologyUtils topologyUtils = - new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); + return new GlobalAuroraHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java deleted file mode 100644 index d1e23e475..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.dialect; - -import java.sql.SQLException; -import java.util.Properties; -import org.checkerframework.checker.nullness.qual.NonNull; -import software.amazon.jdbc.hostlistprovider.HostListProvider; -import software.amazon.jdbc.util.FullServicesContainer; - -@FunctionalInterface -public interface HostListProviderSupplier { - @NonNull HostListProvider getProvider( - final @NonNull Properties properties, - final String initialUrl, - final @NonNull FullServicesContainer servicesContainer) throws SQLException; -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java index 58453f6fa..a054bc9ba 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java @@ -29,7 +29,9 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MariaDBExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.util.FullServicesContainer; public class MariaDbDialect implements Dialect { @@ -80,9 +82,10 @@ public ExceptionHandler getExceptionHandler() { return mariaDBExceptionHandler; } - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> - new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); + @Override + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 5075a1393..01240aaaf 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -26,12 +26,14 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; @@ -83,15 +85,11 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - } - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 6e6ad013d..47b1a8b7c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -21,14 +21,17 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.List; +import java.util.Properties; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.FullServicesContainer; public class MultiAzClusterPgDialect extends PgDialect implements MultiAzClusterDialect { @@ -78,16 +81,11 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> { - final PluginService pluginService = servicesContainer.getPluginService(); - final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); - if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - } - - return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); - }; + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index f24ad1de8..d3bb950f3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -29,7 +29,9 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MySQLExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.util.FullServicesContainer; public class MysqlDialect implements Dialect { @@ -84,9 +86,10 @@ public ExceptionHandler getExceptionHandler() { return mySQLExceptionHandler; } - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> - new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); + @Override + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 13031f012..792e5eb6d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -29,7 +29,9 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.PgExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.util.FullServicesContainer; /** * Generic dialect for any Postgresql database. @@ -76,9 +78,9 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> - new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java index 067261242..da346ad9a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java @@ -17,6 +17,7 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; +import java.sql.SQLException; import java.util.Arrays; import java.util.EnumSet; import java.util.List; @@ -26,7 +27,9 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.GenericExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; +import software.amazon.jdbc.util.FullServicesContainer; public class UnknownDialect implements Dialect { @@ -82,9 +85,9 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProviderSupplier getHostListProviderSupplier() { - return (properties, initialUrl, servicesContainer) -> - new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProvider createHostListProvider( + FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { + return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 55f5c7e6c..9325de25d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -632,12 +632,8 @@ protected void initHostListProvider() throws SQLException { final HostSpec connectionHostSpecCopy = this.connectionHostSpec.get(); if (connectionHostSpecCopy != null) { String hostListProviderUrl = String.format("%s%s/", protocol, connectionHostSpecCopy.getHostAndPort()); - this.hostListProvider = this.pluginService.getDialect() - .getHostListProviderSupplier() - .getProvider( - hostListProperties, - hostListProviderUrl, - this.servicesContainer); + this.hostListProvider = this.pluginService.getDialect().createHostListProvider( + this.servicesContainer, hostListProperties, hostListProviderUrl); } else { LOGGER.warning(() -> Messages.get("bgd.hostSpecNull")); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java index e6a1eadc9..ae46b27f9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java @@ -57,6 +57,7 @@ public class HostMonitorServiceImpl implements HostMonitorService { public HostMonitorServiceImpl(final @NonNull FullServicesContainer serviceContainer, Properties props) { this.serviceContainer = serviceContainer; + // TODO: Can we get rid of the core monitor service class? this.coreMonitorService = serviceContainer.getMonitorService(); this.pluginService = serviceContainer.getPluginService(); this.telemetryFactory = serviceContainer.getTelemetryFactory(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index 9326960e6..f49c6789f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -24,7 +24,6 @@ import software.amazon.jdbc.PartialPluginService; import software.amazon.jdbc.PluginServiceImpl; import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; @@ -52,15 +51,15 @@ public FullServicesContainer createStandardServiceContainer( TargetDriverDialect driverDialect, Properties props, @Nullable ConfigurationProfile configurationProfile) throws SQLException { - FullServicesContainer servicesContainer = + FullServicesContainer serviceContainer = new FullServicesContainerImpl(storageService, monitorService, defaultConnectionProvider, telemetryFactory); ConnectionPluginManager pluginManager = new ConnectionPluginManager(props, telemetryFactory, defaultConnectionProvider, effectiveConnectionProvider); - servicesContainer.setConnectionPluginManager(pluginManager); + serviceContainer.setConnectionPluginManager(pluginManager); PluginServiceImpl pluginService = new PluginServiceImpl( - servicesContainer, + serviceContainer, props, originalUrl, targetDriverProtocol, @@ -68,19 +67,17 @@ public FullServicesContainer createStandardServiceContainer( configurationProfile ); - servicesContainer.setHostListProviderService(pluginService); - servicesContainer.setPluginService(pluginService); - servicesContainer.setPluginManagerService(pluginService); + serviceContainer.setHostListProviderService(pluginService); + serviceContainer.setPluginService(pluginService); + serviceContainer.setPluginManagerService(pluginService); - pluginManager.initPlugins(servicesContainer, configurationProfile); - final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProviderSupplier(); - if (supplier != null) { - final HostListProvider provider = supplier.getProvider(props, originalUrl, servicesContainer); - pluginService.setHostListProvider(provider); - } + pluginManager.initPlugins(serviceContainer, configurationProfile); + final HostListProvider provider = + pluginService.getDialect().createHostListProvider(serviceContainer, props, originalUrl); + pluginService.setHostListProvider(provider); pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); - return servicesContainer; + return serviceContainer; } public FullServicesContainer createMinimalServiceContainer( @@ -113,6 +110,11 @@ public FullServicesContainer createMinimalServiceContainer( serviceContainer.setPluginManagerService(pluginService); pluginManager.initPlugins(serviceContainer, null); + final HostListProvider provider = + pluginService.getDialect().createHostListProvider(serviceContainer, props, originalUrl); + pluginService.setHostListProvider(provider); + + pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); return serviceContainer; } From 400295ba0a942bc95b9a9fbfbe548e63777aece3 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 12 Nov 2025 13:33:14 -0800 Subject: [PATCH 65/90] unit test wip --- .../ConnectionStringHostListProvider.java | 13 +- .../PgTargetDriverDialect.java | 2 +- .../amazon/jdbc/PluginServiceImplTests.java | 1896 ++++++++--------- 3 files changed, 951 insertions(+), 960 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index d811309a0..6de7747d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -36,7 +36,6 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider private static final Logger LOGGER = Logger.getLogger(ConnectionStringHostListProvider.class.getName()); final List hostList = new ArrayList<>(); - private boolean isInitialized = false; private final boolean isSingleWriterConnectionString; private final ConnectionUrlParser connectionUrlParser; private final String initialUrl; @@ -52,7 +51,7 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider public ConnectionStringHostListProvider( final @NonNull Properties properties, final String initialUrl, - final @NonNull HostListProviderService hostListProviderService) { + final @NonNull HostListProviderService hostListProviderService) throws SQLException { this(properties, initialUrl, hostListProviderService, new ConnectionUrlParser()); } @@ -60,18 +59,13 @@ public ConnectionStringHostListProvider( final @NonNull Properties properties, final String initialUrl, final @NonNull HostListProviderService hostListProviderService, - final @NonNull ConnectionUrlParser connectionUrlParser) { + final @NonNull ConnectionUrlParser connectionUrlParser) throws SQLException { this.isSingleWriterConnectionString = SINGLE_WRITER_CONNECTION_STRING.getBoolean(properties); this.initialUrl = initialUrl; this.connectionUrlParser = connectionUrlParser; this.hostListProviderService = hostListProviderService; - } - private void init() throws SQLException { - if (this.isInitialized) { - return; - } this.hostList.addAll( this.connectionUrlParser.getHostsFromConnectionUrl(this.initialUrl, this.isSingleWriterConnectionString, this.hostListProviderService::getHostSpecBuilder)); @@ -81,18 +75,15 @@ private void init() throws SQLException { } this.hostListProviderService.setInitialConnectionHostSpec(this.hostList.get(0)); - this.isInitialized = true; } @Override public List refresh() throws SQLException { - init(); return Collections.unmodifiableList(hostList); } @Override public List forceRefresh() throws SQLException { - init(); return Collections.unmodifiableList(hostList); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/PgTargetDriverDialect.java b/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/PgTargetDriverDialect.java index b4c56f334..5d7f63fb3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/PgTargetDriverDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/targetdriverdialect/PgTargetDriverDialect.java @@ -98,7 +98,7 @@ public boolean isDialect(String dataSourceClass) { @Override public ConnectInfo prepareConnectInfo(final @NonNull String protocol, final @NonNull HostSpec hostSpec, - final @NonNull Properties props) throws SQLException { + final @NonNull Properties props) { final String databaseName = PropertyDefinition.DATABASE.getString(props) != null diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index 6b1fa58e6..ff7e4ae8b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -1,948 +1,948 @@ -// /* -// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// * -// * Licensed under the Apache License, Version 2.0 (the "License"). -// * You may not use this file except in compliance with the License. -// * You may obtain a copy of the License at -// * -// * http://www.apache.org/licenses/LICENSE-2.0 -// * -// * Unless required by applicable law or agreed to in writing, software -// * distributed under the License is distributed on an "AS IS" BASIS, -// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// * See the License for the specific language governing permissions and -// * limitations under the License. -// */ -// -// package software.amazon.jdbc; -// -// import static org.junit.jupiter.api.Assertions.assertArrayEquals; -// import static org.junit.jupiter.api.Assertions.assertEquals; -// import static org.junit.jupiter.api.Assertions.assertFalse; -// import static org.junit.jupiter.api.Assertions.assertNotEquals; -// import static org.junit.jupiter.api.Assertions.assertNull; -// import static org.junit.jupiter.api.Assertions.assertTrue; -// import static org.mockito.ArgumentMatchers.any; -// import static org.mockito.ArgumentMatchers.eq; -// import static org.mockito.Mockito.doNothing; -// import static org.mockito.Mockito.never; -// import static org.mockito.Mockito.spy; -// import static org.mockito.Mockito.times; -// import static org.mockito.Mockito.verify; -// import static org.mockito.Mockito.when; -// -// import java.sql.Connection; -// import java.sql.ResultSet; -// import java.sql.SQLException; -// import java.sql.Statement; -// import java.util.ArrayList; -// import java.util.Arrays; -// import java.util.Collections; -// import java.util.EnumSet; -// import java.util.HashSet; -// import java.util.List; -// import java.util.Map; -// import java.util.Properties; -// import java.util.Set; -// import java.util.stream.Stream; -// import org.junit.jupiter.api.AfterEach; -// import org.junit.jupiter.api.BeforeEach; -// import org.junit.jupiter.api.Test; -// import org.junit.jupiter.params.ParameterizedTest; -// import org.junit.jupiter.params.provider.Arguments; -// import org.junit.jupiter.params.provider.MethodSource; -// import org.mockito.ArgumentCaptor; -// import org.mockito.Captor; -// import org.mockito.Mock; -// import org.mockito.MockitoAnnotations; -// import software.amazon.jdbc.dialect.AuroraPgDialect; -// import software.amazon.jdbc.dialect.Dialect; -// import software.amazon.jdbc.dialect.DialectManager; -// import software.amazon.jdbc.dialect.MysqlDialect; -// import software.amazon.jdbc.exceptions.ExceptionManager; -// import software.amazon.jdbc.hostavailability.HostAvailability; -// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -// import software.amazon.jdbc.hostlistprovider.HostListProvider; -// import software.amazon.jdbc.profile.ConfigurationProfile; -// import software.amazon.jdbc.profile.ConfigurationProfileBuilder; -// import software.amazon.jdbc.states.SessionStateService; -// import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; -// import software.amazon.jdbc.util.FullServicesContainer; -// import software.amazon.jdbc.util.events.EventPublisher; -// import software.amazon.jdbc.util.storage.StorageService; -// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; -// -// public class PluginServiceImplTests { -// -// private static final Properties PROPERTIES = new Properties(); -// private static final String URL = "url"; -// private static final String DRIVER_PROTOCOL = "driverProtocol"; -// private StorageService storageService; -// private AutoCloseable closeable; -// -// @Mock FullServicesContainer servicesContainer; -// @Mock EventPublisher mockEventPublisher; -// @Mock ConnectionPluginManager pluginManager; -// @Mock Connection newConnection; -// @Mock Connection oldConnection; -// @Mock HostListProvider hostListProvider; -// @Mock DialectManager dialectManager; -// @Mock TargetDriverDialect mockTargetDriverDialect; -// @Mock Statement statement; -// @Mock ResultSet resultSet; -// ConfigurationProfile configurationProfile = ConfigurationProfileBuilder.get().withName("test").build(); -// @Mock SessionStateService sessionStateService; -// -// @Captor ArgumentCaptor> argumentChanges; -// @Captor ArgumentCaptor>> argumentChangesMap; -// @Captor ArgumentCaptor argumentSkipPlugin; -// -// @BeforeEach -// void setUp() throws SQLException { -// closeable = MockitoAnnotations.openMocks(this); -// when(oldConnection.isClosed()).thenReturn(false); -// when(newConnection.createStatement()).thenReturn(statement); -// when(statement.executeQuery(any())).thenReturn(resultSet); -// when(servicesContainer.getConnectionPluginManager()).thenReturn(pluginManager); -// when(servicesContainer.getStorageService()).thenReturn(storageService); -// storageService = new TestStorageServiceImpl(mockEventPublisher); -// PluginServiceImpl.hostAvailabilityExpiringCache.clear(); -// } -// -// @AfterEach -// void cleanUp() throws Exception { -// closeable.close(); -// storageService.clearAll(); -// PluginServiceImpl.hostAvailabilityExpiringCache.clear(); -// } -// -// @Test -// public void testOldConnectionNoSuggestion() throws SQLException { -// when(pluginManager.notifyConnectionChanged(any(), any())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") -// .build(); -// -// target.setCurrentConnection(newConnection, -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); -// -// assertNotEquals(oldConnection, target.currentConnection); -// assertEquals(newConnection, target.currentConnection); -// assertEquals("new-host", target.currentHostSpec.getHost()); -// verify(oldConnection, times(1)).close(); -// } -// -// @Test -// public void testOldConnectionDisposeSuggestion() throws SQLException { -// when(pluginManager.notifyConnectionChanged(any(), any())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.DISPOSE)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") -// .build(); -// -// target.setCurrentConnection(newConnection, -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); -// -// assertNotEquals(oldConnection, target.currentConnection); -// assertEquals(newConnection, target.currentConnection); -// assertEquals("new-host", target.currentHostSpec.getHost()); -// verify(oldConnection, times(1)).close(); -// } -// -// @Test -// public void testOldConnectionPreserveSuggestion() throws SQLException { -// when(pluginManager.notifyConnectionChanged(any(), any())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.PRESERVE)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") -// .build(); -// -// target.setCurrentConnection(newConnection, -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); -// -// assertNotEquals(oldConnection, target.currentConnection); -// assertEquals(newConnection, target.currentConnection); -// assertEquals("new-host", target.currentHostSpec.getHost()); -// verify(oldConnection, times(0)).close(); -// } -// -// @Test -// public void testOldConnectionMixedSuggestion() throws SQLException { -// when(pluginManager.notifyConnectionChanged(any(), any())) -// .thenReturn( -// EnumSet.of( -// OldConnectionSuggestedAction.NO_OPINION, -// OldConnectionSuggestedAction.PRESERVE, -// OldConnectionSuggestedAction.DISPOSE)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") -// .build(); -// -// target.setCurrentConnection(newConnection, -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); -// -// assertNotEquals(oldConnection, target.currentConnection); -// assertEquals(newConnection, target.currentConnection); -// assertEquals("new-host", target.currentHostSpec.getHost()); -// verify(oldConnection, times(0)).close(); -// } -// -// @Test -// public void testChangesNewConnectionNewHostNewPortNewRoleNewAvailability() throws SQLException { -// when(pluginManager.notifyConnectionChanged( -// argumentChanges.capture(), argumentSkipPlugin.capture())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).build(); -// -// target.setCurrentConnection( -// newConnection, -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("new-host").port(2000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build()); -// -// assertNull(argumentSkipPlugin.getValue()); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// public void testChangesNewConnectionNewRoleNewAvailability() throws SQLException { -// when(pluginManager.notifyConnectionChanged( -// argumentChanges.capture(), argumentSkipPlugin.capture())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build(); -// -// target.setCurrentConnection(newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE) -// .build()); -// -// assertNull(argumentSkipPlugin.getValue()); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// public void testChangesNewConnection() throws SQLException { -// when(pluginManager.notifyConnectionChanged( -// argumentChanges.capture(), argumentSkipPlugin.capture())) -// .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) -// .build(); -// -// target.setCurrentConnection( -// newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) -// .build()); -// -// assertNull(argumentSkipPlugin.getValue()); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); -// assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); -// assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// public void testChangesNoChanges() throws SQLException { -// when(pluginManager.notifyConnectionChanged(any(), any())).thenReturn( -// EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); -// -// PluginServiceImpl target = -// spy(new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.currentConnection = oldConnection; -// target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(); -// -// target.setCurrentConnection( -// oldConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) -// .build()); -// -// verify(pluginManager, times(0)).notifyConnectionChanged(any(), any()); -// } -// -// @Test -// public void testSetNodeListAdded() throws SQLException { -// -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// when(hostListProvider.refresh()).thenReturn(Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build())); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = new ArrayList<>(); -// target.hostListProvider = hostListProvider; -// -// target.refreshHostList(); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals("hostA", target.getAllHosts().get(0).getHost()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(1, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_ADDED)); -// } -// -// @Test -// public void testSetNodeListDeleted() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// when(hostListProvider.refresh()).thenReturn(Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build())); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build()); -// target.hostListProvider = hostListProvider; -// -// target.refreshHostList(); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals("hostB", target.getAllHosts().get(0).getHost()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(1, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_DELETED)); -// } -// -// @Test -// public void testSetNodeListChanged() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// when(hostListProvider.refresh()).thenReturn( -// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA") -// .port(HostSpec.NO_PORT).role(HostRole.READER).build())); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.WRITER).build()); -// target.hostListProvider = hostListProvider; -// -// target.refreshHostList(); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals("hostA", target.getAllHosts().get(0).getHost()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(2, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostAChanges.contains(NodeChangeOptions.PROMOTED_TO_READER)); -// } -// -// @Test -// public void testSetNodeListNoChanges() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(any()); -// -// when(hostListProvider.refresh()).thenReturn( -// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build())); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build()); -// target.hostListProvider = hostListProvider; -// -// target.refreshHostList(); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals("hostA", target.getAllHosts().get(0).getHost()); -// verify(pluginManager, times(0)).notifyNodeListChanged(any()); -// } -// -// @Test -// public void testNodeAvailabilityNotChanged() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) -// .build()); -// -// Set aliases = new HashSet<>(); -// aliases.add("hostA"); -// target.setAvailability(aliases, HostAvailability.AVAILABLE); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); -// verify(pluginManager, never()).notifyNodeListChanged(any()); -// } -// -// @Test -// public void testNodeAvailabilityChanged_WentDown() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) -// .build()); -// -// Set aliases = new HashSet<>(); -// aliases.add("hostA"); -// target.setAvailability(aliases, HostAvailability.NOT_AVAILABLE); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals(HostAvailability.NOT_AVAILABLE, target.getAllHosts().get(0).getAvailability()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(2, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_DOWN)); -// } -// -// @Test -// public void testNodeAvailabilityChanged_WentUp() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.allHosts = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build()); -// -// Set aliases = new HashSet<>(); -// aliases.add("hostA"); -// target.setAvailability(aliases, HostAvailability.AVAILABLE); -// -// assertEquals(1, target.getAllHosts().size()); -// assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(2, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// public void testNodeAvailabilityChanged_WentUp_ByAlias() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build(); -// hostA.addAlias("ip-10-10-10-10"); -// hostA.addAlias("hostA.custom.domain.com"); -// final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build(); -// hostB.addAlias("ip-10-10-10-10"); -// hostB.addAlias("hostB.custom.domain.com"); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// -// target.allHosts = Arrays.asList(hostA, hostB); -// -// Set aliases = new HashSet<>(); -// aliases.add("hostA.custom.domain.com"); -// target.setAvailability(aliases, HostAvailability.AVAILABLE); -// -// assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); -// assertEquals(HostAvailability.NOT_AVAILABLE, hostB.getAvailability()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(2, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// public void testNodeAvailabilityChanged_WentUp_MultipleHostsByAlias() throws SQLException { -// doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); -// -// final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build(); -// hostA.addAlias("ip-10-10-10-10"); -// hostA.addAlias("hostA.custom.domain.com"); -// final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) -// .build(); -// hostB.addAlias("ip-10-10-10-10"); -// hostB.addAlias("hostB.custom.domain.com"); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// -// target.allHosts = Arrays.asList(hostA, hostB); -// -// Set aliases = new HashSet<>(); -// aliases.add("ip-10-10-10-10"); -// target.setAvailability(aliases, HostAvailability.AVAILABLE); -// -// assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); -// assertEquals(HostAvailability.AVAILABLE, hostB.getAvailability()); -// verify(pluginManager, times(1)).notifyNodeListChanged(any()); -// -// Map> notifiedChanges = argumentChangesMap.getValue(); -// assertTrue(notifiedChanges.containsKey("hostA/")); -// EnumSet hostAChanges = notifiedChanges.get("hostA/"); -// assertEquals(2, hostAChanges.size()); -// assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); -// -// assertTrue(notifiedChanges.containsKey("hostB/")); -// EnumSet hostBChanges = notifiedChanges.get("hostB/"); -// assertEquals(2, hostBChanges.size()); -// assertTrue(hostBChanges.contains(NodeChangeOptions.NODE_CHANGED)); -// assertTrue(hostBChanges.contains(NodeChangeOptions.WENT_UP)); -// } -// -// @Test -// void testRefreshHostList_withCachedHostAvailability() throws SQLException { -// final List newHostSpecs = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// final List newHostSpecs2 = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// final List expectedHostSpecs = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// final List expectedHostSpecs2 = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// when(hostListProvider.refresh()).thenReturn(newHostSpecs); -// // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// when(target.getHostListProvider()).thenReturn(hostListProvider); -// -// assertNotEquals(expectedHostSpecs, newHostSpecs); -// target.refreshHostList(); -// assertEquals(expectedHostSpecs, newHostSpecs); -// -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// target.refreshHostList(newConnection); -// assertEquals(expectedHostSpecs2, newHostSpecs); -// } -// -// @Test -// void testForceRefreshHostList_withCachedHostAvailability() throws SQLException { -// final List newHostSpecs = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// final List expectedHostSpecs = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// final List expectedHostSpecs2 = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) -// .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() -// ); -// -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// // when(hostListProvider.forceRefresh()).thenReturn(newHostSpecs); -// // when(hostListProvider.forceRefresh(newConnection)).thenReturn(newHostSpecs); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// when(target.getHostListProvider()).thenReturn(hostListProvider); -// -// assertNotEquals(expectedHostSpecs, newHostSpecs); -// target.forceRefreshHostList(); -// assertEquals(expectedHostSpecs, newHostSpecs); -// -// PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, -// PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); -// target.forceRefreshHostList(); -// // target.forceRefreshHostList(newConnection); -// assertEquals(expectedHostSpecs2, newHostSpecs); -// } -// -// @Test -// void testIdentifyConnectionWithNoAliases() throws SQLException { -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// when(target.getHostListProvider()).thenReturn(hostListProvider); -// -// when(target.getDialect()).thenReturn(new MysqlDialect()); -// assertNull(target.identifyConnection(newConnection)); -// } -// -// @Test -// void testIdentifyConnectionWithAliases() throws SQLException { -// final HostSpec expected = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("test") -// .build(); -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.hostListProvider = hostListProvider; -// when(target.getHostListProvider()).thenReturn(hostListProvider); -// when(hostListProvider.identifyConnection(eq(newConnection))).thenReturn(expected); -// -// when(target.getDialect()).thenReturn(new AuroraPgDialect()); -// final HostSpec actual = target.identifyConnection(newConnection); -// verify(target, never()).getCurrentHostSpec(); -// verify(hostListProvider).identifyConnection(newConnection); -// assertEquals(expected, actual); -// } -// -// @Test -// void testFillAliasesNonEmptyAliases() throws SQLException { -// final HostSpec oneAlias = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo") -// .build(); -// oneAlias.addAlias(oneAlias.asAlias()); -// -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// -// assertEquals(1, oneAlias.getAliases().size()); -// target.fillAliases(newConnection, oneAlias); -// // Fill aliases should return directly and no additional aliases should be added. -// assertEquals(1, oneAlias.getAliases().size()); -// } -// -// @ParameterizedTest -// @MethodSource("fillAliasesDialects") -// void testFillAliasesWithInstanceEndpoint(Dialect dialect, String[] expectedInstanceAliases) throws SQLException { -// final HostSpec empty = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo").build(); -// PluginServiceImpl target = spy( -// new PluginServiceImpl( -// servicesContainer, -// new ExceptionManager(), -// PROPERTIES, -// URL, -// DRIVER_PROTOCOL, -// dialectManager, -// mockTargetDriverDialect, -// configurationProfile, -// sessionStateService)); -// target.hostListProvider = hostListProvider; -// when(target.getDialect()).thenReturn(dialect); -// when(resultSet.next()).thenReturn(true, false); // Result set contains 1 row. -// when(resultSet.getString(eq(1))).thenReturn("ip"); -// if (dialect instanceof AuroraPgDialect) { -// when(hostListProvider.identifyConnection(eq(newConnection))) -// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("instance").build()); -// } -// -// target.fillAliases(newConnection, empty); -// -// final String[] aliases = empty.getAliases().toArray(new String[] {}); -// assertArrayEquals(expectedInstanceAliases, aliases); -// } -// -// private static Stream fillAliasesDialects() { -// return Stream.of( -// Arguments.of(new AuroraPgDialect(), new String[]{"instance", "foo", "ip"}), -// Arguments.of(new MysqlDialect(), new String[]{"foo", "ip"}) -// ); -// } -// } +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doNothing; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import java.util.Set; +import java.util.concurrent.TimeoutException; +import java.util.stream.Stream; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import software.amazon.jdbc.dialect.AuroraPgDialect; +import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.DialectManager; +import software.amazon.jdbc.dialect.MysqlDialect; +import software.amazon.jdbc.exceptions.ExceptionManager; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.profile.ConfigurationProfile; +import software.amazon.jdbc.profile.ConfigurationProfileBuilder; +import software.amazon.jdbc.states.SessionStateService; +import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.events.EventPublisher; +import software.amazon.jdbc.util.storage.StorageService; +import software.amazon.jdbc.util.storage.TestStorageServiceImpl; + +public class PluginServiceImplTests { + + private static final Properties PROPERTIES = new Properties(); + private static final String URL = "url"; + private static final String DRIVER_PROTOCOL = "driverProtocol"; + private StorageService storageService; + private AutoCloseable closeable; + + @Mock FullServicesContainer servicesContainer; + @Mock EventPublisher mockEventPublisher; + @Mock ConnectionPluginManager pluginManager; + @Mock Connection newConnection; + @Mock Connection oldConnection; + @Mock HostListProvider hostListProvider; + @Mock DialectManager dialectManager; + @Mock TargetDriverDialect mockTargetDriverDialect; + @Mock Statement statement; + @Mock ResultSet resultSet; + ConfigurationProfile configurationProfile = ConfigurationProfileBuilder.get().withName("test").build(); + @Mock SessionStateService sessionStateService; + + @Captor ArgumentCaptor> argumentChanges; + @Captor ArgumentCaptor>> argumentChangesMap; + @Captor ArgumentCaptor argumentSkipPlugin; + + @BeforeEach + void setUp() throws SQLException { + closeable = MockitoAnnotations.openMocks(this); + when(oldConnection.isClosed()).thenReturn(false); + when(newConnection.createStatement()).thenReturn(statement); + when(statement.executeQuery(any())).thenReturn(resultSet); + when(servicesContainer.getConnectionPluginManager()).thenReturn(pluginManager); + when(servicesContainer.getStorageService()).thenReturn(storageService); + storageService = new TestStorageServiceImpl(mockEventPublisher); + PluginServiceImpl.hostAvailabilityExpiringCache.clear(); + } + + @AfterEach + void cleanUp() throws Exception { + closeable.close(); + storageService.clearAll(); + PluginServiceImpl.hostAvailabilityExpiringCache.clear(); + } + + @Test + public void testOldConnectionNoSuggestion() throws SQLException { + when(pluginManager.notifyConnectionChanged(any(), any())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") + .build(); + + target.setCurrentConnection(newConnection, + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); + + assertNotEquals(oldConnection, target.currentConnection); + assertEquals(newConnection, target.currentConnection); + assertEquals("new-host", target.currentHostSpec.getHost()); + verify(oldConnection, times(1)).close(); + } + + @Test + public void testOldConnectionDisposeSuggestion() throws SQLException { + when(pluginManager.notifyConnectionChanged(any(), any())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.DISPOSE)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") + .build(); + + target.setCurrentConnection(newConnection, + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); + + assertNotEquals(oldConnection, target.currentConnection); + assertEquals(newConnection, target.currentConnection); + assertEquals("new-host", target.currentHostSpec.getHost()); + verify(oldConnection, times(1)).close(); + } + + @Test + public void testOldConnectionPreserveSuggestion() throws SQLException { + when(pluginManager.notifyConnectionChanged(any(), any())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.PRESERVE)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") + .build(); + + target.setCurrentConnection(newConnection, + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); + + assertNotEquals(oldConnection, target.currentConnection); + assertEquals(newConnection, target.currentConnection); + assertEquals("new-host", target.currentHostSpec.getHost()); + verify(oldConnection, times(0)).close(); + } + + @Test + public void testOldConnectionMixedSuggestion() throws SQLException { + when(pluginManager.notifyConnectionChanged(any(), any())) + .thenReturn( + EnumSet.of( + OldConnectionSuggestedAction.NO_OPINION, + OldConnectionSuggestedAction.PRESERVE, + OldConnectionSuggestedAction.DISPOSE)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("old-host") + .build(); + + target.setCurrentConnection(newConnection, + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("new-host").build()); + + assertNotEquals(oldConnection, target.currentConnection); + assertEquals(newConnection, target.currentConnection); + assertEquals("new-host", target.currentHostSpec.getHost()); + verify(oldConnection, times(0)).close(); + } + + @Test + public void testChangesNewConnectionNewHostNewPortNewRoleNewAvailability() throws SQLException { + when(pluginManager.notifyConnectionChanged( + argumentChanges.capture(), argumentSkipPlugin.capture())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).build(); + + target.setCurrentConnection( + newConnection, + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("new-host").port(2000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build()); + + assertNull(argumentSkipPlugin.getValue()); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); + } + + @Test + public void testChangesNewConnectionNewRoleNewAvailability() throws SQLException { + when(pluginManager.notifyConnectionChanged( + argumentChanges.capture(), argumentSkipPlugin.capture())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build(); + + target.setCurrentConnection(newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.WRITER).availability(HostAvailability.AVAILABLE) + .build()); + + assertNull(argumentSkipPlugin.getValue()); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); + } + + @Test + public void testChangesNewConnection() throws SQLException { + when(pluginManager.notifyConnectionChanged( + argumentChanges.capture(), argumentSkipPlugin.capture())) + .thenReturn(EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) + .build(); + + target.setCurrentConnection( + newConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) + .build()); + + assertNull(argumentSkipPlugin.getValue()); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_CHANGED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_ADDED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.NODE_DELETED)); + assertTrue(argumentChanges.getValue().contains(NodeChangeOptions.CONNECTION_OBJECT_CHANGED)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.HOSTNAME)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_READER)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.PROMOTED_TO_WRITER)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_DOWN)); + assertFalse(argumentChanges.getValue().contains(NodeChangeOptions.WENT_UP)); + } + + @Test + public void testChangesNoChanges() throws SQLException { + when(pluginManager.notifyConnectionChanged(any(), any())).thenReturn( + EnumSet.of(OldConnectionSuggestedAction.NO_OPINION)); + + PluginServiceImpl target = + spy(new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.currentConnection = oldConnection; + target.currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(); + + target.setCurrentConnection( + oldConnection, new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("old-host").port(1000).role(HostRole.READER).availability(HostAvailability.AVAILABLE) + .build()); + + verify(pluginManager, times(0)).notifyConnectionChanged(any(), any()); + } + + @Test + public void testSetNodeListAdded() throws SQLException { + + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + when(hostListProvider.refresh()).thenReturn(Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build())); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = new ArrayList<>(); + target.hostListProvider = hostListProvider; + + target.refreshHostList(); + + assertEquals(1, target.getAllHosts().size()); + assertEquals("hostA", target.getAllHosts().get(0).getHost()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(1, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_ADDED)); + } + + @Test + public void testSetNodeListDeleted() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + when(hostListProvider.refresh()).thenReturn(Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build())); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").build()); + target.hostListProvider = hostListProvider; + + target.refreshHostList(); + + assertEquals(1, target.getAllHosts().size()); + assertEquals("hostB", target.getAllHosts().get(0).getHost()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(1, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_DELETED)); + } + + @Test + public void testSetNodeListChanged() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + when(hostListProvider.refresh()).thenReturn( + Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA") + .port(HostSpec.NO_PORT).role(HostRole.READER).build())); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.WRITER).build()); + target.hostListProvider = hostListProvider; + + target.refreshHostList(); + + assertEquals(1, target.getAllHosts().size()); + assertEquals("hostA", target.getAllHosts().get(0).getHost()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(2, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostAChanges.contains(NodeChangeOptions.PROMOTED_TO_READER)); + } + + @Test + public void testSetNodeListNoChanges() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(any()); + + when(hostListProvider.refresh()).thenReturn( + Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build())); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).build()); + target.hostListProvider = hostListProvider; + + target.refreshHostList(); + + assertEquals(1, target.getAllHosts().size()); + assertEquals("hostA", target.getAllHosts().get(0).getHost()); + verify(pluginManager, times(0)).notifyNodeListChanged(any()); + } + + @Test + public void testNodeAvailabilityNotChanged() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) + .build()); + + Set aliases = new HashSet<>(); + aliases.add("hostA"); + target.setAvailability(aliases, HostAvailability.AVAILABLE); + + assertEquals(1, target.getAllHosts().size()); + assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); + verify(pluginManager, never()).notifyNodeListChanged(any()); + } + + @Test + public void testNodeAvailabilityChanged_WentDown() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.AVAILABLE) + .build()); + + Set aliases = new HashSet<>(); + aliases.add("hostA"); + target.setAvailability(aliases, HostAvailability.NOT_AVAILABLE); + + assertEquals(1, target.getAllHosts().size()); + assertEquals(HostAvailability.NOT_AVAILABLE, target.getAllHosts().get(0).getAvailability()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(2, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_DOWN)); + } + + @Test + public void testNodeAvailabilityChanged_WentUp() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.allHosts = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build()); + + Set aliases = new HashSet<>(); + aliases.add("hostA"); + target.setAvailability(aliases, HostAvailability.AVAILABLE); + + assertEquals(1, target.getAllHosts().size()); + assertEquals(HostAvailability.AVAILABLE, target.getAllHosts().get(0).getAvailability()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(2, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); + } + + @Test + public void testNodeAvailabilityChanged_WentUp_ByAlias() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build(); + hostA.addAlias("ip-10-10-10-10"); + hostA.addAlias("hostA.custom.domain.com"); + final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build(); + hostB.addAlias("ip-10-10-10-10"); + hostB.addAlias("hostB.custom.domain.com"); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + + target.allHosts = Arrays.asList(hostA, hostB); + + Set aliases = new HashSet<>(); + aliases.add("hostA.custom.domain.com"); + target.setAvailability(aliases, HostAvailability.AVAILABLE); + + assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); + assertEquals(HostAvailability.NOT_AVAILABLE, hostB.getAvailability()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(2, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); + } + + @Test + public void testNodeAvailabilityChanged_WentUp_MultipleHostsByAlias() throws SQLException { + doNothing().when(pluginManager).notifyNodeListChanged(argumentChangesMap.capture()); + + final HostSpec hostA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostA").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build(); + hostA.addAlias("ip-10-10-10-10"); + hostA.addAlias("hostA.custom.domain.com"); + final HostSpec hostB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("hostB").port(HostSpec.NO_PORT).role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE) + .build(); + hostB.addAlias("ip-10-10-10-10"); + hostB.addAlias("hostB.custom.domain.com"); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + + target.allHosts = Arrays.asList(hostA, hostB); + + Set aliases = new HashSet<>(); + aliases.add("ip-10-10-10-10"); + target.setAvailability(aliases, HostAvailability.AVAILABLE); + + assertEquals(HostAvailability.AVAILABLE, hostA.getAvailability()); + assertEquals(HostAvailability.AVAILABLE, hostB.getAvailability()); + verify(pluginManager, times(1)).notifyNodeListChanged(any()); + + Map> notifiedChanges = argumentChangesMap.getValue(); + assertTrue(notifiedChanges.containsKey("hostA/")); + EnumSet hostAChanges = notifiedChanges.get("hostA/"); + assertEquals(2, hostAChanges.size()); + assertTrue(hostAChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostAChanges.contains(NodeChangeOptions.WENT_UP)); + + assertTrue(notifiedChanges.containsKey("hostB/")); + EnumSet hostBChanges = notifiedChanges.get("hostB/"); + assertEquals(2, hostBChanges.size()); + assertTrue(hostBChanges.contains(NodeChangeOptions.NODE_CHANGED)); + assertTrue(hostBChanges.contains(NodeChangeOptions.WENT_UP)); + } + + @Test + void testRefreshHostList_withCachedHostAvailability() throws SQLException { + final List newHostSpecs = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + final List newHostSpecs2 = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + final List expectedHostSpecs = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + final List expectedHostSpecs2 = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + when(hostListProvider.refresh()).thenReturn(newHostSpecs); + // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + when(target.getHostListProvider()).thenReturn(hostListProvider); + + assertNotEquals(expectedHostSpecs, newHostSpecs); + target.refreshHostList(); + assertEquals(expectedHostSpecs, newHostSpecs); + + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + target.refreshHostList(); + assertEquals(expectedHostSpecs2, newHostSpecs); + } + + @Test + void testForceRefreshHostList_withCachedHostAvailability() throws SQLException, TimeoutException { + final List newHostSpecs = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + final List expectedHostSpecs = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + final List expectedHostSpecs2 = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostA").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.NOT_AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostB").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("hostC").port(HostSpec.NO_PORT) + .role(HostRole.READER).availability(HostAvailability.AVAILABLE).build() + ); + + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostA/", HostAvailability.NOT_AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + when(hostListProvider.forceRefresh(eq(false), eq(0))).thenReturn(newHostSpecs); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + when(target.getHostListProvider()).thenReturn(hostListProvider); + + assertNotEquals(expectedHostSpecs, newHostSpecs); + target.forceRefreshHostList(); + assertEquals(expectedHostSpecs, newHostSpecs); + + PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, + PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); + target.forceRefreshHostList(); + // target.forceRefreshHostList(newConnection); + assertEquals(expectedHostSpecs2, newHostSpecs); + } + + @Test + void testIdentifyConnectionWithNoAliases() throws SQLException { + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + when(target.getHostListProvider()).thenReturn(hostListProvider); + + when(target.getDialect()).thenReturn(new MysqlDialect()); + assertNull(target.identifyConnection(newConnection)); + } + + @Test + void testIdentifyConnectionWithAliases() throws SQLException { + final HostSpec expected = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("test") + .build(); + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.hostListProvider = hostListProvider; + when(target.getHostListProvider()).thenReturn(hostListProvider); + when(hostListProvider.identifyConnection(eq(newConnection))).thenReturn(expected); + + when(target.getDialect()).thenReturn(new AuroraPgDialect()); + final HostSpec actual = target.identifyConnection(newConnection); + verify(target, never()).getCurrentHostSpec(); + verify(hostListProvider).identifyConnection(newConnection); + assertEquals(expected, actual); + } + + @Test + void testFillAliasesNonEmptyAliases() throws SQLException { + final HostSpec oneAlias = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo") + .build(); + oneAlias.addAlias(oneAlias.asAlias()); + + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + + assertEquals(1, oneAlias.getAliases().size()); + target.fillAliases(newConnection, oneAlias); + // Fill aliases should return directly and no additional aliases should be added. + assertEquals(1, oneAlias.getAliases().size()); + } + + @ParameterizedTest + @MethodSource("fillAliasesDialects") + void testFillAliasesWithInstanceEndpoint(Dialect dialect, String[] expectedInstanceAliases) throws SQLException { + final HostSpec empty = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("foo").build(); + PluginServiceImpl target = spy( + new PluginServiceImpl( + servicesContainer, + new ExceptionManager(), + PROPERTIES, + URL, + DRIVER_PROTOCOL, + dialectManager, + mockTargetDriverDialect, + configurationProfile, + sessionStateService)); + target.hostListProvider = hostListProvider; + when(target.getDialect()).thenReturn(dialect); + when(resultSet.next()).thenReturn(true, false); // Result set contains 1 row. + when(resultSet.getString(eq(1))).thenReturn("ip"); + if (dialect instanceof AuroraPgDialect) { + when(hostListProvider.identifyConnection(eq(newConnection))) + .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("instance").build()); + } + + target.fillAliases(newConnection, empty); + + final String[] aliases = empty.getAliases().toArray(new String[] {}); + assertArrayEquals(expectedInstanceAliases, aliases); + } + + private static Stream fillAliasesDialects() { + return Stream.of( + Arguments.of(new AuroraPgDialect(), new String[]{"instance", "foo", "ip"}), + Arguments.of(new MysqlDialect(), new String[]{"foo", "ip"}) + ); + } +} From 5432dcbfb5fcd6bfb8c814bb255e6c00d9fe9a59 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 12 Nov 2025 15:06:24 -0800 Subject: [PATCH 66/90] Unit tests passing --- .../amazon/jdbc/PluginServiceImpl.java | 5 +- .../amazon/jdbc/DialectDetectionTests.java | 2 + .../amazon/jdbc/PluginServiceImplTests.java | 6 +- .../RdsHostListProviderTest.java | 531 +++++++++--------- 4 files changed, 277 insertions(+), 267 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 111199a46..086af39a2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -678,10 +678,13 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } + updateHostListProvider(); + } + + protected void updateHostListProvider() throws SQLException { final HostListProvider provider = this.dialect.createHostListProvider(this.servicesContainer, this.props, this.originalUrl); this.setHostListProvider(provider); - // TODO: refreshHostList this.refreshHostList(); } diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java index 1a5517559..b882a2bb0 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java @@ -18,6 +18,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; @@ -110,6 +111,7 @@ PluginServiceImpl getPluginService(String host, String protocol) throws SQLExcep null)); when(this.mockServicesContainer.getHostListProviderService()).thenReturn(pluginService); + doNothing().when(pluginService).updateHostListProvider(); return pluginService; } diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index ff7e4ae8b..1cc23d048 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -23,6 +23,8 @@ import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyBoolean; +import static org.mockito.ArgumentMatchers.anyLong; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.never; @@ -758,7 +760,6 @@ void testRefreshHostList_withCachedHostAvailability() throws SQLException { PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); when(hostListProvider.refresh()).thenReturn(newHostSpecs); - // when(hostListProvider.refresh(newConnection)).thenReturn(newHostSpecs2); PluginServiceImpl target = spy( new PluginServiceImpl( @@ -814,7 +815,7 @@ void testForceRefreshHostList_withCachedHostAvailability() throws SQLException, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.NOT_AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); - when(hostListProvider.forceRefresh(eq(false), eq(0))).thenReturn(newHostSpecs); + when(hostListProvider.forceRefresh(anyBoolean(), anyLong())).thenReturn(newHostSpecs); PluginServiceImpl target = spy( new PluginServiceImpl( @@ -836,7 +837,6 @@ void testForceRefreshHostList_withCachedHostAvailability() throws SQLException, PluginServiceImpl.hostAvailabilityExpiringCache.put("hostB/", HostAvailability.AVAILABLE, PluginServiceImpl.DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO); target.forceRefreshHostList(); - // target.forceRefreshHostList(newConnection); assertEquals(expectedHostSpecs2, newHostSpecs); } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index ed6d27a72..bd32bcf9b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -1,263 +1,268 @@ -// /* -// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// * -// * Licensed under the Apache License, Version 2.0 (the "License"). -// * You may not use this file except in compliance with the License. -// * You may obtain a copy of the License at -// * -// * http://www.apache.org/licenses/LICENSE-2.0 -// * -// * Unless required by applicable law or agreed to in writing, software -// * distributed under the License is distributed on an "AS IS" BASIS, -// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// * See the License for the specific language governing permissions and -// * limitations under the License. -// */ -// -// package software.amazon.jdbc.hostlistprovider; -// -// import static org.junit.jupiter.api.Assertions.assertEquals; -// import static org.junit.jupiter.api.Assertions.assertNotNull; -// import static org.junit.jupiter.api.Assertions.assertNull; -// import static org.junit.jupiter.api.Assertions.assertThrows; -// import static org.mockito.ArgumentMatchers.any; -// import static org.mockito.ArgumentMatchers.eq; -// import static org.mockito.Mockito.atMostOnce; -// import static org.mockito.Mockito.doReturn; -// import static org.mockito.Mockito.never; -// import static org.mockito.Mockito.verify; -// import static org.mockito.Mockito.when; -// -// import java.sql.Connection; -// import java.sql.SQLException; -// import java.util.ArrayList; -// import java.util.Arrays; -// import java.util.Collections; -// import java.util.List; -// import java.util.Properties; -// import org.junit.jupiter.api.AfterEach; -// import org.junit.jupiter.api.BeforeEach; -// import org.junit.jupiter.api.Test; -// import org.mockito.Mock; -// import org.mockito.Mockito; -// import org.mockito.MockitoAnnotations; -// import software.amazon.jdbc.HostRole; -// import software.amazon.jdbc.HostSpec; -// import software.amazon.jdbc.HostSpecBuilder; -// import software.amazon.jdbc.PluginService; -// import software.amazon.jdbc.dialect.TopologyDialect; -// import software.amazon.jdbc.hostavailability.HostAvailability; -// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -// import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -// import software.amazon.jdbc.util.FullServicesContainer; -// import software.amazon.jdbc.util.Pair; -// import software.amazon.jdbc.util.events.EventPublisher; -// import software.amazon.jdbc.util.storage.StorageService; -// import software.amazon.jdbc.util.storage.TestStorageServiceImpl; -// -// class RdsHostListProviderTest { -// private StorageService storageService; -// private RdsHostListProvider rdsHostListProvider; -// -// @Mock private Connection mockConnection; -// @Mock private FullServicesContainer mockServicesContainer; -// @Mock private PluginService mockPluginService; -// @Mock private HostListProviderService mockHostListProviderService; -// @Mock private HostSpecBuilder mockHostSpecBuilder; -// @Mock private EventPublisher mockEventPublisher; -// @Mock private TopologyUtils mockTopologyUtils; -// @Mock private TopologyDialect mockDialect; -// -// private AutoCloseable closeable; -// private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("foo").port(1234).build(); -// private final List hosts = Arrays.asList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); -// -// @BeforeEach -// void setUp() throws SQLException { -// closeable = MockitoAnnotations.openMocks(this); -// storageService = new TestStorageServiceImpl(mockEventPublisher); -// when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); -// when(mockServicesContainer.getStorageService()).thenReturn(storageService); -// when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); -// when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); -// when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); -// when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); -// when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); -// when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); -// when(mockHostListProviderService.getHostSpecBuilder()) -// .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); -// when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); -// } -// -// @AfterEach -// void tearDown() throws Exception { -// storageService.clearAll(); -// closeable.close(); -// } -// -// private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { -// RdsHostListProvider provider = new RdsHostListProvider( -// mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); -// provider.init(); -// return provider; -// } -// -// @Test -// void testGetTopology_returnCachedTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); -// assertEquals(expected, result.hosts); -// assertEquals(2, result.hosts.size()); -// verify(rdsHostListProvider, never()).queryForTopology(mockConnection); -// } -// -// @Test -// void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.isInitialized = true; -// -// storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); -// -// final List newHosts = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); -// doReturn(newHosts).when(mockTopologyUtils).queryForTopology( -// eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertEquals(1, result.hosts.size()); -// assertEquals(newHosts, result.hosts); -// } -// -// @Test -// void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.clusterId = "cluster-id"; -// rdsHostListProvider.isInitialized = true; -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, false); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertEquals(2, result.hosts.size()); -// assertEquals(expected, result.hosts); -// } -// -// @Test -// void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.clear(); -// -// doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(mockConnection); -// -// final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); -// verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); -// assertNotNull(result.hosts); -// assertEquals( -// Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), -// result.hosts); -// } -// -// @Test -// void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { -// final List expectedMySQL = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) -// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); -// final List expectedPostgres = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) -// .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); -// when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class), any(HostSpec.class))) -// .thenReturn(expectedMySQL).thenReturn(expectedPostgres); -// -// -// rdsHostListProvider = getRdsHostListProvider("mysql://url/"); -// -// List hosts = rdsHostListProvider.queryForTopology(mockConnection); -// assertEquals(expectedMySQL, hosts); -// -// rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); -// hosts = rdsHostListProvider.queryForTopology(mockConnection); -// assertEquals(expectedPostgres, hosts); -// } -// -// @Test -// void testGetCachedTopology_returnStoredTopology() throws SQLException { -// rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); -// -// final List expected = hosts; -// storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); -// -// final List result = rdsHostListProvider.getStoredTopology(); -// assertEquals(expected, result); -// } -// -// @Test -// void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// -// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); -// -// when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); -// assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionNullTopology() throws SQLException { -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// rdsHostListProvider.instanceTemplate = -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); -// -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); -// doReturn(null).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionHostNotInTopology() throws SQLException { -// final List cachedTopology = Collections.singletonList( -// new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") -// .port(HostSpec.NO_PORT) -// .role(HostRole.WRITER) -// .build()); -// -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); -// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// assertNull(rdsHostListProvider.identifyConnection(mockConnection)); -// } -// -// @Test -// void testIdentifyConnectionHostInTopology() throws SQLException { -// final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") -// .port(HostSpec.NO_PORT) -// .role(HostRole.WRITER) -// .build(); -// expectedHost.setHostId("instance-a-1"); -// final List cachedTopology = Collections.singletonList(expectedHost); -// -// rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); -// when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); -// doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); -// doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); -// -// final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); -// assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); -// assertEquals("instance-a-1", actual.getHostId()); -// } -// } +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyBoolean; +import static org.mockito.ArgumentMatchers.anyLong; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.atMostOnce; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.TimeoutException; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; +import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Pair; +import software.amazon.jdbc.util.events.EventPublisher; +import software.amazon.jdbc.util.monitoring.MonitorService; +import software.amazon.jdbc.util.storage.StorageService; +import software.amazon.jdbc.util.storage.TestStorageServiceImpl; + +class RdsHostListProviderTest { + private StorageService storageService; + private RdsHostListProvider rdsHostListProvider; + + @Mock private Connection mockConnection; + @Mock private FullServicesContainer mockServicesContainer; + @Mock private MonitorService mockMonitorService; + @Mock private PluginService mockPluginService; + @Mock private HostListProviderService mockHostListProviderService; + @Mock private HostSpecBuilder mockHostSpecBuilder; + @Mock private EventPublisher mockEventPublisher; + @Mock private ClusterTopologyMonitorImpl mockMonitor; + @Mock private TopologyUtils mockTopologyUtils; + @Mock private TopologyDialect mockDialect; + + private AutoCloseable closeable; + private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("foo").port(1234).build(); + private final List hosts = Arrays.asList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); + + @BeforeEach + void setUp() throws SQLException { + closeable = MockitoAnnotations.openMocks(this); + storageService = new TestStorageServiceImpl(mockEventPublisher); + when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); + when(mockServicesContainer.getStorageService()).thenReturn(storageService); + when(mockServicesContainer.getMonitorService()).thenReturn(mockMonitorService); + when(mockMonitorService.get(eq(ClusterTopologyMonitorImpl.class), anyString())).thenReturn(mockMonitor); + when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); + when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); + when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); + when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); + when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); + when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); + when(mockHostListProviderService.getHostSpecBuilder()) + .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); + when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); + } + + @AfterEach + void tearDown() throws Exception { + storageService.clearAll(); + closeable.close(); + } + + private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { + RdsHostListProvider provider = new RdsHostListProvider( + mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); + return provider; + } + + @Test + void testGetTopology_returnCachedTopology() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("protocol://url/")); + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(false); + assertEquals(expected, result.hosts); + assertEquals(2, result.hosts.size()); + verify(rdsHostListProvider, never()).queryForTopology(); + } + + @Test + void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException, TimeoutException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); + + final List newHosts = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); + doReturn(newHosts).when(mockMonitor).forceRefresh(anyBoolean(), anyLong()); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(true); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + assertEquals(1, result.hosts.size()); + assertEquals(newHosts, result.hosts); + } + + @Test + void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + // rdsHostListProvider.clusterId = "cluster-id"; + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(false); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + assertEquals(2, result.hosts.size()); + assertEquals(expected, result.hosts); + } + + @Test + void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + rdsHostListProvider.clear(); + + doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); + + final FetchTopologyResult result = rdsHostListProvider.getTopology(true); + verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + assertNotNull(result.hosts); + assertEquals( + Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), + result.hosts); + } + + @Test + void testQueryForTopology_withDifferentDriverProtocol() throws SQLException, TimeoutException { + final List expectedMySQL = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) + .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); + final List expectedPostgres = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) + .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); + when(mockMonitor.forceRefresh(anyBoolean(), anyLong())) + .thenReturn(expectedMySQL).thenReturn(expectedPostgres); + + + rdsHostListProvider = getRdsHostListProvider("mysql://url/"); + + List hosts = rdsHostListProvider.queryForTopology(); + assertEquals(expectedMySQL, hosts); + + rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); + hosts = rdsHostListProvider.queryForTopology(); + assertEquals(expectedPostgres, hosts); + } + + @Test + void testGetCachedTopology_returnStoredTopology() throws SQLException { + rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); + + final List expected = hosts; + storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); + + final List result = rdsHostListProvider.getStoredTopology(); + assertEquals(expected, result); + } + + @Test + void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + + assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); + + when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); + assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionNullTopology() throws SQLException, TimeoutException { + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + // rdsHostListProvider.instanceTemplate = + // new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); + + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); + doReturn(null).when(rdsHostListProvider).refresh(); + doReturn(null).when(rdsHostListProvider).forceRefresh(); + + assertNull(rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionHostNotInTopology() throws SQLException, TimeoutException { + final List cachedTopology = Collections.singletonList( + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") + .port(HostSpec.NO_PORT) + .role(HostRole.WRITER) + .build()); + + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); + doReturn(cachedTopology).when(rdsHostListProvider).refresh(); + doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(); + + assertNull(rdsHostListProvider.identifyConnection(mockConnection)); + } + + @Test + void testIdentifyConnectionHostInTopology() throws SQLException, TimeoutException { + final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") + .port(HostSpec.NO_PORT) + .role(HostRole.WRITER) + .build(); + expectedHost.setHostId("instance-a-1"); + final List cachedTopology = Collections.singletonList(expectedHost); + + rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); + doReturn(cachedTopology).when(rdsHostListProvider).refresh(); + doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(); + + final HostSpec actual = rdsHostListProvider.identifyConnection(mockConnection); + assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); + assertEquals("instance-a-1", actual.getHostId()); + } +} From 550f23bb2a1363b50b679af680854b1d3694be41 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 12 Nov 2025 15:11:31 -0800 Subject: [PATCH 67/90] cleanup --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 3 --- .../jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java | 4 ---- .../java/software/amazon/jdbc/plugin/efm/HostMonitorImpl.java | 1 - .../amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java | 1 - .../plugin/failover/ClusterAwareWriterFailoverHandler.java | 2 -- .../amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java | 1 - .../jdbc/plugin/failover2/FailoverConnectionPlugin.java | 1 - .../amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java | 2 -- 8 files changed, 15 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index d8c05639b..ff9cb7cf3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -302,11 +302,9 @@ public HostRole getHostRole(Connection conn) throws SQLException { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } - // TODO: refresh List topology = this.refresh(); boolean isForcedRefresh = false; if (topology == null) { - // TODO: forceRefresh topology = this.forceRefresh(); isForcedRefresh = true; } @@ -323,7 +321,6 @@ public HostRole getHostRole(Connection conn) throws SQLException { .orElse(null); if (foundHost == null && !isForcedRefresh) { - // TODO: forceRefresh topology = this.forceRefresh(); if (topology == null) { return null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index b2f9ce4ba..7e8de8aed 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -204,7 +204,6 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); @@ -226,7 +225,6 @@ private Connection getVerifiedWriterConnection( if (this.pluginService.getHostRole(writerCandidateConn) != HostRole.WRITER) { // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); @@ -288,7 +286,6 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); @@ -323,7 +320,6 @@ private Connection getVerifiedReaderConnection( if (this.pluginService.getHostRole(readerCandidateConn) != HostRole.READER) { // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); if (this.hasNoReaders()) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm/HostMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm/HostMonitorImpl.java index 023847636..191832348 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm/HostMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm/HostMonitorImpl.java @@ -335,7 +335,6 @@ ConnectionStatus checkConnectionStatus(final long shortestFailureDetectionInterv LOGGER.finest(() -> "Opening a monitoring connection to " + this.hostSpec.getUrl()); startNano = this.getCurrentTimeNano(); - // TODO: replace with ConnectionService#open this.monitoringConn = this.pluginService.forceConnect(this.hostSpec, monitoringConnProperties); LOGGER.finest(() -> "Opened monitoring connection: " + this.monitoringConn); return new ConnectionStatus(true, this.getCurrentTimeNano() - startNano); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java index ae46b27f9..e6a1eadc9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/efm2/HostMonitorServiceImpl.java @@ -57,7 +57,6 @@ public class HostMonitorServiceImpl implements HostMonitorService { public HostMonitorServiceImpl(final @NonNull FullServicesContainer serviceContainer, Properties props) { this.serviceContainer = serviceContainer; - // TODO: Can we get rid of the core monitor service class? this.coreMonitorService = serviceContainer.getMonitorService(); this.pluginService = serviceContainer.getPluginService(); this.telemetryFactory = serviceContainer.getTelemetryFactory(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 78f979f0a..057e028fd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -284,7 +284,6 @@ public WriterFailoverResult call() { } conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); latestTopology = this.pluginService.getAllHosts(); } catch (final SQLException exception) { @@ -446,7 +445,6 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); final List topology = this.pluginService.getAllHosts(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 0eeec824a..49f91fa6c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -937,7 +937,6 @@ public Connection connect( } if (isInitialConnection) { - // TODO: refreshHostList this.pluginService.refreshHostList(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index 3907bbc11..d34f2e60b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -789,7 +789,6 @@ public Connection connect( } if (isInitialConnection) { - // TODO: refreshHostList this.pluginService.refreshHostList(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 37f92f781..6ab78eb7e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -96,10 +96,8 @@ public Connection getVerifiedConnection( // This is if-statement is only reached if the connection url is a writer cluster endpoint. // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. - // TODO: forceRefreshHostList this.pluginService.forceRefreshHostList(); } else { - // TODO: refreshHostList this.pluginService.refreshHostList(); } From 2a59bdfe2bfeb4248b2ade37c1bdde2451edb8e1 Mon Sep 17 00:00:00 2001 From: Aaron <69273634+aaron-congo@users.noreply.github.com> Date: Thu, 13 Nov 2025 08:10:19 -0800 Subject: [PATCH 68/90] chore: remove unused StorageService method (#1597) --- .../amazon/jdbc/util/storage/StorageService.java | 5 ----- .../amazon/jdbc/util/storage/StorageServiceImpl.java | 11 ----------- 2 files changed, 16 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java index 35770f691..2a49ead0d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageService.java @@ -16,7 +16,6 @@ package software.amazon.jdbc.util.storage; -import java.util.Map; import org.checkerframework.checker.nullness.qual.Nullable; public interface StorageService { @@ -91,9 +90,5 @@ void registerItemClassIfAbsent( */ void clearAll(); - // TODO: this is only called by the suggestedClusterId logic in RdsHostListProvider, which will be removed. This - // method should potentially be removed at that point as well. - @Nullable Map getEntries(Class itemClass); - int size(Class itemClass); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java index e59e8d72e..418885ede 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java @@ -170,17 +170,6 @@ public void clearAll() { } } - @Override - public @Nullable Map getEntries(Class itemClass) { - final ExpirationCache cache = caches.get(itemClass); - if (cache == null) { - return null; - } - - // TODO: remove this method after removing the suggestedClusterId logic - return (Map) cache.getEntries(); - } - @Override public int size(Class itemClass) { final ExpirationCache cache = caches.get(itemClass); From 2baa307937c913b1cd6ab4a450d631fe0fd490f9 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 13 Nov 2025 09:18:36 -0800 Subject: [PATCH 69/90] Fix failing integration test --- .../main/java/software/amazon/jdbc/util/ServiceUtility.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index f49c6789f..53ecac98c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -77,6 +77,9 @@ public FullServicesContainer createStandardServiceContainer( pluginService.setHostListProvider(provider); pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); + // This call initializes pluginService.allHosts with the stored topology if it exists or with the initial host spec + // if it doesn't exist. Plugins may require this information even before connecting. + pluginService.refreshHostList(); return serviceContainer; } From 7bc6bdb43a102861f875100924259060b978b90d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 13 Nov 2025 16:40:34 -0800 Subject: [PATCH 70/90] Fix bug where some monitors were not using PartialPluginService --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 2 +- .../strategy/fastestresponse/HostResponseTimeServiceImpl.java | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index ff9cb7cf3..eed8d886f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -152,7 +152,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.servicesContainer, this.properties, (servicesContainer) -> new ClusterTopologyMonitorImpl( - this.servicesContainer, + servicesContainer, this.topologyUtils, this.clusterId, this.initialHostSpec, diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java index 4d90f6d5d..4b5795434 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java @@ -79,8 +79,8 @@ public void setHosts(final @NonNull List hosts) { hostSpec.getUrl(), servicesContainer, this.props, - (servicesContainer) -> - new NodeResponseTimeMonitor(pluginService, hostSpec, this.props, this.intervalMs)); + (servicesContainer) -> new NodeResponseTimeMonitor( + servicesContainer.getPluginService(), hostSpec, this.props, this.intervalMs)); } catch (SQLException e) { LOGGER.warning( Messages.get("HostResponseTimeServiceImpl.errorStartingMonitor", new Object[] {hostSpec.getUrl(), e})); From f283dd34c18884cf83d770cf9e55d3be539e0a8b Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 13 Nov 2025 17:03:31 -0800 Subject: [PATCH 71/90] Fix bug where topology monitors were created before the dialect was confirmed --- .../java/software/amazon/jdbc/PartialPluginService.java | 6 ++++++ .../src/main/java/software/amazon/jdbc/PluginService.java | 2 ++ .../main/java/software/amazon/jdbc/PluginServiceImpl.java | 7 +++++++ .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 6 ++++++ 4 files changed, 21 insertions(+) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 50685c66e..875ca5c06 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -356,6 +356,12 @@ public boolean isInTransaction() { Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"isInTransaction"})); } + @Override + public boolean isDialectConfirmed() { + throw new UnsupportedOperationException( + Messages.get("PartialPluginService.unexpectedMethodCall", new Object[] {"isDialectConfirmed"})); + } + @Override public void setInTransaction(final boolean inTransaction) { this.isInTransaction = inTransaction; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index e921a7335..51b30f448 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -156,6 +156,8 @@ HostSpec getHostSpecByStrategy(List hosts, HostRole role, String strat boolean isInTransaction(); + boolean isDialectConfirmed(); + HostListProvider getHostListProvider(); void refreshHostList() throws SQLException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 086af39a2..5a38fe37b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -79,6 +79,7 @@ public class PluginServiceImpl implements PluginService, CanReleaseResources, protected HostSpec currentHostSpec; protected HostSpec initialConnectionHostSpec; private boolean isInTransaction; + private boolean isDialectConfirmed; private final ExceptionManager exceptionManager; protected final @Nullable ExceptionHandler exceptionHandler; protected final DialectProvider dialectProvider; @@ -478,6 +479,11 @@ public void setInTransaction(final boolean inTransaction) { this.isInTransaction = inTransaction; } + @Override + public boolean isDialectConfirmed() { + return this.isDialectConfirmed; + } + @Override public HostListProvider getHostListProvider() { return this.hostListProvider; @@ -674,6 +680,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept this.originalUrl, this.initialConnectionHostSpec, connection); + this.isDialectConfirmed = true; if (originalDialect == this.dialect) { return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index eed8d886f..5fc64f51a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -191,6 +191,12 @@ protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLE final List storedHosts = this.getStoredTopology(); if (storedHosts == null || forceUpdate) { // We need to re-fetch topology. + if (!this.pluginService.isDialectConfirmed()) { + // We need to confirm the dialect before creating a topology monitor so that it uses the correct SQL queries. + // We will return the original hosts parsed from the connections string until the dialect has been confirmed. + return new FetchTopologyResult(false, this.initialHostList); + } + final List hosts = this.queryForTopology(); if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); From af4c763f358c85b5902b1f6436dfa387582d0ac3 Mon Sep 17 00:00:00 2001 From: Aaron <69273634+aaron-congo@users.noreply.github.com> Date: Fri, 14 Nov 2025 08:33:20 -0800 Subject: [PATCH 72/90] chore: remove deprecated ConnectionService classes (#1598) --- ...oraGlobalDbMonitoringHostListProvider.java | 3 - .../util/connection/ConnectionService.java | 58 --------- .../connection/ConnectionServiceImpl.java | 111 ------------------ .../FailoverConnectionPluginTest.java | 2 - 4 files changed, 174 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionService.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java index 50bb4263d..9053e93db 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java @@ -23,10 +23,8 @@ import java.util.Properties; import java.util.logging.Logger; import java.util.stream.Collectors; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; import software.amazon.jdbc.util.ConnectionUrlParser; @@ -34,7 +32,6 @@ import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.connection.ConnectionService; public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostListProvider { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionService.java b/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionService.java deleted file mode 100644 index 1c18a9f28..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionService.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.util.connection; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.Properties; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.util.FullServicesContainer; - -/** - * A service used to open new connections for internal driver use. - * - * @deprecated This interface is deprecated and will be removed in a future version. Use - * {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} followed by - * {@link PluginService#forceConnect} instead. - */ -@Deprecated -public interface ConnectionService { - /** - * Creates an auxiliary connection. Auxiliary connections are driver-internal connections that accomplish various - * specific tasks such as monitoring a host's availability, checking the topology information for a cluster, etc. - * - * @param hostSpec the hostSpec containing the host information for the auxiliary connection. - * @param props the properties for the auxiliary connection. - * @return a new connection to the given host using the given props. - * @throws SQLException if an error occurs while opening the connection. - * @deprecated Use {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} followed by - * {@link PluginService#forceConnect} instead. - */ - @Deprecated - Connection open(HostSpec hostSpec, Properties props) throws SQLException; - - /** - * Get the {@link PluginService} associated with this {@link ConnectionService}. - * - * @return the {@link PluginService} associated with this {@link ConnectionService} - * @deprecated Use {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} followed by - * {@link FullServicesContainer#getPluginService()} instead. - */ - @Deprecated - PluginService getPluginService(); -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java deleted file mode 100644 index 540aea280..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionServiceImpl.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.util.connection; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.Properties; -import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PartialPluginService; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.FullServicesContainerImpl; -import software.amazon.jdbc.util.PropertyUtils; -import software.amazon.jdbc.util.monitoring.MonitorService; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.telemetry.TelemetryFactory; - -/** - * A service used to open new connections for internal driver use. - * - * @deprecated This class is deprecated and will be removed in a future version. Use - * {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} followed by - * {@link PluginService#forceConnect} instead. - */ -@Deprecated -public class ConnectionServiceImpl implements ConnectionService { - protected final String targetDriverProtocol; - protected final ConnectionPluginManager pluginManager; - protected final PluginService pluginService; - - /** - * Constructs a {@link ConnectionServiceImpl} instance. - * - * @param storageService An instance of storage service - * @param monitorService An instance of monitor service - * @param telemetryFactory An instance of telemetry factory - * @param connectionProvider An instance of connection provider - * @param originalUrl An original Url - * @param targetDriverProtocol A target driver protocol - * @param driverDialect An instance of driver dialect - * @param dbDialect An instance of database dialect - * @param props Properties - * @throws SQLException if errors occurred while creating an instance - * @deprecated Use {@link software.amazon.jdbc.util.ServiceUtility#createMinimalServiceContainer} instead. - */ - @Deprecated - public ConnectionServiceImpl( - StorageService storageService, - MonitorService monitorService, - TelemetryFactory telemetryFactory, - ConnectionProvider connectionProvider, - String originalUrl, - String targetDriverProtocol, - TargetDriverDialect driverDialect, - Dialect dbDialect, - Properties props) throws SQLException { - this.targetDriverProtocol = targetDriverProtocol; - - FullServicesContainer servicesContainer = - new FullServicesContainerImpl(storageService, monitorService, connectionProvider, telemetryFactory); - this.pluginManager = new ConnectionPluginManager(props, telemetryFactory, connectionProvider, null); - servicesContainer.setConnectionPluginManager(this.pluginManager); - - Properties propsCopy = PropertyUtils.copyProperties(props); - PartialPluginService partialPluginService = new PartialPluginService( - servicesContainer, - propsCopy, - originalUrl, - this.targetDriverProtocol, - driverDialect, - dbDialect - ); - - servicesContainer.setHostListProviderService(partialPluginService); - servicesContainer.setPluginService(partialPluginService); - servicesContainer.setPluginManagerService(partialPluginService); - - this.pluginService = partialPluginService; - this.pluginManager.initPlugins(servicesContainer, null); - } - - @Override - @Deprecated - public Connection open(HostSpec hostSpec, Properties props) throws SQLException { - return this.pluginManager.forceConnect(this.targetDriverProtocol, hostSpec, props, true, null); - } - - @Override - @Deprecated - public PluginService getPluginService() { - return this.pluginService; - } -} diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java index 1fb98265e..ac5b9d7b0 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java @@ -63,7 +63,6 @@ import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.SqlState; -import software.amazon.jdbc.util.connection.ConnectionService; import software.amazon.jdbc.util.telemetry.GaugeCallable; import software.amazon.jdbc.util.telemetry.TelemetryContext; import software.amazon.jdbc.util.telemetry.TelemetryCounter; @@ -82,7 +81,6 @@ class FailoverConnectionPluginTest { .host("reader1").port(1234).role(HostRole.READER).build()); @Mock FullServicesContainer mockContainer; - @Mock ConnectionService mockConnectionService; @Mock PluginService mockPluginService; @Mock Connection mockConnection; @Mock HostSpec mockHostSpec; From 32e09973482c234fcb08db20839c2407ff4b6db4 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 18 Nov 2025 17:16:41 -0800 Subject: [PATCH 73/90] Avoid using monitoring host list provider in ClusterAwareWriterFailoverHandler --- .../ConnectionStringHostListProvider.java | 2 +- .../DynamicHostListProvider.java | 10 +++- .../hostlistprovider/HostListProvider.java | 2 +- .../hostlistprovider/RdsHostListProvider.java | 12 ++++- .../ClusterAwareWriterFailoverHandler.java | 49 +++++++++++++------ 5 files changed, 56 insertions(+), 19 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 6de7747d5..051233bb0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -105,7 +105,7 @@ public HostSpec identifyConnection(Connection connection) throws SQLException { } @Override - public String getClusterId() throws UnsupportedOperationException { + public String getClusterId() { return ""; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index 09d321c41..c6e93c5c9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,7 +16,13 @@ package software.amazon.jdbc.hostlistprovider; -// A marker interface for providers that can fetch a host list reflecting the current database topology. +import software.amazon.jdbc.HostSpec; + +// An interface for providers that can fetch a host list reflecting the current database topology. // Examples include providers for Aurora or Multi-AZ clusters, where the cluster topology, status, and instance roles // change over time. -public interface DynamicHostListProvider extends HostListProvider { } +public interface DynamicHostListProvider extends HostListProvider { + TopologyUtils getTopologyUtils(); + + HostSpec getInstanceTemplate(); +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index e84859699..d5fb932b6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -70,5 +70,5 @@ List forceRefresh(final boolean shouldVerifyWriter, final long timeout @Nullable HostSpec identifyConnection(Connection connection) throws SQLException; - String getClusterId() throws UnsupportedOperationException, SQLException; + String getClusterId(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 5fc64f51a..3188a1807 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -262,6 +262,16 @@ protected void validateHostPatternSetting(final String hostPattern) { } } + @Override + public TopologyUtils getTopologyUtils() { + return this.topologyUtils; + } + + @Override + public HostSpec getInstanceTemplate() { + return this.instanceTemplate; + } + protected static class FetchTopologyResult { public List hosts; @@ -346,7 +356,7 @@ public HostRole getHostRole(Connection conn) throws SQLException { } @Override - public String getClusterId() throws UnsupportedOperationException, SQLException { + public String getClusterId() { return this.clusterId; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 057e028fd..fdec2c077 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -30,11 +30,17 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.logging.Level; import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; @@ -52,13 +58,14 @@ * same writer host, 2) try to update cluster topology and connect to a newly elected writer. */ public class ClusterAwareWriterFailoverHandler implements WriterFailoverHandler { - private static final Logger LOGGER = Logger.getLogger(ClusterAwareReaderFailoverHandler.class.getName()); + private static final Logger LOGGER = Logger.getLogger(ClusterAwareWriterFailoverHandler.class.getName()); protected static final WriterFailoverResult DEFAULT_RESULT = new WriterFailoverResult(false, false, null, null, "None"); protected final Properties initialConnectionProps; protected final FullServicesContainer servicesContainer; protected final PluginService pluginService; + protected final HostListProvider hostListProvider; protected final ReaderFailoverHandler readerFailoverHandler; protected final Map hostAvailabilityMap = new ConcurrentHashMap<>(); protected int maxFailoverTimeoutMs = 60000; // 60 sec @@ -71,6 +78,7 @@ public ClusterAwareWriterFailoverHandler( final Properties initialConnectionProps) { this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); + this.hostListProvider = this.pluginService.getHostListProvider(); this.readerFailoverHandler = readerFailoverHandler; this.initialConnectionProps = initialConnectionProps; } @@ -243,10 +251,25 @@ private SQLException createInterruptedException(final InterruptedException e) { e); } + private @Nullable List getTopology(@NonNull Connection conn) throws SQLException { + if (this.hostListProvider instanceof StaticHostListProvider) { + try { + return this.hostListProvider.forceRefresh(); + } catch (TimeoutException e) { + return null; + } + } + + DynamicHostListProvider dynamicProvider = (DynamicHostListProvider) this.hostListProvider; + HostSpec initialHostSpec = this.pluginService.getInitialConnectionHostSpec(); + HostSpec instanceTemplate = dynamicProvider.getInstanceTemplate(); + return dynamicProvider.getTopologyUtils().queryForTopology(conn, initialHostSpec, instanceTemplate); + } + /** * Internal class responsible for re-connecting to the current writer (aka TaskA). */ - private static class ReconnectToWriterHandler implements Callable { + private class ReconnectToWriterHandler implements Callable { private final PluginService pluginService; private final Map availabilityMap; private final HostSpec originalWriterHost; @@ -284,8 +307,7 @@ public WriterFailoverResult call() { } conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); - this.pluginService.forceRefreshHostList(); - latestTopology = this.pluginService.getAllHosts(); + latestTopology = getTopology(conn); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. if (!pluginService.isNetworkException(exception, pluginService.getTargetDriverDialect())) { @@ -298,7 +320,12 @@ public WriterFailoverResult call() { } if (Utils.isNullOrEmpty(latestTopology)) { - TimeUnit.MILLISECONDS.sleep(reconnectWriterIntervalMs); + try { + TimeUnit.MILLISECONDS.sleep(reconnectWriterIntervalMs); + } catch (final InterruptedException exception) { + Thread.currentThread().interrupt(); + return new WriterFailoverResult(false, false, latestTopology, null, "TaskA"); + } } } @@ -306,9 +333,6 @@ public WriterFailoverResult call() { LOGGER.finest("[TaskA] success: " + success); this.availabilityMap.put(this.originalWriterHost.getHost(), HostAvailability.AVAILABLE); return new WriterFailoverResult(success, false, latestTopology, success ? conn : null, "TaskA"); - } catch (final InterruptedException exception) { - Thread.currentThread().interrupt(); - return new WriterFailoverResult(success, false, latestTopology, success ? conn : null, "TaskA"); } catch (final Exception ex) { LOGGER.severe(ex::getMessage); return new WriterFailoverResult(false, false, null, null, "TaskA"); @@ -342,7 +366,7 @@ private boolean isCurrentHostWriter(final List latestTopology) { * Internal class responsible for getting the latest cluster topology and connecting to a newly * elected writer (aka TaskB). */ - private static class WaitForNewWriterHandler implements Callable { + private class WaitForNewWriterHandler implements Callable { private final PluginService pluginService; private final Map availabilityMap; private final ReaderFailoverHandler readerFailoverHandler; @@ -445,11 +469,8 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { - this.pluginService.forceRefreshHostList(); - final List topology = this.pluginService.getAllHosts(); - - if (!topology.isEmpty()) { - + final List topology = getTopology(this.currentReaderConnection); + if (!Utils.isNullOrEmpty(topology)) { if (topology.size() == 1) { // The currently connected reader is in a middle of failover. It's not yet connected // to a new writer adn works in as "standalone" node. The handler needs to From 070b79be7dc627749472349ab4b99dfe3370a690 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 19 Nov 2025 16:37:38 -0800 Subject: [PATCH 74/90] chore: logging improvement for RW Splitting plugin (#1604) --- .../ReadWriteSplittingPlugin.java | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 5975936c0..587989838 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -280,7 +280,7 @@ private void setWriterConnection(final Connection writerConnection, () -> Messages.get( "ReadWriteSplittingPlugin.setWriterConnection", new Object[] { - writerHostSpec.getUrl()})); + writerHostSpec.getHostAndPort()})); } private void setReaderConnection(final Connection conn, final HostSpec host) { @@ -290,7 +290,7 @@ private void setReaderConnection(final Connection conn, final HostSpec host) { () -> Messages.get( "ReadWriteSplittingPlugin.setReaderConnection", new Object[] { - host.getUrl()})); + host.getHostAndPort()})); } void switchConnectionIfRequired(final boolean readOnly) throws SQLException { @@ -332,7 +332,7 @@ void switchConnectionIfRequired(final boolean readOnly) throws SQLException { "ReadWriteSplittingPlugin.fallbackToWriter", new Object[] { e.getMessage(), - this.pluginService.getCurrentHostSpec().getUrl()})); + this.pluginService.getCurrentHostSpec().getHostAndPort()})); } } } else { @@ -393,7 +393,7 @@ private void switchToWriterConnection( } LOGGER.finer(() -> Messages.get("ReadWriteSplittingPlugin.switchedFromReaderToWriter", - new Object[] {writerHost.getUrl()})); + new Object[] {writerHost.getHostAndPort()})); } private void switchCurrentConnectionTo( @@ -409,7 +409,7 @@ private void switchCurrentConnectionTo( LOGGER.finest(() -> Messages.get( "ReadWriteSplittingPlugin.settingCurrentConnection", new Object[] { - newConnectionHost.getUrl()})); + newConnectionHost.getHostAndPort()})); } private void switchToReaderConnection(final List hosts) @@ -436,15 +436,15 @@ private void switchToReaderConnection(final List hosts) try { switchCurrentConnectionTo(this.readerConnection, this.readerHostSpec); LOGGER.finer(() -> Messages.get("ReadWriteSplittingPlugin.switchedFromWriterToReader", - new Object[] {this.readerHostSpec.getUrl()})); + new Object[] {this.readerHostSpec.getHostAndPort()})); } catch (SQLException e) { if (e.getMessage() != null) { LOGGER.warning( () -> Messages.get("ReadWriteSplittingPlugin.errorSwitchingToCachedReaderWithCause", - new Object[] {this.readerHostSpec.getUrl(), e.getMessage()})); + new Object[] {this.readerHostSpec.getHostAndPort(), e.getMessage()})); } else { LOGGER.warning(() -> Messages.get("ReadWriteSplittingPlugin.errorSwitchingToCachedReader", - new Object[] {this.readerHostSpec.getUrl()})); + new Object[] {this.readerHostSpec.getHostAndPort()})); } this.readerConnection.close(); @@ -466,11 +466,11 @@ private void initializeReaderConnection(final @NonNull List hosts) thr getNewWriterConnection(writerHost); } LOGGER.warning(() -> Messages.get("ReadWriteSplittingPlugin.noReadersFound", - new Object[] {writerHost.getUrl()})); + new Object[] {writerHost.getHostAndPort()})); } else { getNewReaderConnection(); LOGGER.finer(() -> Messages.get("ReadWriteSplittingPlugin.switchedFromWriterToReader", - new Object[] {this.readerHostSpec.getUrl()})); + new Object[] {this.readerHostSpec.getHostAndPort()})); } } @@ -501,7 +501,7 @@ private void getNewReaderConnection() throws SQLException { Messages.get( "ReadWriteSplittingPlugin.failedToConnectToReader", new Object[]{ - hostSpec.getUrl()}), + hostSpec.getHostAndPort()}), e); } } @@ -516,7 +516,7 @@ private void getNewReaderConnection() throws SQLException { final HostSpec finalReaderHost = readerHost; LOGGER.finest( () -> Messages.get("ReadWriteSplittingPlugin.successfullyConnectedToReader", - new Object[] {finalReaderHost.getUrl()})); + new Object[] {finalReaderHost.getHostAndPort()})); setReaderConnection(conn, readerHost); switchCurrentConnectionTo(this.readerConnection, this.readerHostSpec); } From 20f2f25bda5391ea9ba03f70bf26d8cfaa4456a0 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Wed, 19 Nov 2025 16:45:07 -0800 Subject: [PATCH 75/90] feat: allow to override IAM token property name (#1603) --- .../UsingTheIamAuthenticationPlugin.md | 13 +++++++------ .../jdbc/plugin/iam/IamAuthConnectionPlugin.java | 15 ++++++++++++--- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md b/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md index d76d7f503..b7aec30c3 100644 --- a/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md +++ b/docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md @@ -42,12 +42,13 @@ IAM database authentication use is limited to certain database engines. For more GRANT rds_iam TO db_userx;` 4. Add the plugin code `iam` to the [`wrapperPlugins`](../UsingTheJdbcDriver.md#connection-plugin-manager-parameters) parameter value. -| Parameter | Value | Required | Description | Example Value | -|-------------------|:-------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| -| `iamDefaultPort` | String | No | This property will override the default port that is used to generate the IAM token. The default port is determined based on the underlying driver protocol. For now, there is support for `jdbc:postgresql:` and `jdbc:mysql:`. Target drivers with different protocols will require users to provide a default port. | `1234` | -| `iamHost` | String | No | This property will override the default hostname that is used to generate the IAM token. The default hostname is derived from the connection string. This parameter is required when users are connecting with custom endpoints. | `database.cluster-hash.us-east-1.rds.amazonaws.com` | -| `iamRegion` | String | No | This property will override the default region that is used to generate the IAM token. The default region is parsed from the connection string. | `us-east-2` | -| `iamExpiration` | Integer | No | This property determines how long an IAM token is kept in the driver cache before a new one is generated. The default expiration time is set to be 14 minutes and 30 seconds. Note that IAM database authentication tokens have a lifetime of 15 minutes. | `600` | +| Parameter | Value | Required | Description | Example Value | +|------------------------------|:-------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| +| `iamDefaultPort` | String | No | This property will override the default port that is used to generate the IAM token. The default port is determined based on the underlying driver protocol. For now, there is support for `jdbc:postgresql:` and `jdbc:mysql:`. Target drivers with different protocols will require users to provide a default port. | `1234` | +| `iamHost` | String | No | This property will override the default hostname that is used to generate the IAM token. The default hostname is derived from the connection string. This parameter is required when users are connecting with custom endpoints. | `database.cluster-hash.us-east-1.rds.amazonaws.com` | +| `iamRegion` | String | No | This property will override the default region that is used to generate the IAM token. The default region is parsed from the connection string. | `us-east-2` | +| `iamExpiration` | Integer | No | This property determines how long an IAM token is kept in the driver cache before a new one is generated. The default expiration time is set to be 14 minutes and 30 seconds. Note that IAM database authentication tokens have a lifetime of 15 minutes. | `600` | +| `iamAccessTokenPropertyName` | String | No | This property allows you to override the property name used for passing the IAM access token. Some underlying drivers may require a specific property name for IAM authentication. Default value is `password`. | `password`, `accessToken` | ## Sample code [AwsIamAuthenticationPostgresqlExample.java](../../../examples/AWSDriverExample/src/main/java/software/amazon/AwsIamAuthenticationPostgresqlExample.java)
diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/iam/IamAuthConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/iam/IamAuthConnectionPlugin.java index 5541ac917..f8a2be272 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/iam/IamAuthConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/iam/IamAuthConnectionPlugin.java @@ -72,6 +72,10 @@ public class IamAuthConnectionPlugin extends AbstractConnectionPlugin { "iamExpiration", String.valueOf(DEFAULT_TOKEN_EXPIRATION_SEC), "IAM token cache expiration in seconds"); + public static final AwsWrapperProperty IAM_TOKEN_PROPERTY_NAME = new AwsWrapperProperty( + "iamAccessTokenPropertyName", PropertyDefinition.PASSWORD.name, + "Overrides default IAM access token property name"); + protected static final RegionUtils regionUtils = new RegionUtils(); protected final PluginService pluginService; protected final RdsUtils rdsUtils = new RdsUtils(); @@ -121,6 +125,10 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro throw new SQLException(PropertyDefinition.USER.name + " is null or empty."); } + if (StringUtils.isNullOrEmpty(IAM_TOKEN_PROPERTY_NAME.getString(props))) { + throw new SQLException(IAM_TOKEN_PROPERTY_NAME.name + " is null or empty."); + } + String host = IamAuthUtils.getIamHost(IAM_HOST.getString(props), hostSpec); int port = IamAuthUtils.getIamPort( @@ -149,7 +157,7 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro () -> Messages.get( "AuthenticationToken.useCachedToken", new Object[] {tokenInfo.getToken()})); - PropertyDefinition.PASSWORD.set(props, tokenInfo.getToken()); + props.setProperty(IAM_TOKEN_PROPERTY_NAME.getString(props), tokenInfo.getToken()); } else { final Instant tokenExpiry = Instant.now().plus(tokenExpirationSec, ChronoUnit.SECONDS); if (this.fetchTokenCounter != null) { @@ -167,7 +175,8 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro () -> Messages.get( "AuthenticationToken.generatedNewToken", new Object[] {token})); - PropertyDefinition.PASSWORD.set(props, token); + + props.setProperty(IAM_TOKEN_PROPERTY_NAME.getString(props), token); IamAuthCacheHolder.tokenCache.put( cacheKey, new TokenInfo(token, tokenExpiry)); @@ -206,7 +215,7 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro () -> Messages.get( "AuthenticationToken.generatedNewToken", new Object[] {token})); - PropertyDefinition.PASSWORD.set(props, token); + props.setProperty(IAM_TOKEN_PROPERTY_NAME.getString(props), token); IamAuthCacheHolder.tokenCache.put( cacheKey, new TokenInfo(token, tokenExpiry)); From 8df2a3f7923ec70df973e14abff6efd521e429e2 Mon Sep 17 00:00:00 2001 From: Aaron <69273634+aaron-congo@users.noreply.github.com> Date: Thu, 20 Nov 2025 09:41:16 -0800 Subject: [PATCH 76/90] Refactor: dialects and host list providers to reduce code duplication (#1588) --- .../ConnectionPluginManagerBenchmarks.java | 2 +- .../jdbc/benchmarks/PluginBenchmarks.java | 2 +- .../testplugin/BenchmarkPlugin.java | 2 +- .../testplugin/TestConnectionWrapper.java | 2 +- .../amazon/jdbc/BlockingHostListProvider.java | 1 + .../amazon/jdbc/ConnectionPlugin.java | 1 + .../amazon/jdbc/ConnectionPluginManager.java | 1 + .../amazon/jdbc/PartialPluginService.java | 7 +- .../software/amazon/jdbc/PluginService.java | 1 + .../amazon/jdbc/PluginServiceImpl.java | 7 +- .../jdbc/dialect/AuroraMysqlDialect.java | 116 ++--- .../amazon/jdbc/dialect/AuroraPgDialect.java | 176 +++----- .../amazon/jdbc/dialect/BlueGreenDialect.java | 4 +- .../software/amazon/jdbc/dialect/Dialect.java | 15 +- .../amazon/jdbc/dialect/DialectManager.java | 23 +- .../amazon/jdbc/dialect/DialectUtils.java | 46 ++ .../dialect/GlobalAuroraMysqlDialect.java | 107 ++--- .../jdbc/dialect/GlobalAuroraPgDialect.java | 123 ++--- .../dialect/GlobalAuroraTopologyDialect.java | 21 + .../dialect/HostListProviderSupplier.java | 2 +- .../amazon/jdbc/dialect/MariaDbDialect.java | 85 ++-- .../jdbc/dialect/MultiAzClusterDialect.java} | 14 +- ...t.java => MultiAzClusterMysqlDialect.java} | 117 +++-- ...lect.java => MultiAzClusterPgDialect.java} | 116 ++--- .../amazon/jdbc/dialect/MysqlDialect.java | 83 ++-- .../amazon/jdbc/dialect/PgDialect.java | 80 ++-- .../amazon/jdbc/dialect/RdsMysqlDialect.java | 77 ++-- .../amazon/jdbc/dialect/RdsPgDialect.java | 63 +-- .../amazon/jdbc/dialect/TopologyDialect.java | 27 ++ .../amazon/jdbc/dialect/UnknownDialect.java | 2 +- .../AuroraGlobalDbHostListProvider.java | 114 ----- .../AuroraHostListProvider.java | 43 -- .../hostlistprovider/AuroraTopologyUtils.java | 95 ++++ .../ConnectionStringHostListProvider.java | 5 +- .../DynamicHostListProvider.java | 8 +- .../GlobalAuroraHostListProvider.java | 73 +++ .../GlobalAuroraTopologyUtils.java | 152 +++++++ .../HostListProvider.java | 6 +- .../HostListProviderService.java | 4 +- .../MultiAzTopologyUtils.java | 117 +++++ .../hostlistprovider/RdsHostListProvider.java | 304 +++---------- .../RdsMultiAzDbClusterListProvider.java | 208 --------- .../StaticHostListProvider.java | 6 +- .../jdbc/hostlistprovider/TopologyUtils.java | 235 ++++++++++ ...oraGlobalDbMonitoringHostListProvider.java | 108 ----- .../ClusterTopologyMonitorImpl.java | 427 +++++------------- .../GlobalAuroraTopologyMonitor.java | 78 ++++ .../GlobalDbClusterTopologyMonitorImpl.java | 111 ----- ...onitoringGlobalAuroraHostListProvider.java | 91 ++++ .../MonitoringRdsHostListProvider.java | 39 +- .../MonitoringRdsMultiAzHostListProvider.java | 74 --- .../MultiAzClusterTopologyMonitorImpl.java | 128 ------ .../jdbc/plugin/AbstractConnectionPlugin.java | 2 +- ...AuroraInitialConnectionStrategyPlugin.java | 2 +- .../jdbc/plugin/DefaultConnectionPlugin.java | 2 +- .../bluegreen/BlueGreenInterimStatus.java | 6 +- .../bluegreen/BlueGreenStatusMonitor.java | 4 +- .../ClusterAwareReaderFailoverHandler.java | 4 +- .../ClusterAwareWriterFailoverHandler.java | 3 +- .../failover/FailoverConnectionPlugin.java | 7 +- .../failover2/FailoverConnectionPlugin.java | 11 +- .../limitless/LimitlessRouterMonitor.java | 4 +- .../ReadWriteSplittingPlugin.java | 5 +- .../plugin/staledns/AuroraStaleDnsHelper.java | 7 +- .../plugin/staledns/AuroraStaleDnsPlugin.java | 2 +- .../HostResponseTimeServiceImpl.java | 1 - .../jdbc/util/FullServicesContainer.java | 2 +- .../jdbc/util/FullServicesContainerImpl.java | 2 +- .../software/amazon/jdbc/util/LogUtils.java | 55 +++ .../amazon/jdbc/util/ServiceUtility.java | 4 +- .../java/software/amazon/jdbc/util/Utils.java | 24 - .../util/monitoring/MonitorServiceImpl.java | 2 - .../jdbc/wrapper/ConnectionWrapper.java | 2 +- ..._advanced_jdbc_wrapper_messages.properties | 37 +- .../tests/AdvancedPerformanceTest.java | 2 +- .../container/tests/AutoscalingTests.java | 6 +- .../container/tests/FailoverTest.java | 4 +- .../container/tests/PerformanceTest.java | 1 - .../tests/ReadWriteSplittingTests.java | 6 +- .../amazon/jdbc/DialectDetectionTests.java | 13 +- .../software/amazon/jdbc/DialectTests.java | 8 +- .../amazon/jdbc/PluginServiceImplTests.java | 1 + .../jdbc/RoundRobinHostSelectorTest.java | 5 - .../RdsHostListProviderTest.java | 227 +--------- .../RdsMultiAzDbClusterListProviderTest.java | 311 ------------- .../amazon/jdbc/mock/TestPluginOne.java | 2 +- .../FailoverConnectionPluginTest.java | 6 +- .../LimitlessConnectionPluginTest.java | 2 +- .../LimitlessRouterServiceImplTest.java | 2 +- .../ReadWriteSplittingPluginTest.java | 2 +- .../hibernate_files/DataSourceTest.java | 7 +- ...stgreSQLCastingIntervalSecondJdbcType.java | 1 - .../PostgresIntervalSecondTest.java | 19 +- .../StructEmbeddableArrayTest.java | 20 +- 94 files changed, 1811 insertions(+), 2771 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java rename wrapper/src/{test/java/integration/container/aurora/TestAuroraHostListProvider.java => main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java} (57%) rename wrapper/src/main/java/software/amazon/jdbc/dialect/{RdsMultiAzDbClusterMysqlDialect.java => MultiAzClusterMysqlDialect.java} (52%) rename wrapper/src/main/java/software/amazon/jdbc/dialect/{RdsMultiAzDbClusterPgDialect.java => MultiAzClusterPgDialect.java} (59%) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java rename wrapper/src/main/java/software/amazon/jdbc/{ => hostlistprovider}/HostListProvider.java (89%) rename wrapper/src/main/java/software/amazon/jdbc/{ => hostlistprovider}/HostListProviderService.java (89%) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java create mode 100644 wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java delete mode 100644 wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java index eb4a8d3b2..ebdb34355 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java @@ -54,7 +54,7 @@ import software.amazon.jdbc.ConnectionPluginFactory; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.JdbcMethod; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java index 405b6fc00..dda847f73 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java @@ -54,7 +54,7 @@ import software.amazon.jdbc.ConnectionProviderManager; import software.amazon.jdbc.Driver; import software.amazon.jdbc.HikariPooledConnectionProvider; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.JdbcMethod; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java index ffed10f77..07fede27a 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/BenchmarkPlugin.java @@ -28,7 +28,7 @@ import java.util.Set; import java.util.logging.Logger; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; diff --git a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java index a3c0cd7f2..483d6768c 100644 --- a/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java +++ b/benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java @@ -20,7 +20,7 @@ import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.wrapper.ConnectionWrapper; diff --git a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java index 9fe7e40fb..31f3d1182 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/BlockingHostListProvider.java @@ -19,6 +19,7 @@ import java.sql.SQLException; import java.util.List; import java.util.concurrent.TimeoutException; +import software.amazon.jdbc.hostlistprovider.HostListProvider; public interface BlockingHostListProvider extends HostListProvider { diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java index d2d72b05c..ad271f2ad 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPlugin.java @@ -23,6 +23,7 @@ import java.util.Map; import java.util.Properties; import java.util.Set; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; /** * Interface for connection plugins. This class implements ways to execute a JDBC method and to clean up resources used diff --git a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java index 2697c5b03..33f7618b9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginManager.java @@ -30,6 +30,7 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AuroraConnectionTrackerPlugin; import software.amazon.jdbc.plugin.AuroraInitialConnectionStrategyPlugin; import software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 50a1e3667..078626d5b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -41,11 +41,14 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.HostAvailabilityStrategyFactory; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; @@ -130,7 +133,7 @@ public PartialPluginService( ? this.configurationProfile.getExceptionHandler() : null; - HostListProviderSupplier supplier = this.dbDialect.getHostListProvider(); + HostListProviderSupplier supplier = this.dbDialect.getHostListProviderSupplier(); this.hostListProvider = supplier.getProvider(this.props, this.originalUrl, this.servicesContainer); } @@ -157,7 +160,7 @@ public HostSpec getCurrentHostSpec() { Messages.get("PluginServiceImpl.currentHostNotAllowed", new Object[] { currentHostSpec == null ? "" : currentHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java index aae57d7f4..bc1e232f2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginService.java @@ -28,6 +28,7 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 4518eff66..025818cfd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -46,12 +46,15 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.HostAvailabilityStrategyFactory; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.states.SessionStateService; import software.amazon.jdbc.states.SessionStateServiceImpl; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.storage.CacheMap; @@ -191,7 +194,7 @@ public HostSpec getCurrentHostSpec() { Messages.get("PluginServiceImpl.currentHostNotAllowed", new Object[] { currentHostSpec == null ? "" : currentHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } @@ -707,7 +710,7 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } - final HostListProviderSupplier supplier = this.dialect.getHostListProvider(); + final HostListProviderSupplier supplier = this.dialect.getHostListProviderSupplier(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); this.refreshHostList(connection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 1e44afdb0..8ae253cbd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -17,119 +17,85 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.util.Arrays; import java.util.Collections; import java.util.List; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class AuroraMysqlDialect extends MysqlDialect implements BlueGreenDialect { +public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { - protected final String topologyQuery = + protected static final String AURORA_VERSION_EXISTS_QUERY = "SHOW VARIABLES LIKE 'aurora_version'"; + protected static final String TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, REPLICA_LAG_IN_MILLISECONDS, LAST_UPDATE_TIMESTAMP " + "FROM information_schema.replica_host_status " - // filter out nodes that haven't been updated in the last 5 minutes + // filter out instances that have not been updated in the last 5 minutes + "WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' "; - protected final String isWriterQuery = + protected static final String INSTANCE_ID_QUERY = "SELECT @@aurora_server_id, @@aurora_server_id"; + protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM information_schema.replica_host_status " - + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; + + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id"; + protected static final String IS_READER_QUERY = "SELECT @@innodb_read_only"; - protected final String nodeIdQuery = "SELECT @@aurora_server_id, @@aurora_server_id"; - protected final String isReaderQuery = "SELECT @@innodb_read_only"; - - private static final String BG_STATUS_QUERY = - "SELECT * FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String BG_TOPOLOGY_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery("SHOW VARIABLES LIKE 'aurora_version'"); - if (rs.next()) { - // If variable with such name is presented then it means it's an Aurora cluster - return true; - } - } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } - } - return false; + return dialectUtils.checkExistenceQueries(connection, AURORA_VERSION_EXISTS_QUERY); } @Override public List getDialectUpdateCandidates() { - return Arrays.asList( - DialectCodes.GLOBAL_AURORA_MYSQL, - DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); + return Collections.singletonList(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER); } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - this.topologyQuery, - this.nodeIdQuery, - this.isReaderQuery, - this.isWriterQuery); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - this.topologyQuery, - this.nodeIdQuery, - this.isReaderQuery); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; + } + + @Override + public String getWriterIdQuery() { + return WRITER_ID_QUERY; + } + + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; } @Override public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + return dialectUtils.checkExistenceQueries(connection, BG_TOPOLOGY_EXISTS_QUERY); } + @Override + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; + } } - diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index c88f595af..e43f30cb8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -24,59 +24,49 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.Messages; -/** - * Suitable for the following AWS PG configurations. - * - Regional Cluster - */ -public class AuroraPgDialect extends PgDialect implements AuroraLimitlessDialect, BlueGreenDialect { - private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); +public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { - protected final String extensionsSql = + protected static final String AURORA_UTILS_EXIST_QUERY = "SELECT (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " + "FROM pg_catalog.pg_settings " + "WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'"; - - protected final String topologySql = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; - - protected final String topologyQuery = + protected static final String TOPOLOGY_EXISTS_QUERY = "SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1"; + protected static final String TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "CPU, COALESCE(REPLICA_LAG_IN_MSEC, 0), LAST_UPDATE_TIMESTAMP " + "FROM pg_catalog.aurora_replica_status() " - // filter out nodes that haven't been updated in the last 5 minutes + // filter out instances that haven't been updated in the last 5 minutes + "WHERE EXTRACT(" + "EPOCH FROM(pg_catalog.NOW() OPERATOR(pg_catalog.-) LAST_UPDATE_TIMESTAMP)) OPERATOR(pg_catalog.<=) 300 " + "OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "OR LAST_UPDATE_TIMESTAMP IS NULL"; - protected final String isWriterQuery = + protected static final String INSTANCE_ID_QUERY = + "SELECT pg_catalog.aurora_db_instance_identifier(), pg_catalog.aurora_db_instance_identifier()"; + protected static final String WRITER_ID_QUERY = "SELECT SERVER_ID FROM pg_catalog.aurora_replica_status() " + "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " + "AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()"; + protected static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; - protected final String nodeIdQuery = - "SELECT pg_catalog.aurora_db_instance_identifier(), pg_catalog.aurora_db_instance_identifier()"; - protected final String isReaderQuery = "SELECT pg_catalog.pg_is_in_recovery()"; protected static final String LIMITLESS_ROUTER_ENDPOINT_QUERY = "select router_endpoint, load from pg_catalog.aurora_limitless_router_endpoints()"; - private static final String BG_STATUS_QUERY = - "SELECT * FROM " - + "pg_catalog.get_blue_green_fast_switchover_metadata('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String BG_TOPOLOGY_EXISTS_QUERY = "SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::regproc"; + protected static final String BG_STATUS_QUERY = + "SELECT * FROM " + + "pg_catalog.get_blue_green_fast_switchover_metadata('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - @Override - public List getDialectUpdateCandidates() { - return Arrays.asList(DialectCodes.GLOBAL_AURORA_PG, - DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, - DialectCodes.RDS_PG); - } + private static final Logger LOGGER = Logger.getLogger(AuroraPgDialect.class.getName()); @Override public boolean isDialect(final Connection connection) { @@ -84,112 +74,80 @@ public boolean isDialect(final Connection connection) { return false; } - Statement stmt = null; - ResultSet rs = null; boolean hasExtensions = false; - boolean hasTopology = false; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(extensionsSql); - if (rs.next()) { - final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); - if (auroraUtils) { - hasExtensions = true; - } - } - } catch (SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { + if (!rs.next()) { + return false; } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } + + final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); + LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); + if (auroraUtils) { + hasExtensions = true; } + } catch (SQLException ex) { + return false; } + if (!hasExtensions) { return false; } - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(topologySql); - if (rs.next()) { - LOGGER.finest(() -> "hasTopology: true"); - hasTopology = true; - } - } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } - } - return hasExtensions && hasTopology; + + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_EXISTS_QUERY); + } + + @Override + public List getDialectUpdateCandidates() { + return Arrays.asList(DialectCodes.GLOBAL_AURORA_PG, + DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, + DialectCodes.RDS_PG); } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsHostListProvider( - properties, - initialUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery, - isWriterQuery); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new AuroraHostListProvider( - properties, - initialUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; + } + + @Override + public String getWriterIdQuery() { + return WRITER_ID_QUERY; + } + + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + @Override public String getLimitlessRouterEndpointQuery() { return LIMITLESS_ROUTER_ENDPOINT_QUERY; } @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; + public boolean isBlueGreenStatusAvailable(final Connection connection) { + return dialectUtils.checkExistenceQueries(connection, BG_TOPOLOGY_EXISTS_QUERY); } @Override - public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java index ce1b678d3..a5e34f150 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/BlueGreenDialect.java @@ -19,7 +19,7 @@ import java.sql.Connection; public interface BlueGreenDialect { - String getBlueGreenStatusQuery(); - boolean isBlueGreenStatusAvailable(final Connection connection); + + String getBlueGreenStatusQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java index 367db7d25..5f09aae0b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java @@ -26,22 +26,23 @@ import software.amazon.jdbc.plugin.failover.FailoverRestriction; public interface Dialect { - int getDefaultPort(); - ExceptionHandler getExceptionHandler(); + boolean isDialect(Connection connection); - String getHostAliasQuery(); + int getDefaultPort(); - String getServerVersionQuery(); + List getDialectUpdateCandidates(); - boolean isDialect(Connection connection); + ExceptionHandler getExceptionHandler(); - List getDialectUpdateCandidates(); + HostListProviderSupplier getHostListProviderSupplier(); - HostListProviderSupplier getHostListProvider(); + String getHostAliasQuery(); void prepareConnectProperties( final @NonNull Properties connectProperties, final @NonNull String protocol, final @NonNull HostSpec hostSpec); EnumSet getFailoverRestrictions(); + + String getServerVersionQuery(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java index 273edf82a..ed7f4e71e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectManager.java @@ -57,9 +57,9 @@ public class DialectManager implements DialectProvider { put(DialectCodes.PG, new PgDialect()); put(DialectCodes.MARIADB, new MariaDbDialect()); put(DialectCodes.RDS_MYSQL, new RdsMysqlDialect()); - put(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, new RdsMultiAzDbClusterMysqlDialect()); + put(DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, new MultiAzClusterMysqlDialect()); put(DialectCodes.RDS_PG, new RdsPgDialect()); - put(DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, new RdsMultiAzDbClusterPgDialect()); + put(DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, new MultiAzClusterPgDialect()); put(DialectCodes.GLOBAL_AURORA_MYSQL, new GlobalAuroraMysqlDialect()); put(DialectCodes.AURORA_MYSQL, new AuroraMysqlDialect()); put(DialectCodes.GLOBAL_AURORA_PG, new GlobalAuroraPgDialect()); @@ -75,7 +75,7 @@ public class DialectManager implements DialectProvider { */ protected static final long ENDPOINT_CACHE_EXPIRATION = TimeUnit.HOURS.toNanos(24); - // Map of host name, or url, by dialect code. + // Keys are host names or URLs, values are dialect codes. protected static final CacheMap knownEndpointDialects = new CacheMap<>(); private final RdsUtils rdsHelper = new RdsUtils(); @@ -129,8 +129,7 @@ public Dialect getDialect( this.logCurrentDialect(); return userDialect; } else { - throw new SQLException( - Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCode})); + throw new SQLException(Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCode})); } } @@ -140,7 +139,7 @@ public Dialect getDialect( String host = url; final List hosts = this.connectionUrlParser.getHostsFromConnectionUrl( - url, true, pluginService::getHostSpecBuilder); + url, true, pluginService::getHostSpecBuilder); if (!Utils.isNullOrEmpty(hosts)) { host = hosts.get(0).getHost(); } @@ -238,9 +237,10 @@ public Dialect getDialect( for (String dialectCandidateCode : dialectCandidates) { Dialect dialectCandidate = knownDialectsByCode.get(dialectCandidateCode); if (dialectCandidate == null) { - throw new SQLException( - Messages.get("DialectManager.unknownDialectCode", new Object[] {dialectCandidateCode})); + throw new SQLException(Messages.get( + "DialectManager.unknownDialectCode", new Object[] {dialectCandidateCode})); } + boolean isDialect = dialectCandidate.isDialect(connection); if (isDialect) { this.canUpdate = false; @@ -270,9 +270,8 @@ public Dialect getDialect( } private void logCurrentDialect() { - LOGGER.finest(() -> String.format("Current dialect: %s, %s, canUpdate: %b", - this.dialectCode, - this.dialect == null ? "" : this.dialect, - this.canUpdate)); + LOGGER.finest(Messages.get( + "DialectManager.currentDialect", + new Object[] {this.dialectCode, this.dialect == null ? "" : this.dialect, this.canUpdate})); } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java new file mode 100644 index 000000000..a09480cd7 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/DialectUtils.java @@ -0,0 +1,46 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; + +public class DialectUtils { + /** + * Given a series of existence queries, returns true if they all execute successfully and contain at least one record. + * Otherwise, returns false. + * + * @param conn the connection to use for executing the queries. + * @param existenceQueries the queries to check for existing records. + * @return true if all queries execute successfully and return at least one record, false otherwise. + */ + public boolean checkExistenceQueries(Connection conn, String... existenceQueries) { + for (String existenceQuery : existenceQueries) { + try (Statement stmt = conn.createStatement(); ResultSet rs = stmt.executeQuery(existenceQuery)) { + if (!rs.next()) { + return false; + } + } catch (SQLException e) { + return false; + } + } + + return true; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index 3e4db74e6..334757af9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -23,79 +23,48 @@ import java.util.Collections; import java.util.List; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; -public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect { +public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalAuroraTopologyDialect { - protected final String globalDbStatusTableExistQuery = + protected static final String GLOBAL_STATUS_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_STATUS'"; - - protected final String globalDbStatusQuery = - "SELECT count(1) FROM information_schema.aurora_global_db_status"; - - protected final String globalDbInstanceStatusTableExistQuery = + protected static final String GLOBAL_INSTANCE_STATUS_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_INSTANCE_STATUS'"; - protected final String globalTopologyQuery = + protected static final String GLOBAL_TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + "FROM information_schema.aurora_global_db_instance_status "; - protected final String regionByNodeIdQuery = + protected static final String REGION_COUNT_QUERY = "SELECT count(1) FROM information_schema.aurora_global_db_status"; + protected static final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?"; + @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusTableExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbInstanceStatusTableExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusQuery); + if (!dialectUtils.checkExistenceQueries( + connection, GLOBAL_STATUS_TABLE_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)) { + return false; + } - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { + if (!rs.next()) { + return false; } - return false; + + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } catch (final SQLException ex) { - // ignore - } finally { - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } - return false; } @Override @@ -104,27 +73,25 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery, - this.isWriterQuery, - this.regionByNodeIdQuery); + return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new AuroraGlobalDbHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } + + @Override + public String getTopologyQuery() { + return GLOBAL_TOPOLOGY_QUERY; + } + + @Override + public String getRegionByInstanceIdQuery() { + return REGION_BY_INSTANCE_ID_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index 289ced4ae..7c060c800 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -24,91 +24,62 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.AuroraGlobalDbMonitoringHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringGlobalAuroraHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; +import software.amazon.jdbc.util.Messages; -public class GlobalAuroraPgDialect extends AuroraPgDialect { +public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { - private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); - - protected final String globalDbStatusFuncExistQuery = - "select 'aurora_global_db_status'::regproc"; - - protected final String globalDbInstanceStatusFuncExistQuery = + protected static final String GLOBAL_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_status'::regproc"; + protected static final String GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY = "select 'aurora_global_db_instance_status'::regproc"; - protected final String globalTopologyQuery = + protected static final String GLOBAL_TOPOLOGY_QUERY = "SELECT SERVER_ID, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END, " + "VISIBILITY_LAG_IN_MSEC, AWS_REGION " + "FROM aurora_global_db_instance_status()"; - protected final String globalDbStatusQuery = - "SELECT count(1) FROM aurora_global_db_status()"; - - protected final String regionByNodeIdQuery = + protected static final String REGION_COUNT_QUERY = "SELECT count(1) FROM aurora_global_db_status()"; + protected static final String REGION_BY_INSTANCE_ID_QUERY = "SELECT AWS_REGION FROM aurora_global_db_instance_status() WHERE SERVER_ID = ?"; + private static final Logger LOGGER = Logger.getLogger(GlobalAuroraPgDialect.class.getName()); + @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.extensionsSql); - if (rs.next()) { + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(AURORA_UTILS_EXIST_QUERY)) { + if (!rs.next()) { + return false; + } + final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("auroraUtils: %b", auroraUtils)); + LOGGER.finest(Messages.get("AuroraPgDialect.auroraUtils", new Object[] {auroraUtils})); if (!auroraUtils) { return false; } } - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusFuncExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbInstanceStatusFuncExistQuery); - - if (rs.next()) { - rs.close(); - stmt.close(); - - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.globalDbStatusQuery); + if (!dialectUtils.checkExistenceQueries( + connection, GLOBAL_STATUS_FUNC_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY)) { + return false; + } - if (rs.next()) { - int awsRegionCount = rs.getInt(1); - return awsRegionCount > 1; - } + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REGION_COUNT_QUERY)) { + if (!rs.next()) { + return false; } + + int awsRegionCount = rs.getInt(1); + return awsRegionCount > 1; } - return false; } catch (final SQLException ex) { - // ignore - } finally { - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } - return false; } @Override @@ -117,27 +88,25 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new AuroraGlobalDbMonitoringHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery, - this.isWriterQuery, - this.regionByNodeIdQuery); + return new MonitoringGlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } - return new AuroraGlobalDbHostListProvider( - properties, - initialUrl, - servicesContainer, - this.globalTopologyQuery, - this.nodeIdQuery, - this.isReaderQuery); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } + + @Override + public String getTopologyQuery() { + return GLOBAL_TOPOLOGY_QUERY; + } + + @Override + public String getRegionByInstanceIdQuery() { + return REGION_BY_INSTANCE_ID_QUERY; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java new file mode 100644 index 000000000..11db48dff --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraTopologyDialect.java @@ -0,0 +1,21 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +public interface GlobalAuroraTopologyDialect extends TopologyDialect { + String getRegionByInstanceIdQuery(); +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java index 0dfe44dc5..bee378f9f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java @@ -18,7 +18,7 @@ import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; -import software.amazon.jdbc.HostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.util.FullServicesContainer; @FunctionalInterface diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java index 3b368a8a1..58453f6fa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java @@ -32,45 +32,23 @@ import software.amazon.jdbc.plugin.failover.FailoverRestriction; public class MariaDbDialect implements Dialect { + + protected static final String VERSION_QUERY = "SELECT VERSION()"; + protected static final String HOST_ALIAS_QUERY = "SELECT CONCAT(@@hostname, ':', @@port)"; + + private static MariaDBExceptionHandler mariaDBExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, DialectCodes.RDS_MYSQL, DialectCodes.MYSQL); - private static MariaDBExceptionHandler mariaDBExceptionHandler; - - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); - - @Override - public int getDefaultPort() { - return 3306; - } - - @Override - public ExceptionHandler getExceptionHandler() { - if (mariaDBExceptionHandler == null) { - mariaDBExceptionHandler = new MariaDBExceptionHandler(); - } - return mariaDBExceptionHandler; - } - - @Override - public String getHostAliasQuery() { - return "SELECT CONCAT(@@hostname, ':', @@port)"; - } - - @Override - public String getServerVersionQuery() { - return "SELECT VERSION()"; - } @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { while (rs.next()) { final String columnValue = rs.getString(1); if (columnValue != null && columnValue.toLowerCase().contains("mariadb")) { @@ -78,32 +56,31 @@ public boolean isDialect(final Connection connection) { } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } + @Override + public int getDefaultPort() { + return 3306; + } + @Override public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } - public HostListProviderSupplier getHostListProvider() { + @Override + public ExceptionHandler getExceptionHandler() { + if (mariaDBExceptionHandler == null) { + mariaDBExceptionHandler = new MariaDBExceptionHandler(); + } + return mariaDBExceptionHandler; + } + + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @@ -116,6 +93,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java similarity index 57% rename from wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java index 5303763f7..4dc0a584d 100644 --- a/wrapper/src/test/java/integration/container/aurora/TestAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterDialect.java @@ -14,16 +14,10 @@ * limitations under the License. */ -package integration.container.aurora; +package software.amazon.jdbc.dialect; -import java.util.Properties; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; -import software.amazon.jdbc.util.FullServicesContainer; +public interface MultiAzClusterDialect extends TopologyDialect { + String getWriterIdQuery(); -public class TestAuroraHostListProvider extends AuroraHostListProvider { - - public TestAuroraHostListProvider( - FullServicesContainer servicesContainer, Properties properties, String originalUrl) { - super(properties, originalUrl, servicesContainer, "", "", ""); - } + String getWriterIdColumnName(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java similarity index 52% rename from wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 9c920c8e6..9fe7d3b03 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -26,69 +26,56 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsMultiAzHostListProvider; +import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; -public class RdsMultiAzDbClusterMysqlDialect extends MysqlDialect { +public class MultiAzClusterMysqlDialect extends MysqlDialect implements MultiAzClusterDialect { - private static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" - + " table_schema = 'mysql' AND table_name = 'rds_topology'"; - - // For reader nodes, the query returns a writer node ID. For a writer node, the query returns no data. - private static final String FETCH_WRITER_NODE_QUERY = "SHOW REPLICA STATUS"; - - private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "Source_Server_Id"; + + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String TOPOLOGY_QUERY = "SELECT id, endpoint, port FROM mysql.rds_topology"; - // The query return nodeId and nodeName. + // This query returns both instanceId and instanceName. // For example: "1845128080", "test-multiaz-instance-1" - private static final String NODE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + protected static final String INSTANCE_ID_QUERY = "SELECT id, SUBSTRING_INDEX(endpoint, '.', 1)" + " FROM mysql.rds_topology" + " WHERE id = @@server_id"; - private static final String IS_READER_QUERY = "SELECT @@read_only"; + // For reader instances, this query returns a writer instance ID. For a writer instance, this query returns no data. + protected static final String WRITER_ID_QUERY = "SHOW REPLICA STATUS"; + protected static final String WRITER_ID_QUERY_COLUMN_NAME = "Source_Server_Id"; + protected static final String IS_READER_QUERY = "SELECT @@read_only"; - private static final EnumSet RDS_MULTI_AZ_RESTRICTIONS = + private static final EnumSet FAILOVER_RESTRICTIONS = EnumSet.of(FailoverRestriction.DISABLE_TASK_A, FailoverRestriction.ENABLE_WRITER_IN_TASK_B); protected final RdsUtils rdsUtils = new RdsUtils(); @Override public boolean isDialect(final Connection connection) { - try { - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - if (!rs.next()) { - return false; - } - } - - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(TOPOLOGY_QUERY)) { - if (!rs.next()) { - return false; - } - } + if (!dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY, TOPOLOGY_QUERY)) { + return false; + } - try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery("SHOW VARIABLES LIKE 'report_host'")) { - if (!rs.next()) { - return false; - } - final String reportHost = rs.getString(2); // get variable value; expected value is IP address - return !StringUtils.isNullOrEmpty(reportHost); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } + final String reportHost = rs.getString(2); // Expected value is an IP address + return !StringUtils.isNullOrEmpty(reportHost); } catch (final SQLException ex) { - // ignore + return false; } - return false; } @Override @@ -97,31 +84,14 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsMultiAzHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); - - } else { - return new RdsMultiAzDbClusterListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } @@ -138,6 +108,31 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return RDS_MULTI_AZ_RESTRICTIONS; + return FAILOVER_RESTRICTIONS; + } + + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; + } + + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + + @Override + public String getWriterIdQuery() { + return WRITER_ID_QUERY; + } + + @Override + public String getWriterIdColumnName() { + return WRITER_ID_QUERY_COLUMN_NAME; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java similarity index 59% rename from wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java rename to wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 0f6f51301..ba3600710 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMultiAzDbClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -21,60 +21,48 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.List; -import java.util.logging.Logger; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; -import software.amazon.jdbc.hostlistprovider.RdsMultiAzDbClusterListProvider; -import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsMultiAzHostListProvider; +import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -public class RdsMultiAzDbClusterPgDialect extends PgDialect { +public class MultiAzClusterPgDialect extends PgDialect implements MultiAzClusterDialect { - private static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterPgDialect.class.getName()); - - private static MultiAzDbClusterPgExceptionHandler exceptionHandler; - - private static final String TOPOLOGY_QUERY = - "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - - // For reader nodes, the query should return a writer node ID. For a writer node, the query should return no data. - private static final String FETCH_WRITER_NODE_QUERY = - "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" - + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" - + " (SELECT dbi_resource_id FROM rds_tools.dbi_resource_id())"; - - private static final String IS_RDS_CLUSTER_QUERY = + protected static final String IS_RDS_CLUSTER_QUERY = "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()"; + protected static final String TOPOLOGY_QUERY = + "SELECT id, endpoint, port FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - private static final String FETCH_WRITER_NODE_QUERY_COLUMN_NAME = "multi_az_db_cluster_source_dbi_resource_id"; - - // The query return nodeId and nodeName. + // This query returns both instanceId and instanceName. // For example: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ", "test-multiaz-instance-1" - private static final String NODE_ID_QUERY = "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + protected static final String INSTANCE_ID_QUERY = + "SELECT id, SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint))" + " FROM rds_tools.show_topology()" + " WHERE id OPERATOR(pg_catalog.=) rds_tools.dbi_resource_id()"; + // For reader instances, this query should return a writer instance ID. + // For a writer instance, this query should return no data. + protected static final String WRITER_ID_QUERY = + "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()" + + " WHERE multi_az_db_cluster_source_dbi_resource_id OPERATOR(pg_catalog.!=)" + + " (SELECT dbi_resource_id FROM rds_tools.dbi_resource_id())"; + protected static final String WRITER_ID_QUERY_COLUMN_NAME = "multi_az_db_cluster_source_dbi_resource_id"; + protected static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; - private static final String IS_READER_QUERY = "SELECT pg_catalog.pg_is_in_recovery()"; - - @Override - public ExceptionHandler getExceptionHandler() { - if (exceptionHandler == null) { - exceptionHandler = new MultiAzDbClusterPgExceptionHandler(); - } - return exceptionHandler; - } + private static MultiAzDbClusterPgExceptionHandler exceptionHandler; @Override public boolean isDialect(final Connection connection) { try (Statement stmt = connection.createStatement(); - ResultSet rs = stmt.executeQuery(IS_RDS_CLUSTER_QUERY)) { + ResultSet rs = stmt.executeQuery(IS_RDS_CLUSTER_QUERY)) { return rs.next() && rs.getString(1) != null; } catch (final SQLException ex) { - // ignore + return false; } - return false; } @Override @@ -83,32 +71,48 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProviderSupplier getHostListProvider() { + public ExceptionHandler getExceptionHandler() { + if (exceptionHandler == null) { + exceptionHandler = new MultiAzDbClusterPgExceptionHandler(); + } + return exceptionHandler; + } + + @Override + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> { final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { - return new MonitoringRdsMultiAzHostListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); - - } else { - - return new RdsMultiAzDbClusterListProvider( - properties, - initialUrl, - servicesContainer, - TOPOLOGY_QUERY, - NODE_ID_QUERY, - IS_READER_QUERY, - FETCH_WRITER_NODE_QUERY, - FETCH_WRITER_NODE_QUERY_COLUMN_NAME); + return new MonitoringRdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); } + + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); }; } + + @Override + public String getTopologyQuery() { + return TOPOLOGY_QUERY; + } + + @Override + public String getInstanceIdQuery() { + return INSTANCE_ID_QUERY; + } + + @Override + public String getIsReaderQuery() { + return IS_READER_QUERY; + } + + @Override + public String getWriterIdQuery() { + return WRITER_ID_QUERY; + } + + @Override + public String getWriterIdColumnName() { + return WRITER_ID_QUERY_COLUMN_NAME; + } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index 7c930bb5e..e21bd06d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -33,46 +33,24 @@ public class MysqlDialect implements Dialect { + protected static final String VERSION_QUERY = "SHOW VARIABLES LIKE 'version_comment'"; + protected static final String HOST_ALIAS_QUERY = "SELECT CONCAT(@@hostname, ':', @@port)"; + private static MySQLExceptionHandler mySQLExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.GLOBAL_AURORA_MYSQL, DialectCodes.AURORA_MYSQL, DialectCodes.RDS_MULTI_AZ_MYSQL_CLUSTER, DialectCodes.RDS_MYSQL ); - private static MySQLExceptionHandler mySQLExceptionHandler; - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); - - @Override - public int getDefaultPort() { - return 3306; - } - - @Override - public ExceptionHandler getExceptionHandler() { - if (mySQLExceptionHandler == null) { - mySQLExceptionHandler = new MySQLExceptionHandler(); - } - return mySQLExceptionHandler; - } - - @Override - public String getHostAliasQuery() { - return "SELECT CONCAT(@@hostname, ':', @@port)"; - } - - @Override - public String getServerVersionQuery() { - return "SHOW VARIABLES LIKE 'version_comment'"; - } + protected final DialectUtils dialectUtils = new DialectUtils(); @Override public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { while (rs.next()) { final String columnValue = rs.getString(2); if (columnValue != null && columnValue.toLowerCase().contains("mysql")) { @@ -80,32 +58,31 @@ public boolean isDialect(final Connection connection) { } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } + @Override + public int getDefaultPort() { + return 3306; + } + @Override public List getDialectUpdateCandidates() { return dialectUpdateCandidates; } - public HostListProviderSupplier getHostListProvider() { + @Override + public ExceptionHandler getExceptionHandler() { + if (mySQLExceptionHandler == null) { + mySQLExceptionHandler = new MySQLExceptionHandler(); + } + return mySQLExceptionHandler; + } + + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @@ -118,6 +95,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 40363b4da..abf33ee56 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -36,21 +36,37 @@ */ public class PgDialect implements Dialect { + protected static final String PG_PROC_EXISTS_QUERY = "SELECT 1 FROM pg_catalog.pg_proc LIMIT 1"; + protected static final String VERSION_QUERY = "SELECT 'version', pg_catalog.VERSION()"; + protected static final String HOST_ALIAS_QUERY = + "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())"; + + private static PgExceptionHandler pgExceptionHandler; + private static final EnumSet NO_FAILOVER_RESTRICTIONS = + EnumSet.noneOf(FailoverRestriction.class); private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.GLOBAL_AURORA_PG, DialectCodes.AURORA_PG, DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, DialectCodes.RDS_PG); - private static PgExceptionHandler pgExceptionHandler; + protected final DialectUtils dialectUtils = new DialectUtils(); - private static final EnumSet NO_RESTRICTIONS = EnumSet.noneOf(FailoverRestriction.class); + @Override + public boolean isDialect(final Connection connection) { + return dialectUtils.checkExistenceQueries(connection, PG_PROC_EXISTS_QUERY); + } @Override public int getDefaultPort() { return 5432; } + @Override + public List getDialectUpdateCandidates() { + return dialectUpdateCandidates; + } + @Override public ExceptionHandler getExceptionHandler() { if (pgExceptionHandler == null) { @@ -60,53 +76,7 @@ public ExceptionHandler getExceptionHandler() { } @Override - public String getHostAliasQuery() { - return "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())"; - } - - @Override - public String getServerVersionQuery() { - return "SELECT 'version', pg_catalog.VERSION()"; - } - - @Override - public boolean isDialect(final Connection connection) { - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery("SELECT 1 FROM pg_catalog.pg_proc LIMIT 1"); - if (rs.next()) { - return true; - } - } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } - } - return false; - } - - @Override - public List getDialectUpdateCandidates() { - return dialectUpdateCandidates; - } - - @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @@ -119,6 +89,16 @@ public void prepareConnectProperties( @Override public EnumSet getFailoverRestrictions() { - return NO_RESTRICTIONS; + return NO_FAILOVER_RESTRICTIONS; + } + + @Override + public String getServerVersionQuery() { + return VERSION_QUERY; + } + + @Override + public String getHostAliasQuery() { + return HOST_ALIAS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java index b91f6a1e3..1e173c772 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsMysqlDialect.java @@ -26,13 +26,13 @@ public class RdsMysqlDialect extends MysqlDialect implements BlueGreenDialect { - private static final String BG_STATUS_QUERY = - "SELECT * FROM mysql.rds_topology"; - - private static final String TOPOLOGY_TABLE_EXIST_QUERY = + protected static final String REPORT_HOST_EXISTS_QUERY = "SHOW VARIABLES LIKE 'report_host'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = "SELECT 1 AS tmp FROM information_schema.tables WHERE" + " table_schema = 'mysql' AND table_name = 'rds_topology'"; + protected static final String BG_STATUS_QUERY = "SELECT * FROM mysql.rds_topology"; + private static final List dialectUpdateCandidates = Arrays.asList( DialectCodes.AURORA_MYSQL, DialectCodes.GLOBAL_AURORA_MYSQL, @@ -54,50 +54,34 @@ public boolean isDialect(final Connection connection) { // | Variable_name | value | // |-----------------|---------------------| // | version_comment | Source distribution | - // If super.idDialect returns true there is no need to check for RdsMysqlDialect. + // If super.isDialect returns true there is no need to check for RdsMysqlDialect. return false; } - Statement stmt = null; - ResultSet rs = null; - - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(this.getServerVersionQuery()); - if (!rs.next()) { - return false; - } - final String columnValue = rs.getString(2); - if (!"Source distribution".equalsIgnoreCase(columnValue)) { - return false; - } - rs.close(); - rs = stmt.executeQuery("SHOW VARIABLES LIKE 'report_host'"); - if (!rs.next()) { - return false; - } - final String reportHost = rs.getString(2); // get variable value; expected empty value - return StringUtils.isNullOrEmpty(reportHost); + try (Statement stmt = connection.createStatement()) { + try (ResultSet rs = stmt.executeQuery(VERSION_QUERY)) { + if (!rs.next()) { + return false; + } - } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore + final String columnValue = rs.getString(2); + if (!"Source distribution".equalsIgnoreCase(columnValue)) { + return false; } } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore + + try (ResultSet rs = stmt.executeQuery(REPORT_HOST_EXISTS_QUERY)) { + if (!rs.next()) { + return false; } + + final String reportHost = rs.getString(2); // An empty value is expected + return StringUtils.isNullOrEmpty(reportHost); } + + } catch (final SQLException ex) { + return false; } - return false; } @Override @@ -106,19 +90,12 @@ public List getDialectUpdateCandidates() { } @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; + public boolean isBlueGreenStatusAvailable(final Connection connection) { + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY); } @Override - public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java index 33d2c480a..62a52d019 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/RdsPgDialect.java @@ -24,6 +24,7 @@ import java.util.List; import java.util.logging.Logger; import software.amazon.jdbc.util.DriverInfo; +import software.amazon.jdbc.util.Messages; /** * Suitable for the following AWS PG configurations. @@ -33,61 +34,42 @@ */ public class RdsPgDialect extends PgDialect implements BlueGreenDialect { - private static final Logger LOGGER = Logger.getLogger(RdsPgDialect.class.getName()); - - private static final List dialectUpdateCandidates = Arrays.asList( - DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, - DialectCodes.GLOBAL_AURORA_PG, - DialectCodes.AURORA_PG); - - private static final String extensionsSql = "SELECT (setting LIKE '%rds_tools%') AS rds_tools, " + protected static final String EXTENSIONS_EXIST_SQL = "SELECT (setting LIKE '%rds_tools%') AS rds_tools, " + "(setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " + "FROM pg_catalog.pg_settings " + "WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'"; + protected static final String TOPOLOGY_TABLE_EXISTS_QUERY = + "SELECT 'rds_tools.show_topology'::regproc"; - private static final String BG_STATUS_QUERY = + protected static final String BG_STATUS_QUERY = "SELECT * FROM rds_tools.show_topology('aws_jdbc_driver-" + DriverInfo.DRIVER_VERSION + "')"; - private static final String TOPOLOGY_TABLE_EXIST_QUERY = - "SELECT 'rds_tools.show_topology'::regproc"; + private static final Logger LOGGER = Logger.getLogger(RdsPgDialect.class.getName()); + private static final List dialectUpdateCandidates = Arrays.asList( + DialectCodes.RDS_MULTI_AZ_PG_CLUSTER, + DialectCodes.GLOBAL_AURORA_PG, + DialectCodes.AURORA_PG); @Override public boolean isDialect(final Connection connection) { if (!super.isDialect(connection)) { return false; } - Statement stmt = null; - ResultSet rs = null; - try { - stmt = connection.createStatement(); - rs = stmt.executeQuery(extensionsSql); + try (Statement stmt = connection.createStatement(); + ResultSet rs = stmt.executeQuery(EXTENSIONS_EXIST_SQL)) { while (rs.next()) { final boolean rdsTools = rs.getBoolean("rds_tools"); final boolean auroraUtils = rs.getBoolean("aurora_stat_utils"); - LOGGER.finest(() -> String.format("rdsTools: %b, auroraUtils: %b", rdsTools, auroraUtils)); + LOGGER.finest(Messages.get("RdsPgDialect.rdsToolsAuroraUtils", new Object[] {rdsTools, auroraUtils})); if (rdsTools && !auroraUtils) { return true; } } } catch (final SQLException ex) { - // ignore - } finally { - if (stmt != null) { - try { - stmt.close(); - } catch (SQLException ex) { - // ignore - } - } - if (rs != null) { - try { - rs.close(); - } catch (SQLException ex) { - // ignore - } - } + return false; } + return false; } @@ -97,19 +79,12 @@ public List getDialectUpdateCandidates() { } @Override - public String getBlueGreenStatusQuery() { - return BG_STATUS_QUERY; + public boolean isBlueGreenStatusAvailable(final Connection connection) { + return dialectUtils.checkExistenceQueries(connection, TOPOLOGY_TABLE_EXISTS_QUERY); } @Override - public boolean isBlueGreenStatusAvailable(final Connection connection) { - try { - try (Statement statement = connection.createStatement(); - ResultSet rs = statement.executeQuery(TOPOLOGY_TABLE_EXIST_QUERY)) { - return rs.next(); - } - } catch (SQLException ex) { - return false; - } + public String getBlueGreenStatusQuery() { + return BG_STATUS_QUERY; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java new file mode 100644 index 000000000..e7aa0f4d2 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/TopologyDialect.java @@ -0,0 +1,27 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +public interface TopologyDialect extends Dialect { + String getTopologyQuery(); + + String getInstanceIdQuery(); + + String getWriterIdQuery(); + + String getIsReaderQuery(); +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java index f9bd1e4a3..067261242 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java @@ -82,7 +82,7 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProviderSupplier getHostListProvider() { + public HostListProviderSupplier getHostListProviderSupplier() { return (properties, initialUrl, servicesContainer) -> new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java deleted file mode 100644 index d85069323..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraGlobalDbHostListProvider.java +++ /dev/null @@ -1,114 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.Arrays; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import java.util.stream.Collectors; -import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.util.ConnectionUrlParser; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; - -public class AuroraGlobalDbHostListProvider extends AuroraHostListProvider { - - static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbHostListProvider.class.getName()); - - public static final AwsWrapperProperty GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS = - new AwsWrapperProperty( - "globalClusterInstanceHostPatterns", - null, - "Comma-separated list of the cluster instance DNS patterns that will be used to " - + "build a complete instance endpoints. " - + "A \"?\" character in these patterns should be used as a placeholder for cluster instance names. " - + "This parameter is required for Global Aurora Databases. " - + "Each region in the Global Aurora Database should be specified in the list."); - - protected final RdsUtils rdsUtils = new RdsUtils(); - - protected Map globalClusterInstanceTemplateByAwsRegion; - - static { - PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); - } - - public AuroraGlobalDbHostListProvider(Properties properties, String originalUrl, - final FullServicesContainer servicesContainer, String topologyQuery, - String nodeIdQuery, String isReaderQuery) { - super(properties, originalUrl, servicesContainer, topologyQuery, nodeIdQuery, isReaderQuery); - } - - @Override - protected void initSettings() throws SQLException { - super.initSettings(); - - String templates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); - } - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) - .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) - .collect(Collectors.toMap( - k -> k.getValue1(), - v -> { - this.validateHostPatternSetting(v.getValue2().getHost()); - return v.getValue2(); - })); - LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) - ); - } - - @Override - protected HostSpec createHost(final ResultSet resultSet) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora Global Database clusters. - // Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float nodeLag = resultSet.getFloat(3); - final String awsRegion = resultSet.getString(4); - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L; - - final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - - return createHost(hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java deleted file mode 100644 index fc53f9e1d..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraHostListProvider.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - - -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.util.FullServicesContainer; - - -public class AuroraHostListProvider extends RdsHostListProvider { - - static final Logger LOGGER = Logger.getLogger(AuroraHostListProvider.class.getName()); - - public AuroraHostListProvider( - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery) { - super(properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java new file mode 100644 index 000000000..f62415ff9 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/AuroraTopologyUtils.java @@ -0,0 +1,95 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; + +public class AuroraTopologyUtils extends TopologyUtils { + private static final Logger LOGGER = Logger.getLogger(AuroraTopologyUtils.class.getName()); + + public AuroraTopologyUtils(TopologyDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); + } + + @Override + protected @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); + while (rs.next()) { + try { + HostSpec host = createHost(rs, initialHostSpec, instanceTemplate); + hostsMap.put(host.getHost(), host); + } catch (Exception e) { + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); + return null; + } + } + + return new ArrayList<>(hostsMap.values()); + } + + @Override + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (rs.next()) { + return !StringUtils.isNullOrEmpty(rs.getString(1)); + } + } + } + + return false; + } + + protected HostSpec createHost(ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException { + // According to the topology query the result set should contain 4 columns: + // instance ID, 1/0 (writer/reader), CPU utilization, instance lag in time. + String hostName = rs.getString(1); + final boolean isWriter = rs.getBoolean(2); + final double cpuUtilization = rs.getDouble(3); + final double instanceLag = rs.getDouble(4); + Timestamp lastUpdateTime; + try { + lastUpdateTime = rs.getTimestamp(5); + } catch (Exception e) { + lastUpdateTime = Timestamp.from(Instant.now()); + } + + // Calculate weight based on instance lag in time and CPU utilization. + final long weight = Math.round(instanceLag) * 100L + Math.round(cpuUtilization); + + return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, initialHostSpec, instanceTemplate); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 80f55bdad..426ea3963 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -25,7 +25,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.ConnectionUrlParser; @@ -36,7 +35,6 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider private static final Logger LOGGER = Logger.getLogger(ConnectionStringHostListProvider.class.getName()); final List hostList = new ArrayList<>(); - Properties properties; private boolean isInitialized = false; private final boolean isSingleWriterConnectionString; private final ConnectionUrlParser connectionUrlParser; @@ -75,11 +73,12 @@ private void init() throws SQLException { } this.hostList.addAll( this.connectionUrlParser.getHostsFromConnectionUrl(this.initialUrl, this.isSingleWriterConnectionString, - () -> this.hostListProviderService.getHostSpecBuilder())); + this.hostListProviderService::getHostSpecBuilder)); if (this.hostList.isEmpty()) { throw new SQLException(Messages.get("ConnectionStringHostListProvider.parsedListEmpty", new Object[] {this.initialUrl})); } + this.hostListProviderService.setInitialConnectionHostSpec(this.hostList.get(0)); this.isInitialized = true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index 451c047f3..09d321c41 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,9 +16,7 @@ package software.amazon.jdbc.hostlistprovider; -import software.amazon.jdbc.HostListProvider; - -// A marker interface for providers that can fetch a host list, and it changes depending on database status -// A good example of such provider would be DB cluster provider (Aurora DB clusters, patroni DB clusters, etc.) -// where cluster topology (nodes, their roles, their statuses) changes over time. +// A marker interface for providers that can fetch a host list reflecting the current database topology. +// Examples include providers for Aurora or Multi-AZ clusters, where the cluster topology, status, and instance roles +// change over time. public interface DynamicHostListProvider extends HostListProvider { } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java new file mode 100644 index 000000000..682ebb31f --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -0,0 +1,73 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import software.amazon.jdbc.AwsWrapperProperty; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.RdsUtils; + +public class GlobalAuroraHostListProvider extends RdsHostListProvider { + + public static final AwsWrapperProperty GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS = + new AwsWrapperProperty( + "globalClusterInstanceHostPatterns", + null, + "Comma-separated list of the cluster instance DNS patterns that will be used to " + + "build a complete instance endpoints. " + + "A \"?\" character in these patterns should be used as a placeholder for cluster instance names. " + + "This parameter is required for Global Aurora Databases. " + + "Each region in the Global Aurora Database should be specified in the list."); + + protected final RdsUtils rdsUtils = new RdsUtils(); + protected final GlobalAuroraTopologyUtils topologyUtils; + + protected Map instanceTemplatesByRegion; + + static { + PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); + } + + public GlobalAuroraHostListProvider( + GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, + FullServicesContainer servicesContainer) { + super(topologyUtils, properties, originalUrl, servicesContainer); + this.topologyUtils = topologyUtils; + } + + @Override + protected void initSettings() throws SQLException { + super.initSettings(); + + String instanceTemplates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + this.instanceTemplatesByRegion = + this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); + } + + @Override + protected List queryForTopology(final Connection conn) throws SQLException { + init(); + return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplatesByRegion); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java new file mode 100644 index 000000000..4a5d5eeea --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyUtils.java @@ -0,0 +1,152 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.SQLSyntaxErrorException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.function.Consumer; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.GlobalAuroraTopologyDialect; +import software.amazon.jdbc.util.ConnectionUrlParser; +import software.amazon.jdbc.util.LogUtils; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; +import software.amazon.jdbc.util.StringUtils; + +public class GlobalAuroraTopologyUtils extends AuroraTopologyUtils { + private static final Logger LOGGER = Logger.getLogger(GlobalAuroraTopologyUtils.class.getName()); + + protected final GlobalAuroraTopologyDialect dialect; + + public GlobalAuroraTopologyUtils(GlobalAuroraTopologyDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); + this.dialect = dialect; + } + + public @Nullable List queryForTopology( + Connection conn, HostSpec initialHostSpec, Map instanceTemplatesByRegion) + throws SQLException { + int originalNetworkTimeout = setNetworkTimeout(conn); + try (final Statement stmt = conn.createStatement(); + final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { + if (rs.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); + return null; + } + + return this.verifyWriter(this.getHosts(rs, initialHostSpec, instanceTemplatesByRegion)); + } catch (final SQLSyntaxErrorException e) { + throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); + } finally { + if (originalNetworkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, originalNetworkTimeout); + } + } + } + + protected @Nullable List getHosts( + ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) throws SQLException { + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); + while (rs.next()) { + try { + HostSpec host = createHost(rs, initialHostSpec, instanceTemplatesByRegion); + hostsMap.put(host.getHost(), host); + } catch (Exception e) { + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[] {e.getMessage()})); + return null; + } + } + + return new ArrayList<>(hostsMap.values()); + } + + protected HostSpec createHost( + ResultSet rs, HostSpec initialHostSpec, Map instanceTemplatesByRegion) + throws SQLException { + // According to the topology query the result set should contain 4 columns: + // instance ID, 1/0 (writer/reader), node lag in time (msec), AWS region. + String hostName = rs.getString(1); + final boolean isWriter = rs.getBoolean(2); + final float nodeLag = rs.getFloat(3); + final String awsRegion = rs.getString(4); + + // Calculate weight based on node lag in time and CPU utilization. + final long weight = Math.round(nodeLag) * 100L; + + final HostSpec instanceTemplate = instanceTemplatesByRegion.get(awsRegion); + if (instanceTemplate == null) { + throw new SQLException(Messages.get( + "GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {awsRegion})); + } + + return createHost( + hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); + } + + public @Nullable String getRegion(String instanceId, Connection conn) throws SQLException { + try (final PreparedStatement stmt = conn.prepareStatement(this.dialect.getRegionByInstanceIdQuery())) { + stmt.setString(1, instanceId); + try (final ResultSet rs = stmt.executeQuery()) { + if (rs.next()) { + String awsRegion = rs.getString(1); + return StringUtils.isNullOrEmpty(awsRegion) ? null : awsRegion; + } + } + } + + return null; + } + + public Map parseInstanceTemplates(String instanceTemplatesString, Consumer hostValidator) + throws SQLException { + if (StringUtils.isNullOrEmpty(instanceTemplatesString)) { + throw new SQLException(Messages.get("GlobalAuroraTopologyUtils.globalClusterInstanceHostPatternsRequired")); + } + + Map instanceTemplates = Arrays.stream(instanceTemplatesString.split(",")) + .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) + .collect(Collectors.toMap( + Pair::getValue1, + v -> { + hostValidator.accept(v.getValue2().getHost()); + return v.getValue2(); + })); + LOGGER.finest(Messages.get( + "GlobalAuroraTopologyUtils.detectedGdbPatterns", + new Object[] {LogUtils.toLogString(instanceTemplates)})); + + return instanceTemplates; + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java similarity index 89% rename from wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index 0aa93714a..206a35415 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -14,11 +14,14 @@ * limitations under the License. */ -package software.amazon.jdbc; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; import java.sql.SQLException; import java.util.List; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; public interface HostListProvider { @@ -40,6 +43,7 @@ public interface HostListProvider { */ HostRole getHostRole(Connection connection) throws SQLException; + @Nullable HostSpec identifyConnection(Connection connection) throws SQLException; String getClusterId() throws UnsupportedOperationException, SQLException; diff --git a/wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java similarity index 89% rename from wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java index b2f6b5353..0413cb423 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/HostListProviderService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProviderService.java @@ -14,9 +14,11 @@ * limitations under the License. */ -package software.amazon.jdbc; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.dialect.Dialect; public interface HostListProviderService { diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java new file mode 100644 index 000000000..1e1045002 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/MultiAzTopologyUtils.java @@ -0,0 +1,117 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.MultiAzClusterDialect; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; + +public class MultiAzTopologyUtils extends TopologyUtils { + private static final Logger LOGGER = Logger.getLogger(MultiAzTopologyUtils.class.getName()); + + protected final MultiAzClusterDialect dialect; + + public MultiAzTopologyUtils(MultiAzClusterDialect dialect, HostSpecBuilder hostSpecBuilder) { + super(dialect, hostSpecBuilder); + this.dialect = dialect; + } + + @Override + protected @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) + throws SQLException { + String writerId = this.getWriterId(conn); + + // Data in the result set is ordered by last update time, so the latest records are last. + // We add hosts to a map to ensure newer records are not overwritten by older ones. + Map hostsMap = new HashMap<>(); + while (rs.next()) { + try { + HostSpec host = createHost(rs, initialHostSpec, instanceTemplate, writerId); + hostsMap.put(host.getHost(), host); + } catch (Exception e) { + LOGGER.finest(Messages.get("TopologyUtils.errorProcessingQueryResults", new Object[]{e.getMessage()})); + return null; + } + } + + return new ArrayList<>(hostsMap.values()); + } + + @Override + public boolean isWriterInstance(final Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + // When connected to a writer, the result is empty, otherwise it contains a single row. + return !rs.next(); + } + } + } + + protected @Nullable String getWriterId(Connection connection) throws SQLException { + try (final Statement stmt = connection.createStatement()) { + try (final ResultSet rs = stmt.executeQuery(this.dialect.getWriterIdQuery())) { + if (rs.next()) { + String writerId = rs.getString(this.dialect.getWriterIdColumnName()); + if (!StringUtils.isNullOrEmpty(writerId)) { + return writerId; + } + } + } + + // The writer ID is only returned when connected to a reader, so if the query does not return a value, it + // means we are connected to a writer + try (final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (rs.next()) { + return rs.getString(1); + } + } + } + + return null; + } + + protected HostSpec createHost( + final ResultSet rs, + final HostSpec initialHostSpec, + final HostSpec instanceTemplate, + final @Nullable String writerId) throws SQLException { + + String endpoint = rs.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" + String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" + String hostId = rs.getString("id"); // "1034958454" + final boolean isWriter = hostId.equals(writerId); + + return createHost( + hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), initialHostSpec, instanceTemplate); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index aed5f83d7..4bd523e39 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -17,45 +17,29 @@ package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; import java.util.Collections; -import java.util.Comparator; -import java.util.HashMap; import java.util.List; -import java.util.Map; -import java.util.Map.Entry; import java.util.Objects; import java.util.Properties; -import java.util.UUID; -import java.util.concurrent.Executor; import java.util.concurrent.TimeUnit; import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; -import java.util.stream.Collectors; -import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.SynchronousExecutor; import software.amazon.jdbc.util.Utils; -import software.amazon.jdbc.util.storage.CacheMap; public class RdsHostListProvider implements DynamicHostListProvider { @@ -84,17 +68,17 @@ public class RdsHostListProvider implements DynamicHostListProvider { + "This pattern is required to be specified for IP address or custom domain connections to AWS RDS " + "clusters. Otherwise, if unspecified, the pattern will be automatically created for AWS RDS clusters."); - protected static final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final ConnectionUrlParser connectionUrlParser = new ConnectionUrlParser(); protected static final int defaultTopologyQueryTimeoutMs = 5000; + protected final ReentrantLock lock = new ReentrantLock(); + protected final Properties properties; + protected final String originalUrl; protected final FullServicesContainer servicesContainer; protected final HostListProviderService hostListProviderService; - protected final String originalUrl; - protected final String topologyQuery; - protected final String nodeIdQuery; - protected final String isReaderQuery; + protected final TopologyUtils topologyUtils; + protected RdsUrlType rdsUrlType; protected long refreshRateNano = CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue != null ? TimeUnit.MILLISECONDS.toNanos(Long.parseLong(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.defaultValue)) @@ -102,33 +86,25 @@ public class RdsHostListProvider implements DynamicHostListProvider { protected List hostList = new ArrayList<>(); protected List initialHostList = new ArrayList<>(); protected HostSpec initialHostSpec; - - protected final ReentrantLock lock = new ReentrantLock(); protected String clusterId; - protected HostSpec clusterInstanceTemplate; + protected HostSpec instanceTemplate; protected volatile boolean isInitialized = false; - protected Properties properties; - static { PropertyDefinition.registerPluginProperties(RdsHostListProvider.class); } public RdsHostListProvider( + final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery) { + final FullServicesContainer servicesContainer) { + this.topologyUtils = topologyUtils; this.properties = properties; this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; this.hostListProviderService = servicesContainer.getHostListProviderService(); - this.topologyQuery = topologyQuery; - this.nodeIdQuery = nodeIdQuery; - this.isReaderQuery = isReaderQuery; } protected void init() throws SQLException { @@ -149,14 +125,12 @@ protected void init() throws SQLException { } protected void initSettings() throws SQLException { - - // initial topology is based on connection string + // The initial topology is based on the connection string. this.initialHostList = connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, this.hostListProviderService::getHostSpecBuilder); if (this.initialHostList == null || this.initialHostList.isEmpty()) { - throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", - new Object[] {this.originalUrl})); + throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); } this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); @@ -168,10 +142,10 @@ protected void initSettings() throws SQLException { HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); if (clusterInstancePattern != null) { - this.clusterInstanceTemplate = + this.instanceTemplate = ConnectionUrlParser.parseHostPortPair(clusterInstancePattern, () -> hostSpecBuilder); } else { - this.clusterInstanceTemplate = + this.instanceTemplate = hostSpecBuilder .host(rdsHelper.getRdsInstanceHostPattern(this.initialHostSpec.getHost())) .hostId(this.initialHostSpec.getHostId()) @@ -179,8 +153,7 @@ protected void initSettings() throws SQLException { .build(); } - validateHostPatternSetting(this.clusterInstanceTemplate.getHost()); - + validateHostPatternSetting(this.instanceTemplate.getHost()); this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); } @@ -189,9 +162,9 @@ protected void initSettings() throws SQLException { * cached copy of topology is returned if it's not yet outdated (controlled by {@link * #refreshRateNano}). * - * @param conn A connection to database to fetch the latest topology, if needed. + * @param conn A connection to database to fetch the latest topology, if needed. * @param forceUpdate If true, it forces a service to ignore cached copy of topology and to fetch - * a fresh one. + * a fresh one. * @return a list of hosts that describes cluster topology. A writer is always at position 0. * Returns an empty list if isn't available or is invalid (doesn't contain a writer). * @throws SQLException if errors occurred while retrieving the topology. @@ -200,20 +173,15 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f init(); final List storedHosts = this.getStoredTopology(); - if (storedHosts == null || forceUpdate) { - - // need to re-fetch topology - + // We need to re-fetch topology. if (conn == null) { - // can't fetch the latest topology since no connection - // return original hosts parsed from connection string + // We cannot fetch the latest topology since we do not have access to a connection, so we return the original + // hosts parsed from the connection string. return new FetchTopologyResult(false, this.initialHostList); } - // fetch topology from the DB - final List hosts = queryForTopology(conn); - + final List hosts = this.queryForTopology(conn); if (!Utils.isNullOrEmpty(hosts)) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); return new FetchTopologyResult(false, hosts); @@ -223,7 +191,7 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f if (storedHosts == null) { return new FetchTopologyResult(false, this.initialHostList); } else { - // use cached data + // Return the cached data. return new FetchTopologyResult(true, storedHosts); } } @@ -236,144 +204,8 @@ protected FetchTopologyResult getTopology(final Connection conn, final boolean f * @throws SQLException if errors occurred while retrieving the topology. */ protected List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("RdsHostListProvider.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.topologyQuery)) { - return processQueryResults(resultSet); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("RdsHostListProvider.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - /** - * Form a list of hosts from the results of the topology query. - * - * @param resultSet The results of the topology query - * @return a list of {@link HostSpec} objects representing - * the topology that was returned by the - * topology query. The list will be empty if the topology query returned an invalid topology - * (no writer instance). - */ - private List processQueryResults(final ResultSet resultSet) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (resultSet.next()) { - final HostSpec host = createHost(resultSet); - hostMap.put(host.getHost(), host); - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.severe( - () -> Messages.get( - "RdsHostListProvider.invalidTopology")); - hosts.clear(); - } else if (writerCount == 1) { - hosts.add(writers.get(0)); - } else { - // Take the latest updated writer node as the current writer. All others will be ignored. - List sortedWriters = writers.stream() - .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) - .collect(Collectors.toList()); - hosts.add(sortedWriters.get(0)); - } - - return hosts; - } - - /** - * Creates an instance of HostSpec which captures details about a connectable host. - * - * @param resultSet the result set from querying the topology - * @return a {@link HostSpec} instance for a specific instance from the cluster - * @throws SQLException If unable to retrieve the hostName from the result set - */ - protected HostSpec createHost(final ResultSet resultSet) throws SQLException { - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final double cpuUtilization = resultSet.getDouble(3); - final double nodeLag = resultSet.getDouble(4); - Timestamp lastUpdateTime; - try { - lastUpdateTime = resultSet.getTimestamp(5); - } catch (Exception e) { - lastUpdateTime = Timestamp.from(Instant.now()); - } - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - - return createHost(hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); - } - - protected HostSpec createHost( - String host, - final boolean isWriter, - final long weight, - final Timestamp lastUpdateTime, - final HostSpec clusterInstanceTemplate) { - - host = host == null ? "?" : host; - final String endpoint = getHostEndpoint(host, clusterInstanceTemplate); - final int port = clusterInstanceTemplate.isPortSpecified() - ? clusterInstanceTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.hostListProviderService.getHostSpecBuilder() - .host(endpoint) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(lastUpdateTime) - .build(); - hostSpec.addAlias(host); - hostSpec.setHostId(host); - return hostSpec; - } - - /** - * Build a host dns endpoint based on host/node name. - * - * @param nodeName A host name. - * @param clusterInstanceTemplate A cluster instance template - * @return Host dns endpoint - */ - protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { - final String host = clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); + init(); + return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplate); } /** @@ -407,7 +239,7 @@ public List refresh(final Connection connection) throws SQLException { : this.hostListProviderService.getCurrentConnection(); final FetchTopologyResult results = getTopology(currentConnection, false); - LOGGER.finest(() -> Utils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); + LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); this.hostList = results.hosts; return Collections.unmodifiableList(hostList); @@ -426,7 +258,7 @@ public List forceRefresh(final Connection connection) throws SQLExcept : this.hostListProviderService.getCurrentConnection(); final FetchTopologyResult results = getTopology(currentConnection, true); - LOGGER.finest(() -> Utils.logTopology(results.hosts)); + LOGGER.finest(() -> LogUtils.logTopology(results.hosts)); this.hostList = results.hosts; return Collections.unmodifiableList(this.hostList); } @@ -438,9 +270,6 @@ public RdsUrlType getRdsUrlType() throws SQLException { protected void validateHostPatternSetting(final String hostPattern) { if (!rdsHelper.isDnsPatternValid(hostPattern)) { - // "Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host - // pattern must contain a '?' - // character as a placeholder for the DB instance identifiers of the instances in the cluster" final String message = Messages.get("RdsHostListProvider.invalidPattern"); LOGGER.severe(message); throw new RuntimeException(message); @@ -448,18 +277,13 @@ protected void validateHostPatternSetting(final String hostPattern) { final RdsUrlType rdsUrlType = rdsHelper.identifyRdsType(hostPattern); if (rdsUrlType == RdsUrlType.RDS_PROXY || rdsUrlType == RdsUrlType.RDS_PROXY_ENDPOINT) { - // "An RDS Proxy url can't be used as the 'clusterInstanceHostPattern' configuration setting." - final String message = - Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy"); + final String message = Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy"); LOGGER.severe(message); throw new RuntimeException(message); } if (rdsUrlType == RdsUrlType.RDS_CUSTOM_CLUSTER) { - // "An RDS Custom Cluster endpoint can't be used as the 'clusterInstanceHostPattern' - // configuration setting." - final String message = - Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom"); + final String message = Messages.get("RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom"); LOGGER.severe(message); throw new RuntimeException(message); } @@ -478,64 +302,54 @@ public FetchTopologyResult(final boolean isCachedData, final List host @Override public HostRole getHostRole(Connection conn) throws SQLException { - try (final Statement stmt = conn.createStatement(); - final ResultSet rs = stmt.executeQuery(this.isReaderQuery)) { - if (rs.next()) { - boolean isReader = rs.getBoolean(1); - return isReader ? HostRole.READER : HostRole.WRITER; - } - } catch (SQLException e) { - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole"), e); - } - - throw new SQLException(Messages.get("RdsHostListProvider.errorGettingHostRole")); + init(); + return this.topologyUtils.getHostRole(conn); } @Override - public HostSpec identifyConnection(Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - final String instanceName = resultSet.getString(1); + public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { + init(); + try { + Pair instanceIds = this.topologyUtils.getInstanceId(connection); + if (instanceIds == null) { + throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); + } - List topology = this.refresh(connection); + List topology = this.refresh(connection); + boolean isForcedRefresh = false; + if (topology == null) { + topology = this.forceRefresh(connection); + isForcedRefresh = true; + } - boolean isForcedRefresh = false; - if (topology == null) { - topology = this.forceRefresh(connection); - isForcedRefresh = true; - } + if (topology == null) { + return null; + } + String instanceName = instanceIds.getValue2(); + HostSpec foundHost = topology + .stream() + .filter(host -> Objects.equals(instanceName, host.getHostId())) + .findAny() + .orElse(null); + + if (foundHost == null && !isForcedRefresh) { + topology = this.forceRefresh(connection); if (topology == null) { return null; } - HostSpec foundHost = topology + foundHost = topology .stream() .filter(host -> Objects.equals(instanceName, host.getHostId())) .findAny() .orElse(null); - - if (foundHost == null && !isForcedRefresh) { - topology = this.forceRefresh(connection); - if (topology == null) { - return null; - } - - foundHost = topology - .stream() - .filter(host -> Objects.equals(instanceName, host.getHostId())) - .findAny() - .orElse(null); - } - - return foundHost; } + + return foundHost; } catch (final SQLException e) { throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection"), e); } - - throw new SQLException(Messages.get("RdsHostListProvider.errorIdentifyConnection")); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java deleted file mode 100644 index a63323176..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProvider.java +++ /dev/null @@ -1,208 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Messages; - -public class RdsMultiAzDbClusterListProvider extends RdsHostListProvider { - private final String fetchWriterNodeQuery; - private final String fetchWriterNodeQueryHeader; - static final Logger LOGGER = Logger.getLogger(RdsMultiAzDbClusterListProvider.class.getName()); - - public RdsMultiAzDbClusterListProvider( - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeQueryHeader - ) { - super(properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeQueryHeader = fetchWriterNodeQueryHeader; - } - - /** - * Obtain a cluster topology from database. - * - * @param conn A connection to database to fetch the latest topology. - * @return a list of {@link HostSpec} objects representing the topology - * @throws SQLException if errors occurred while retrieving the topology. - */ - protected List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("RdsHostListProvider.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - try { - final Statement stmt = conn.createStatement(); - String writerNodeId = processWriterNodeId(stmt.executeQuery(this.fetchWriterNodeQuery)); - if (writerNodeId == null) { - final ResultSet nodeIdResultSet = stmt.executeQuery(this.nodeIdQuery); - while (nodeIdResultSet.next()) { - writerNodeId = nodeIdResultSet.getString(1); - } - } - final ResultSet topologyResultSet = stmt.executeQuery(this.topologyQuery); - return processTopologyQueryResults(topologyResultSet, writerNodeId); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("RdsHostListProvider.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - /** - * Get writer node ID. - * - * @param fetchWriterNodeResultSet A ResultSet of writer node query - * @return String The ID of a writer node - * @throws SQLException if errors occurred while retrieving the topology - */ - private String processWriterNodeId(final ResultSet fetchWriterNodeResultSet) throws SQLException { - String writerNodeId = null; - if (fetchWriterNodeResultSet.next()) { - writerNodeId = fetchWriterNodeResultSet.getString(fetchWriterNodeQueryHeader); - } - return writerNodeId; - } - - /** - * Form a list of hosts from the results of the topology query. - * - * @param topologyResultSet The results of the topology query - * @param writerNodeId The writer node ID - * @return a list of {@link HostSpec} objects representing - * the topology that was returned by the - * topology query. The list will be empty if the topology query returned an invalid topology - * (no writer instance). - */ - private List processTopologyQueryResults( - final ResultSet topologyResultSet, - final String writerNodeId) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (topologyResultSet.next()) { - final HostSpec host = createHost(topologyResultSet, writerNodeId); - hostMap.put(host.getHost(), host); - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.severe(() -> Messages.get("RdsHostListProvider.invalidTopology")); - hosts.clear(); - } else { - hosts.add(writers.get(0)); - } - - return hosts; - } - - /** - * Creates an instance of HostSpec which captures details about a connectable host. - * - * @param resultSet the result set from querying the topology - * @return a {@link HostSpec} instance for a specific instance from the cluster - * @throws SQLException If unable to retrieve the hostName from the result set - */ - private HostSpec createHost(final ResultSet resultSet, final String writerNodeId) throws SQLException { - - String hostName = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" - String instanceName = hostName.substring(0, hostName.indexOf(".")); // "instance-name" - - // "instance-name.XYZ.us-west-2.rds.amazonaws.com" based on cluster instance template - final String endpoint = getHostEndpoint(instanceName); - - String hostId = resultSet.getString("id"); - int queryPort = resultSet.getInt("port"); - final int port = this.clusterInstanceTemplate.isPortSpecified() - ? this.clusterInstanceTemplate.getPort() - : queryPort; - final boolean isWriter = hostId.equals(writerNodeId); - - final HostSpec hostSpec = this.hostListProviderService.getHostSpecBuilder() - .host(endpoint) - .hostId(hostId) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(0) - .lastUpdateTime(Timestamp.from(Instant.now())) - .build(); - hostSpec.addAlias(hostName); - return hostSpec; - } - - /** - * Build a host dns endpoint based on host/node name. - * - * @param nodeName A host name. - * @return Host dns endpoint - */ - protected String getHostEndpoint(final String nodeName) { - final String host = this.clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java index b37eb4cc3..13e646a03 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/StaticHostListProvider.java @@ -16,8 +16,6 @@ package software.amazon.jdbc.hostlistprovider; -import software.amazon.jdbc.HostListProvider; - -// A marker interface for providers that fetch node lists, and it never changes since after. -// An example of such provider is a provider that use connection string as a source. +// A marker interface for providers that fetch host lists that do not change over time. +// An example is a provider that uses a connection string to determine the host list. public interface StaticHostListProvider extends HostListProvider {} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java new file mode 100644 index 000000000..5a6a2ef68 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/TopologyUtils.java @@ -0,0 +1,235 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + +package software.amazon.jdbc.hostlistprovider; + +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.SQLSyntaxErrorException; +import java.sql.Statement; +import java.sql.Timestamp; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.List; +import java.util.concurrent.Executor; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostRole; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.dialect.TopologyDialect; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.Pair; +import software.amazon.jdbc.util.SynchronousExecutor; + +/** + * An abstract class defining utility methods that can be used to retrieve and process a variety of database topology + * information. This class can be overridden to define logic specific to various database engine deployments + * (e.g. Aurora, Multi-AZ, Global Aurora etc.). + */ +public abstract class TopologyUtils { + private static final Logger LOGGER = Logger.getLogger(TopologyUtils.class.getName()); + protected static final int DEFAULT_QUERY_TIMEOUT_MS = 1000; + + protected final Executor networkTimeoutExecutor = new SynchronousExecutor(); + protected final TopologyDialect dialect; + protected final HostSpecBuilder hostSpecBuilder; + + public TopologyUtils( + TopologyDialect dialect, + HostSpecBuilder hostSpecBuilder) { + this.dialect = dialect; + this.hostSpecBuilder = hostSpecBuilder; + } + + /** + * Query the database for information for each instance in the database topology. + * + * @param conn the connection to use to query the database. + * @param initialHostSpec the {@link HostSpec} that was used to initially connect. + * @param instanceTemplate the template {@link HostSpec} to use when constructing new {@link HostSpec} objects from + * the data returned by the topology query. + * @return a list of {@link HostSpec} objects representing the results of the topology query. + * @throws SQLException if an error occurs when executing the topology or processing the results. + */ + public @Nullable List queryForTopology(Connection conn, HostSpec initialHostSpec, HostSpec instanceTemplate) + throws SQLException { + int originalNetworkTimeout = setNetworkTimeout(conn); + try (final Statement stmt = conn.createStatement(); + final ResultSet rs = stmt.executeQuery(this.dialect.getTopologyQuery())) { + if (rs.getMetaData().getColumnCount() == 0) { + // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. + LOGGER.finest(Messages.get("TopologyUtils.unexpectedTopologyQueryColumnCount")); + return null; + } + + return this.verifyWriter(this.getHosts(conn, rs, initialHostSpec, instanceTemplate)); + } catch (final SQLSyntaxErrorException e) { + throw new SQLException(Messages.get("TopologyUtils.invalidQuery"), e); + } finally { + if (originalNetworkTimeout == 0 && !conn.isClosed()) { + conn.setNetworkTimeout(networkTimeoutExecutor, originalNetworkTimeout); + } + } + } + + protected int setNetworkTimeout(Connection conn) { + int networkTimeout = -1; + try { + networkTimeout = conn.getNetworkTimeout(); + // The topology query is not monitored by the EFM plugin, so it needs a socket timeout. + if (networkTimeout == 0) { + conn.setNetworkTimeout(this.networkTimeoutExecutor, DEFAULT_QUERY_TIMEOUT_MS); + } + } catch (SQLException e) { + LOGGER.warning(() -> Messages.get("TopologyUtils.errorGettingNetworkTimeout", new Object[] {e.getMessage()})); + } + return networkTimeout; + } + + protected abstract @Nullable List getHosts( + Connection conn, ResultSet rs, HostSpec initialHostSpec, HostSpec instanceTemplate) throws SQLException; + + protected @Nullable List verifyWriter(@Nullable List allHosts) { + if (allHosts == null) { + return null; + } + + List hosts = new ArrayList<>(); + List writers = new ArrayList<>(); + for (HostSpec host : allHosts) { + if (HostRole.WRITER == host.getRole()) { + writers.add(host); + } else { + hosts.add(host); + } + } + + int writerCount = writers.size(); + if (writerCount == 0) { + return null; + } else if (writerCount == 1) { + hosts.add(writers.get(0)); + } else { + // Assume the latest updated writer instance is the current writer. Other potential writers will be ignored. + List sortedWriters = writers.stream() + .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) + .collect(Collectors.toList()); + hosts.add(sortedWriters.get(0)); + } + + return hosts; + } + + /** + * Creates a {@link HostSpec} from the given topology information. + * + * @param instanceId the database instance identifier, e.g. "mydb-instance-1". + * @param isWriter true if this is a writer instance, false for reader. + * @param weight the instance weight for load balancing. + * @param lastUpdateTime the timestamp of the last update to this instance's information. + * @param initialHostSpec the original host specification used for connecting. + * @param instanceTemplate the template used to construct the new {@link HostSpec}. + * @return a {@link HostSpec} representing the given information. + */ + public HostSpec createHost( + String instanceId, + String instanceName, + final boolean isWriter, + final long weight, + final Timestamp lastUpdateTime, + final HostSpec initialHostSpec, + final HostSpec instanceTemplate) { + instanceName = instanceName == null ? "?" : instanceName; + final String endpoint = instanceTemplate.getHost().replace("?", instanceName); + final int port = instanceTemplate.isPortSpecified() + ? instanceTemplate.getPort() + : initialHostSpec.getPort(); + + final HostSpec hostSpec = this.hostSpecBuilder + .hostId(instanceId) + .host(endpoint) + .port(port) + .role(isWriter ? HostRole.WRITER : HostRole.READER) + .availability(HostAvailability.AVAILABLE) + .weight(weight) + .lastUpdateTime(lastUpdateTime) + .build(); + hostSpec.addAlias(instanceName); + hostSpec.setHostId(instanceName); + return hostSpec; + } + + /** + * Identifies instances across different database types using instanceId and instanceName values. + * + *

Database types handle these identifiers differently: + * - Aurora: Uses the instance name as both instanceId and instanceName + * Example: "test-instance-1" for both values + * - RDS Cluster: Uses distinct values for instanceId and instanceName + * Example: + * instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" + * instanceName: "test-multiaz-instance-1" + */ + public @Nullable Pair getInstanceId(final Connection connection) { + try { + try (final Statement stmt = connection.createStatement(); + final ResultSet rs = stmt.executeQuery(this.dialect.getInstanceIdQuery())) { + if (rs.next()) { + return Pair.create(rs.getString(1), rs.getString(2)); + } + } + } catch (SQLException ex) { + return null; + } + + return null; + } + + /** + * Evaluate whether the given connection is to a writer instance. + * + * @param connection the connection to evaluate. + * @return true if the connection is to a writer instance, false otherwise. + * @throws SQLException if an exception occurs when querying the database or processing the database response. + */ + public abstract boolean isWriterInstance(Connection connection) throws SQLException; + + /** + * Evaluate the database role of the given connection, either {@link HostRole#WRITER} or {@link HostRole#READER}. + * + * @param conn the connection to evaluate. + * @return the database role of the given connection. + * @throws SQLException if an exception occurs when querying the database or processing the database response. + */ + public HostRole getHostRole(Connection conn) throws SQLException { + try (final Statement stmt = conn.createStatement(); + final ResultSet rs = stmt.executeQuery(this.dialect.getIsReaderQuery())) { + if (rs.next()) { + boolean isReader = rs.getBoolean(1); + return isReader ? HostRole.READER : HostRole.WRITER; + } + } catch (SQLException e) { + throw new SQLException(Messages.get("TopologyUtils.errorGettingHostRole"), e); + } + + throw new SQLException(Messages.get("TopologyUtils.errorGettingHostRole")); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java deleted file mode 100644 index 9053e93db..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/AuroraGlobalDbMonitoringHostListProvider.java +++ /dev/null @@ -1,108 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.SQLException; -import java.util.Arrays; -import java.util.HashMap; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import java.util.stream.Collectors; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraGlobalDbHostListProvider; -import software.amazon.jdbc.util.ConnectionUrlParser; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.Pair; -import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; - -public class AuroraGlobalDbMonitoringHostListProvider extends MonitoringRdsHostListProvider { - - static final Logger LOGGER = Logger.getLogger(AuroraGlobalDbMonitoringHostListProvider.class.getName()); - - protected Map globalClusterInstanceTemplateByAwsRegion = new HashMap<>(); - - protected final RdsUtils rdsUtils = new RdsUtils(); - - protected String regionByNodeIdQuery; - - static { - // Register property definition in AuroraGlobalDbHostListProvider class. It's not a mistake. - PropertyDefinition.registerPluginProperties(AuroraGlobalDbHostListProvider.class); - } - - public AuroraGlobalDbMonitoringHostListProvider(Properties properties, String originalUrl, - final FullServicesContainer servicesContainer, String globalTopologyQuery, - String nodeIdQuery, String isReaderQuery, String writerTopologyQuery, - String regionByNodeIdQuery) { - - super(properties, originalUrl, servicesContainer, globalTopologyQuery, nodeIdQuery, isReaderQuery, - writerTopologyQuery); - this.regionByNodeIdQuery = regionByNodeIdQuery; - } - - @Override - protected void initSettings() throws SQLException { - super.initSettings(); - - String templates = AuroraGlobalDbHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - if (StringUtils.isNullOrEmpty(templates)) { - throw new SQLException("Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database."); - } - - HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); - this.globalClusterInstanceTemplateByAwsRegion = Arrays.stream(templates.split(",")) - .map(x -> ConnectionUrlParser.parseHostPortPairWithRegionPrefix(x.trim(), () -> hostSpecBuilder)) - .collect(Collectors.toMap( - Pair::getValue1, - v -> { - this.validateHostPatternSetting(v.getValue2().getHost()); - return v.getValue2(); - })); - LOGGER.finest(() -> "Recognized GDB instance template patterns:\n" - + this.globalClusterInstanceTemplateByAwsRegion.entrySet().stream() - .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) - .collect(Collectors.joining("\n")) - ); - } - - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent( - ClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> - new GlobalDbClusterTopologyMonitorImpl( - servicesContainer, - this.clusterId, - this.initialHostSpec, - this.properties, - this.clusterInstanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery, - this.globalClusterInstanceTemplateByAwsRegion, - this.regionByNodeIdQuery)); - } - -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java index 80775f00d..5c142e498 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java @@ -17,15 +17,9 @@ package software.amazon.jdbc.hostlistprovider.monitoring; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; -import java.util.Comparator; -import java.util.HashMap; import java.util.List; import java.util.Properties; import java.util.concurrent.ConcurrentHashMap; @@ -39,22 +33,21 @@ import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Level; import java.util.logging.Logger; -import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostlistprovider.Topology; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.ServiceUtility; -import software.amazon.jdbc.util.StringUtils; import software.amazon.jdbc.util.SynchronousExecutor; import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; @@ -67,38 +60,22 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected static final Executor networkTimeoutExecutor = new SynchronousExecutor(); protected static final RdsUtils rdsHelper = new RdsUtils(); protected static final long monitorTerminationTimeoutSec = 30; - - protected static final int defaultTopologyQueryTimeoutMs = 1000; protected static final int closeConnectionNetworkTimeoutMs = 500; - protected static final int defaultConnectionTimeoutMs = 5000; protected static final int defaultSocketTimeoutMs = 5000; - // Keep monitoring topology with a high rate for 30s after failover. + // Keep monitoring topology at a high rate for 30s after failover. protected static final long highRefreshPeriodAfterPanicNano = TimeUnit.SECONDS.toNanos(30); protected static final long ignoreTopologyRequestNano = TimeUnit.SECONDS.toNanos(10); - protected final long refreshRateNano; - protected final long highRefreshRateNano; - protected final FullServicesContainer servicesContainer; - protected final Properties properties; - protected Properties monitoringProperties; - protected final HostSpec initialHostSpec; - protected final String topologyQuery; - protected final String nodeIdQuery; - protected final String writerTopologyQuery; - protected final HostSpec clusterInstanceTemplate; - - protected String clusterId; protected final AtomicReference writerHostSpec = new AtomicReference<>(null); protected final AtomicReference monitoringConnection = new AtomicReference<>(null); - protected boolean isVerifiedWriterConnection = false; - protected long highRefreshRateEndTimeNano = 0; + protected final Object topologyUpdated = new Object(); protected final AtomicBoolean requestToUpdateTopology = new AtomicBoolean(false); protected final AtomicLong ignoreNewTopologyRequestsEndTimeNano = new AtomicLong(-1); protected final ConcurrentHashMap submittedNodes = new ConcurrentHashMap<>(); - protected ExecutorService nodeExecutorService = null; + protected final ReentrantLock nodeExecutorLock = new ReentrantLock(); protected final AtomicBoolean nodeThreadsStop = new AtomicBoolean(false); protected final AtomicReference nodeThreadsWriterConnection = new AtomicReference<>(null); @@ -106,34 +83,40 @@ public class ClusterTopologyMonitorImpl extends AbstractMonitor implements Clust protected final AtomicReference nodeThreadsReaderConnection = new AtomicReference<>(null); protected final AtomicReference> nodeThreadsLatestTopology = new AtomicReference<>(null); + protected final long refreshRateNano; + protected final long highRefreshRateNano; + protected final TopologyUtils topologyUtils; + protected final FullServicesContainer servicesContainer; + protected final Properties properties; + protected final Properties monitoringProperties; + protected final HostSpec initialHostSpec; + protected final HostSpec instanceTemplate; + + protected ExecutorService nodeExecutorService = null; + protected boolean isVerifiedWriterConnection = false; + protected long highRefreshRateEndTimeNano = 0; + protected String clusterId; + public ClusterTopologyMonitorImpl( final FullServicesContainer servicesContainer, + final TopologyUtils topologyUtils, final String clusterId, final HostSpec initialHostSpec, final Properties properties, - final HostSpec clusterInstanceTemplate, + final HostSpec instanceTemplate, final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery) { + final long highRefreshRateNano) { super(monitorTerminationTimeoutSec); - this.clusterId = clusterId; this.servicesContainer = servicesContainer; + this.topologyUtils = topologyUtils; + this.clusterId = clusterId; this.initialHostSpec = initialHostSpec; - this.clusterInstanceTemplate = clusterInstanceTemplate; + this.instanceTemplate = instanceTemplate; this.properties = properties; this.refreshRateNano = refreshRateNano; this.highRefreshRateNano = highRefreshRateNano; - this.topologyQuery = topologyQuery; - this.writerTopologyQuery = writerTopologyQuery; - this.nodeIdQuery = nodeIdQuery; - - this.initSettings(); - } - protected void initSettings() { this.monitoringProperties = PropertyUtils.copyProperties(properties); this.properties.stringPropertyNames().stream() .filter(p -> p.startsWith(MONITORING_PROPERTY_PREFIX)) @@ -168,10 +151,11 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long if (this.ignoreNewTopologyRequestsEndTimeNano.get() > 0 && System.nanoTime() < this.ignoreNewTopologyRequestsEndTimeNano.get()) { - // Previous failover has just completed. We can use results of it without triggering a new topology update. + // A previous failover event has completed recently. + // We can use the results of it without triggering a new topology update. List currentHosts = getStoredHosts(); LOGGER.finest( - Utils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.ignoringTopologyRequest"))); + LogUtils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.ignoringTopologyRequest"))); if (currentHosts != null) { return currentHosts; } @@ -190,13 +174,12 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long @Override public List forceRefresh(@Nullable Connection connection, final long timeoutMs) throws SQLException, TimeoutException { - if (this.isVerifiedWriterConnection) { - // Push monitoring thread to refresh topology with a verified connection + // Get the monitoring thread to refresh the topology using a verified connection. return this.waitTillTopologyGetsUpdated(timeoutMs); } - // Otherwise use provided unverified connection to update topology + // Otherwise, use the provided unverified connection to update the topology. return this.fetchTopologyAndUpdateCache(connection); } @@ -207,12 +190,12 @@ protected List waitTillTopologyGetsUpdated(final long timeoutMs) throw synchronized (this.requestToUpdateTopology) { this.requestToUpdateTopology.set(true); - // Notify monitoring thread (that might be sleeping) that topology should be refreshed immediately. + // Notify the monitoring thread, which may be sleeping, that topology should be refreshed immediately. this.requestToUpdateTopology.notifyAll(); } if (timeoutMs == 0) { - LOGGER.finest(Utils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.timeoutSetToZero"))); + LOGGER.finest(LogUtils.logTopology(currentHosts, Messages.get("ClusterTopologyMonitorImpl.timeoutSetToZero"))); return currentHosts; } @@ -235,9 +218,8 @@ protected List waitTillTopologyGetsUpdated(final long timeoutMs) throw } if (System.nanoTime() >= end) { - throw new TimeoutException(Messages.get( - "ClusterTopologyMonitorImpl.topologyNotUpdated", - new Object[]{timeoutMs})); + throw new TimeoutException( + Messages.get("ClusterTopologyMonitorImpl.topologyNotUpdated", new Object[] {timeoutMs})); } return latestHosts; @@ -253,7 +235,7 @@ public void stop() { this.nodeThreadsStop.set(true); this.shutdownNodeExecutorService(); - // It breaks a waiting/sleeping cycles in monitoring thread + // This code interrupts the waiting/sleeping cycle in the monitoring thread. synchronized (this.requestToUpdateTopology) { this.requestToUpdateTopology.set(true); this.requestToUpdateTopology.notifyAll(); @@ -274,7 +256,7 @@ public void monitor() throws Exception { try { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.startMonitoringThread", - new Object[]{this.clusterId, this.initialHostSpec.getHost()})); + new Object[] {this.clusterId, this.initialHostSpec.getHost()})); while (!this.stop.get() && !Thread.currentThread().isInterrupted()) { this.lastActivityTimestampNanos.set(System.nanoTime()); @@ -284,7 +266,7 @@ public void monitor() throws Exception { if (this.submittedNodes.isEmpty()) { LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.startingNodeMonitoringThreads")); - // start node threads + // Start node monitors. this.nodeThreadsStop.set(false); this.nodeThreadsWriterConnection.set(null); this.nodeThreadsReaderConnection.set(null); @@ -293,7 +275,7 @@ public void monitor() throws Exception { List hosts = getStoredHosts(); if (hosts == null) { - // need any connection to get topology + // Use any available connection to get the topology. hosts = this.openAnyConnectionAndUpdateTopology(); } @@ -324,20 +306,17 @@ public void monitor() throws Exception { throw exceptionList.get(0); } } - // It's not possible to call shutdown() on this.nodeExecutorService since more node may be added later. + // We do not call nodeExecutorService.shutdown() here since more node monitors may be submitted later. } - // otherwise let's try it again the next round - + // We will try again in the next iteration. } else { - // node threads are running - // check if writer is already detected + // The node monitors are running, so we check if the writer has been detected. final Connection writerConnection = this.nodeThreadsWriterConnection.get(); final HostSpec writerConnectionHostSpec = this.nodeThreadsWriterHostSpec.get(); if (writerConnection != null && writerConnectionHostSpec != null) { - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors", - new Object[]{writerConnectionHostSpec})); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors", + new Object[] {writerConnectionHostSpec})); this.closeConnection(this.monitoringConnection.get()); this.monitoringConnection.set(writerConnection); @@ -359,7 +338,7 @@ public void monitor() throws Exception { continue; } else { - // update node threads with new nodes in the topology + // Update node monitors with the new instances in the topology List hosts = this.nodeThreadsLatestTopology.get(); if (hosts != null && !this.nodeThreadsStop.get()) { for (HostSpec hostSpec : hosts) { @@ -383,7 +362,7 @@ public void monitor() throws Exception { throw exceptionList.get(0); } } - // It's not possible to call shutdown() on this.nodeExecutorService since more node may be added later. + // We do not call nodeExecutorService.shutdown() here since more node monitors may be submitted later. } } } @@ -391,8 +370,7 @@ public void monitor() throws Exception { this.delay(true); } else { - // regular mode (not panic mode) - + // We are in regular mode (not panic mode). if (!this.submittedNodes.isEmpty()) { this.shutdownNodeExecutorService(); this.submittedNodes.clear(); @@ -400,8 +378,7 @@ public void monitor() throws Exception { final List hosts = this.fetchTopologyAndUpdateCache(this.monitoringConnection.get()); if (hosts == null) { - // can't get topology - // let's switch to panic mode + // Attempt to fetch topology failed, so we switch to panic mode. Connection conn = this.monitoringConnection.get(); this.monitoringConnection.set(null); this.isVerifiedWriterConnection = false; @@ -413,9 +390,9 @@ public void monitor() throws Exception { this.highRefreshRateEndTimeNano = 0; } - // Do not log topology while in high refresh rate. It's noisy! + // We avoid logging the topology while using the high refresh rate because it is too noisy. if (this.highRefreshRateEndTimeNano == 0) { - LOGGER.finest(Utils.logTopology(getStoredHosts())); + LOGGER.finest(LogUtils.logTopology(getStoredHosts())); } this.delay(false); @@ -430,14 +407,14 @@ public void monitor() throws Exception { } catch (final InterruptedException intEx) { Thread.currentThread().interrupt(); } catch (final Exception ex) { - // this should not be reached; log and exit thread + // This should not be reached. if (LOGGER.isLoggable(Level.FINEST)) { - // We want to print full trace stack of the exception. + // We want to print the full trace stack of the exception. LOGGER.log( Level.FINEST, Messages.get( "ClusterTopologyMonitorImpl.exceptionDuringMonitoringStop", - new Object[]{this.initialHostSpec.getHost()}), + new Object[] {this.initialHostSpec.getHost()}), ex); } @@ -452,7 +429,7 @@ public void monitor() throws Exception { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.stopMonitoringThread", - new Object[]{this.initialHostSpec.getHost()})); + new Object[] {this.initialHostSpec.getHost()})); } } @@ -475,7 +452,7 @@ protected void shutdownNodeExecutorService() { this.nodeExecutorService.shutdownNow(); } } catch (InterruptedException e) { - // do nothing + // Do nothing. } this.nodeExecutorService = null; @@ -512,49 +489,48 @@ protected List openAnyConnectionAndUpdateTopology() { Connection conn; - // open a new connection + // Open a new connection. try { conn = this.servicesContainer.getPluginService().forceConnect(this.initialHostSpec, this.monitoringProperties); } catch (SQLException ex) { - // can't connect return null; } if (this.monitoringConnection.compareAndSet(null, conn)) { LOGGER.finest(() -> Messages.get( "ClusterTopologyMonitorImpl.openedMonitoringConnection", - new Object[]{this.initialHostSpec.getHost()})); + new Object[] {this.initialHostSpec.getHost()})); try { - if (!StringUtils.isNullOrEmpty(this.getWriterNodeId(this.monitoringConnection.get()))) { + if (this.topologyUtils.isWriterInstance(this.monitoringConnection.get())) { this.isVerifiedWriterConnection = true; writerVerifiedByThisThread = true; if (rdsHelper.isRdsInstance(this.initialHostSpec.getHost())) { this.writerHostSpec.set(this.initialHostSpec); - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[]{this.writerHostSpec.get().getHost()})); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerMonitoringConnection", + new Object[] {this.writerHostSpec.get().getHost()})); } else { - final Pair pair = this.getNodeId(this.monitoringConnection.get()); + final Pair pair = this.topologyUtils.getInstanceId(this.monitoringConnection.get()); if (pair != null) { - this.writerHostSpec.set(this.createHost(pair.getValue1(), pair.getValue2(), true, 0, null, - this.getClusterInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()))); - LOGGER.finest( - Messages.get( - "ClusterTopologyMonitorImpl.writerMonitoringConnection", - new Object[]{this.writerHostSpec.get().getHost()})); + HostSpec instanceTemplate = this.getInstanceTemplate(pair.getValue2(), this.monitoringConnection.get()); + HostSpec writerHost = this.topologyUtils.createHost( + pair.getValue1(), pair.getValue2(), true, 0, null, this.initialHostSpec, instanceTemplate); + this.writerHostSpec.set(writerHost); + LOGGER.finest(Messages.get( + "ClusterTopologyMonitorImpl.writerMonitoringConnection", + new Object[] {this.writerHostSpec.get().getHost()})); } } } } catch (SQLException ex) { - // do nothing + // Do nothing. } } else { - // monitoring connection has already been set by other thread - // close new connection as we don't need it + // The monitoring connection has already been detected by another thread. We close the new connection since it + // is not needed anymore. this.closeConnection(conn); } } @@ -570,8 +546,7 @@ protected List openAnyConnectionAndUpdateTopology() { } if (hosts == null) { - // can't get topology; it might be something's wrong with a connection - // close connection + // Attempt to fetch topology failed. There might be something wrong with the connection, so we close it here. Connection connToClose = this.monitoringConnection.get(); this.monitoringConnection.set(null); this.closeConnection(connToClose); @@ -581,33 +556,8 @@ protected List openAnyConnectionAndUpdateTopology() { return hosts; } - protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { - return this.clusterInstanceTemplate; - } - - /** - * Identifies nodes across different database types using nodeId and nodeName values. - * - *

Database types handle these identifiers differently: - * - Aurora: Uses the instance (node) name as both nodeId and nodeName - * Example: "test-instance-1" for both values - * - RDS Cluster: Uses distinct values for nodeId and nodeName - * Example: - * nodeId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" - * nodeName: "test-multiaz-instance-1" - */ - protected Pair getNodeId(final Connection connection) { - try { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return Pair.create(resultSet.getString(1), resultSet.getString(2)); - } - } - } catch (SQLException ex) { - // do nothing - } - return null; + protected HostSpec getInstanceTemplate(String nodeId, Connection connection) throws SQLException { + return this.instanceTemplate; } protected void closeConnection(final @Nullable Connection connection) { @@ -616,16 +566,16 @@ protected void closeConnection(final @Nullable Connection connection) { try { connection.setNetworkTimeout(networkTimeoutExecutor, closeConnectionNetworkTimeoutMs); } catch (SQLException ex) { - // do nothing + // Do nothing. } connection.close(); } } catch (final SQLException ex) { - // ignore + // Do nothing. } } - // Sleep that can be easily interrupted + // Sleep method that can be easily interrupted. protected void delay(boolean useHighRefreshRate) throws InterruptedException { if (this.highRefreshRateEndTimeNano > 0 && System.nanoTime() < this.highRefreshRateEndTimeNano) { useHighRefreshRate = true; @@ -655,12 +605,16 @@ protected void delay(boolean useHighRefreshRate) throws InterruptedException { } return hosts; } catch (SQLException ex) { - // do nothing - LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[]{ex})); + LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.errorFetchingTopology", new Object[] {ex})); } + return null; } + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplate); + } + protected void updateTopologyCache(final @NonNull List hosts) { synchronized (this.requestToUpdateTopology) { this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); @@ -673,161 +627,6 @@ protected void updateTopologyCache(final @NonNull List hosts) { } } - // Returns a writer node ID if connected to a writer node. Returns null otherwise. - protected String getWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.writerTopologyQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - protected @Nullable List queryForTopology(final Connection conn) throws SQLException { - int networkTimeout = -1; - try { - networkTimeout = conn.getNetworkTimeout(); - // The topology query is not monitored by the EFM plugin, so it needs a socket timeout - if (networkTimeout == 0) { - conn.setNetworkTimeout(networkTimeoutExecutor, defaultTopologyQueryTimeoutMs); - } - } catch (SQLException e) { - LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.errorGettingNetworkTimeout", - new Object[] {e.getMessage()})); - } - - final String suggestedWriterNodeId = this.getSuggestedWriterNodeId(conn); - try (final Statement stmt = conn.createStatement(); - final ResultSet resultSet = stmt.executeQuery(this.topologyQuery)) { - return this.processQueryResults(resultSet, suggestedWriterNodeId); - } catch (final SQLSyntaxErrorException e) { - throw new SQLException(Messages.get("ClusterTopologyMonitorImpl.invalidQuery"), e); - } finally { - if (networkTimeout == 0 && !conn.isClosed()) { - conn.setNetworkTimeout(networkTimeoutExecutor, networkTimeout); - } - } - } - - protected String getSuggestedWriterNodeId(final Connection connection) throws SQLException { - // Aurora topology query can detect a writer for itself, so it doesn't need any suggested writer node ID. - return null; // intentionally null - } - - protected @Nullable List processQueryResults( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - final HashMap hostMap = new HashMap<>(); - - if (resultSet.getMetaData().getColumnCount() == 0) { - // We expect at least 4 columns. Note that the server may return 0 columns if failover has occurred. - LOGGER.finest(Messages.get("ClusterTopologyMonitorImpl.unexpectedTopologyQueryColumnCount")); - return null; - } - - // Data is result set is ordered by last updated time so the latest records go last. - // When adding hosts to a map, the newer records replace the older ones. - while (resultSet.next()) { - try { - final HostSpec host = createHost(resultSet, suggestedWriterNodeId); - hostMap.put(host.getHost(), host); - } catch (Exception e) { - LOGGER.finest( - Messages.get("ClusterTopologyMonitorImpl.errorProcessingQueryResults", new Object[]{e.getMessage()})); - return null; - } - } - - final List hosts = new ArrayList<>(); - final List writers = new ArrayList<>(); - - for (final HostSpec host : hostMap.values()) { - if (host.getRole() != HostRole.WRITER) { - hosts.add(host); - } else { - writers.add(host); - } - } - - int writerCount = writers.size(); - - if (writerCount == 0) { - LOGGER.warning(() -> Messages.get("ClusterTopologyMonitorImpl.invalidTopology")); - hosts.clear(); - } else if (writerCount == 1) { - hosts.add(writers.get(0)); - } else { - // Take the latest updated writer node as the current writer. All others will be ignored. - List sortedWriters = writers.stream() - .sorted(Comparator.comparing(HostSpec::getLastUpdateTime, Comparator.nullsLast(Comparator.reverseOrder()))) - .collect(Collectors.toList()); - hosts.add(sortedWriters.get(0)); - } - - return hosts; - } - - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora clusters. Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), CPU utilization, node lag in time. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float cpuUtilization = resultSet.getFloat(3); - final float nodeLag = resultSet.getFloat(4); - Timestamp lastUpdateTime; - try { - lastUpdateTime = resultSet.getTimestamp(5); - } catch (Exception e) { - lastUpdateTime = Timestamp.from(Instant.now()); - } - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - - return createHost(hostName, hostName, isWriter, weight, lastUpdateTime, this.clusterInstanceTemplate); - } - - protected HostSpec createHost( - String nodeId, - String nodeName, - final boolean isWriter, - final long weight, - final Timestamp lastUpdateTime, - final HostSpec clusterInstanceTemplate) { - - nodeName = nodeName == null ? "?" : nodeName; - final String endpoint = getHostEndpoint(nodeName, clusterInstanceTemplate); - final int port = clusterInstanceTemplate.isPortSpecified() - ? clusterInstanceTemplate.getPort() - : this.initialHostSpec.getPort(); - - final HostSpec hostSpec = this.servicesContainer.getHostListProviderService().getHostSpecBuilder() - .hostId(nodeId) - .host(endpoint) - .port(port) - .role(isWriter ? HostRole.WRITER : HostRole.READER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(lastUpdateTime) - .build(); - hostSpec.addAlias(nodeName); - hostSpec.setHostId(nodeName); - return hostSpec; - } - - protected String getHostEndpoint(final String nodeName, final HostSpec clusterInstanceTemplate) { - final String host = clusterInstanceTemplate.getHost(); - return host.replace("?", nodeName); - } - private static class NodeMonitoringWorker implements Runnable { private static final Logger LOGGER = Logger.getLogger(NodeMonitoringWorker.class.getName()); @@ -872,26 +671,24 @@ public void run() { } if (connection != null) { - - String writerId = null; + boolean isWriter = false; try { - writerId = this.monitor.getWriterNodeId(connection); - + isWriter = this.monitor.topologyUtils.isWriterInstance(connection); } catch (SQLSyntaxErrorException ex) { - LOGGER.severe(() -> Messages.get("NodeMonitoringThread.invalidWriterQuery", + LOGGER.severe(() -> Messages.get( + "NodeMonitoringThread.invalidWriterQuery", new Object[] {ex.getMessage()})); throw new RuntimeException(ex); - } catch (SQLException ex) { this.monitor.closeConnection(connection); connection = null; } - if (!StringUtils.isNullOrEmpty(writerId)) { + if (isWriter) { try { if (this.servicesContainer.getPluginService().getHostRole(connection) != HostRole.WRITER) { // The first connection after failover may be stale. - writerId = null; + isWriter = false; } } catch (SQLException e) { // Invalid connection, retry. @@ -899,38 +696,36 @@ public void run() { } } - if (!StringUtils.isNullOrEmpty(writerId)) { - // this prevents closing connection in finally block + if (isWriter) { + // This prevents us from closing the connection in the finally block. if (!this.monitor.nodeThreadsWriterConnection.compareAndSet(null, connection)) { - // writer connection is already setup + // The writer connection is already set up, probably by another node monitor. this.monitor.closeConnection(connection); - } else { - // writer connection is successfully set to writerConnection - LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[]{writerId})); + // Successfully updated the node monitor writer connection. + LOGGER.fine(Messages.get("NodeMonitoringThread.detectedWriter", new Object[] {hostSpec.getUrl()})); // When nodeThreadsWriterConnection and nodeThreadsWriterHostSpec are both set, the topology monitor may // set ignoreNewTopologyRequestsEndTimeNano, in which case other threads will use the cached topology // for the ignore duration, so we need to update the topology before setting nodeThreadsWriterHostSpec. this.monitor.fetchTopologyAndUpdateCache(connection); this.monitor.nodeThreadsWriterHostSpec.set(hostSpec); this.monitor.nodeThreadsStop.set(true); - LOGGER.fine(Utils.logTopology(this.monitor.getStoredHosts())); + LOGGER.fine(LogUtils.logTopology(this.monitor.getStoredHosts())); } - // Setting the connection to null here prevents the final block - // from closing nodeThreadsWriterConnection. + // We set the connection to null to prevent the finally block from closing nodeThreadsWriterConnection. connection = null; return; - } else if (connection != null) { - // this connection is a reader connection + // This connection is a reader connection. if (this.monitor.nodeThreadsWriterConnection.get() == null) { - // while writer connection isn't yet established this reader connection may update topology + // We can use this reader connection to update the topology while we wait for the writer connection to + // be established. if (updateTopology) { this.readerThreadFetchTopology(connection, this.writerHostSpec); } else if (this.monitor.nodeThreadsReaderConnection.get() == null) { if (this.monitor.nodeThreadsReaderConnection.compareAndSet(null, connection)) { - // let's use this connection to update topology + // Use this connection to update the topology. updateTopology = true; this.readerThreadFetchTopology(connection, this.writerHostSpec); } @@ -945,7 +740,8 @@ public void run() { } finally { this.monitor.closeConnection(connection); final long end = System.nanoTime(); - LOGGER.finest(() -> Messages.get("NodeMonitoringThread.threadCompleted", + LOGGER.finest(() -> Messages.get( + "NodeMonitoringThread.threadCompleted", new Object[] {TimeUnit.NANOSECONDS.toMillis(end - start)})); } } @@ -957,7 +753,8 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla List hosts; try { - hosts = this.monitor.queryForTopology(connection); + hosts = this.monitor.topologyUtils.queryForTopology( + connection, this.monitor.initialHostSpec, this.monitor.instanceTemplate); if (hosts == null) { return; } @@ -965,12 +762,12 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla return; } - // share this topology so the main monitoring thread be able to adjust node monitoring threads + // Share this topology so that the main monitoring thread can adjust the node monitoring threads. this.monitor.nodeThreadsLatestTopology.set(hosts); if (this.writerChanged) { this.monitor.updateTopologyCache(hosts); - LOGGER.finest(Utils.logTopology(hosts)); + LOGGER.finest(LogUtils.logTopology(hosts)); return; } @@ -981,16 +778,14 @@ private void readerThreadFetchTopology(final Connection connection, final @Nulla if (latestWriterHostSpec != null && writerHostSpec != null && !latestWriterHostSpec.getHostAndPort().equals(writerHostSpec.getHostAndPort())) { - - // writer node has changed this.writerChanged = true; - - LOGGER.fine(() -> Messages.get("NodeMonitoringThread.writerNodeChanged", + LOGGER.fine(() -> Messages.get( + "NodeMonitoringThread.writerNodeChanged", new Object[] {writerHostSpec.getHost(), latestWriterHostSpec.getHost()})); - // we can update topology cache and notify all waiting threads + // Update the topology cache and notify all waiting threads. this.monitor.updateTopologyCache(hosts); - LOGGER.fine(Utils.logTopology(hosts)); + LOGGER.fine(LogUtils.logTopology(hosts)); } } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java new file mode 100644 index 000000000..c280035d3 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java @@ -0,0 +1,78 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider.monitoring; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.StringUtils; + + +public class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl { + protected final Map instanceTemplatesByRegion; + protected final GlobalAuroraTopologyUtils topologyUtils; + + public GlobalAuroraTopologyMonitor( + final FullServicesContainer servicesContainer, + final GlobalAuroraTopologyUtils topologyUtils, + final String clusterId, + final HostSpec initialHostSpec, + final Properties properties, + final HostSpec instanceTemplate, + final long refreshRateNano, + final long highRefreshRateNano, + final Map instanceTemplatesByRegion) { + super(servicesContainer, + topologyUtils, + clusterId, + initialHostSpec, + properties, + instanceTemplate, + refreshRateNano, + highRefreshRateNano); + + this.instanceTemplatesByRegion = instanceTemplatesByRegion; + this.topologyUtils = topologyUtils; + } + + @Override + protected HostSpec getInstanceTemplate(String instanceId, Connection connection) throws SQLException { + String region = this.topologyUtils.getRegion(instanceId, connection); + if (!StringUtils.isNullOrEmpty(region)) { + final HostSpec instanceTemplate = this.instanceTemplatesByRegion.get(region); + if (instanceTemplate == null) { + throw new SQLException( + Messages.get("GlobalAuroraTopologyMonitor.cannotFindRegionTemplate", new Object[] {region})); + } + + return instanceTemplate; + } + + return this.instanceTemplate; + } + + @Override + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java deleted file mode 100644 index 0c2ee29a2..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalDbClusterTopologyMonitorImpl.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.StringUtils; - - -public class GlobalDbClusterTopologyMonitorImpl extends ClusterTopologyMonitorImpl { - - private static final Logger LOGGER = Logger.getLogger(GlobalDbClusterTopologyMonitorImpl.class.getName()); - - protected final Map globalClusterInstanceTemplateByAwsRegion; - protected final String regionByNodeIdQuery; - - public GlobalDbClusterTopologyMonitorImpl( - final FullServicesContainer servicesContainer, - final String clusterId, - final HostSpec initialHostSpec, - final Properties properties, - final HostSpec clusterInstanceTemplate, - final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery, - final Map globalClusterInstanceTemplateByAwsRegion, - final String regionByNodeIdQuery) { - - super(servicesContainer, clusterId, initialHostSpec, properties, clusterInstanceTemplate, - refreshRateNano, highRefreshRateNano, topologyQuery, writerTopologyQuery, nodeIdQuery); - this.globalClusterInstanceTemplateByAwsRegion = globalClusterInstanceTemplateByAwsRegion; - this.regionByNodeIdQuery = regionByNodeIdQuery; - } - - @Override - protected HostSpec getClusterInstanceTemplate(String nodeId, Connection connection) { - try { - try (final PreparedStatement stmt = connection.prepareStatement(this.regionByNodeIdQuery)) { - stmt.setString(1, nodeId); - try (final ResultSet resultSet = stmt.executeQuery()) { - if (resultSet.next()) { - String awsRegion = resultSet.getString(1); - if (!StringUtils.isNullOrEmpty(awsRegion)) { - final HostSpec clusterInstanceTemplateForRegion - = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - return clusterInstanceTemplateForRegion; - } - } - } - } - } catch (SQLException ex) { - throw new RuntimeException(ex); - } - return this.clusterInstanceTemplate; - } - - @Override - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - // suggestedWriterNodeId is not used for Aurora Global Database clusters. - // Topology query can detect a writer for itself. - - // According to the topology query the result set - // should contain 4 columns: node ID, 1/0 (writer/reader), node lag in time (msec), AWS region. - String hostName = resultSet.getString(1); - final boolean isWriter = resultSet.getBoolean(2); - final float nodeLag = resultSet.getFloat(3); - final String awsRegion = resultSet.getString(4); - - // Calculate weight based on node lag in time and CPU utilization. - final long weight = Math.round(nodeLag) * 100L; - - final HostSpec clusterInstanceTemplateForRegion = this.globalClusterInstanceTemplateByAwsRegion.get(awsRegion); - if (clusterInstanceTemplateForRegion == null) { - throw new SQLException("Can't find cluster template for region " + awsRegion); - } - - return createHost( - hostName, hostName, isWriter, weight, Timestamp.from(Instant.now()), clusterInstanceTemplateForRegion); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java new file mode 100644 index 000000000..b258c223d --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java @@ -0,0 +1,91 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.hostlistprovider.monitoring; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import java.util.logging.Logger; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; +import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; +import software.amazon.jdbc.util.Messages; +import software.amazon.jdbc.util.RdsUtils; +import software.amazon.jdbc.util.StringUtils; + +public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostListProvider { + + static final Logger LOGGER = Logger.getLogger(MonitoringGlobalAuroraHostListProvider.class.getName()); + + protected Map instanceTemplatesByRegion = new HashMap<>(); + + protected final RdsUtils rdsUtils = new RdsUtils(); + protected final GlobalAuroraTopologyUtils topologyUtils; + + static { + // Intentionally register property definition using the GlobalAuroraHostListProvider class. + PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); + } + + public MonitoringGlobalAuroraHostListProvider( + GlobalAuroraTopologyUtils topologyUtils, + Properties properties, + String originalUrl, + FullServicesContainer servicesContainer) { + super(topologyUtils, properties, originalUrl, servicesContainer); + this.topologyUtils = topologyUtils; + } + + @Override + protected void initSettings() throws SQLException { + super.initSettings(); + + String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + this.instanceTemplatesByRegion = + this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); + } + + protected ClusterTopologyMonitor initMonitor() throws SQLException { + return this.servicesContainer.getMonitorService().runIfAbsent( + ClusterTopologyMonitorImpl.class, + this.clusterId, + this.servicesContainer, + this.properties, + (servicesContainer) -> + new GlobalAuroraTopologyMonitor( + servicesContainer, + this.topologyUtils, + this.clusterId, + this.initialHostSpec, + this.properties, + this.instanceTemplate, + this.refreshRateNano, + this.highRefreshRateNano, + this.instanceTemplatesByRegion)); + } + + @Override + protected List queryForTopology(Connection connection) throws SQLException { + return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java index f3a39b7a9..a1ab3490c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsHostListProvider.java @@ -22,7 +22,6 @@ import java.util.Properties; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; -import java.util.logging.Logger; import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.BlockingHostListProvider; import software.amazon.jdbc.HostSpec; @@ -30,15 +29,11 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; -import software.amazon.jdbc.hostlistprovider.Topology; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.monitoring.MonitorService; -import software.amazon.jdbc.util.storage.StorageService; -public class MonitoringRdsHostListProvider extends RdsHostListProvider - implements BlockingHostListProvider, CanReleaseResources { - - private static final Logger LOGGER = Logger.getLogger(MonitoringRdsHostListProvider.class.getName()); +public class MonitoringRdsHostListProvider + extends RdsHostListProvider implements BlockingHostListProvider, CanReleaseResources { public static final AwsWrapperProperty CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS = new AwsWrapperProperty( @@ -53,29 +48,19 @@ public class MonitoringRdsHostListProvider extends RdsHostListProvider protected final FullServicesContainer servicesContainer; protected final PluginService pluginService; protected final long highRefreshRateNano; - protected final String writerTopologyQuery; public MonitoringRdsHostListProvider( + final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String writerTopologyQuery) { - super(properties, originalUrl, servicesContainer, topologyQuery, nodeIdQuery, isReaderQuery); + final FullServicesContainer servicesContainer) { + super(topologyUtils, properties, originalUrl, servicesContainer); this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); - this.writerTopologyQuery = writerTopologyQuery; this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); } - @Override - protected void init() throws SQLException { - super.init(); - } - protected ClusterTopologyMonitor initMonitor() throws SQLException { return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, @@ -83,16 +68,14 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.servicesContainer, this.properties, (servicesContainer) -> new ClusterTopologyMonitorImpl( - servicesContainer, + this.servicesContainer, + this.topologyUtils, this.clusterId, this.initialHostSpec, this.properties, - this.clusterInstanceTemplate, + this.instanceTemplate, this.refreshRateNano, - this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery)); + this.highRefreshRateNano)); } @Override @@ -125,6 +108,6 @@ public List forceRefresh(final boolean shouldVerifyWriter, final long @Override public void releaseResources() { - // do nothing + // Do nothing. } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java deleted file mode 100644 index c11da2be9..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringRdsMultiAzHostListProvider.java +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.SQLException; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.util.FullServicesContainer; - -public class MonitoringRdsMultiAzHostListProvider extends MonitoringRdsHostListProvider { - - private static final Logger LOGGER = Logger.getLogger(MonitoringRdsMultiAzHostListProvider.class.getName()); - - protected final String fetchWriterNodeQuery; - protected final String fetchWriterNodeColumnName; - - public MonitoringRdsMultiAzHostListProvider( - final Properties properties, - final String originalUrl, - final FullServicesContainer servicesContainer, - final String topologyQuery, - final String nodeIdQuery, - final String isReaderQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeColumnName) { - super( - properties, - originalUrl, - servicesContainer, - topologyQuery, - nodeIdQuery, - isReaderQuery, - ""); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeColumnName = fetchWriterNodeColumnName; - } - - @Override - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent(MultiAzClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> new MultiAzClusterTopologyMonitorImpl( - servicesContainer, - this.clusterId, - this.initialHostSpec, - this.properties, - this.hostListProviderService, - this.clusterInstanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano, - this.topologyQuery, - this.writerTopologyQuery, - this.nodeIdQuery, - this.fetchWriterNodeQuery, - this.fetchWriterNodeColumnName)); - } - -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java deleted file mode 100644 index de23fb34c..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MultiAzClusterTopologyMonitorImpl.java +++ /dev/null @@ -1,128 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.StringUtils; - -public class MultiAzClusterTopologyMonitorImpl extends ClusterTopologyMonitorImpl { - - private static final Logger LOGGER = Logger.getLogger(MultiAzClusterTopologyMonitorImpl.class.getName()); - - protected final String fetchWriterNodeQuery; - protected final String fetchWriterNodeColumnName; - - public MultiAzClusterTopologyMonitorImpl( - final FullServicesContainer servicesContainer, - final String clusterId, - final HostSpec initialHostSpec, - final Properties properties, - final HostListProviderService hostListProviderService, - final HostSpec clusterInstanceTemplate, - final long refreshRateNano, - final long highRefreshRateNano, - final String topologyQuery, - final String writerTopologyQuery, - final String nodeIdQuery, - final String fetchWriterNodeQuery, - final String fetchWriterNodeColumnName) { - super( - servicesContainer, - clusterId, - initialHostSpec, - properties, - clusterInstanceTemplate, - refreshRateNano, - highRefreshRateNano, - topologyQuery, - writerTopologyQuery, - nodeIdQuery); - this.fetchWriterNodeQuery = fetchWriterNodeQuery; - this.fetchWriterNodeColumnName = fetchWriterNodeColumnName; - } - - // Returns a writer node ID if connected to a writer node. Returns null otherwise. - @Override - protected String getWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.fetchWriterNodeQuery)) { - if (resultSet.next()) { - String nodeId = resultSet.getString(this.fetchWriterNodeColumnName); - if (!StringUtils.isNullOrEmpty(nodeId)) { - // Replica status exists and shows a writer node ID. - // That means that this node (this connection) is a reader - return null; - } - } - } - // Replica status doesn't exist. That means that this node is a writer. - try (final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - @Override - protected String getSuggestedWriterNodeId(final Connection connection) throws SQLException { - try (final Statement stmt = connection.createStatement()) { - try (final ResultSet resultSet = stmt.executeQuery(this.fetchWriterNodeQuery)) { - if (resultSet.next()) { - String nodeId = resultSet.getString(this.fetchWriterNodeColumnName); - if (!StringUtils.isNullOrEmpty(nodeId)) { - // Replica status exists and shows a writer node ID. - // That means that this node (this connection) is a reader. - // But we now what replication source is and that is a writer node. - return nodeId; - } - } - } - // Replica status doesn't exist. That means that this node is a writer. - try (final ResultSet resultSet = stmt.executeQuery(this.nodeIdQuery)) { - if (resultSet.next()) { - return resultSet.getString(1); - } - } - } - return null; - } - - @Override - protected HostSpec createHost( - final ResultSet resultSet, - final String suggestedWriterNodeId) throws SQLException { - - String endpoint = resultSet.getString("endpoint"); // "instance-name.XYZ.us-west-2.rds.amazonaws.com" - String instanceName = endpoint.substring(0, endpoint.indexOf(".")); // "instance-name" - String hostId = resultSet.getString("id"); // "1034958454" - final boolean isWriter = hostId.equals(suggestedWriterNodeId); - - return createHost(hostId, instanceName, isWriter, 0, Timestamp.from(Instant.now()), this.clusterInstanceTemplate); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java index 035e4ecf9..9cfb8de24 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AbstractConnectionPlugin.java @@ -24,12 +24,12 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.OldConnectionSuggestedAction; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; public abstract class AbstractConnectionPlugin implements ConnectionPlugin { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index 1dbee4029..9e692f777 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -30,13 +30,13 @@ import java.util.stream.Collectors; import org.jetbrains.annotations.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java index 2427cc816..8da199b59 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/DefaultConnectionPlugin.java @@ -35,7 +35,6 @@ import software.amazon.jdbc.ConnectionPlugin; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.ConnectionProviderManager; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -44,6 +43,7 @@ import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlMethodAnalyzer; import software.amazon.jdbc.util.WrapperUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java index 63a2cef2a..4a49d57a6 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenInterimStatus.java @@ -23,8 +23,8 @@ import java.util.Set; import java.util.stream.Collectors; import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.StringUtils; -import software.amazon.jdbc.util.Utils; public class BlueGreenInterimStatus { public BlueGreenPhase blueGreenPhase; @@ -74,8 +74,8 @@ public String toString() { .map(x -> String.format("%s -> %s", x.getKey(), x.getValue())) .collect(Collectors.joining("\n ")); String allHostNamesStr = String.join("\n ", this.hostNames); - String startTopologyStr = Utils.logTopology(this.startTopology); - String currentTopologyStr = Utils.logTopology(this.currentTopology); + String startTopologyStr = LogUtils.logTopology(this.startTopology); + String currentTopologyStr = LogUtils.logTopology(this.currentTopology); return String.format("%s [\n" + " phase %s, \n" + " version '%s', \n" diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 057b152a6..832e06056 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -43,12 +43,12 @@ import java.util.stream.Collectors; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -import software.amazon.jdbc.HostListProvider; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.dialect.BlueGreenDialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.iam.IamAuthConnectionPlugin; import software.amazon.jdbc.util.ConnectionUrlParser; @@ -626,7 +626,7 @@ protected void initHostListProvider() { if (connectionHostSpecCopy != null) { String hostListProviderUrl = String.format("%s%s/", protocol, connectionHostSpecCopy.getHostAndPort()); this.hostListProvider = this.pluginService.getDialect() - .getHostListProvider() + .getHostListProviderSupplier() .getProvider( hostListProperties, hostListProviderUrl, diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java index 6b8661e02..1b5078d26 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareReaderFailoverHandler.java @@ -317,7 +317,7 @@ private ReaderFailoverResult getConnectionFromHostGroup(final List hos } } - return new ReaderFailoverResult(null, null, false); + return FAILED_READER_FAILOVER_RESULT; } finally { executor.shutdownNow(); } @@ -364,7 +364,7 @@ private ReaderFailoverResult getResultFromNextTaskBatch( return result; } } - return new ReaderFailoverResult(null, null, false); + return FAILED_READER_FAILOVER_RESULT; } private ReaderFailoverResult getNextResult(final CompletionService service) diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 8504842c6..a6eafd1d3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -37,6 +37,7 @@ import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; import software.amazon.jdbc.util.ServiceUtility; @@ -465,7 +466,7 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti if (allowOldWriter || !isSame(writerCandidate, this.originalWriterHost)) { // new writer is available, and it's different from the previous writer - LOGGER.finest(() -> Utils.logTopology(this.currentTopology, "[TaskB] Topology:")); + LOGGER.finest(() -> LogUtils.logTopology(this.currentTopology, "[TaskB] Topology:")); if (connectToWriter(writerCandidate)) { return true; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index 25ce77ecb..0eb2d9baa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -33,7 +33,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -43,10 +42,12 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; @@ -757,7 +758,7 @@ protected void failoverWriter() throws SQLException { throwFailoverFailedException( Messages.get( "Failover.noWriterHostAfterReconnecting", - new Object[]{Utils.logTopology(hosts, "")})); + new Object[]{LogUtils.logTopology(hosts, "")})); return; } @@ -765,7 +766,7 @@ protected void failoverWriter() throws SQLException { if (!Utils.containsHostAndPort(allowedHosts, writerHostSpec.getHostAndPort())) { throwFailoverFailedException( Messages.get("Failover.newWriterNotAllowed", - new Object[] {writerHostSpec.getUrl(), Utils.logTopology(allowedHosts, "")})); + new Object[] {writerHostSpec.getUrl(), LogUtils.logTopology(allowedHosts, "")})); return; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java index bd1d6b660..3c4e109a8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java @@ -31,7 +31,6 @@ import java.util.logging.Logger; import java.util.stream.Collectors; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -40,6 +39,7 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverFailedSQLException; import software.amazon.jdbc.plugin.failover.FailoverMode; @@ -47,6 +47,7 @@ import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsHelper; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; @@ -430,7 +431,7 @@ protected ReaderFailoverResult getReaderFailoverConnection(long failoverEndTimeN this.failoverReaderHostSelectorStrategySetting); } catch (UnsupportedOperationException | SQLException ex) { LOGGER.finest( - Utils.logTopology( + LogUtils.logTopology( new ArrayList<>(remainingReaders), Messages.get("Failover.errorSelectingReaderHost", new Object[]{ex.getMessage()}))); break; @@ -438,7 +439,7 @@ protected ReaderFailoverResult getReaderFailoverConnection(long failoverEndTimeN if (readerCandidate == null) { LOGGER.finest( - Utils.logTopology(new ArrayList<>(remainingReaders), Messages.get("Failover.readerCandidateNull"))); + LogUtils.logTopology(new ArrayList<>(remainingReaders), Messages.get("Failover.readerCandidateNull"))); break; } @@ -559,7 +560,7 @@ protected void failoverWriter() throws SQLException { if (this.failoverWriterFailedCounter != null) { this.failoverWriterFailedCounter.inc(); } - String message = Utils.logTopology(updatedHosts, Messages.get("Failover.noWriterHost")); + String message = LogUtils.logTopology(updatedHosts, Messages.get("Failover.noWriterHost")); LOGGER.severe(message); throw new FailoverFailedSQLException(message); } @@ -569,7 +570,7 @@ protected void failoverWriter() throws SQLException { if (this.failoverWriterFailedCounter != null) { this.failoverWriterFailedCounter.inc(); } - String topologyString = Utils.logTopology(allowedHosts, ""); + String topologyString = LogUtils.logTopology(allowedHosts, ""); LOGGER.severe(Messages.get("Failover.newWriterNotAllowed", new Object[] {writerCandidate.getUrl(), topologyString})); throw new FailoverFailedSQLException( diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java index f4075a285..9264e1603 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterMonitor.java @@ -26,9 +26,9 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.PropertyUtils; -import software.amazon.jdbc.util.Utils; import software.amazon.jdbc.util.monitoring.AbstractMonitor; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryContext; @@ -116,7 +116,7 @@ public void monitor() { List newLimitlessRouters = queryHelper.queryForLimitlessRouters(this.monitoringConn, this.hostSpec.getPort()); this.storageService.set(this.limitlessRouterCacheKey, new LimitlessRouters(newLimitlessRouters)); - LOGGER.finest(Utils.logTopology(newLimitlessRouters, "[limitlessRouterMonitor] Topology:")); + LOGGER.finest(LogUtils.logTopology(newLimitlessRouters, "[limitlessRouterMonitor] Topology:")); TimeUnit.MILLISECONDS.sleep(this.intervalMs); // do not include this in the telemetry } catch (final Exception ex) { if (telemetryContext != null) { diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 587989838..3e5c09f75 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -28,7 +28,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.AwsWrapperProperty; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; @@ -38,8 +37,10 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlState; import software.amazon.jdbc.util.Utils; @@ -425,7 +426,7 @@ private void switchToReaderConnection(final List hosts) LOGGER.finest( Messages.get( "ReadWriteSplittingPlugin.previousReaderNotAllowed", - new Object[] {this.readerHostSpec, Utils.logTopology(hosts, "")})); + new Object[] {this.readerHostSpec, LogUtils.logTopology(hosts, "")})); closeConnectionIfIdle(this.readerConnection); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java index 69864104d..a54e345d5 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsHelper.java @@ -25,12 +25,13 @@ import java.util.Map; import java.util.Properties; import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.RdsUrlType; import software.amazon.jdbc.util.RdsUtils; @@ -101,7 +102,7 @@ public Connection getVerifiedConnection( this.pluginService.refreshHostList(conn); } - LOGGER.finest(() -> Utils.logTopology(this.pluginService.getAllHosts())); + LOGGER.finest(() -> LogUtils.logTopology(this.pluginService.getAllHosts())); if (this.writerHostSpec == null) { final HostSpec writerCandidate = Utils.getWriter(this.pluginService.getAllHosts()); @@ -149,7 +150,7 @@ public Connection getVerifiedConnection( Messages.get("AuroraStaleDnsHelper.currentWriterNotAllowed", new Object[] { this.writerHostSpec == null ? "" : this.writerHostSpec.getHostAndPort(), - Utils.logTopology(allowedHosts, "")}) + LogUtils.logTopology(allowedHosts, "")}) ); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index 6345c27fa..080d19990 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -25,12 +25,12 @@ import java.util.Properties; import java.util.Set; import java.util.logging.Logger; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.JdbcCallable; import software.amazon.jdbc.JdbcMethod; import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java index 9915391ac..4d90f6d5d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/strategy/fastestresponse/HostResponseTimeServiceImpl.java @@ -28,7 +28,6 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.storage.SlidingExpirationCacheWithCleanupThread; public class HostResponseTimeServiceImpl implements HostResponseTimeService { diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java index 7b7857175..4420bab7d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainer.java @@ -18,9 +18,9 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java index db0ea3f57..44cfda664 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/FullServicesContainerImpl.java @@ -18,9 +18,9 @@ import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.util.monitoring.MonitorService; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.telemetry.TelemetryFactory; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java new file mode 100644 index 000000000..932e4a21e --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/util/LogUtils.java @@ -0,0 +1,55 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.util; + +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import org.checkerframework.checker.nullness.qual.Nullable; +import software.amazon.jdbc.HostSpec; + +public class LogUtils { + public static String logTopology(final @Nullable List hosts) { + return logTopology(hosts, null); + } + + public static String logTopology( + final @Nullable List hosts, + final @Nullable String messagePrefix) { + + final StringBuilder msg = new StringBuilder(); + if (hosts == null) { + msg.append(""); + } else { + for (final HostSpec host : hosts) { + if (msg.length() > 0) { + msg.append("\n"); + } + msg.append(" ").append(host == null ? "" : host); + } + } + + return Messages.get("Utils.topology", + new Object[] {messagePrefix == null ? "Topology:" : messagePrefix, msg.toString()}); + } + + public static String toLogString(Map map) { + return map.entrySet().stream() + .map(x -> String.format("\t[%s] -> %s", x.getKey(), x.getValue().getHostAndPort())) + .collect(Collectors.joining("\n")); + } +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index fe150f835..3e4b134a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -21,11 +21,11 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; import software.amazon.jdbc.ConnectionProvider; -import software.amazon.jdbc.HostListProvider; import software.amazon.jdbc.PartialPluginService; import software.amazon.jdbc.PluginServiceImpl; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.HostListProviderSupplier; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.monitoring.MonitorService; @@ -73,7 +73,7 @@ public FullServicesContainer createStandardServiceContainer( servicesContainer.setPluginManagerService(pluginService); pluginManager.initPlugins(servicesContainer, configurationProfile); - final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProvider(); + final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProviderSupplier(); if (supplier != null) { final HostListProvider provider = supplier.getProvider(props, originalUrl, servicesContainer); pluginService.setHostListProvider(provider); diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java b/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java index 4d02e9224..8bfe5ca1b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/Utils.java @@ -53,28 +53,4 @@ public static boolean containsHostAndPort(final Collection hosts, Stri } return null; } - - public static String logTopology(final @Nullable List hosts) { - return logTopology(hosts, null); - } - - public static String logTopology( - final @Nullable List hosts, - final @Nullable String messagePrefix) { - - final StringBuilder msg = new StringBuilder(); - if (hosts == null) { - msg.append(""); - } else { - for (final HostSpec host : hosts) { - if (msg.length() > 0) { - msg.append("\n"); - } - msg.append(" ").append(host == null ? "" : host); - } - } - - return Messages.get("Utils.topology", - new Object[] {messagePrefix == null ? "Topology:" : messagePrefix, msg.toString()}); - } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index 97de15f57..509b3c8fd 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -36,7 +36,6 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; -import software.amazon.jdbc.hostlistprovider.monitoring.MultiAzClusterTopologyMonitorImpl; import software.amazon.jdbc.plugin.strategy.fastestresponse.NodeResponseTimeMonitor; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.ExecutorFactory; @@ -64,7 +63,6 @@ public class MonitorServiceImpl implements MonitorService, EventSubscriber { TimeUnit.MINUTES.toNanos(15), TimeUnit.MINUTES.toNanos(3), recreateOnError); suppliers.put(ClusterTopologyMonitorImpl.class, () -> new CacheContainer(defaultSettings, Topology.class)); - suppliers.put(MultiAzClusterTopologyMonitorImpl.class, () -> new CacheContainer(defaultSettings, Topology.class)); suppliers.put(NodeResponseTimeMonitor.class, () -> new CacheContainer(defaultSettings, null)); defaultSuppliers = Collections.unmodifiableMap(suppliers); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java index b0e86574e..312dd8c26 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java +++ b/wrapper/src/main/java/software/amazon/jdbc/wrapper/ConnectionWrapper.java @@ -39,12 +39,12 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionPluginManager; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.JdbcMethod; import software.amazon.jdbc.PluginManagerService; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties index dbfc72a4b..441188f6f 100644 --- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties +++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties @@ -27,6 +27,8 @@ AdfsCredentialsProviderFactory.signOnPagePostActionRequestFailed=ADFS SignOn Pag AdfsCredentialsProviderFactory.signOnPageRequestFailed=ADFS SignOn Page Request Failed with HTTP status ''{0}'', reason phrase ''{1}'', and response ''{2}'' AdfsCredentialsProviderFactory.signOnPageUrl=ADFS SignOn URL: ''{0}'' +AuroraPgDialect.auroraUtils=auroraUtils: {0} + AuthenticationToken.useCachedToken=Use cached authentication token = ''{0}'' AuthenticationToken.generatedNewToken=Generated new authentication token = ''{0}'' AuthenticationToken.javaSdkNotInClasspath=Required dependency 'AWS Java SDK RDS v2.x' is not on the classpath. @@ -34,13 +36,10 @@ AuthenticationToken.javaSdkNotInClasspath=Required dependency 'AWS Java SDK RDS RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRDSProxy=An RDS Proxy url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.clusterInstanceHostPatternNotSupportedForRdsCustom=A custom RDS url can''t be used as the 'clusterInstanceHostPattern' configuration setting. RdsHostListProvider.invalidPattern=Invalid value for the 'clusterInstanceHostPattern' configuration setting - the host pattern must contain a '?' character as a placeholder for the DB instance identifiers of the instances in the cluster. -RdsHostListProvider.invalidTopology=The topology query returned an invalid topology - no writer instance detected. -RdsHostListProvider.suggestedClusterId=ClusterId ''{0}'' is suggested for url ''{1}''. RdsHostListProvider.parsedListEmpty=Can''t parse connection string: ''{0}'' -RdsHostListProvider.invalidQuery=Error obtaining host list. Provided database might not be an Aurora Db cluster -RdsHostListProvider.errorGettingHostRole=An error occurred while obtaining the connected host's role. This could occur if the connection is broken or if you are not connected to an Aurora database. RdsHostListProvider.errorIdentifyConnection=An error occurred while obtaining the connection's host ID. -RdsHostListProvider.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} + +RdsPgDialect.rdsToolsAuroraUtils=rdsTools: {0}, auroraUtils: {1} AwsSdk.unsupportedRegion=Unsupported AWS region ''{0}''. For supported regions please read https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html @@ -135,6 +134,8 @@ DefaultConnectionPlugin.executingMethod=Executing method: ''{0}'' DefaultConnectionPlugin.noHostsAvailable=The default connection plugin received an empty host list from the plugin service. DefaultConnectionPlugin.unknownRoleRequested=A HostSpec with a role of HostRole.UNKNOWN was requested via getHostSpecByStrategy. The requested role must be either HostRole.WRITER or HostRole.READER +DialectManager.currentDialect=Current dialect: {0}, {1}, canUpdate: {2} + Driver.nullUrl=Url is null. Driver.alreadyRegistered=Driver is already registered. It can only be registered once. Driver.missingDriver=Can''t find the target driver for ''{0}''. Please ensure the target driver is in the classpath and is registered. Here is the list of registered drivers in the classpath: {1} @@ -184,6 +185,11 @@ Failover.skipFailoverOnInterruptedThread=Do not start failover since the current FederatedAuthPlugin.unableToDetermineRegion=Unable to determine connection region. If you are using a non-standard RDS URL, please set the ''{0}'' property. +GlobalAuroraTopologyMonitor.cannotFindRegionTemplate=Cannot find cluster template for region {0}. + +GlobalAuroraTopologyUtils.globalClusterInstanceHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. +GlobalAuroraTopologyUtils.detectedGdbPatterns=Detected GDB instance template patterns:\n{0} + HostAvailabilityStrategy.invalidMaxRetries=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyMaxRetries`. It must be an integer greater than 1. HostAvailabilityStrategy.invalidInitialBackoffTime=Invalid value of {0} for configuration parameter `hostAvailabilityStrategyInitialBackoffTime`. It must be an integer greater than 1. @@ -250,7 +256,6 @@ HostMonitorImpl.interruptedExceptionDuringMonitoring=Monitoring thread for node HostMonitorImpl.exceptionDuringMonitoringContinue=Continuing monitoring after unhandled exception was thrown in monitoring thread for node {0}. HostMonitorImpl.exceptionDuringMonitoringStop=Stopping monitoring after unhandled exception was thrown in monitoring thread for node {0}. HostMonitorImpl.monitorIsStopped=Monitoring was already stopped for node {0}. -HostMonitorImpl.stopped=Stopped monitoring thread for node ''{0}''. HostMonitorImpl.startMonitoringThreadNewContext=Start monitoring thread for checking new contexts for {0}. HostMonitorImpl.stopMonitoringThreadNewContext=Stop monitoring thread for checking new contexts for {0}. HostMonitorImpl.startMonitoringThread=Start monitoring thread for {0}. @@ -260,6 +265,8 @@ HostMonitorServiceImpl.emptyAliasSet=Empty alias set passed for ''{0}''. Set sho HostResponseTimeServiceImpl.errorStartingMonitor=An error occurred while starting a response time monitor for ''{0}'': {1} +MonitoringGlobalAuroraHostListProvider.globalHostPatternsRequired=Parameter 'globalClusterInstanceHostPatterns' is required for Aurora Global Database. + MonitorServiceImpl.checkingMonitors=Checking monitors for errors... MonitorServiceImpl.monitorClassMismatch=The monitor stored at ''{0}'' did not have the expected type. The expected type was ''{1}'', but the monitor ''{2}'' had a type of ''{3}''. MonitorServiceImpl.monitorStuck=Monitor ''{0}'' has not been updated within the inactive timeout of {1} milliseconds. The monitor will be stopped. @@ -358,11 +365,18 @@ TargetDriverDialectManager.useDialect=Target driver dialect set to: ''{0}'', {1} TargetDriverDialectManager.unexpectedClass=Unexpected DataSource class. Expected class(es): {0}, actual class: {1}. TargetDriverDialect.unsupported=This target driver dialect does not support this operation. MysqlConnectorJDriverHelper.canNotRegister=Can''t register driver com.mysql.cj.jdbc.Driver. + +TopologyUtils.errorGettingHostRole=An error occurred while obtaining the connected host's role. This could occur if the connection is broken or if you are not connected to an Aurora database. +TopologyUtils.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} +TopologyUtils.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} +TopologyUtils.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS cluster. +TopologyUtils.invalidTopology=The topology query returned an invalid topology - no writer instance detected. +TopologyUtils.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. + MariadbDriverHelper.canNotRegister=Can''t register driver org.mariadb.jdbc.Driver. AuroraInitialConnectionStrategyPlugin.unsupportedStrategy=Unsupported host selection strategy ''{0}''. -NodeResponseTimeMonitor.stopped=Stopped Response time thread for node ''{0}''. NodeResponseTimeMonitor.responseTime=Response time for ''{0}'': {1} ms NodeResponseTimeMonitor.interruptedExceptionDuringMonitoring=Response time thread for node {0} was interrupted. NodeResponseTimeMonitor.exceptionDuringMonitoringStop=Stopping thread after unhandled exception was thrown in Response time thread for node {0}. @@ -372,10 +386,7 @@ NodeResponseTimeMonitor.openedConnection=Opened Response time connection: {0}. ClusterTopologyMonitorImpl.startMonitoringThread=[clusterId: ''{0}''] Start cluster topology monitoring thread for ''{1}''. ClusterTopologyMonitorImpl.stopMonitoringThread=Stop cluster topology monitoring thread for ''{0}''. ClusterTopologyMonitorImpl.exceptionDuringMonitoringStop=Stopping cluster topology monitoring after unhandled exception was thrown in monitoring thread for node ''{0}''. -ClusterTopologyMonitorImpl.invalidQuery=An error occurred while attempting to obtain the topology because the topology query was invalid. Please ensure you are connecting to an Aurora or RDS Db cluster. -ClusterTopologyMonitorImpl.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0} -ClusterTopologyMonitorImpl.invalidTopology=The topology query returned an invalid topology - no writer instance detected. -ClusterTopologyMonitorImpl.topologyNotUpdated=Topology hasn''t been updated after {0} ms. +ClusterTopologyMonitorImpl.topologyNotUpdated=Topology has not been updated after {0} ms. ClusterTopologyMonitorImpl.openedMonitoringConnection=Opened monitoring connection to node ''{0}''. ClusterTopologyMonitorImpl.ignoringTopologyRequest=A topology refresh was requested, but the topology was already updated recently. Returning cached hosts: ClusterTopologyMonitorImpl.timeoutSetToZero=A topology refresh was requested, but the given timeout for the request was 0ms. Returning cached hosts: @@ -384,8 +395,6 @@ ClusterTopologyMonitorImpl.startingNodeMonitoringThreads=Starting node monitorin ClusterTopologyMonitorImpl.writerPickedUpFromNodeMonitors=The writer host detected by the node monitors was picked up by the topology monitor: ''{0}''. ClusterTopologyMonitorImpl.writerMonitoringConnection=The monitoring connection is connected to a writer: ''{0}''. ClusterTopologyMonitorImpl.errorFetchingTopology=An error occurred while querying for topology: {0} -ClusterTopologyMonitorImpl.errorProcessingQueryResults=An error occurred while processing the results from the topology query: {0} -ClusterTopologyMonitorImpl.unexpectedTopologyQueryColumnCount=The topology query returned a result with 0 columns. This may occur if the topology query is executed when the server is failing over. # Blue/Green Deployment bgd.inProgressConnectionClosed=Connection has been closed since Blue/Green switchover is in progress. @@ -406,7 +415,7 @@ bgd.interrupted=[{0}] Interrupted. bgd.monitoringUnhandledException=[{0}] Unhandled exception while monitoring blue/green status. bgd.threadCompleted=[{0}] Blue/green status monitoring thread is completed. bgd.statusNotAvailable=[{0}] (status not available) currentPhase: {1} -bgd.usesVersion=[{0}] Blue/Green deployment uses version ''{1}'' which the driver doesn''t support. Version ''{2}'' will be used instead. +bgd.usesVersion=[{0}] Blue/Green deployment uses version ''{1}'' which the driver does not support. Version ''{2}'' will be used instead. bgd.noEntriesInStatusTable=[{0}] No entries in status table. bgd.exception=[{0}] currentPhase: {1}, exception while querying for blue/green status. bgd.unhandledSqlException=[{0}] Unhandled SQLException. diff --git a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java index e2b19303c..5339a177e 100644 --- a/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/AdvancedPerformanceTest.java @@ -29,7 +29,6 @@ import integration.container.ConnectionStringHelper; import integration.container.TestDriverProvider; import integration.container.TestEnvironment; -import integration.container.aurora.TestAuroraHostListProvider; import integration.container.aurora.TestPluginServiceImpl; import integration.container.condition.DisableOnTestFeature; import integration.container.condition.EnableOnTestFeature; @@ -66,6 +65,7 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.provider.Arguments; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; import software.amazon.jdbc.plugin.efm2.HostMonitorServiceImpl; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; diff --git a/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java b/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java index 307e00bb9..28a6c63e4 100644 --- a/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java +++ b/wrapper/src/test/java/integration/container/tests/AutoscalingTests.java @@ -52,7 +52,7 @@ import software.amazon.jdbc.HikariPoolConfigurator; import software.amazon.jdbc.HikariPooledConnectionProvider; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPlugin; @@ -104,7 +104,7 @@ public void test_pooledConnectionAutoScaling_setReadOnlyOnOldConnection() final Properties props = getProps(); final long topologyRefreshRateMs = 5000; ReadWriteSplittingPlugin.READER_HOST_SELECTOR_STRATEGY.set(props, "leastConnections"); - AuroraHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, + RdsHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, Long.toString(topologyRefreshRateMs)); final TestEnvironmentInfo testInfo = TestEnvironment.getCurrent().getInfo(); @@ -186,7 +186,7 @@ public void test_pooledConnectionAutoScaling_failoverFromDeletedReader() final Properties props = getPropsWithFailover(); final long topologyRefreshRateMs = 5000; ReadWriteSplittingPlugin.READER_HOST_SELECTOR_STRATEGY.set(props, "leastConnections"); - AuroraHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, + RdsHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS.set(props, Long.toString(topologyRefreshRateMs)); final TestEnvironmentInfo testInfo = TestEnvironment.getCurrent().getInfo(); diff --git a/wrapper/src/test/java/integration/container/tests/FailoverTest.java b/wrapper/src/test/java/integration/container/tests/FailoverTest.java index 758e5ca5f..241499f63 100644 --- a/wrapper/src/test/java/integration/container/tests/FailoverTest.java +++ b/wrapper/src/test/java/integration/container/tests/FailoverTest.java @@ -62,7 +62,7 @@ import org.junit.jupiter.api.extension.ExtendWith; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.ds.AwsWrapperDataSource; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.plugin.failover.TransactionStateUnknownSQLException; import software.amazon.jdbc.util.SqlState; @@ -688,7 +688,7 @@ protected Properties initDefaultProxiedProps() { // Some tests temporarily disable connectivity for 5 seconds. The socket timeout needs to be less than this to // trigger driver failover. PropertyDefinition.SOCKET_TIMEOUT.set(props, "2000"); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set( + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set( props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); diff --git a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java index 1c521f617..5993a716b 100644 --- a/wrapper/src/test/java/integration/container/tests/PerformanceTest.java +++ b/wrapper/src/test/java/integration/container/tests/PerformanceTest.java @@ -61,7 +61,6 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.provider.Arguments; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.OpenedConnectionTracker; import software.amazon.jdbc.plugin.efm.HostMonitorThreadContainer; diff --git a/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java b/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java index b8c96edbe..8b3accba1 100644 --- a/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java +++ b/wrapper/src/test/java/integration/container/tests/ReadWriteSplittingTests.java @@ -73,7 +73,7 @@ import software.amazon.jdbc.HikariPooledConnectionProvider; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.plugin.failover.FailoverConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverFailedSQLException; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; @@ -122,7 +122,7 @@ public void tearDownEach() { protected static Properties getProxiedPropsWithFailover() { final Properties props = getPropsWithFailover(); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); return props; @@ -130,7 +130,7 @@ protected static Properties getProxiedPropsWithFailover() { protected static Properties getProxiedProps() { final Properties props = getProps(); - AuroraHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, + RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN.set(props, "?." + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointSuffix() + ":" + TestEnvironment.getCurrent().getInfo().getProxyDatabaseInfo().getInstanceEndpointPort()); return props; diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java index 3b47f12bb..1a5517559 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectDetectionTests.java @@ -43,13 +43,14 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.DialectManager; import software.amazon.jdbc.dialect.MariaDbDialect; +import software.amazon.jdbc.dialect.MultiAzClusterMysqlDialect; +import software.amazon.jdbc.dialect.MultiAzClusterPgDialect; import software.amazon.jdbc.dialect.MysqlDialect; import software.amazon.jdbc.dialect.PgDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterMysqlDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterPgDialect; import software.amazon.jdbc.dialect.RdsMysqlDialect; import software.amazon.jdbc.dialect.RdsPgDialect; import software.amazon.jdbc.exceptions.ExceptionManager; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.storage.StorageService; @@ -70,10 +71,10 @@ public class DialectDetectionTests { @Mock private Statement mockStatement; @Mock private ResultSet mockSuccessResultSet; @Mock private ResultSet mockFailResultSet; + @Mock private ResultSetMetaData mockResultSetMetaData; @Mock private HostSpec mockHost; @Mock private ConnectionPluginManager mockPluginManager; @Mock private TargetDriverDialect mockTargetDriverDialect; - @Mock private ResultSetMetaData mockResultSetMetaData; @BeforeEach void setUp() throws SQLException { @@ -83,6 +84,8 @@ void setUp() throws SQLException { when(this.mockServicesContainer.getStorageService()).thenReturn(mockStorageService); when(this.mockConnection.createStatement()).thenReturn(this.mockStatement); when(this.mockHost.getUrl()).thenReturn("url"); + when(this.mockFailResultSet.getMetaData()).thenReturn(mockResultSetMetaData); + when(this.mockResultSetMetaData.getColumnCount()).thenReturn(4); when(this.mockFailResultSet.next()).thenReturn(false); mockPluginManager.plugins = new ArrayList<>(); } @@ -219,7 +222,7 @@ void testUpdateDialectPgToTaz() throws SQLException { final PluginServiceImpl target = getPluginService(LOCALHOST, PG_PROTOCOL); target.setInitialConnectionHostSpec(mockHost); target.updateDialect(mockConnection); - assertEquals(RdsMultiAzDbClusterPgDialect.class, target.dialect.getClass()); + assertEquals(MultiAzClusterPgDialect.class, target.dialect.getClass()); } @Test @@ -272,7 +275,7 @@ void testUpdateDialectMariaToMysqlTaz() throws SQLException { final PluginServiceImpl target = getPluginService(LOCALHOST, MARIA_PROTOCOL); target.setInitialConnectionHostSpec(mockHost); target.updateDialect(mockConnection); - assertEquals(RdsMultiAzDbClusterMysqlDialect.class, target.dialect.getClass()); + assertEquals(MultiAzClusterMysqlDialect.class, target.dialect.getClass()); } @Test diff --git a/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java b/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java index 4170f8556..e3c2df258 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/DialectTests.java @@ -36,10 +36,10 @@ import software.amazon.jdbc.dialect.AuroraMysqlDialect; import software.amazon.jdbc.dialect.AuroraPgDialect; import software.amazon.jdbc.dialect.MariaDbDialect; +import software.amazon.jdbc.dialect.MultiAzClusterMysqlDialect; +import software.amazon.jdbc.dialect.MultiAzClusterPgDialect; import software.amazon.jdbc.dialect.MysqlDialect; import software.amazon.jdbc.dialect.PgDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterMysqlDialect; -import software.amazon.jdbc.dialect.RdsMultiAzDbClusterPgDialect; import software.amazon.jdbc.dialect.RdsMysqlDialect; import software.amazon.jdbc.dialect.RdsPgDialect; @@ -51,11 +51,11 @@ public class DialectTests { @Mock private ResultSetMetaData mockResultSetMetaData; private final MysqlDialect mysqlDialect = new MysqlDialect(); private final RdsMysqlDialect rdsMysqlDialect = new RdsMysqlDialect(); - private final RdsMultiAzDbClusterMysqlDialect rdsTazMysqlDialect = new RdsMultiAzDbClusterMysqlDialect(); + private final MultiAzClusterMysqlDialect rdsTazMysqlDialect = new MultiAzClusterMysqlDialect(); private final AuroraMysqlDialect auroraMysqlDialect = new AuroraMysqlDialect(); private final PgDialect pgDialect = new PgDialect(); private final RdsPgDialect rdsPgDialect = new RdsPgDialect(); - private final RdsMultiAzDbClusterPgDialect rdsTazPgDialect = new RdsMultiAzDbClusterPgDialect(); + private final MultiAzClusterPgDialect rdsTazPgDialect = new MultiAzClusterPgDialect(); private final AuroraPgDialect auroraPgDialect = new AuroraPgDialect(); private final MariaDbDialect mariaDbDialect = new MariaDbDialect(); private AutoCloseable closeable; diff --git a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java index db9a072a1..5ef1235ad 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/PluginServiceImplTests.java @@ -62,6 +62,7 @@ import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.profile.ConfigurationProfileBuilder; import software.amazon.jdbc.states.SessionStateService; diff --git a/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java b/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java index 7a523a3e7..3f61a1ec8 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/RoundRobinHostSelectorTest.java @@ -27,12 +27,7 @@ import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.RoundRobinHostSelector; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.util.HostSelectorUtils; public class RoundRobinHostSelectorTest { private static final int TEST_PORT = 5432; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index cc337d2a3..991c0734b 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -17,7 +17,6 @@ package software.amazon.jdbc.hostlistprovider; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -25,19 +24,12 @@ import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atMostOnce; import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -import com.mysql.cj.exceptions.WrongArgumentException; import java.sql.Connection; -import java.sql.ResultSet; import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.sql.Timestamp; -import java.time.Instant; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -46,21 +38,19 @@ import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.TopologyDialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; import software.amazon.jdbc.util.FullServicesContainer; +import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.events.EventPublisher; import software.amazon.jdbc.util.storage.StorageService; import software.amazon.jdbc.util.storage.TestStorageServiceImpl; @@ -70,14 +60,13 @@ class RdsHostListProviderTest { private RdsHostListProvider rdsHostListProvider; @Mock private Connection mockConnection; - @Mock private Statement mockStatement; - @Mock private ResultSet mockResultSet; @Mock private FullServicesContainer mockServicesContainer; @Mock private PluginService mockPluginService; @Mock private HostListProviderService mockHostListProviderService; + @Mock private HostSpecBuilder mockHostSpecBuilder; @Mock private EventPublisher mockEventPublisher; - @Mock Dialect mockTopologyAwareDialect; - @Captor private ArgumentCaptor queryCaptor; + @Mock private TopologyUtils mockTopologyUtils; + @Mock private TopologyDialect mockDialect; private AutoCloseable closeable; private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) @@ -92,12 +81,12 @@ void setUp() throws SQLException { storageService = new TestStorageServiceImpl(mockEventPublisher); when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); when(mockServicesContainer.getStorageService()).thenReturn(storageService); + when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService); when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); - when(mockConnection.createStatement()).thenReturn(mockStatement); - when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); - when(mockHostListProviderService.getDialect()).thenReturn(mockTopologyAwareDialect); + when(mockPluginService.getHostSpecBuilder()).thenReturn(mockHostSpecBuilder); + when(mockHostListProviderService.getDialect()).thenReturn(mockDialect); when(mockHostListProviderService.getHostSpecBuilder()) .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); when(mockHostListProviderService.getCurrentConnection()).thenReturn(mockConnection); @@ -111,10 +100,7 @@ void tearDown() throws Exception { private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { RdsHostListProvider provider = new RdsHostListProvider( - new Properties(), - originalUrl, - mockServicesContainer, - "foo", "bar", "baz"); + mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); provider.init(); return provider; } @@ -141,7 +127,8 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio final List newHosts = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(rdsHostListProvider).queryForTopology(mockConnection); + doReturn(newHosts).when(mockTopologyUtils).queryForTopology( + eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); @@ -189,9 +176,8 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { final List expectedPostgres = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("postgresql").port(HostSpec.NO_PORT) .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getBoolean(eq(2))).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("mysql"); + when(mockTopologyUtils.queryForTopology(eq(mockConnection), any(HostSpec.class), any(HostSpec.class))) + .thenReturn(expectedMySQL).thenReturn(expectedPostgres); rdsHostListProvider = getRdsHostListProvider("mysql://url/"); @@ -199,24 +185,11 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException { List hosts = rdsHostListProvider.queryForTopology(mockConnection); assertEquals(expectedMySQL, hosts); - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getString(eq(1))).thenReturn("postgresql"); - rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); hosts = rdsHostListProvider.queryForTopology(mockConnection); assertEquals(expectedPostgres, hosts); } - @Test - void testQueryForTopology_queryResultsInException() throws SQLException { - rdsHostListProvider = getRdsHostListProvider("protocol://url/"); - when(mockStatement.executeQuery(queryCaptor.capture())).thenThrow(new SQLSyntaxErrorException()); - - assertThrows( - SQLException.class, - () -> rdsHostListProvider.queryForTopology(mockConnection)); - } - @Test void testGetCachedTopology_returnStoredTopology() throws SQLException { rdsHostListProvider = getRdsHostListProvider("jdbc:someprotocol://url"); @@ -228,53 +201,10 @@ void testGetCachedTopology_returnStoredTopology() throws SQLException { assertEquals(expected, result); } - @Test - void testTopologyCache() throws SQLException { - - RdsHostListProvider provider1 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-a.domain.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - - doReturn(topologyClusterA) - .when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsHostListProvider provider2 = Mockito.spy(getRdsHostListProvider("jdbc:something://cluster-b.domain.com/")); - assertNotNull(provider2.getStoredTopology()); - - final List topologyClusterB = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - - List topologyProvider2 = provider2.refresh(mock(Connection.class)); - assertNotEquals(topologyClusterB, topologyProvider2); - - topologyProvider2 = provider2.forceRefresh(mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - @Test void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(false); assertThrows(SQLException.class, () -> rdsHostListProvider.identifyConnection(mockConnection)); when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); @@ -284,11 +214,10 @@ void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { @Test void testIdentifyConnectionNullTopology() throws SQLException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("?.pattern").build(); + rdsHostListProvider.instanceTemplate = + new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("?.pattern").build(); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); doReturn(null).when(rdsHostListProvider).refresh(mockConnection); doReturn(null).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -305,8 +234,7 @@ void testIdentifyConnectionHostNotInTopology() throws SQLException { .build()); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-1", "instance-1")); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -324,8 +252,7 @@ void testIdentifyConnectionHostInTopology() throws SQLException { final List cachedTopology = Collections.singletonList(expectedHost); rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-a-1"); + when(mockTopologyUtils.getInstanceId(mockConnection)).thenReturn(Pair.create("instance-a-1", "instance-a-1")); doReturn(cachedTopology).when(rdsHostListProvider).refresh(mockConnection); doReturn(cachedTopology).when(rdsHostListProvider).forceRefresh(mockConnection); @@ -333,122 +260,4 @@ void testIdentifyConnectionHostInTopology() throws SQLException { assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); assertEquals("instance-a-1", actual.getHostId()); } - - @Test - void testGetTopology_StaleRecord() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - final String hostName1 = "hostName1"; - final String hostName2 = "hostName2"; - final Double cpuUtilization = 11.1D; - final Double nodeLag = 0.123D; - final Timestamp firstTimestamp = Timestamp.from(Instant.now()); - final Timestamp secondTimestamp = new Timestamp(firstTimestamp.getTime() + 100); - when(mockResultSet.next()).thenReturn(true, true, false); - when(mockResultSet.getString(1)).thenReturn(hostName1).thenReturn(hostName2); - when(mockResultSet.getBoolean(2)).thenReturn(true).thenReturn(true); - when(mockResultSet.getDouble(3)).thenReturn(cpuUtilization).thenReturn(cpuUtilization); - when(mockResultSet.getDouble(4)).thenReturn(nodeLag).thenReturn(nodeLag); - when(mockResultSet.getTimestamp(5)).thenReturn(firstTimestamp).thenReturn(secondTimestamp); - long weight = Math.round(nodeLag) * 100L + Math.round(cpuUtilization); - final HostSpec expectedWriter = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host(hostName2) - .port(-1) - .role(HostRole.WRITER) - .availability(HostAvailability.AVAILABLE) - .weight(weight) - .lastUpdateTime(secondTimestamp) - .build(); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(expectedWriter, result.hosts.get(0)); - } - - @Test - void testGetTopology_InvalidLastUpdatedTimestamp() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - final String hostName = "hostName"; - final Double cpuUtilization = 11.1D; - final Double nodeLag = 0.123D; - when(mockResultSet.next()).thenReturn(true, false); - when(mockResultSet.getString(1)).thenReturn(hostName); - when(mockResultSet.getBoolean(2)).thenReturn(true); - when(mockResultSet.getDouble(3)).thenReturn(cpuUtilization); - when(mockResultSet.getDouble(4)).thenReturn(nodeLag); - when(mockResultSet.getTimestamp(5)).thenThrow(WrongArgumentException.class); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - - final String expectedLastUpdatedTimeStampRounded = Timestamp.from(Instant.now()).toString().substring(0, 16); - assertEquals(1, result.hosts.size()); - assertEquals( - expectedLastUpdatedTimeStampRounded, - result.hosts.get(0).getLastUpdateTime().toString().substring(0, 16)); - } - - @Test - void testGetTopology_returnsLatestWriter() throws SQLException { - rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); - rdsHostListProvider.isInitialized = true; - - HostSpec expectedWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("expectedWriterHost") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("3000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHost0 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHost0") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("1000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHost1 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHost1") - .role(HostRole.WRITER) - .lastUpdateTime(Timestamp.valueOf("2000-01-01 00:00:00")) - .build(); - - HostSpec unexpectedWriterHostWithNullLastUpdateTime0 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHostWithNullLastUpdateTime0") - .role(HostRole.WRITER) - .lastUpdateTime(null) - .build(); - - HostSpec unexpectedWriterHostWithNullLastUpdateTime1 = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("unexpectedWriterHostWithNullLastUpdateTime1") - .role(HostRole.WRITER) - .lastUpdateTime(null) - .build(); - - when(mockResultSet.next()).thenReturn(true, true, true, true, true, false); - - when(mockResultSet.getString(1)).thenReturn( - unexpectedWriterHostWithNullLastUpdateTime0.getHost(), - unexpectedWriterHost0.getHost(), - expectedWriterHost.getHost(), - unexpectedWriterHost1.getHost(), - unexpectedWriterHostWithNullLastUpdateTime1.getHost()); - when(mockResultSet.getBoolean(2)).thenReturn(true, true, true, true, true); - when(mockResultSet.getFloat(3)).thenReturn((float) 0, (float) 0, (float) 0, (float) 0, (float) 0); - when(mockResultSet.getFloat(4)).thenReturn((float) 0, (float) 0, (float) 0, (float) 0, (float) 0); - when(mockResultSet.getTimestamp(5)).thenReturn( - unexpectedWriterHostWithNullLastUpdateTime0.getLastUpdateTime(), - unexpectedWriterHost0.getLastUpdateTime(), - expectedWriterHost.getLastUpdateTime(), - unexpectedWriterHost1.getLastUpdateTime(), - unexpectedWriterHostWithNullLastUpdateTime1.getLastUpdateTime() - ); - - final FetchTopologyResult result = rdsHostListProvider.getTopology(mockConnection, true); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(mockConnection); - - assertEquals(expectedWriterHost.getHost(), result.hosts.get(0).getHost()); - } } diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java deleted file mode 100644 index 5c0343487..000000000 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsMultiAzDbClusterListProviderTest.java +++ /dev/null @@ -1,311 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNotEquals; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.atMostOnce; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.SQLSyntaxErrorException; -import java.sql.Statement; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; -import org.mockito.Mock; -import org.mockito.Mockito; -import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; -import software.amazon.jdbc.HostRole; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.events.EventPublisher; -import software.amazon.jdbc.util.storage.StorageService; -import software.amazon.jdbc.util.storage.TestStorageServiceImpl; - -class RdsMultiAzDbClusterListProviderTest { - private StorageService storageService; - private RdsMultiAzDbClusterListProvider rdsMazDbClusterHostListProvider; - - @Mock private Connection mockConnection; - @Mock private Statement mockStatement; - @Mock private ResultSet mockResultSet; - @Mock private FullServicesContainer mockServicesContainer; - @Mock private PluginService mockPluginService; - @Mock private HostListProviderService mockHostListProviderService; - @Mock private EventPublisher mockEventPublisher; - @Mock Dialect mockTopologyAwareDialect; - @Captor private ArgumentCaptor queryCaptor; - - private AutoCloseable closeable; - private final HostSpec currentHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("foo").port(1234).build(); - private final List hosts = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host1").build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("host2").build()); - - @BeforeEach - void setUp() throws SQLException { - closeable = MockitoAnnotations.openMocks(this); - storageService = new TestStorageServiceImpl(mockEventPublisher); - when(mockServicesContainer.getHostListProviderService()).thenReturn(mockHostListProviderService); - when(mockServicesContainer.getStorageService()).thenReturn(storageService); - when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection); - when(mockPluginService.connect(any(HostSpec.class), any(Properties.class))).thenReturn(mockConnection); - when(mockPluginService.getCurrentHostSpec()).thenReturn(currentHostSpec); - when(mockConnection.createStatement()).thenReturn(mockStatement); - when(mockStatement.executeQuery(queryCaptor.capture())).thenReturn(mockResultSet); - when(mockHostListProviderService.getDialect()).thenReturn(mockTopologyAwareDialect); - when(mockHostListProviderService.getHostSpecBuilder()) - .thenReturn(new HostSpecBuilder(new SimpleHostAvailabilityStrategy())); - } - - @AfterEach - void tearDown() throws Exception { - storageService.clearAll(); - closeable.close(); - } - - private RdsMultiAzDbClusterListProvider getRdsMazDbClusterHostListProvider(String originalUrl) throws SQLException { - RdsMultiAzDbClusterListProvider provider = new RdsMultiAzDbClusterListProvider( - new Properties(), - originalUrl, - mockServicesContainer, - "foo", - "bar", - "baz", - "fang", - "li"); - provider.init(); - // provider.clusterId = "1"; - return provider; - } - - @Test - void testGetTopology_returnCachedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("protocol://url/")); - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, false); - assertEquals(expected, result.hosts); - assertEquals(2, result.hosts.size()); - verify(rdsMazDbClusterHostListProvider, never()).queryForTopology(mockConnection); - } - - @Test - void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.isInitialized = true; - - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(hosts)); - - final List newHosts = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); - doReturn(newHosts).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, true); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(1, result.hosts.size()); - assertEquals(newHosts, result.hosts); - } - - @Test - void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clusterId = "cluster-id"; - rdsMazDbClusterHostListProvider.isInitialized = true; - - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - doReturn(new ArrayList<>()).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, false); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertEquals(2, result.hosts.size()); - assertEquals(expected, result.hosts); - } - - @Test - void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clear(); - - doReturn(new ArrayList<>()).when(rdsMazDbClusterHostListProvider).queryForTopology(mockConnection); - - final FetchTopologyResult result = rdsMazDbClusterHostListProvider.getTopology(mockConnection, true); - verify(rdsMazDbClusterHostListProvider, atMostOnce()).queryForTopology(mockConnection); - assertNotNull(result.hosts); - assertEquals( - Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), - result.hosts); - } - - @Test - void testQueryForTopology_queryResultsInException() throws SQLException { - rdsMazDbClusterHostListProvider = getRdsMazDbClusterHostListProvider("protocol://url/"); - when(mockStatement.executeQuery(queryCaptor.capture())).thenThrow(new SQLSyntaxErrorException()); - - assertThrows( - SQLException.class, - () -> rdsMazDbClusterHostListProvider.queryForTopology(mockConnection)); - } - - @Test - void testGetCachedTopology_returnCachedTopology() throws SQLException { - rdsMazDbClusterHostListProvider = getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url"); - - final List expected = hosts; - storageService.set(rdsMazDbClusterHostListProvider.clusterId, new Topology(expected)); - - final List result = rdsMazDbClusterHostListProvider.getStoredTopology(); - assertEquals(expected, result); - } - - @Test - void testTopologyCache() throws SQLException { - - RdsMultiAzDbClusterListProvider provider1 = - Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-a.domain.com/")); - provider1.init(); - final List topologyClusterA = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - - doReturn(topologyClusterA) - .when(provider1).queryForTopology(any(Connection.class)); - - assertEquals(0, storageService.size(Topology.class)); - - final List topologyProvider1 = provider1.refresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterA, topologyProvider1); - - RdsMultiAzDbClusterListProvider provider2 = - Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:something://cluster-b.domain.com/")); - assertNotNull(provider2.getStoredTopology()); - - final List topologyClusterB = Arrays.asList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-1.domain.com").port(HostSpec.NO_PORT).role(HostRole.WRITER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-2.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build(), - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-b-3.domain.com").port(HostSpec.NO_PORT).role(HostRole.READER).build()); - doReturn(topologyClusterB).when(provider2).queryForTopology(any(Connection.class)); - - List topologyProvider2 = provider2.refresh(Mockito.mock(Connection.class)); - assertNotEquals(topologyClusterB, topologyProvider2); - - topologyProvider2 = provider2.forceRefresh(Mockito.mock(Connection.class)); - assertEquals(topologyClusterB, topologyProvider2); - - assertEquals(1, storageService.size(Topology.class)); - } - - @Test - void testIdentifyConnectionWithInvalidNodeIdQuery() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - - when(mockResultSet.next()).thenReturn(false); - assertThrows(SQLException.class, () -> rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - - when(mockConnection.createStatement()).thenThrow(new SQLException("exception")); - assertThrows(SQLException.class, () -> rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionNullTopology() throws SQLException { - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - rdsMazDbClusterHostListProvider.clusterInstanceTemplate = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("?.pattern").build(); - - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); - doReturn(null).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(null).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostNotInTopology() throws SQLException { - final List cachedTopology = Collections.singletonList( - new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build()); - - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-1"); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - assertNull(rdsMazDbClusterHostListProvider.identifyConnection(mockConnection)); - } - - @Test - void testIdentifyConnectionHostInTopology() throws SQLException { - final HostSpec expectedHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("instance-a-1.xyz.us-east-2.rds.amazonaws.com") - .hostId("instance-a-1") - .port(HostSpec.NO_PORT) - .role(HostRole.WRITER) - .build(); - final List cachedTopology = Collections.singletonList(expectedHost); - - rdsMazDbClusterHostListProvider = Mockito.spy(getRdsMazDbClusterHostListProvider("jdbc:someprotocol://url")); - when(mockResultSet.next()).thenReturn(true); - when(mockResultSet.getString(eq(1))).thenReturn("instance-a-1"); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).refresh(mockConnection); - doReturn(cachedTopology).when(rdsMazDbClusterHostListProvider).forceRefresh(mockConnection); - - final HostSpec actual = rdsMazDbClusterHostListProvider.identifyConnection(mockConnection); - assertEquals("instance-a-1.xyz.us-east-2.rds.amazonaws.com", actual.getHost()); - assertEquals("instance-a-1", actual.getHostId()); - } - -} diff --git a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java index 9ca4c86dd..523d3be59 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java +++ b/wrapper/src/test/java/software/amazon/jdbc/mock/TestPluginOne.java @@ -27,7 +27,6 @@ import java.util.Properties; import java.util.Set; import software.amazon.jdbc.ConnectionPlugin; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -35,6 +34,7 @@ import software.amazon.jdbc.NodeChangeOptions; import software.amazon.jdbc.OldConnectionSuggestedAction; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; public class TestPluginOne implements ConnectionPlugin { diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java index ac5b9d7b0..b01c95053 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPluginTest.java @@ -49,7 +49,6 @@ import org.junit.jupiter.params.provider.ValueSource; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -58,7 +57,8 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.AuroraHostListProvider; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; +import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUrlType; @@ -85,7 +85,7 @@ class FailoverConnectionPluginTest { @Mock Connection mockConnection; @Mock HostSpec mockHostSpec; @Mock HostListProviderService mockHostListProviderService; - @Mock AuroraHostListProvider mockHostListProvider; + @Mock RdsHostListProvider mockHostListProvider; @Mock JdbcCallable mockInitHostProviderFunc; @Mock ReaderFailoverHandler mockReaderFailoverHandler; @Mock WriterFailoverHandler mockWriterFailoverHandler; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java index 411233100..e6e498a41 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessConnectionPluginTest.java @@ -35,7 +35,6 @@ import org.mockito.MockitoAnnotations; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; -import software.amazon.jdbc.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -45,6 +44,7 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.PgDialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; public class LimitlessConnectionPluginTest { diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java index 7c12f83fb..81559231c 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/limitless/LimitlessRouterServiceImplTest.java @@ -39,7 +39,6 @@ import org.mockito.MockitoAnnotations; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.HighestWeightHostSelector; -import software.amazon.jdbc.HostListProvider; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -48,6 +47,7 @@ import software.amazon.jdbc.WeightedRandomHostSelector; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.FullServicesContainerImpl; import software.amazon.jdbc.util.events.EventPublisher; diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java index 976fcf2ea..7fea814ad 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPluginTest.java @@ -45,7 +45,6 @@ import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import software.amazon.jdbc.HostListProviderService; import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.HostSpecBuilder; @@ -56,6 +55,7 @@ import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.failover.FailoverSuccessSQLException; import software.amazon.jdbc.util.SqlState; diff --git a/wrapper/src/test/resources/hibernate_files/DataSourceTest.java b/wrapper/src/test/resources/hibernate_files/DataSourceTest.java index 624114400..38a6b1c78 100644 --- a/wrapper/src/test/resources/hibernate_files/DataSourceTest.java +++ b/wrapper/src/test/resources/hibernate_files/DataSourceTest.java @@ -4,6 +4,9 @@ */ package org.hibernate.orm.test.datasource; +import static org.hibernate.internal.util.StringHelper.split; +import static org.junit.jupiter.api.Assertions.assertTrue; + import jakarta.persistence.Entity; import jakarta.persistence.Id; import org.hibernate.cfg.Environment; @@ -21,10 +24,6 @@ import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; - -import static org.hibernate.internal.util.StringHelper.split; -import static org.junit.jupiter.api.Assertions.assertTrue; - @Jpa(annotatedClasses = DataSourceTest.TestEntity.class, integrationSettings = @Setting(name = JdbcSettings.CONNECTION_PROVIDER, value = "org.hibernate.orm.test.datasource.TestDataSourceConnectionProvider")) diff --git a/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java b/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java index 7dcd98188..55f5386bf 100644 --- a/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java +++ b/wrapper/src/test/resources/hibernate_files/PostgreSQLCastingIntervalSecondJdbcType.java @@ -9,7 +9,6 @@ import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; - import org.hibernate.dialect.Dialect; import org.hibernate.engine.spi.SessionFactoryImplementor; import org.hibernate.metamodel.mapping.JdbcMappingContainer; diff --git a/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java b/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java index f07faccac..065b83fb3 100644 --- a/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java +++ b/wrapper/src/test/resources/hibernate_files/PostgresIntervalSecondTest.java @@ -6,33 +6,30 @@ import static org.assertj.core.api.Assertions.assertThat; +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.Table; import java.time.Duration; - import org.hibernate.annotations.JdbcTypeCode; import org.hibernate.cfg.AvailableSettings; import org.hibernate.dialect.PostgreSQLDialect; import org.hibernate.dialect.type.PostgreSQLIntervalSecondJdbcType; import org.hibernate.metamodel.spi.MappingMetamodelImplementor; import org.hibernate.persister.entity.EntityPersister; -import org.hibernate.type.SqlTypes; -import org.hibernate.type.descriptor.jdbc.JdbcType; -import org.hibernate.type.descriptor.jdbc.NumericJdbcType; -import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry; - import org.hibernate.testing.orm.junit.DomainModel; import org.hibernate.testing.orm.junit.RequiresDialect; import org.hibernate.testing.orm.junit.ServiceRegistry; import org.hibernate.testing.orm.junit.SessionFactory; import org.hibernate.testing.orm.junit.SessionFactoryScope; import org.hibernate.testing.orm.junit.Setting; +import org.hibernate.type.SqlTypes; +import org.hibernate.type.descriptor.jdbc.JdbcType; +import org.hibernate.type.descriptor.jdbc.NumericJdbcType; +import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; -import jakarta.persistence.Column; -import jakarta.persistence.Entity; -import jakarta.persistence.Id; -import jakarta.persistence.Table; - /** * Test to see if using `@org.hibernate.annotations.JdbcTypeCode` or `@org.hibernate.annotations.JdbcType` * will override a default JdbcType set by a {@link AvailableSettings#PREFERRED_DURATION_JDBC_TYPE config property}. diff --git a/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java b/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java index c7c7faa20..46cc08277 100644 --- a/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java +++ b/wrapper/src/test/resources/hibernate_files/StructEmbeddableArrayTest.java @@ -4,6 +4,14 @@ */ package org.hibernate.orm.test.mapping.embeddable; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNull; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.ParameterMode; +import jakarta.persistence.Tuple; import java.net.URL; import java.sql.Time; import java.sql.Timestamp; @@ -18,7 +26,6 @@ import java.util.List; import java.util.Set; import java.util.UUID; - import org.hibernate.annotations.Struct; import org.hibernate.boot.ResourceStreamLocator; import org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl; @@ -35,7 +42,6 @@ import org.hibernate.dialect.PostgresPlusDialect; import org.hibernate.procedure.ProcedureCall; import org.hibernate.procedure.ProcedureParameter; - import org.hibernate.testing.jdbc.SharedDriverManagerTypeCacheClearingIntegrator; import org.hibernate.testing.orm.domain.gambit.EntityOfBasics; import org.hibernate.testing.orm.domain.gambit.MutableValue; @@ -54,16 +60,6 @@ import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; -import jakarta.persistence.Entity; -import jakarta.persistence.Id; -import jakarta.persistence.ParameterMode; -import jakarta.persistence.Tuple; - -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertInstanceOf; -import static org.junit.jupiter.api.Assertions.assertNull; - @BootstrapServiceRegistry( javaServices = @BootstrapServiceRegistry.JavaService( role = AdditionalMappingContributor.class, From efd6c12567cb4fcf904868d3535f44d9f2f77693 Mon Sep 17 00:00:00 2001 From: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com> Date: Thu, 20 Nov 2025 12:43:23 -0800 Subject: [PATCH 77/90] docs: permissions for non-admin users accessing MultiAZ clusters (#1602) Co-authored-by: Sophia Chu <112967780+sophia-bq@users.noreply.github.com> --- .../SupportForRDSMultiAzDBCluster.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md b/docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md index 457a1f034..795dabebd 100644 --- a/docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md +++ b/docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md @@ -8,6 +8,12 @@ The process of using the AWS JDBC Driver with RDS Multi-AZ DB Cluster is the sam ### MySQL +There are permissions that must be granted to all non-administrative users who need database access. Without proper access, these users cannot utilize many of the driver's advanced features, including failover support. To grant the necessary permissions to non-administrative users, execute the following statement: + +```sql +GRANT SELECT ON mysql.rds_topology TO 'non-admin-username'@'%' +``` + Preparing a connection with MySQL in a Multi-AZ Cluster remains the same as before: ```java @@ -24,6 +30,12 @@ Per AWS documentation and [this blog post](https://aws.amazon.com/blogs/database CREATE EXTENSION rds_tools; ``` +The extension must be granted to all non-administrative users who need database access. Without access to `rds_tools`, non-admin users cannot utilize many of the driver's advanced features, including failover support. To grant the necessary permissions to non-administrative users, execute the following statement: + +```sql +GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA rds_tools TO non-admin-username; +``` + Then, prepare the connection with: ```java From 084d003cb8c705b94016d3d9098ff4ad5d924ef4 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 20 Nov 2025 17:14:00 -0800 Subject: [PATCH 78/90] Revert "getHostListProviderSupplier -> createHostListProvider" This reverts commit 438ab145732a4cb06c0f956eb470068a45a1968c. --- .../amazon/jdbc/PartialPluginService.java | 4 +++ .../amazon/jdbc/PluginServiceImpl.java | 11 +++---- .../jdbc/dialect/AuroraMysqlDialect.java | 15 ++++----- .../amazon/jdbc/dialect/AuroraPgDialect.java | 12 +++---- .../software/amazon/jdbc/dialect/Dialect.java | 6 +--- .../dialect/GlobalAuroraMysqlDialect.java | 12 +++---- .../jdbc/dialect/GlobalAuroraPgDialect.java | 14 ++++----- .../dialect/HostListProviderSupplier.java | 31 +++++++++++++++++++ .../amazon/jdbc/dialect/MariaDbDialect.java | 9 ++---- .../dialect/MultiAzClusterMysqlDialect.java | 16 +++++----- .../jdbc/dialect/MultiAzClusterPgDialect.java | 18 ++++++----- .../amazon/jdbc/dialect/MysqlDialect.java | 9 ++---- .../amazon/jdbc/dialect/PgDialect.java | 8 ++--- .../amazon/jdbc/dialect/UnknownDialect.java | 9 ++---- .../bluegreen/BlueGreenStatusMonitor.java | 8 +++-- .../amazon/jdbc/util/ServiceUtility.java | 28 ++++++++--------- 16 files changed, 112 insertions(+), 98 deletions(-) create mode 100644 wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java index 875ca5c06..df2126d06 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java @@ -36,6 +36,7 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.cleanup.CanReleaseResources; import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; @@ -132,6 +133,9 @@ public PartialPluginService( this.exceptionHandler = this.configurationProfile != null && this.configurationProfile.getExceptionHandler() != null ? this.configurationProfile.getExceptionHandler() : null; + + HostListProviderSupplier supplier = this.dbDialect.getHostListProviderSupplier(); + this.hostListProvider = supplier.getProvider(this.props, this.originalUrl, this.servicesContainer); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index 5a38fe37b..f5b422fe4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -41,6 +41,7 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.dialect.DialectManager; import software.amazon.jdbc.dialect.DialectProvider; +import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.ExceptionManager; import software.amazon.jdbc.hostavailability.HostAvailability; @@ -685,13 +686,9 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } - updateHostListProvider(); - } - - protected void updateHostListProvider() throws SQLException { - final HostListProvider provider = - this.dialect.createHostListProvider(this.servicesContainer, this.props, this.originalUrl); - this.setHostListProvider(provider); + final HostListProviderSupplier supplier = this.dialect.getHostListProviderSupplier(); + this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); + // TODO: refreshHostList this.refreshHostList(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java index 5456e4565..4402a1ed3 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraMysqlDialect.java @@ -17,15 +17,11 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; -import java.sql.SQLException; import java.util.Collections; import java.util.List; -import java.util.Properties; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.util.FullServicesContainer; public class AuroraMysqlDialect extends MysqlDialect implements TopologyDialect, BlueGreenDialect { @@ -59,11 +55,12 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final TopologyUtils topologyUtils = - new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final TopologyUtils topologyUtils = + new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java index 2337eebb8..df1df5ee4 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/AuroraPgDialect.java @@ -22,14 +22,11 @@ import java.sql.Statement; import java.util.Arrays; import java.util.List; -import java.util.Properties; import java.util.logging.Logger; import software.amazon.jdbc.hostlistprovider.AuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.DriverInfo; -import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; public class AuroraPgDialect extends PgDialect implements TopologyDialect, AuroraLimitlessDialect, BlueGreenDialect { @@ -105,11 +102,12 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final TopologyUtils topologyUtils = + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final TopologyUtils topologyUtils = new AuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java index 50ffdba98..5f09aae0b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/Dialect.java @@ -17,16 +17,13 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; -import java.sql.SQLException; import java.util.EnumSet; import java.util.List; import java.util.Properties; import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.exceptions.ExceptionHandler; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.util.FullServicesContainer; public interface Dialect { @@ -38,8 +35,7 @@ public interface Dialect { ExceptionHandler getExceptionHandler(); - HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException; + HostListProviderSupplier getHostListProviderSupplier(); String getHostAliasQuery(); diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java index aabc7822e..655123cd2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraMysqlDialect.java @@ -22,11 +22,8 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import java.util.Properties; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.HostListProvider; -import software.amazon.jdbc.util.FullServicesContainer; public class GlobalAuroraMysqlDialect extends AuroraMysqlDialect implements GlobalAuroraTopologyDialect { @@ -73,11 +70,12 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final GlobalAuroraTopologyUtils topologyUtils = + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final GlobalAuroraTopologyUtils topologyUtils = new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new GlobalAuroraHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java index df5d1dc07..2efd96b2c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/GlobalAuroraPgDialect.java @@ -22,12 +22,9 @@ import java.sql.Statement; import java.util.Collections; import java.util.List; -import java.util.Properties; import java.util.logging.Logger; import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.hostlistprovider.HostListProvider; -import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; public class GlobalAuroraPgDialect extends AuroraPgDialect implements GlobalAuroraTopologyDialect { @@ -88,11 +85,12 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final GlobalAuroraTopologyUtils topologyUtils = - new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); - return new GlobalAuroraHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final GlobalAuroraTopologyUtils topologyUtils = + new GlobalAuroraTopologyUtils(this, servicesContainer.getPluginService().getHostSpecBuilder()); + return new GlobalAuroraHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java new file mode 100644 index 000000000..d1e23e475 --- /dev/null +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/HostListProviderSupplier.java @@ -0,0 +1,31 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.dialect; + +import java.sql.SQLException; +import java.util.Properties; +import org.checkerframework.checker.nullness.qual.NonNull; +import software.amazon.jdbc.hostlistprovider.HostListProvider; +import software.amazon.jdbc.util.FullServicesContainer; + +@FunctionalInterface +public interface HostListProviderSupplier { + @NonNull HostListProvider getProvider( + final @NonNull Properties properties, + final String initialUrl, + final @NonNull FullServicesContainer servicesContainer) throws SQLException; +} diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java index a054bc9ba..58453f6fa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MariaDbDialect.java @@ -29,9 +29,7 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MariaDBExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.util.FullServicesContainer; public class MariaDbDialect implements Dialect { @@ -82,10 +80,9 @@ public ExceptionHandler getExceptionHandler() { return mariaDBExceptionHandler; } - @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> + new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java index 01240aaaf..5075a1393 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterMysqlDialect.java @@ -26,14 +26,12 @@ import org.checkerframework.checker.nullness.qual.NonNull; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.plugin.failover.FailoverRestriction; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUtils; import software.amazon.jdbc.util.StringUtils; @@ -85,11 +83,15 @@ public boolean isDialect(final Connection connection) { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final PluginService pluginService = servicesContainer.getPluginService(); - final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + } + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java index 47b1a8b7c..6e6ad013d 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MultiAzClusterPgDialect.java @@ -21,17 +21,14 @@ import java.sql.SQLException; import java.sql.Statement; import java.util.List; -import java.util.Properties; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MultiAzDbClusterPgExceptionHandler; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.hostlistprovider.MultiAzTopologyUtils; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider; import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin; import software.amazon.jdbc.util.DriverInfo; -import software.amazon.jdbc.util.FullServicesContainer; public class MultiAzClusterPgDialect extends PgDialect implements MultiAzClusterDialect { @@ -81,11 +78,16 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - final PluginService pluginService = servicesContainer.getPluginService(); - final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); - return new RdsHostListProvider(topologyUtils, props, initialUrl, servicesContainer); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> { + final PluginService pluginService = servicesContainer.getPluginService(); + final TopologyUtils topologyUtils = new MultiAzTopologyUtils(this, pluginService.getHostSpecBuilder()); + if (pluginService.isPluginInUse(FailoverConnectionPlugin.class)) { + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + } + + return new RdsHostListProvider(topologyUtils, properties, initialUrl, servicesContainer); + }; } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java index ac2f7a440..146836bf8 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/MysqlDialect.java @@ -29,9 +29,7 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.MySQLExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.util.FullServicesContainer; public class MysqlDialect implements Dialect { @@ -85,10 +83,9 @@ public ExceptionHandler getExceptionHandler() { return mySQLExceptionHandler; } - @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> + new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java index 6b94ec41c..abf33ee56 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/PgDialect.java @@ -29,9 +29,7 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.PgExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.util.FullServicesContainer; /** * Generic dialect for any Postgresql database. @@ -78,9 +76,9 @@ public ExceptionHandler getExceptionHandler() { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> + new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java index da346ad9a..067261242 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java +++ b/wrapper/src/main/java/software/amazon/jdbc/dialect/UnknownDialect.java @@ -17,7 +17,6 @@ package software.amazon.jdbc.dialect; import java.sql.Connection; -import java.sql.SQLException; import java.util.Arrays; import java.util.EnumSet; import java.util.List; @@ -27,9 +26,7 @@ import software.amazon.jdbc.exceptions.ExceptionHandler; import software.amazon.jdbc.exceptions.GenericExceptionHandler; import software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.plugin.failover.FailoverRestriction; -import software.amazon.jdbc.util.FullServicesContainer; public class UnknownDialect implements Dialect { @@ -85,9 +82,9 @@ public List getDialectUpdateCandidates() { } @Override - public HostListProvider createHostListProvider( - FullServicesContainer servicesContainer, Properties props, String initialUrl) throws SQLException { - return new ConnectionStringHostListProvider(props, initialUrl, servicesContainer.getHostListProviderService()); + public HostListProviderSupplier getHostListProviderSupplier() { + return (properties, initialUrl, servicesContainer) -> + new ConnectionStringHostListProvider(properties, initialUrl, servicesContainer.getHostListProviderService()); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java index 9325de25d..55f5c7e6c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/bluegreen/BlueGreenStatusMonitor.java @@ -632,8 +632,12 @@ protected void initHostListProvider() throws SQLException { final HostSpec connectionHostSpecCopy = this.connectionHostSpec.get(); if (connectionHostSpecCopy != null) { String hostListProviderUrl = String.format("%s%s/", protocol, connectionHostSpecCopy.getHostAndPort()); - this.hostListProvider = this.pluginService.getDialect().createHostListProvider( - this.servicesContainer, hostListProperties, hostListProviderUrl); + this.hostListProvider = this.pluginService.getDialect() + .getHostListProviderSupplier() + .getProvider( + hostListProperties, + hostListProviderUrl, + this.servicesContainer); } else { LOGGER.warning(() -> Messages.get("bgd.hostSpecNull")); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index 53ecac98c..7b66f4367 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -24,6 +24,7 @@ import software.amazon.jdbc.PartialPluginService; import software.amazon.jdbc.PluginServiceImpl; import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.dialect.HostListProviderSupplier; import software.amazon.jdbc.hostlistprovider.HostListProvider; import software.amazon.jdbc.profile.ConfigurationProfile; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; @@ -51,15 +52,15 @@ public FullServicesContainer createStandardServiceContainer( TargetDriverDialect driverDialect, Properties props, @Nullable ConfigurationProfile configurationProfile) throws SQLException { - FullServicesContainer serviceContainer = + FullServicesContainer servicesContainer = new FullServicesContainerImpl(storageService, monitorService, defaultConnectionProvider, telemetryFactory); ConnectionPluginManager pluginManager = new ConnectionPluginManager(props, telemetryFactory, defaultConnectionProvider, effectiveConnectionProvider); - serviceContainer.setConnectionPluginManager(pluginManager); + servicesContainer.setConnectionPluginManager(pluginManager); PluginServiceImpl pluginService = new PluginServiceImpl( - serviceContainer, + servicesContainer, props, originalUrl, targetDriverProtocol, @@ -67,14 +68,16 @@ public FullServicesContainer createStandardServiceContainer( configurationProfile ); - serviceContainer.setHostListProviderService(pluginService); - serviceContainer.setPluginService(pluginService); - serviceContainer.setPluginManagerService(pluginService); + servicesContainer.setHostListProviderService(pluginService); + servicesContainer.setPluginService(pluginService); + servicesContainer.setPluginManagerService(pluginService); - pluginManager.initPlugins(serviceContainer, configurationProfile); - final HostListProvider provider = - pluginService.getDialect().createHostListProvider(serviceContainer, props, originalUrl); - pluginService.setHostListProvider(provider); + pluginManager.initPlugins(servicesContainer, configurationProfile); + final HostListProviderSupplier supplier = pluginService.getDialect().getHostListProviderSupplier(); + if (supplier != null) { + final HostListProvider provider = supplier.getProvider(props, originalUrl, servicesContainer); + pluginService.setHostListProvider(provider); + } pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); // This call initializes pluginService.allHosts with the stored topology if it exists or with the initial host spec @@ -113,11 +116,6 @@ public FullServicesContainer createMinimalServiceContainer( serviceContainer.setPluginManagerService(pluginService); pluginManager.initPlugins(serviceContainer, null); - final HostListProvider provider = - pluginService.getDialect().createHostListProvider(serviceContainer, props, originalUrl); - pluginService.setHostListProvider(provider); - - pluginManager.initHostProvider(targetDriverProtocol, originalUrl, props, pluginService); return serviceContainer; } From 58c165af0f33c42fcec27910760f494fce7d426d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Fri, 21 Nov 2025 16:56:35 -0800 Subject: [PATCH 79/90] wip --- .../amazon/jdbc/PluginServiceImpl.java | 5 ++++- .../amazon/jdbc/util/ServiceUtility.java | 2 +- ...ClusterAwareWriterFailoverHandlerTest.java | 20 ++++++++++++------- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java index f5b422fe4..382f56602 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java @@ -686,9 +686,12 @@ public void updateDialect(final @NonNull Connection connection) throws SQLExcept return; } + updateHostListProvider(); + } + + protected void updateHostListProvider() throws SQLException { final HostListProviderSupplier supplier = this.dialect.getHostListProviderSupplier(); this.setHostListProvider(supplier.getProvider(this.props, this.originalUrl, this.servicesContainer)); - // TODO: refreshHostList this.refreshHostList(); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java index 7b66f4367..feb67178f 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/ServiceUtility.java @@ -83,7 +83,7 @@ public FullServicesContainer createStandardServiceContainer( // This call initializes pluginService.allHosts with the stored topology if it exists or with the initial host spec // if it doesn't exist. Plugins may require this information even before connecting. pluginService.refreshHostList(); - return serviceContainer; + return servicesContainer; } public FullServicesContainer createMinimalServiceContainer( diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java index c41e7ebf3..7ebf6f009 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java @@ -49,6 +49,8 @@ import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; class ClusterAwareWriterFailoverHandlerTest { @@ -56,6 +58,8 @@ class ClusterAwareWriterFailoverHandlerTest { @Mock FullServicesContainer mockTask1Container; @Mock FullServicesContainer mockTask2Container; @Mock PluginService mockPluginService; + @Mock DynamicHostListProvider mockHostListProvider; + @Mock TopologyUtils mockTopologyUtils; @Mock Connection mockConnection; @Mock ReaderFailoverHandler mockReaderFailoverHandler; @Mock Connection mockWriterConnection; @@ -83,6 +87,8 @@ void setUp() { when(mockContainer.getPluginService()).thenReturn(mockPluginService); when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); + when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); + when(mockHostListProvider.getTopologyUtils()).thenReturn(mockTopologyUtils); writer.addAlias("writer-host"); newWriterHost.addAlias("new-writer-host"); readerA.addAlias("reader-a-host"); @@ -100,7 +106,7 @@ public void testReconnectToWriter_taskBReaderException() throws SQLException { when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - when(mockPluginService.getAllHosts()).thenReturn(topology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); @@ -147,7 +153,7 @@ public void testReconnectToWriter_SlowReaderA() throws SQLException { when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - when(mockPluginService.getAllHosts()).thenReturn(topology).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenAnswer( @@ -188,7 +194,7 @@ public void testReconnectToWriter_taskBDefers() throws SQLException { }); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - when(mockPluginService.getAllHosts()).thenReturn(topology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -227,7 +233,7 @@ public void testConnectToReaderA_SlowWriter() throws SQLException { when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - when(mockPluginService.getAllHosts()).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -268,7 +274,7 @@ public void testConnectToReaderA_taskADefers() throws SQLException { }); final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); - when(mockPluginService.getAllHosts()).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -315,7 +321,7 @@ public void testFailedToConnect_failoverTimeout() throws SQLException { Thread.sleep(30000); return mockNewWriterConnection; }); - when(mockPluginService.getAllHosts()).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -355,7 +361,7 @@ public void testFailedToConnect_taskAException_taskBWriterException() throws SQL when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); - when(mockPluginService.getAllHosts()).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); From 51bfd14f4dee31751fff601a50cad481f39f73af Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 4 Dec 2025 10:04:05 -0800 Subject: [PATCH 80/90] Fix unit tests --- .../RdsHostListProviderTest.java | 1 + ...ClusterAwareWriterFailoverHandlerTest.java | 33 ++++++++++++++----- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index bd32bcf9b..083052385 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -131,6 +131,7 @@ void testGetTopology_returnCachedTopology() throws SQLException { void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLException, TimeoutException { rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); storageService.set(rdsHostListProvider.clusterId, new Topology(hosts)); + when(mockPluginService.isDialectConfirmed()).thenReturn(true); final List newHosts = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("newHost").build()); diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java index 7ebf6f009..254ba2201 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java @@ -66,6 +66,8 @@ class ClusterAwareWriterFailoverHandlerTest { @Mock Connection mockNewWriterConnection; @Mock Connection mockReaderAConnection; @Mock Connection mockReaderBConnection; + @Mock HostSpec mockInitialHostSpec; + @Mock HostSpec mockInstanceTemplate; @Mock Dialect mockDialect; private AutoCloseable closeable; @@ -88,6 +90,8 @@ void setUp() { when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); + when(mockPluginService.getInitialConnectionHostSpec()).thenReturn(mockInitialHostSpec); + when(mockHostListProvider.getInstanceTemplate()).thenReturn(mockInstanceTemplate); when(mockHostListProvider.getTopologyUtils()).thenReturn(mockTopologyUtils); writer.addAlias("writer-host"); newWriterHost.addAlias("new-writer-host"); @@ -106,7 +110,9 @@ public void testReconnectToWriter_taskBReaderException() throws SQLException { when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))) + .thenReturn(topology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); @@ -153,7 +159,8 @@ public void testReconnectToWriter_SlowReaderA() throws SQLException { when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenAnswer( @@ -194,7 +201,8 @@ public void testReconnectToWriter_taskBDefers() throws SQLException { }); when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(topology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -233,7 +241,8 @@ public void testConnectToReaderA_SlowWriter() throws SQLException { when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -274,7 +283,8 @@ public void testConnectToReaderA_taskADefers() throws SQLException { }); final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -291,7 +301,9 @@ public void testConnectToReaderA_taskADefers() throws SQLException { assertEquals(4, result.getTopology().size()); assertEquals("new-writer-host", result.getTopology().get(0).getHost()); - verify(mockPluginService, atLeastOnce()).forceRefreshHostList(); + verify(mockTopologyUtils, atLeastOnce()).queryForTopology( + any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); } @@ -321,7 +333,8 @@ public void testFailedToConnect_failoverTimeout() throws SQLException { Thread.sleep(30000); return mockNewWriterConnection; }); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); @@ -338,7 +351,8 @@ public void testFailedToConnect_failoverTimeout() throws SQLException { assertFalse(result.isConnected()); assertFalse(result.isNewHost()); - verify(mockPluginService, atLeastOnce()).forceRefreshHostList(); + verify(mockTopologyUtils, atLeastOnce()).queryForTopology( + any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); // 5s is a max allowed failover timeout; add 1s for inaccurate measurements assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); @@ -361,7 +375,8 @@ public void testFailedToConnect_taskAException_taskBWriterException() throws SQL when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); - when(mockTopologyUtils.queryForTopology(any(), any(), any())).thenReturn(newTopology); + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); From 98f0df88750af552163543403493bd7db731895a Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 9 Dec 2025 13:27:51 -0800 Subject: [PATCH 81/90] gradlew check passing --- .../hostlistprovider/HostListProvider.java | 2 - .../hostlistprovider/RdsHostListProvider.java | 4 +- ...onitoringGlobalAuroraHostListProvider.java | 91 ------------------- ...AuroraInitialConnectionStrategyPlugin.java | 8 +- .../ReadWriteSplittingPlugin.java | 2 + .../amazon/jdbc/util/RdsUtilsTests.java | 12 --- 6 files changed, 8 insertions(+), 111 deletions(-) delete mode 100644 wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index ccc59511b..c6390fe4b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -56,8 +56,6 @@ public interface HostListProvider { List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException; - List forceRefresh(Connection connection) throws SQLException; - /** * Evaluates the host role of the given connection - either a writer or a reader. * diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 1425b1923..57d7f5669 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -24,6 +24,7 @@ import java.util.Properties; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; +import java.util.concurrent.locks.ReentrantLock; import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.AwsWrapperProperty; @@ -32,6 +33,7 @@ import software.amazon.jdbc.HostSpecBuilder; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; +import software.amazon.jdbc.cleanup.CanReleaseResources; import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitor; import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; import software.amazon.jdbc.util.ConnectionUrlParser; @@ -91,8 +93,6 @@ public class RdsHostListProvider implements DynamicHostListProvider, CanReleaseR protected final PluginService pluginService; protected final HostListProviderService hostListProviderService; protected final TopologyUtils topologyUtils; - protected final String originalUrl; - protected final Properties properties; protected final RdsUrlType rdsUrlType; protected final List initialHostList; protected final HostSpec initialHostSpec; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java deleted file mode 100644 index b258c223d..000000000 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/MonitoringGlobalAuroraHostListProvider.java +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.hostlistprovider.monitoring; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Properties; -import java.util.logging.Logger; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.GlobalAuroraHostListProvider; -import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; -import software.amazon.jdbc.util.FullServicesContainer; -import software.amazon.jdbc.util.LogUtils; -import software.amazon.jdbc.util.Messages; -import software.amazon.jdbc.util.RdsUtils; -import software.amazon.jdbc.util.StringUtils; - -public class MonitoringGlobalAuroraHostListProvider extends MonitoringRdsHostListProvider { - - static final Logger LOGGER = Logger.getLogger(MonitoringGlobalAuroraHostListProvider.class.getName()); - - protected Map instanceTemplatesByRegion = new HashMap<>(); - - protected final RdsUtils rdsUtils = new RdsUtils(); - protected final GlobalAuroraTopologyUtils topologyUtils; - - static { - // Intentionally register property definition using the GlobalAuroraHostListProvider class. - PropertyDefinition.registerPluginProperties(GlobalAuroraHostListProvider.class); - } - - public MonitoringGlobalAuroraHostListProvider( - GlobalAuroraTopologyUtils topologyUtils, - Properties properties, - String originalUrl, - FullServicesContainer servicesContainer) { - super(topologyUtils, properties, originalUrl, servicesContainer); - this.topologyUtils = topologyUtils; - } - - @Override - protected void initSettings() throws SQLException { - super.initSettings(); - - String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); - this.instanceTemplatesByRegion = - this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); - } - - protected ClusterTopologyMonitor initMonitor() throws SQLException { - return this.servicesContainer.getMonitorService().runIfAbsent( - ClusterTopologyMonitorImpl.class, - this.clusterId, - this.servicesContainer, - this.properties, - (servicesContainer) -> - new GlobalAuroraTopologyMonitor( - servicesContainer, - this.topologyUtils, - this.clusterId, - this.initialHostSpec, - this.properties, - this.instanceTemplate, - this.refreshRateNano, - this.highRefreshRateNano, - this.instanceTemplatesByRegion)); - } - - @Override - protected List queryForTopology(Connection connection) throws SQLException { - return this.topologyUtils.queryForTopology(connection, this.initialHostSpec, this.instanceTemplatesByRegion); - } -} diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java index d467e8b22..d0cf85564 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/AuroraInitialConnectionStrategyPlugin.java @@ -182,7 +182,7 @@ private Connection getVerifiedWriterConnection( // Writer is not found. It seems that topology is outdated. writerCandidateConn = connectFunc.call(); - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); writerCandidate = this.pluginService.identifyConnection(writerCandidateConn); if (writerCandidate == null || writerCandidate.getRole() != HostRole.WRITER) { @@ -203,7 +203,7 @@ private Connection getVerifiedWriterConnection( if (this.pluginService.getHostRole(writerCandidateConn) != HostRole.WRITER) { // If the new connection resolves to a reader instance, this means the topology is outdated. // Force refresh to update the topology. - this.pluginService.forceRefreshHostList(writerCandidateConn); + this.pluginService.forceRefreshHostList(); this.closeConnection(writerCandidateConn); this.delay(retryDelayMs); continue; @@ -265,7 +265,7 @@ private Connection getVerifiedReaderConnection( // Reader is not found. It seems that topology is outdated. readerCandidateConn = connectFunc.call(); - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); readerCandidate = this.pluginService.identifyConnection(readerCandidateConn); if (readerCandidate == null) { @@ -299,7 +299,7 @@ private Connection getVerifiedReaderConnection( if (this.pluginService.getHostRole(readerCandidateConn) != HostRole.READER) { // If the new connection resolves to a writer instance, this means the topology is outdated. // Force refresh to update the topology. - this.pluginService.forceRefreshHostList(readerCandidateConn); + this.pluginService.forceRefreshHostList(); if (this.hasNoReaders()) { // It seems that cluster has no readers. Simulate Aurora reader cluster endpoint logic diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java index 5b884833e..899f6d97a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/readwritesplitting/ReadWriteSplittingPlugin.java @@ -41,6 +41,8 @@ import software.amazon.jdbc.hostlistprovider.HostListProviderService; import software.amazon.jdbc.plugin.AbstractConnectionPlugin; import software.amazon.jdbc.plugin.failover.FailoverSQLException; +import software.amazon.jdbc.util.CacheItem; +import software.amazon.jdbc.util.LogUtils; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.SqlState; import software.amazon.jdbc.util.Utils; diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java index e0f76aaf7..9938dc2e6 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java @@ -437,18 +437,6 @@ public void testisRdsProxyEndpointDns() { assertTrue(target.isRdsProxyEndpointDns(usEastRegionProxyEndpoint)); } - @Test - public void testIsGlobalDbWriterClusterDns() { - assertFalse(target.isGlobalDbWriterClusterDns(usEastRegionCluster)); - assertTrue(target.isGlobalDbWriterClusterDns(globalDbWriterCluster)); - } - - @Test - public void testisRdsProxyEndpointDns() { - assertFalse(target.isRdsProxyEndpointDns(usEastRegionProxy)); - assertTrue(target.isRdsProxyEndpointDns(usEastRegionProxyEndpoint)); - } - @Test public void testBrokenPathsHostPattern() { final String incorrectChinaHostPattern = "?.rds.cn-northwest-1.rds.amazonaws.com.cn"; From 011d54099221d0f45efed2d2f6dae7b733dfc933 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Tue, 9 Dec 2025 17:40:22 -0800 Subject: [PATCH 82/90] fix: refresh host list after failover in failover1 plugin --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 4 ---- .../jdbc/plugin/failover/FailoverConnectionPlugin.java | 6 +++--- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 57d7f5669..537c79f24 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -164,10 +164,6 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { this.highRefreshRateNano)); } - protected List queryForTopology(final Connection conn) throws SQLException { - return this.topologyUtils.queryForTopology(conn, this.initialHostSpec, this.instanceTemplate); - } - protected List queryForTopology() throws SQLException { ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() .get(ClusterTopologyMonitorImpl.class, this.clusterId); diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java index fe072a500..9d93586ba 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java @@ -747,8 +747,6 @@ protected void failoverWriter() throws SQLException { if (exception != null) { throw exception; } - - updateHostAvailability(this.writerFailoverHandler.getHostAvailabilityMap()); } if (failoverResult == null || !failoverResult.isConnected()) { @@ -766,6 +764,9 @@ protected void failoverWriter() throws SQLException { return; } + this.pluginService.forceRefreshHostList(); + updateHostAvailability(this.writerFailoverHandler.getHostAvailabilityMap()); + final List allowedHosts = this.pluginService.getHosts(); if (!Utils.containsHostAndPort(allowedHosts, writerHostSpec.getHostAndPort())) { throwFailoverFailedException( @@ -781,7 +782,6 @@ protected void failoverWriter() throws SQLException { "Failover.establishedConnection", new Object[]{this.pluginService.getCurrentHostSpec()})); - this.pluginService.refreshHostList(); throwFailoverSuccessException(); } catch (FailoverSuccessSQLException ex) { if (telemetryContext != null) { From 9688ea8280c225017081642243f5eb7a1ad2fd60 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Wed, 10 Dec 2025 11:53:26 -0800 Subject: [PATCH 83/90] Cleanup --- docs/development-guide/IntegrationTests.md | 12 +++++++++++ .../software/amazon/jdbc/util/RdsUtils.java | 21 ++++++++++--------- .../util/monitoring/MonitorServiceImpl.java | 3 +-- .../jdbc/util/storage/StorageServiceImpl.java | 4 ++-- .../amazon/jdbc/util/RdsUtilsTests.java | 14 +++++++++++++ 5 files changed, 40 insertions(+), 14 deletions(-) diff --git a/docs/development-guide/IntegrationTests.md b/docs/development-guide/IntegrationTests.md index 62cf5168f..2dec6b0b1 100644 --- a/docs/development-guide/IntegrationTests.md +++ b/docs/development-guide/IntegrationTests.md @@ -69,3 +69,15 @@ cmd /c ./gradlew --no-parallel --no-daemon test-all-environments ``` Test results can be found at `wrapper/build/report/index.html`. + +If you encounter unexplained build issues/errors, or after major project structure changes, try running the following to perform a clean build: + +macOS: +```bash +./gradlew clean +``` + +Windows: +```bash +cmd /c ./gradlew clean +``` diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java index 1331e6dc4..c1eec6545 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/RdsUtils.java @@ -93,7 +93,7 @@ public class RdsUtils { "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.rds\\.amazonaws\\.com\\.?)$", + + "\\.(rds|rds-fips)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_CLUSTER_PATTERN = @@ -101,20 +101,21 @@ public class RdsUtils { "^(?.+)\\." + "(?cluster-|cluster-ro-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.rds\\.amazonaws\\.com\\.?)$", + + "\\.(rds|rds-fips)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_LIMITLESS_CLUSTER_PATTERN = Pattern.compile( "(?.+)\\." + "(?shardgrp-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.rds\\.(amazonaws\\.com\\.?|amazonaws\\.com\\.cn\\.?|sc2s\\.sgov\\.gov\\.?|c2s\\.ic\\.gov\\.?))$", + + "\\.(rds|rds-fips)\\.(amazonaws\\.com\\.?|amazonaws\\.eu\\.?|amazonaws\\.au\\.?|amazonaws\\.uk\\.?" + + "|amazonaws\\.com\\.cn\\.?|sc2s\\.sgov\\.gov\\.?|c2s\\.ic\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_CHINA_DNS_PATTERN = Pattern.compile( "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" - + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + "\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); @@ -122,7 +123,7 @@ public class RdsUtils { Pattern.compile( "^(?.+)\\." + "(?cluster-|cluster-ro-)+" - + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + "\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); @@ -131,7 +132,7 @@ public class RdsUtils { "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.rds\\.amazonaws\\.com\\.cn\\.?)$", + + "\\.(rds|rds-fips)\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_OLD_CHINA_CLUSTER_PATTERN = @@ -139,14 +140,14 @@ public class RdsUtils { "^(?.+)\\." + "(?cluster-|cluster-ro-)+" + "(?[a-zA-Z0-9]+\\.(?[a-zA-Z0-9\\-]+)" - + "\\.rds\\.amazonaws\\.com\\.cn\\.?)$", + + "\\.(rds|rds-fips)\\.amazonaws\\.com\\.cn\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern AURORA_GOV_DNS_PATTERN = Pattern.compile( "^(?.+)\\." + "(?proxy-|cluster-|cluster-ro-|cluster-custom-|shardgrp-)?" - + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + "\\.(amazonaws\\.com\\.?|c2s\\.ic\\.gov\\.?|sc2s\\.sgov\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); @@ -154,14 +155,14 @@ public class RdsUtils { Pattern.compile( "^(?.+)\\." + "(?cluster-|cluster-ro-)+" - + "(?[a-zA-Z0-9]+\\.rds\\.(?[a-zA-Z0-9\\-]+)" + + "(?[a-zA-Z0-9]+\\.(rds|rds-fips)\\.(?[a-zA-Z0-9\\-]+)" + "\\.(amazonaws\\.com\\.?|c2s\\.ic\\.gov\\.?|sc2s\\.sgov\\.gov\\.?))$", Pattern.CASE_INSENSITIVE); private static final Pattern ELB_PATTERN = Pattern.compile( "^(?.+)\\.elb\\." - + "((?[a-zA-Z0-9\\-]+)\\.amazonaws\\.com\\.?)$", + + "((?[a-zA-Z0-9\\-]+)\\.amazonaws\\.(com|au|eu|uk)\\.?)$", Pattern.CASE_INSENSITIVE); private static final Pattern IP_V4 = diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index a13f40c62..5183d376b 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -32,7 +32,6 @@ import java.util.logging.Logger; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -import org.jetbrains.annotations.NotNull; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostlistprovider.Topology; @@ -284,7 +283,7 @@ protected FullServicesContainer newServicesContainer( } @Override - public @Nullable T get(Class monitorClass, @NotNull Object key) { + public @Nullable T get(Class monitorClass, @NonNull Object key) { CacheContainer cacheContainer = monitorCaches.get(monitorClass); if (cacheContainer == null) { return null; diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java index d36ac1010..5728d5894 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/storage/StorageServiceImpl.java @@ -24,8 +24,8 @@ import java.util.concurrent.TimeUnit; import java.util.function.Supplier; import java.util.logging.Logger; +import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -import org.jetbrains.annotations.NotNull; import software.amazon.jdbc.AllowedAndBlockedHosts; import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.plugin.bluegreen.BlueGreenStatus; @@ -114,7 +114,7 @@ public void set(Object key, V value) { } @Override - public @Nullable V get(Class itemClass, @NotNull Object key) { + public @Nullable V get(Class itemClass, @NonNull Object key) { final ExpirationCache cache = caches.get(itemClass); if (cache == null) { return null; diff --git a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java index 9938dc2e6..a0b5090ab 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java +++ b/wrapper/src/test/java/software/amazon/jdbc/util/RdsUtilsTests.java @@ -44,6 +44,9 @@ public class RdsUtilsTests { private static final String usEastRegionLimitlessDbShardGroup = "database-test-name.shardgrp-XYZ.us-east-2.rds.amazonaws.com"; + private static final String euRedshift = + "redshift-test-name.XYZ.eusc-de-east-1.rds.amazonaws.eu"; + private static final String chinaRegionCluster = "database-test-name.cluster-XYZ.rds.cn-northwest-1.amazonaws.com.cn"; private static final String chinaRegionClusterTrailingDot = @@ -139,6 +142,7 @@ public void testIsRdsDns() { assertFalse(target.isRdsDns(usEastRegionElbUrl)); assertFalse(target.isRdsDns(usEastRegionElbUrlTrailingDot)); assertTrue(target.isRdsDns(usEastRegionLimitlessDbShardGroup)); + assertTrue(target.isRdsDns(euRedshift)); assertTrue(target.isRdsDns(chinaRegionCluster)); assertTrue(target.isRdsDns(chinaRegionClusterTrailingDot)); @@ -216,6 +220,9 @@ public void testGetRdsInstanceHostPattern() { assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionProxy)); assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionCustomDomain)); assertEquals(oldChinaExpectedHostPattern, target.getRdsInstanceHostPattern(oldChinaRegionLimitlessDbShardGroup)); + + final String euRedshiftExpectedHostPattern = "?.XYZ.eusc-de-east-1.rds.amazonaws.eu"; + assertEquals(euRedshiftExpectedHostPattern, target.getRdsInstanceHostPattern(euRedshift)); } @Test @@ -228,6 +235,7 @@ public void testIsRdsClusterDns() { assertFalse(target.isRdsClusterDns(usEastRegionCustomDomain)); assertFalse(target.isRdsClusterDns(usEastRegionElbUrl)); assertFalse(target.isRdsClusterDns(usEastRegionLimitlessDbShardGroup)); + assertFalse(target.isRdsClusterDns(euRedshift)); assertTrue(target.isRdsClusterDns(usIsobEastRegionCluster)); assertTrue(target.isRdsClusterDns(usIsobEastRegionClusterReadOnly)); @@ -268,6 +276,7 @@ public void testIsWriterClusterDns() { assertFalse(target.isWriterClusterDns(usEastRegionCustomDomain)); assertFalse(target.isWriterClusterDns(usEastRegionElbUrl)); assertFalse(target.isWriterClusterDns(usEastRegionLimitlessDbShardGroup)); + assertFalse(target.isWriterClusterDns(euRedshift)); assertTrue(target.isWriterClusterDns(usIsobEastRegionCluster)); assertFalse(target.isWriterClusterDns(usIsobEastRegionClusterReadOnly)); @@ -308,6 +317,7 @@ public void testIsReaderClusterDns() { assertFalse(target.isReaderClusterDns(usEastRegionCustomDomain)); assertFalse(target.isReaderClusterDns(usEastRegionElbUrl)); assertFalse(target.isReaderClusterDns(usEastRegionLimitlessDbShardGroup)); + assertFalse(target.isReaderClusterDns(euRedshift)); assertFalse(target.isReaderClusterDns(usIsobEastRegionCluster)); assertTrue(target.isReaderClusterDns(usIsobEastRegionClusterReadOnly)); @@ -348,6 +358,7 @@ public void testIsLimitlessDbShardGroupDns() { assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionCustomDomain)); assertFalse(target.isLimitlessDbShardGroupDns(usEastRegionElbUrl)); assertTrue(target.isLimitlessDbShardGroupDns(usEastRegionLimitlessDbShardGroup)); + assertFalse(target.isLimitlessDbShardGroupDns(euRedshift)); assertFalse(target.isLimitlessDbShardGroupDns(usIsobEastRegionCluster)); assertFalse(target.isLimitlessDbShardGroupDns(usIsobEastRegionClusterReadOnly)); @@ -423,6 +434,9 @@ public void testGetRdsRegion() { assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionProxy)); assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionCustomDomain)); assertEquals(chinaExpectedHostPattern, target.getRdsRegion(oldChinaRegionLimitlessDbShardGroup)); + + final String euRedshiftExpectedHostPattern = "eusc-de-east-1"; + assertEquals(euRedshiftExpectedHostPattern, target.getRdsRegion(euRedshift)); } @Test From fecace812014dfde789e16d356cd361c1663ea45 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 12:27:21 -0800 Subject: [PATCH 84/90] PR comments --- .../ClusterTopologyMonitor.java | 2 +- .../ClusterTopologyMonitorImpl.java | 4 +-- .../GlobalAuroraHostListProvider.java | 5 +--- .../GlobalAuroraTopologyMonitor.java | 3 +-- .../hostlistprovider/RdsHostListProvider.java | 27 ++++++------------- .../util/monitoring/MonitorServiceImpl.java | 2 +- .../RdsHostListProviderTest.java | 9 +++---- 7 files changed, 17 insertions(+), 35 deletions(-) rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/{monitoring => }/ClusterTopologyMonitor.java (95%) rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/{monitoring => }/ClusterTopologyMonitorImpl.java (99%) rename wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/{monitoring => }/GlobalAuroraTopologyMonitor.java (95%) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitor.java similarity index 95% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitor.java index e26e9839f..1f0410354 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitor.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package software.amazon.jdbc.hostlistprovider.monitoring; +package software.amazon.jdbc.hostlistprovider; import java.sql.SQLException; import java.util.List; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitorImpl.java similarity index 99% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitorImpl.java index 93ffb0d83..ec79532e2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/ClusterTopologyMonitorImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ClusterTopologyMonitorImpl.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package software.amazon.jdbc.hostlistprovider.monitoring; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; import java.sql.SQLException; @@ -40,8 +40,6 @@ import software.amazon.jdbc.HostRole; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.Topology; -import software.amazon.jdbc.hostlistprovider.TopologyUtils; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index 11267b5e3..de8d2ee02 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -22,9 +22,6 @@ import software.amazon.jdbc.AwsWrapperProperty; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PropertyDefinition; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitor; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; -import software.amazon.jdbc.hostlistprovider.monitoring.GlobalAuroraTopologyMonitor; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.RdsUtils; @@ -59,7 +56,7 @@ public GlobalAuroraHostListProvider( this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); } - protected ClusterTopologyMonitor initMonitor() throws SQLException { + protected ClusterTopologyMonitor getOrCreateMonitor() throws SQLException { return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, this.clusterId, diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyMonitor.java similarity index 95% rename from wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java rename to wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyMonitor.java index c280035d3..282a6950a 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/monitoring/GlobalAuroraTopologyMonitor.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraTopologyMonitor.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package software.amazon.jdbc.hostlistprovider.monitoring; +package software.amazon.jdbc.hostlistprovider; import java.sql.Connection; import java.sql.SQLException; @@ -22,7 +22,6 @@ import java.util.Map; import java.util.Properties; import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.hostlistprovider.GlobalAuroraTopologyUtils; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Messages; import software.amazon.jdbc.util.StringUtils; diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 537c79f24..228df2f38 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -34,8 +34,6 @@ import software.amazon.jdbc.PluginService; import software.amazon.jdbc.PropertyDefinition; import software.amazon.jdbc.cleanup.CanReleaseResources; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitor; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; import software.amazon.jdbc.util.ConnectionUrlParser; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; @@ -147,7 +145,9 @@ public RdsHostListProvider( this.rdsUrlType = rdsHelper.identifyRdsType(this.initialHostSpec.getHost()); } - protected ClusterTopologyMonitor initMonitor() throws SQLException { + protected ClusterTopologyMonitor getOrCreateMonitor() throws SQLException { + ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() + .get(ClusterTopologyMonitorImpl.class, this.clusterId); return this.servicesContainer.getMonitorService().runIfAbsent( ClusterTopologyMonitorImpl.class, this.clusterId, @@ -165,12 +165,7 @@ protected ClusterTopologyMonitor initMonitor() throws SQLException { } protected List queryForTopology() throws SQLException { - ClusterTopologyMonitor monitor = this.servicesContainer.getMonitorService() - .get(ClusterTopologyMonitorImpl.class, this.clusterId); - if (monitor == null) { - monitor = this.initMonitor(); - } - + ClusterTopologyMonitor monitor = this.getOrCreateMonitor(); try { return monitor.forceRefresh(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); } catch (TimeoutException ex) { @@ -183,15 +178,13 @@ protected List queryForTopology() throws SQLException { * cached copy of topology is returned if it's not yet outdated (controlled by {@link * #refreshRateNano}). * - * @param forceUpdate If true, it forces a service to ignore cached copy of topology and to fetch - * a fresh one. * @return a list of hosts that describes cluster topology. A writer is always at position 0. * Returns an empty list if isn't available or is invalid (doesn't contain a writer). * @throws SQLException if errors occurred while retrieving the topology. */ - protected FetchTopologyResult getTopology(final boolean forceUpdate) throws SQLException { + protected FetchTopologyResult getTopology() throws SQLException { final List storedHosts = this.getStoredTopology(); - if (storedHosts == null || forceUpdate) { + if (storedHosts == null) { // We need to re-fetch topology. if (!this.pluginService.isDialectConfirmed()) { // We need to confirm the dialect before creating a topology monitor so that it uses the correct SQL queries. @@ -234,7 +227,7 @@ public void clear() { @Override public List refresh() throws SQLException { - final FetchTopologyResult results = getTopology(false); + final FetchTopologyResult results = getTopology(); LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); return Collections.unmodifiableList(results.hosts); } @@ -293,11 +286,7 @@ public List forceRefresh() throws SQLException, TimeoutException { @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { - ClusterTopologyMonitor monitor = - this.servicesContainer.getMonitorService().get(ClusterTopologyMonitorImpl.class, this.clusterId); - if (monitor == null) { - monitor = this.initMonitor(); - } + ClusterTopologyMonitor monitor = this.getOrCreateMonitor(); assert monitor != null; return monitor.forceRefresh(shouldVerifyWriter, timeoutMs); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index 5183d376b..ddb4d349c 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -35,7 +35,7 @@ import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; import software.amazon.jdbc.hostlistprovider.Topology; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; +import software.amazon.jdbc.hostlistprovider.ClusterTopologyMonitorImpl; import software.amazon.jdbc.plugin.strategy.fastestresponse.NodeResponseTimeMonitor; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.ExecutorFactory; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index fcaa8cf78..a7f52fb88 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -53,7 +53,6 @@ import software.amazon.jdbc.hostavailability.HostAvailability; import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; import software.amazon.jdbc.hostlistprovider.RdsHostListProvider.FetchTopologyResult; -import software.amazon.jdbc.hostlistprovider.monitoring.ClusterTopologyMonitorImpl; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.Pair; import software.amazon.jdbc.util.events.EventPublisher; @@ -121,7 +120,7 @@ void testGetTopology_returnCachedTopology() throws SQLException { final List expected = hosts; storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - final FetchTopologyResult result = rdsHostListProvider.getTopology(false); + final FetchTopologyResult result = rdsHostListProvider.getTopology(); assertEquals(expected, result.hosts); assertEquals(2, result.hosts.size()); verify(rdsHostListProvider, never()).queryForTopology(); @@ -141,7 +140,7 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio doReturn(newHosts).when(mockTopologyUtils).queryForTopology( eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); - final FetchTopologyResult result = rdsHostListProvider.getTopology(true); + final FetchTopologyResult result = rdsHostListProvider.getTopology(); verify(rdsHostListProvider, atMostOnce()).queryForTopology(); assertEquals(1, result.hosts.size()); assertEquals(newHosts, result.hosts); @@ -157,7 +156,7 @@ void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLExcepti doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); - final FetchTopologyResult result = rdsHostListProvider.getTopology(false); + final FetchTopologyResult result = rdsHostListProvider.getTopology(); verify(rdsHostListProvider, atMostOnce()).queryForTopology(); assertEquals(2, result.hosts.size()); assertEquals(expected, result.hosts); @@ -170,7 +169,7 @@ void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLExceptio doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); - final FetchTopologyResult result = rdsHostListProvider.getTopology(true); + final FetchTopologyResult result = rdsHostListProvider.getTopology(); verify(rdsHostListProvider, atMostOnce()).queryForTopology(); assertNotNull(result.hosts); assertEquals( From f00e301343d0fa03c5a2182e090f368d5ee8c3f1 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 12:35:25 -0800 Subject: [PATCH 85/90] PR suggestions --- .../DynamicHostListProvider.java | 7 +- .../hostlistprovider/RdsHostListProvider.java | 16 +- .../ClusterAwareWriterFailoverHandler.java | 3 +- ...ClusterAwareWriterFailoverHandlerTest.java | 790 +++++++++--------- 4 files changed, 406 insertions(+), 410 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index c6e93c5c9..ae77a4a57 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,13 +16,14 @@ package software.amazon.jdbc.hostlistprovider; +import java.sql.Connection; +import java.sql.SQLException; +import java.util.List; import software.amazon.jdbc.HostSpec; // An interface for providers that can fetch a host list reflecting the current database topology. // Examples include providers for Aurora or Multi-AZ clusters, where the cluster topology, status, and instance roles // change over time. public interface DynamicHostListProvider extends HostListProvider { - TopologyUtils getTopologyUtils(); - - HostSpec getInstanceTemplate(); + List queryForTopology(Connection conn, HostSpec initialHostSpec) throws SQLException; } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 228df2f38..394c08260 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -164,6 +164,11 @@ protected ClusterTopologyMonitor getOrCreateMonitor() throws SQLException { this.highRefreshRateNano)); } + @Override + public List queryForTopology(Connection conn, HostSpec initialHostSpec) throws SQLException { + return this.topologyUtils.queryForTopology(conn, initialHostSpec, this.instanceTemplate); + } + protected List queryForTopology() throws SQLException { ClusterTopologyMonitor monitor = this.getOrCreateMonitor(); try { @@ -173,6 +178,7 @@ protected List queryForTopology() throws SQLException { } } + /** * Get cluster topology. It may require an extra call to database to fetch the latest topology. A * cached copy of topology is returned if it's not yet outdated (controlled by {@link @@ -257,16 +263,6 @@ protected void validateHostPatternSetting(final String hostPattern) { } } - @Override - public TopologyUtils getTopologyUtils() { - return this.topologyUtils; - } - - @Override - public HostSpec getInstanceTemplate() { - return this.instanceTemplate; - } - protected static class FetchTopologyResult { public List hosts; diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index fdec2c077..b50ad1cdc 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -262,8 +262,7 @@ private SQLException createInterruptedException(final InterruptedException e) { DynamicHostListProvider dynamicProvider = (DynamicHostListProvider) this.hostListProvider; HostSpec initialHostSpec = this.pluginService.getInitialConnectionHostSpec(); - HostSpec instanceTemplate = dynamicProvider.getInstanceTemplate(); - return dynamicProvider.getTopologyUtils().queryForTopology(conn, initialHostSpec, instanceTemplate); + return dynamicProvider.queryForTopology(conn, initialHostSpec); } /** diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java index 254ba2201..ca297fe42 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java @@ -1,395 +1,395 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package software.amazon.jdbc.plugin.failover; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertSame; -import static org.junit.jupiter.api.Assertions.assertTrue; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.ArgumentMatchers.refEq; -import static org.mockito.Mockito.atLeastOnce; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.spy; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.sql.Connection; -import java.sql.SQLException; -import java.util.Arrays; -import java.util.EnumSet; -import java.util.List; -import java.util.Properties; -import java.util.concurrent.TimeUnit; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.ArgumentMatchers; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import org.mockito.stubbing.Answer; -import software.amazon.jdbc.HostSpec; -import software.amazon.jdbc.HostSpecBuilder; -import software.amazon.jdbc.PluginService; -import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; -import software.amazon.jdbc.hostlistprovider.TopologyUtils; -import software.amazon.jdbc.util.FullServicesContainer; - -class ClusterAwareWriterFailoverHandlerTest { - @Mock FullServicesContainer mockContainer; - @Mock FullServicesContainer mockTask1Container; - @Mock FullServicesContainer mockTask2Container; - @Mock PluginService mockPluginService; - @Mock DynamicHostListProvider mockHostListProvider; - @Mock TopologyUtils mockTopologyUtils; - @Mock Connection mockConnection; - @Mock ReaderFailoverHandler mockReaderFailoverHandler; - @Mock Connection mockWriterConnection; - @Mock Connection mockNewWriterConnection; - @Mock Connection mockReaderAConnection; - @Mock Connection mockReaderBConnection; - @Mock HostSpec mockInitialHostSpec; - @Mock HostSpec mockInstanceTemplate; - @Mock Dialect mockDialect; - - private AutoCloseable closeable; - private final Properties properties = new Properties(); - private final HostSpec newWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("new-writer-host").build(); - private final HostSpec writer = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("writer-host").build(); - private final HostSpec readerA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("reader-a-host").build(); - private final HostSpec readerB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) - .host("reader-b-host").build(); - private final List topology = Arrays.asList(writer, readerA, readerB); - private final List newTopology = Arrays.asList(newWriterHost, readerA, readerB); - - @BeforeEach - void setUp() { - closeable = MockitoAnnotations.openMocks(this); - when(mockContainer.getPluginService()).thenReturn(mockPluginService); - when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); - when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); - when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); - when(mockPluginService.getInitialConnectionHostSpec()).thenReturn(mockInitialHostSpec); - when(mockHostListProvider.getInstanceTemplate()).thenReturn(mockInstanceTemplate); - when(mockHostListProvider.getTopologyUtils()).thenReturn(mockTopologyUtils); - writer.addAlias("writer-host"); - newWriterHost.addAlias("new-writer-host"); - readerA.addAlias("reader-a-host"); - readerB.addAlias("reader-b-host"); - } - - @AfterEach - void tearDown() throws Exception { - closeable.close(); - } - - @Test - public void testReconnectToWriter_taskBReaderException() throws SQLException { - when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockConnection); - when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))) - .thenReturn(topology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); - final WriterFailoverResult result = target.failover(topology); - - assertTrue(result.isConnected()); - assertFalse(result.isNewHost()); - assertSame(result.getNewConnection(), mockConnection); - - assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); - } - - private ClusterAwareWriterFailoverHandler getSpyFailoverHandler( - final int failoverTimeoutMs, - final int readTopologyIntervalMs, - final int reconnectWriterIntervalMs) throws SQLException { - ClusterAwareWriterFailoverHandler handler = new ClusterAwareWriterFailoverHandler( - mockContainer, - mockReaderFailoverHandler, - properties, - failoverTimeoutMs, - readTopologyIntervalMs, - reconnectWriterIntervalMs); - - ClusterAwareWriterFailoverHandler spyHandler = spy(handler); - doReturn(mockTask1Container, mockTask2Container).when(spyHandler).newServicesContainer(); - return spyHandler; - } - - /** - * Verify that writer failover handler can re-connect to a current writer node. - * - *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. - * TaskA: successfully re-connect to initial writer; return new connection. - * TaskB: successfully connect to readerA and then new writer, but it takes more time than taskA. - * Expected test result: new connection by taskA. - */ - @Test - public void testReconnectToWriter_SlowReaderA() throws SQLException { - when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology).thenReturn(newTopology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(5000); - return new ReaderFailoverResult(mockReaderAConnection, readerA, true); - }); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); - final WriterFailoverResult result = target.failover(topology); - - assertTrue(result.isConnected()); - assertFalse(result.isNewHost()); - assertSame(result.getNewConnection(), mockWriterConnection); - assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); - } - - /** - * Verify that writer failover handler can re-connect to a current writer node. - * - *

Topology: no changes. - * TaskA: successfully re-connect to writer; return new connection. - * TaskB: successfully connect to readerA and retrieve topology, but latest writer is not new (defer to taskA). - * Expected test result: new connection by taskA. - */ - @Test - public void testReconnectToWriter_taskBDefers() throws SQLException { - when(mockPluginService.forceConnect(refEq(writer), eq(properties))) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(5000); - return mockWriterConnection; - }); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); - - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 2000, 2000); - final WriterFailoverResult result = target.failover(topology); - - assertTrue(result.isConnected()); - assertFalse(result.isNewHost()); - assertSame(result.getNewConnection(), mockWriterConnection); - assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); - } - - /** - * Verify that writer failover handler can re-connect to a new writer node. - * - *

Topology: changes to [new-writer, reader-A, reader-B] for taskB, taskA sees no changes. - * taskA: successfully re-connect to writer; return connection to initial writer, but it takes more - * time than taskB. - * TaskB: successfully connect to readerA and then to new-writer. - * Expected test result: new connection to writer by taskB. - */ - @Test - public void testConnectToReaderA_SlowWriter() throws SQLException { - when(mockPluginService.forceConnect(refEq(writer), eq(properties))) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(5000); - return mockWriterConnection; - }); - when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); - when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); - - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); - final WriterFailoverResult result = target.failover(topology); - - assertTrue(result.isConnected()); - assertTrue(result.isNewHost()); - assertSame(result.getNewConnection(), mockNewWriterConnection); - assertEquals(3, result.getTopology().size()); - assertEquals("new-writer-host", result.getTopology().get(0).getHost()); - assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); - } - - /** - * Verify that writer failover handler can re-connect to a new writer node. - * - *

Topology: changes to [new-writer, initial-writer, reader-A, reader-B]. - * TaskA: successfully reconnect, but initial-writer is now a reader (defer to taskB). - * TaskB: successfully connect to readerA and then to new-writer. - * Expected test result: new connection to writer by taskB. - */ - @Test - public void testConnectToReaderA_taskADefers() throws SQLException { - when(mockPluginService.forceConnect(writer, properties)).thenReturn(mockConnection); - when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); - when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(5000); - return mockNewWriterConnection; - }); - - final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); - final WriterFailoverResult result = target.failover(topology); - - assertTrue(result.isConnected()); - assertTrue(result.isNewHost()); - assertSame(result.getNewConnection(), mockNewWriterConnection); - assertEquals(4, result.getTopology().size()); - assertEquals("new-writer-host", result.getTopology().get(0).getHost()); - - verify(mockTopologyUtils, atLeastOnce()).queryForTopology( - any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); - - assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); - } - - /** - * Verify that writer failover handler fails to re-connect to any writer node. - * - *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. - * TaskA: fail to re-connect to writer due to failover timeout. - * TaskB: successfully connect to readerA and then fail to connect to writer due to failover timeout. - * Expected test result: no connection. - */ - @Test - public void testFailedToConnect_failoverTimeout() throws SQLException { - when(mockPluginService.forceConnect(refEq(writer), eq(properties))) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(30000); - return mockWriterConnection; - }); - when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); - when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) - .thenAnswer( - (Answer) - invocation -> { - Thread.sleep(30000); - return mockNewWriterConnection; - }); - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); - - final long startTimeNano = System.nanoTime(); - final WriterFailoverResult result = target.failover(topology); - final long durationNano = System.nanoTime() - startTimeNano; - - assertFalse(result.isConnected()); - assertFalse(result.isNewHost()); - - verify(mockTopologyUtils, atLeastOnce()).queryForTopology( - any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); - - // 5s is a max allowed failover timeout; add 1s for inaccurate measurements - assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); - } - - /** - * Verify that writer failover handler fails to re-connect to any writer node. - * - *

Topology: changes to [new-writer, reader-A, reader-B] for taskB. - * TaskA: fail to re-connect to writer due to exception. - * TaskB: successfully connect to readerA and then fail to connect to writer due to exception. - * Expected test result: no connection. - */ - @Test - public void testFailedToConnect_taskAException_taskBWriterException() throws SQLException { - final SQLException exception = new SQLException("exception", "08S01", null); - when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenThrow(exception); - when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); - when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); - when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); - when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); - - when(mockTopologyUtils.queryForTopology( - any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); - - when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) - .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); - - when(mockPluginService.getDialect()).thenReturn(mockDialect); - when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); - - final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); - final WriterFailoverResult result = target.failover(topology); - - assertFalse(result.isConnected()); - assertFalse(result.isNewHost()); - - assertEquals(HostAvailability.NOT_AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); - } -} +// /* +// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// * +// * Licensed under the Apache License, Version 2.0 (the "License"). +// * You may not use this file except in compliance with the License. +// * You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +// +// package software.amazon.jdbc.plugin.failover; +// +// import static org.junit.jupiter.api.Assertions.assertEquals; +// import static org.junit.jupiter.api.Assertions.assertFalse; +// import static org.junit.jupiter.api.Assertions.assertSame; +// import static org.junit.jupiter.api.Assertions.assertTrue; +// import static org.mockito.ArgumentMatchers.any; +// import static org.mockito.ArgumentMatchers.eq; +// import static org.mockito.ArgumentMatchers.refEq; +// import static org.mockito.Mockito.atLeastOnce; +// import static org.mockito.Mockito.doReturn; +// import static org.mockito.Mockito.spy; +// import static org.mockito.Mockito.verify; +// import static org.mockito.Mockito.when; +// +// import java.sql.Connection; +// import java.sql.SQLException; +// import java.util.Arrays; +// import java.util.EnumSet; +// import java.util.List; +// import java.util.Properties; +// import java.util.concurrent.TimeUnit; +// import org.junit.jupiter.api.AfterEach; +// import org.junit.jupiter.api.BeforeEach; +// import org.junit.jupiter.api.Test; +// import org.mockito.ArgumentMatchers; +// import org.mockito.Mock; +// import org.mockito.MockitoAnnotations; +// import org.mockito.stubbing.Answer; +// import software.amazon.jdbc.HostSpec; +// import software.amazon.jdbc.HostSpecBuilder; +// import software.amazon.jdbc.PluginService; +// import software.amazon.jdbc.dialect.Dialect; +// import software.amazon.jdbc.hostavailability.HostAvailability; +// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +// import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; +// import software.amazon.jdbc.hostlistprovider.TopologyUtils; +// import software.amazon.jdbc.util.FullServicesContainer; +// +// class ClusterAwareWriterFailoverHandlerTest { +// @Mock FullServicesContainer mockContainer; +// @Mock FullServicesContainer mockTask1Container; +// @Mock FullServicesContainer mockTask2Container; +// @Mock PluginService mockPluginService; +// @Mock DynamicHostListProvider mockHostListProvider; +// @Mock TopologyUtils mockTopologyUtils; +// @Mock Connection mockConnection; +// @Mock ReaderFailoverHandler mockReaderFailoverHandler; +// @Mock Connection mockWriterConnection; +// @Mock Connection mockNewWriterConnection; +// @Mock Connection mockReaderAConnection; +// @Mock Connection mockReaderBConnection; +// @Mock HostSpec mockInitialHostSpec; +// @Mock HostSpec mockInstanceTemplate; +// @Mock Dialect mockDialect; +// +// private AutoCloseable closeable; +// private final Properties properties = new Properties(); +// private final HostSpec newWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("new-writer-host").build(); +// private final HostSpec writer = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("writer-host").build(); +// private final HostSpec readerA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("reader-a-host").build(); +// private final HostSpec readerB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) +// .host("reader-b-host").build(); +// private final List topology = Arrays.asList(writer, readerA, readerB); +// private final List newTopology = Arrays.asList(newWriterHost, readerA, readerB); +// +// @BeforeEach +// void setUp() { +// closeable = MockitoAnnotations.openMocks(this); +// when(mockContainer.getPluginService()).thenReturn(mockPluginService); +// when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); +// when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); +// when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); +// when(mockPluginService.getInitialConnectionHostSpec()).thenReturn(mockInitialHostSpec); +// when(mockHostListProvider.getInstanceTemplate()).thenReturn(mockInstanceTemplate); +// when(mockHostListProvider.getTopologyUtils()).thenReturn(mockTopologyUtils); +// writer.addAlias("writer-host"); +// newWriterHost.addAlias("new-writer-host"); +// readerA.addAlias("reader-a-host"); +// readerB.addAlias("reader-b-host"); +// } +// +// @AfterEach +// void tearDown() throws Exception { +// closeable.close(); +// } +// +// @Test +// public void testReconnectToWriter_taskBReaderException() throws SQLException { +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockConnection); +// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); +// +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))) +// .thenReturn(topology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertTrue(result.isConnected()); +// assertFalse(result.isNewHost()); +// assertSame(result.getNewConnection(), mockConnection); +// +// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); +// } +// +// private ClusterAwareWriterFailoverHandler getSpyFailoverHandler( +// final int failoverTimeoutMs, +// final int readTopologyIntervalMs, +// final int reconnectWriterIntervalMs) throws SQLException { +// ClusterAwareWriterFailoverHandler handler = new ClusterAwareWriterFailoverHandler( +// mockContainer, +// mockReaderFailoverHandler, +// properties, +// failoverTimeoutMs, +// readTopologyIntervalMs, +// reconnectWriterIntervalMs); +// +// ClusterAwareWriterFailoverHandler spyHandler = spy(handler); +// doReturn(mockTask1Container, mockTask2Container).when(spyHandler).newServicesContainer(); +// return spyHandler; +// } +// +// /** +// * Verify that writer failover handler can re-connect to a current writer node. +// * +// *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. +// * TaskA: successfully re-connect to initial writer; return new connection. +// * TaskB: successfully connect to readerA and then new writer, but it takes more time than taskA. +// * Expected test result: new connection by taskA. +// */ +// @Test +// public void testReconnectToWriter_SlowReaderA() throws SQLException { +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); +// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology).thenReturn(newTopology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(5000); +// return new ReaderFailoverResult(mockReaderAConnection, readerA, true); +// }); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertTrue(result.isConnected()); +// assertFalse(result.isNewHost()); +// assertSame(result.getNewConnection(), mockWriterConnection); +// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); +// } +// +// /** +// * Verify that writer failover handler can re-connect to a current writer node. +// * +// *

Topology: no changes. +// * TaskA: successfully re-connect to writer; return new connection. +// * TaskB: successfully connect to readerA and retrieve topology, but latest writer is not new (defer to taskA). +// * Expected test result: new connection by taskA. +// */ +// @Test +// public void testReconnectToWriter_taskBDefers() throws SQLException { +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(5000); +// return mockWriterConnection; +// }); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); +// +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 2000, 2000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertTrue(result.isConnected()); +// assertFalse(result.isNewHost()); +// assertSame(result.getNewConnection(), mockWriterConnection); +// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); +// } +// +// /** +// * Verify that writer failover handler can re-connect to a new writer node. +// * +// *

Topology: changes to [new-writer, reader-A, reader-B] for taskB, taskA sees no changes. +// * taskA: successfully re-connect to writer; return connection to initial writer, but it takes more +// * time than taskB. +// * TaskB: successfully connect to readerA and then to new-writer. +// * Expected test result: new connection to writer by taskB. +// */ +// @Test +// public void testConnectToReaderA_SlowWriter() throws SQLException { +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(5000); +// return mockWriterConnection; +// }); +// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); +// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); +// +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertTrue(result.isConnected()); +// assertTrue(result.isNewHost()); +// assertSame(result.getNewConnection(), mockNewWriterConnection); +// assertEquals(3, result.getTopology().size()); +// assertEquals("new-writer-host", result.getTopology().get(0).getHost()); +// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); +// } +// +// /** +// * Verify that writer failover handler can re-connect to a new writer node. +// * +// *

Topology: changes to [new-writer, initial-writer, reader-A, reader-B]. +// * TaskA: successfully reconnect, but initial-writer is now a reader (defer to taskB). +// * TaskB: successfully connect to readerA and then to new-writer. +// * Expected test result: new connection to writer by taskB. +// */ +// @Test +// public void testConnectToReaderA_taskADefers() throws SQLException { +// when(mockPluginService.forceConnect(writer, properties)).thenReturn(mockConnection); +// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); +// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(5000); +// return mockNewWriterConnection; +// }); +// +// final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertTrue(result.isConnected()); +// assertTrue(result.isNewHost()); +// assertSame(result.getNewConnection(), mockNewWriterConnection); +// assertEquals(4, result.getTopology().size()); +// assertEquals("new-writer-host", result.getTopology().get(0).getHost()); +// +// verify(mockTopologyUtils, atLeastOnce()).queryForTopology( +// any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); +// +// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); +// } +// +// /** +// * Verify that writer failover handler fails to re-connect to any writer node. +// * +// *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. +// * TaskA: fail to re-connect to writer due to failover timeout. +// * TaskB: successfully connect to readerA and then fail to connect to writer due to failover timeout. +// * Expected test result: no connection. +// */ +// @Test +// public void testFailedToConnect_failoverTimeout() throws SQLException { +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(30000); +// return mockWriterConnection; +// }); +// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); +// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) +// .thenAnswer( +// (Answer) +// invocation -> { +// Thread.sleep(30000); +// return mockNewWriterConnection; +// }); +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); +// +// final long startTimeNano = System.nanoTime(); +// final WriterFailoverResult result = target.failover(topology); +// final long durationNano = System.nanoTime() - startTimeNano; +// +// assertFalse(result.isConnected()); +// assertFalse(result.isNewHost()); +// +// verify(mockTopologyUtils, atLeastOnce()).queryForTopology( +// any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); +// +// // 5s is a max allowed failover timeout; add 1s for inaccurate measurements +// assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); +// } +// +// /** +// * Verify that writer failover handler fails to re-connect to any writer node. +// * +// *

Topology: changes to [new-writer, reader-A, reader-B] for taskB. +// * TaskA: fail to re-connect to writer due to exception. +// * TaskB: successfully connect to readerA and then fail to connect to writer due to exception. +// * Expected test result: no connection. +// */ +// @Test +// public void testFailedToConnect_taskAException_taskBWriterException() throws SQLException { +// final SQLException exception = new SQLException("exception", "08S01", null); +// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenThrow(exception); +// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); +// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); +// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); +// when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); +// +// when(mockTopologyUtils.queryForTopology( +// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); +// +// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) +// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); +// +// when(mockPluginService.getDialect()).thenReturn(mockDialect); +// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); +// +// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); +// final WriterFailoverResult result = target.failover(topology); +// +// assertFalse(result.isConnected()); +// assertFalse(result.isNewHost()); +// +// assertEquals(HostAvailability.NOT_AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); +// } +// } From 0c35408d3773bb6c1fd00599996e54e6d1cdd50d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 12:44:54 -0800 Subject: [PATCH 86/90] PR suggestions --- .../ClusterAwareWriterFailoverHandler.java | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index b50ad1cdc..3dc417568 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -65,7 +65,6 @@ public class ClusterAwareWriterFailoverHandler implements WriterFailoverHandler protected final Properties initialConnectionProps; protected final FullServicesContainer servicesContainer; protected final PluginService pluginService; - protected final HostListProvider hostListProvider; protected final ReaderFailoverHandler readerFailoverHandler; protected final Map hostAvailabilityMap = new ConcurrentHashMap<>(); protected int maxFailoverTimeoutMs = 60000; // 60 sec @@ -78,7 +77,6 @@ public ClusterAwareWriterFailoverHandler( final Properties initialConnectionProps) { this.servicesContainer = servicesContainer; this.pluginService = servicesContainer.getPluginService(); - this.hostListProvider = this.pluginService.getHostListProvider(); this.readerFailoverHandler = readerFailoverHandler; this.initialConnectionProps = initialConnectionProps; } @@ -251,17 +249,19 @@ private SQLException createInterruptedException(final InterruptedException e) { e); } - private @Nullable List getTopology(@NonNull Connection conn) throws SQLException { - if (this.hostListProvider instanceof StaticHostListProvider) { + private @Nullable List getTopology(@NonNull PluginService pluginService, @NonNull Connection conn) + throws SQLException { + HostListProvider hostListProvider = pluginService.getHostListProvider(); + if (hostListProvider instanceof StaticHostListProvider) { try { - return this.hostListProvider.forceRefresh(); + return hostListProvider.forceRefresh(); } catch (TimeoutException e) { return null; } } - DynamicHostListProvider dynamicProvider = (DynamicHostListProvider) this.hostListProvider; - HostSpec initialHostSpec = this.pluginService.getInitialConnectionHostSpec(); + DynamicHostListProvider dynamicProvider = (DynamicHostListProvider) hostListProvider; + HostSpec initialHostSpec = pluginService.getInitialConnectionHostSpec(); return dynamicProvider.queryForTopology(conn, initialHostSpec); } @@ -269,7 +269,7 @@ private SQLException createInterruptedException(final InterruptedException e) { * Internal class responsible for re-connecting to the current writer (aka TaskA). */ private class ReconnectToWriterHandler implements Callable { - private final PluginService pluginService; + private final PluginService taskAPluginService; private final Map availabilityMap; private final HostSpec originalWriterHost; private final Properties props; @@ -281,7 +281,7 @@ public ReconnectToWriterHandler( final HostSpec originalWriterHost, final Properties props, final int reconnectWriterIntervalMs) { - this.pluginService = servicesContainer.getPluginService(); + this.taskAPluginService = servicesContainer.getPluginService(); this.availabilityMap = availabilityMap; this.originalWriterHost = originalWriterHost; this.props = props; @@ -305,11 +305,11 @@ public WriterFailoverResult call() { conn.close(); } - conn = this.pluginService.forceConnect(this.originalWriterHost, this.props); - latestTopology = getTopology(conn); + conn = this.taskAPluginService.forceConnect(this.originalWriterHost, this.props); + latestTopology = getTopology(this.taskAPluginService, conn); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. - if (!pluginService.isNetworkException(exception, pluginService.getTargetDriverDialect())) { + if (!taskAPluginService.isNetworkException(exception, taskAPluginService.getTargetDriverDialect())) { LOGGER.finer( () -> Messages.get( "ClusterAwareWriterFailoverHandler.taskAEncounteredException", @@ -366,7 +366,7 @@ private boolean isCurrentHostWriter(final List latestTopology) { * elected writer (aka TaskB). */ private class WaitForNewWriterHandler implements Callable { - private final PluginService pluginService; + private final PluginService taskBPluginService; private final Map availabilityMap; private final ReaderFailoverHandler readerFailoverHandler; private final HostSpec originalWriterHost; @@ -385,7 +385,7 @@ public WaitForNewWriterHandler( final Properties props, final int readTopologyIntervalMs, final List currentTopology) { - this.pluginService = servicesContainer.getPluginService(); + this.taskBPluginService = servicesContainer.getPluginService(); this.availabilityMap = availabilityMap; this.readerFailoverHandler = readerFailoverHandler; this.originalWriterHost = originalWriterHost; @@ -462,13 +462,13 @@ private boolean isValidReaderConnection(final ReaderFailoverResult result) { * @return Returns true if successful. */ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedException { - boolean allowOldWriter = this.pluginService.getDialect() + boolean allowOldWriter = this.taskBPluginService.getDialect() .getFailoverRestrictions() .contains(FailoverRestriction.ENABLE_WRITER_IN_TASK_B); while (true) { try { - final List topology = getTopology(this.currentReaderConnection); + final List topology = getTopology(this.taskBPluginService, this.currentReaderConnection); if (!Utils.isNullOrEmpty(topology)) { if (topology.size() == 1) { // The currently connected reader is in a middle of failover. It's not yet connected @@ -525,7 +525,7 @@ private boolean connectToWriter(final HostSpec writerCandidate) { new Object[] {writerCandidate.getUrl()})); try { // connect to the new writer - this.currentConnection = this.pluginService.forceConnect(writerCandidate, this.props); + this.currentConnection = this.taskBPluginService.forceConnect(writerCandidate, this.props); this.availabilityMap.put(writerCandidate.getHost(), HostAvailability.AVAILABLE); return true; } catch (final SQLException exception) { From a16594bcb7f9a4939b90af1a658680a7327b5c75 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 12:50:14 -0800 Subject: [PATCH 87/90] PR suggestions --- .../amazon/jdbc/hostlistprovider/RdsHostListProvider.java | 1 - 1 file changed, 1 deletion(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 394c08260..ea81b3199 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -200,7 +200,6 @@ protected FetchTopologyResult getTopology() throws SQLException { final List hosts = this.queryForTopology(); if (!Utils.isNullOrEmpty(hosts)) { - this.servicesContainer.getStorageService().set(this.clusterId, new Topology(hosts)); return new FetchTopologyResult(false, hosts); } } From 8f073ec755c2f0e656bf9196c6b7543597ba3444 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 15:26:50 -0800 Subject: [PATCH 88/90] PR suggestions --- .../ConnectionStringHostListProvider.java | 5 +++ .../DynamicHostListProvider.java | 11 ++----- .../hostlistprovider/HostListProvider.java | 12 +++++++ .../hostlistprovider/RdsHostListProvider.java | 16 +++++---- .../ClusterAwareWriterFailoverHandler.java | 33 ++++--------------- .../RdsHostListProviderTest.java | 18 +++++----- 6 files changed, 45 insertions(+), 50 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 051233bb0..78c315aeb 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -77,6 +77,11 @@ public ConnectionStringHostListProvider( this.hostListProviderService.setInitialConnectionHostSpec(this.hostList.get(0)); } + @Override + public List getCurrentTopology(Connection conn, HostSpec initialHostSpec) { + return Collections.unmodifiableList(hostList); + } + @Override public List refresh() throws SQLException { return Collections.unmodifiableList(hostList); diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java index ae77a4a57..09d321c41 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/DynamicHostListProvider.java @@ -16,14 +16,7 @@ package software.amazon.jdbc.hostlistprovider; -import java.sql.Connection; -import java.sql.SQLException; -import java.util.List; -import software.amazon.jdbc.HostSpec; - -// An interface for providers that can fetch a host list reflecting the current database topology. +// A marker interface for providers that can fetch a host list reflecting the current database topology. // Examples include providers for Aurora or Multi-AZ clusters, where the cluster topology, status, and instance roles // change over time. -public interface DynamicHostListProvider extends HostListProvider { - List queryForTopology(Connection conn, HostSpec initialHostSpec) throws SQLException; -} +public interface DynamicHostListProvider extends HostListProvider { } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java index c6390fe4b..fd2bb35e2 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/HostListProvider.java @@ -26,6 +26,18 @@ public interface HostListProvider { + /** + * Get current topology information for the connected database. The returned topology should be the static host list + * if `this` is a {@link StaticHostListProvider}. The returned topology should be fresh info returned from a topology + * query if `this` is a {@link DynamicHostListProvider}, + * + * @param conn the connection to use to query the database for topology information, if needed. + * @param initialHostSpec the host details of the initial connection. + * @return the topology information for the connected database. + * @throws SQLException if an error occurs while attempting to acquire the database topology information. + */ + List getCurrentTopology(Connection conn, HostSpec initialHostSpec) throws SQLException; + List refresh() throws SQLException; /** diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index ea81b3199..9d94b56a1 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -165,11 +165,11 @@ protected ClusterTopologyMonitor getOrCreateMonitor() throws SQLException { } @Override - public List queryForTopology(Connection conn, HostSpec initialHostSpec) throws SQLException { + public List getCurrentTopology(Connection conn, HostSpec initialHostSpec) throws SQLException { return this.topologyUtils.queryForTopology(conn, initialHostSpec, this.instanceTemplate); } - protected List queryForTopology() throws SQLException { + protected List getFreshTopology(boolean shouldVerifyWriter, long timeoutMs) throws SQLException { ClusterTopologyMonitor monitor = this.getOrCreateMonitor(); try { return monitor.forceRefresh(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); @@ -198,7 +198,7 @@ protected FetchTopologyResult getTopology() throws SQLException { return new FetchTopologyResult(false, this.initialHostList); } - final List hosts = this.queryForTopology(); + final List hosts = this.getFreshTopology(false, DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS); if (!Utils.isNullOrEmpty(hosts)) { return new FetchTopologyResult(false, hosts); } @@ -281,9 +281,13 @@ public List forceRefresh() throws SQLException, TimeoutException { @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { - ClusterTopologyMonitor monitor = this.getOrCreateMonitor(); - assert monitor != null; - return monitor.forceRefresh(shouldVerifyWriter, timeoutMs); + if (!this.pluginService.isDialectConfirmed()) { + // We need to confirm the dialect before creating a topology monitor so that it uses the correct SQL queries. + // We will return the original hosts parsed from the connections string until the dialect has been confirmed. + return this.initialHostList; + } + + return this.getFreshTopology(shouldVerifyWriter, timeoutMs); } @Override diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java index 3dc417568..66859b783 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandler.java @@ -30,17 +30,11 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; import java.util.logging.Level; import java.util.logging.Logger; -import org.checkerframework.checker.nullness.qual.NonNull; -import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.HostSpec; import software.amazon.jdbc.PluginService; import software.amazon.jdbc.hostavailability.HostAvailability; -import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; -import software.amazon.jdbc.hostlistprovider.HostListProvider; -import software.amazon.jdbc.hostlistprovider.StaticHostListProvider; import software.amazon.jdbc.util.ExecutorFactory; import software.amazon.jdbc.util.FullServicesContainer; import software.amazon.jdbc.util.LogUtils; @@ -249,26 +243,10 @@ private SQLException createInterruptedException(final InterruptedException e) { e); } - private @Nullable List getTopology(@NonNull PluginService pluginService, @NonNull Connection conn) - throws SQLException { - HostListProvider hostListProvider = pluginService.getHostListProvider(); - if (hostListProvider instanceof StaticHostListProvider) { - try { - return hostListProvider.forceRefresh(); - } catch (TimeoutException e) { - return null; - } - } - - DynamicHostListProvider dynamicProvider = (DynamicHostListProvider) hostListProvider; - HostSpec initialHostSpec = pluginService.getInitialConnectionHostSpec(); - return dynamicProvider.queryForTopology(conn, initialHostSpec); - } - /** * Internal class responsible for re-connecting to the current writer (aka TaskA). */ - private class ReconnectToWriterHandler implements Callable { + private static class ReconnectToWriterHandler implements Callable { private final PluginService taskAPluginService; private final Map availabilityMap; private final HostSpec originalWriterHost; @@ -306,7 +284,8 @@ public WriterFailoverResult call() { } conn = this.taskAPluginService.forceConnect(this.originalWriterHost, this.props); - latestTopology = getTopology(this.taskAPluginService, conn); + HostSpec initialHostSpec = this.taskAPluginService.getInitialConnectionHostSpec(); + latestTopology = this.taskAPluginService.getHostListProvider().getCurrentTopology(conn, initialHostSpec); } catch (final SQLException exception) { // Propagate exceptions that are not caused by network errors. if (!taskAPluginService.isNetworkException(exception, taskAPluginService.getTargetDriverDialect())) { @@ -365,7 +344,7 @@ private boolean isCurrentHostWriter(final List latestTopology) { * Internal class responsible for getting the latest cluster topology and connecting to a newly * elected writer (aka TaskB). */ - private class WaitForNewWriterHandler implements Callable { + private static class WaitForNewWriterHandler implements Callable { private final PluginService taskBPluginService; private final Map availabilityMap; private final ReaderFailoverHandler readerFailoverHandler; @@ -468,7 +447,9 @@ private boolean refreshTopologyAndConnectToNewWriter() throws InterruptedExcepti while (true) { try { - final List topology = getTopology(this.taskBPluginService, this.currentReaderConnection); + HostSpec initialHostSpec = this.taskBPluginService.getInitialConnectionHostSpec(); + final List topology = this.taskBPluginService.getHostListProvider() + .getCurrentTopology(this.currentReaderConnection, initialHostSpec); if (!Utils.isNullOrEmpty(topology)) { if (topology.size() == 1) { // The currently connected reader is in a middle of failover. It's not yet connected diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index a7f52fb88..bfcedbdf2 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -123,7 +123,7 @@ void testGetTopology_returnCachedTopology() throws SQLException { final FetchTopologyResult result = rdsHostListProvider.getTopology(); assertEquals(expected, result.hosts); assertEquals(2, result.hosts.size()); - verify(rdsHostListProvider, never()).queryForTopology(); + verify(rdsHostListProvider, never()).refreshMonitor(); } @Test @@ -141,7 +141,7 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); assertEquals(1, result.hosts.size()); assertEquals(newHosts, result.hosts); } @@ -154,10 +154,10 @@ void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLExcepti final List expected = hosts; storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); + doReturn(new ArrayList<>()).when(rdsHostListProvider).refreshMonitor(); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); assertEquals(2, result.hosts.size()); assertEquals(expected, result.hosts); } @@ -167,10 +167,10 @@ void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLExceptio rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); rdsHostListProvider.clear(); - doReturn(new ArrayList<>()).when(rdsHostListProvider).queryForTopology(); + doReturn(new ArrayList<>()).when(rdsHostListProvider).refreshMonitor(); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).queryForTopology(); + verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); assertNotNull(result.hosts); assertEquals( Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), @@ -178,7 +178,7 @@ void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLExceptio } @Test - void testQueryForTopology_withDifferentDriverProtocol() throws SQLException, TimeoutException { + void testGetFreshTopology_withDifferentDriverProtocol() throws SQLException, TimeoutException { final List expectedMySQL = Collections.singletonList( new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("mysql").port(HostSpec.NO_PORT) .role(HostRole.WRITER).availability(HostAvailability.AVAILABLE).weight(0).build()); @@ -195,11 +195,11 @@ void testQueryForTopology_withDifferentDriverProtocol() throws SQLException, Tim rdsHostListProvider = getRdsHostListProvider("mysql://url/"); - List hosts = rdsHostListProvider.queryForTopology(); + List hosts = rdsHostListProvider.refreshMonitor(); assertEquals(expectedMySQL, hosts); rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); - hosts = rdsHostListProvider.queryForTopology(); + hosts = rdsHostListProvider.refreshMonitor(); assertEquals(expectedPostgres, hosts); } From 809cac3d11cee6b1116fd328ddb6382597c2c224 Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 16:01:52 -0800 Subject: [PATCH 89/90] PR suggestions --- .../ConnectionStringHostListProvider.java | 19 ++++-- .../GlobalAuroraHostListProvider.java | 10 +++- .../hostlistprovider/RdsHostListProvider.java | 59 ++++++++++++++----- 3 files changed, 68 insertions(+), 20 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java index 78c315aeb..f559b1f34 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/ConnectionStringHostListProvider.java @@ -36,6 +36,7 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider private static final Logger LOGGER = Logger.getLogger(ConnectionStringHostListProvider.class.getName()); final List hostList = new ArrayList<>(); + private boolean isInitialized = false; private final boolean isSingleWriterConnectionString; private final ConnectionUrlParser connectionUrlParser; private final String initialUrl; @@ -51,7 +52,7 @@ public class ConnectionStringHostListProvider implements StaticHostListProvider public ConnectionStringHostListProvider( final @NonNull Properties properties, final String initialUrl, - final @NonNull HostListProviderService hostListProviderService) throws SQLException { + final @NonNull HostListProviderService hostListProviderService) { this(properties, initialUrl, hostListProviderService, new ConnectionUrlParser()); } @@ -59,13 +60,18 @@ public ConnectionStringHostListProvider( final @NonNull Properties properties, final String initialUrl, final @NonNull HostListProviderService hostListProviderService, - final @NonNull ConnectionUrlParser connectionUrlParser) throws SQLException { + final @NonNull ConnectionUrlParser connectionUrlParser) { this.isSingleWriterConnectionString = SINGLE_WRITER_CONNECTION_STRING.getBoolean(properties); this.initialUrl = initialUrl; this.connectionUrlParser = connectionUrlParser; this.hostListProviderService = hostListProviderService; + } + private void init() throws SQLException { + if (this.isInitialized) { + return; + } this.hostList.addAll( this.connectionUrlParser.getHostsFromConnectionUrl(this.initialUrl, this.isSingleWriterConnectionString, this.hostListProviderService::getHostSpecBuilder)); @@ -75,26 +81,31 @@ public ConnectionStringHostListProvider( } this.hostListProviderService.setInitialConnectionHostSpec(this.hostList.get(0)); + this.isInitialized = true; } @Override - public List getCurrentTopology(Connection conn, HostSpec initialHostSpec) { + public List getCurrentTopology(Connection conn, HostSpec initialHostSpec) throws SQLException { + init(); return Collections.unmodifiableList(hostList); } @Override public List refresh() throws SQLException { + init(); return Collections.unmodifiableList(hostList); } @Override public List forceRefresh() throws SQLException { + init(); return Collections.unmodifiableList(hostList); } @Override public List forceRefresh(boolean shouldVerifyWriter, long timeoutMs) throws SQLException, TimeoutException { + init(); return this.forceRefresh(); } @@ -110,7 +121,7 @@ public HostSpec identifyConnection(Connection connection) throws SQLException { } @Override - public String getClusterId() { + public String getClusterId() throws UnsupportedOperationException { return ""; } } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java index de8d2ee02..f756d79f9 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/GlobalAuroraHostListProvider.java @@ -48,10 +48,16 @@ public class GlobalAuroraHostListProvider extends RdsHostListProvider { public GlobalAuroraHostListProvider( GlobalAuroraTopologyUtils topologyUtils, Properties properties, String originalUrl, - FullServicesContainer servicesContainer) throws SQLException { + FullServicesContainer servicesContainer) { super(topologyUtils, properties, originalUrl, servicesContainer); this.topologyUtils = topologyUtils; - String instanceTemplates = GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); + } + + @Override + protected void initSettings() throws SQLException { + super.initSettings(); + + String instanceTemplates = GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS.getString(properties); this.instanceTemplatesByRegion = this.topologyUtils.parseInstanceTemplates(instanceTemplates, this::validateHostPatternSetting); } diff --git a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java index 9d94b56a1..fa5ad474e 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java +++ b/wrapper/src/main/java/software/amazon/jdbc/hostlistprovider/RdsHostListProvider.java @@ -18,6 +18,7 @@ import java.sql.Connection; import java.sql.SQLException; +import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Objects; @@ -91,29 +92,51 @@ public class RdsHostListProvider implements DynamicHostListProvider, CanReleaseR protected final PluginService pluginService; protected final HostListProviderService hostListProviderService; protected final TopologyUtils topologyUtils; - protected final RdsUrlType rdsUrlType; - protected final List initialHostList; - protected final HostSpec initialHostSpec; - protected final String clusterId; - protected final HostSpec instanceTemplate; protected final long refreshRateNano; protected final long highRefreshRateNano; + protected RdsUrlType rdsUrlType; + protected List initialHostList = new ArrayList<>(); + protected HostSpec initialHostSpec; + protected String clusterId; + protected HostSpec instanceTemplate; + protected volatile boolean isInitialized = false; + public RdsHostListProvider( final TopologyUtils topologyUtils, final Properties properties, final String originalUrl, - final FullServicesContainer servicesContainer) throws SQLException { + final FullServicesContainer servicesContainer) { this.topologyUtils = topologyUtils; this.properties = properties; this.originalUrl = originalUrl; this.servicesContainer = servicesContainer; - this.hostListProviderService = servicesContainer.getHostListProviderService(); this.pluginService = servicesContainer.getPluginService(); + this.hostListProviderService = servicesContainer.getHostListProviderService(); + this.refreshRateNano = + TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); this.highRefreshRateNano = TimeUnit.MILLISECONDS.toNanos( CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS.getLong(this.properties)); + } - this.clusterId = CLUSTER_ID.getString(this.properties); + protected void init() throws SQLException { + if (this.isInitialized) { + return; + } + + lock.lock(); + try { + if (this.isInitialized) { + return; + } + this.initSettings(); + this.isInitialized = true; + } finally { + lock.unlock(); + } + } + + protected void initSettings() throws SQLException { // The initial topology is based on the connection string. this.initialHostList = connectionUrlParser.getHostsFromConnectionUrl(this.originalUrl, false, @@ -121,12 +144,10 @@ public RdsHostListProvider( if (this.initialHostList == null || this.initialHostList.isEmpty()) { throw new SQLException(Messages.get("RdsHostListProvider.parsedListEmpty", new Object[] {this.originalUrl})); } - this.initialHostSpec = this.initialHostList.get(0); this.hostListProviderService.setInitialConnectionHostSpec(this.initialHostSpec); - this.refreshRateNano = - TimeUnit.MILLISECONDS.toNanos(CLUSTER_TOPOLOGY_REFRESH_RATE_MS.getInteger(properties)); + this.clusterId = CLUSTER_ID.getString(this.properties); HostSpecBuilder hostSpecBuilder = this.hostListProviderService.getHostSpecBuilder(); String clusterInstancePattern = CLUSTER_INSTANCE_HOST_PATTERN.getString(this.properties); if (clusterInstancePattern != null) { @@ -166,6 +187,7 @@ protected ClusterTopologyMonitor getOrCreateMonitor() throws SQLException { @Override public List getCurrentTopology(Connection conn, HostSpec initialHostSpec) throws SQLException { + init(); return this.topologyUtils.queryForTopology(conn, initialHostSpec, this.instanceTemplate); } @@ -189,6 +211,8 @@ protected List getFreshTopology(boolean shouldVerifyWriter, long timeo * @throws SQLException if errors occurred while retrieving the topology. */ protected FetchTopologyResult getTopology() throws SQLException { + init(); + final List storedHosts = this.getStoredTopology(); if (storedHosts == null) { // We need to re-fetch topology. @@ -218,7 +242,8 @@ protected FetchTopologyResult getTopology() throws SQLException { * @return list of hosts that represents topology. If there's no topology in the cache or the * cached topology is outdated, it returns null. */ - public @Nullable List getStoredTopology() { + public @Nullable List getStoredTopology() throws SQLException { + init(); Topology topology = this.servicesContainer.getStorageService().get(Topology.class, this.clusterId); return topology == null ? null : topology.getHosts(); } @@ -232,12 +257,14 @@ public void clear() { @Override public List refresh() throws SQLException { + init(); final FetchTopologyResult results = getTopology(); LOGGER.finest(() -> LogUtils.logTopology(results.hosts, results.isCachedData ? "[From cache] Topology:" : null)); return Collections.unmodifiableList(results.hosts); } - public RdsUrlType getRdsUrlType() { + public RdsUrlType getRdsUrlType() throws SQLException { + init(); return this.rdsUrlType; } @@ -281,6 +308,7 @@ public List forceRefresh() throws SQLException, TimeoutException { @Override public List forceRefresh(final boolean shouldVerifyWriter, final long timeoutMs) throws SQLException, TimeoutException { + init(); if (!this.pluginService.isDialectConfirmed()) { // We need to confirm the dialect before creating a topology monitor so that it uses the correct SQL queries. // We will return the original hosts parsed from the connections string until the dialect has been confirmed. @@ -297,11 +325,13 @@ public void releaseResources() { @Override public HostRole getHostRole(Connection conn) throws SQLException { + init(); return this.topologyUtils.getHostRole(conn); } @Override public @Nullable HostSpec identifyConnection(Connection connection) throws SQLException { + init(); try { Pair instanceIds = this.topologyUtils.getInstanceId(connection); if (instanceIds == null) { @@ -346,7 +376,8 @@ public HostRole getHostRole(Connection conn) throws SQLException { } @Override - public String getClusterId() { + public String getClusterId() throws SQLException { + init(); return this.clusterId; } } From 43fdc8116865b57ea9e09ed60240e1c006b1412d Mon Sep 17 00:00:00 2001 From: aaron-congo Date: Thu, 11 Dec 2025 17:04:46 -0800 Subject: [PATCH 90/90] PR suggestions --- .../util/monitoring/MonitorServiceImpl.java | 2 +- .../RdsHostListProviderTest.java | 21 +- ...ClusterAwareWriterFailoverHandlerTest.java | 769 +++++++++--------- 3 files changed, 385 insertions(+), 407 deletions(-) diff --git a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java index ddb4d349c..47ccb1fb0 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java +++ b/wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorServiceImpl.java @@ -34,8 +34,8 @@ import org.checkerframework.checker.nullness.qual.Nullable; import software.amazon.jdbc.ConnectionProvider; import software.amazon.jdbc.dialect.Dialect; -import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.hostlistprovider.ClusterTopologyMonitorImpl; +import software.amazon.jdbc.hostlistprovider.Topology; import software.amazon.jdbc.plugin.strategy.fastestresponse.NodeResponseTimeMonitor; import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect; import software.amazon.jdbc.util.ExecutorFactory; diff --git a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java index bfcedbdf2..1c4a7edf0 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/hostlistprovider/RdsHostListProviderTest.java @@ -107,10 +107,9 @@ void tearDown() throws Exception { closeable.close(); } - private RdsHostListProvider getRdsHostListProvider(String originalUrl) throws SQLException { - RdsHostListProvider provider = new RdsHostListProvider( + private RdsHostListProvider getRdsHostListProvider(String originalUrl) { + return new RdsHostListProvider( mockTopologyUtils, new Properties(), originalUrl, mockServicesContainer); - return provider; } @Test @@ -123,7 +122,7 @@ void testGetTopology_returnCachedTopology() throws SQLException { final FetchTopologyResult result = rdsHostListProvider.getTopology(); assertEquals(expected, result.hosts); assertEquals(2, result.hosts.size()); - verify(rdsHostListProvider, never()).refreshMonitor(); + verify(rdsHostListProvider, never()).getFreshTopology(anyBoolean(), anyLong()); } @Test @@ -141,7 +140,7 @@ void testGetTopology_withForceUpdate_returnsUpdatedTopology() throws SQLExceptio eq(mockConnection), any(HostSpec.class), any(HostSpec.class)); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); + verify(rdsHostListProvider, atMostOnce()).getFreshTopology(anyBoolean(), anyLong()); assertEquals(1, result.hosts.size()); assertEquals(newHosts, result.hosts); } @@ -154,10 +153,10 @@ void testGetTopology_noForceUpdate_queryReturnsEmptyHostList() throws SQLExcepti final List expected = hosts; storageService.set(rdsHostListProvider.clusterId, new Topology(expected)); - doReturn(new ArrayList<>()).when(rdsHostListProvider).refreshMonitor(); + doReturn(new ArrayList<>()).when(rdsHostListProvider).getFreshTopology(anyBoolean(), anyLong()); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); + verify(rdsHostListProvider, atMostOnce()).getFreshTopology(anyBoolean(), anyLong()); assertEquals(2, result.hosts.size()); assertEquals(expected, result.hosts); } @@ -167,10 +166,10 @@ void testGetTopology_withForceUpdate_returnsInitialHostList() throws SQLExceptio rdsHostListProvider = Mockito.spy(getRdsHostListProvider("jdbc:someprotocol://url")); rdsHostListProvider.clear(); - doReturn(new ArrayList<>()).when(rdsHostListProvider).refreshMonitor(); + doReturn(new ArrayList<>()).when(rdsHostListProvider).getFreshTopology(anyBoolean(), anyLong()); final FetchTopologyResult result = rdsHostListProvider.getTopology(); - verify(rdsHostListProvider, atMostOnce()).refreshMonitor(); + verify(rdsHostListProvider, atMostOnce()).getFreshTopology(anyBoolean(), anyLong()); assertNotNull(result.hosts); assertEquals( Collections.singletonList(new HostSpecBuilder(new SimpleHostAvailabilityStrategy()).host("url").build()), @@ -195,11 +194,11 @@ void testGetFreshTopology_withDifferentDriverProtocol() throws SQLException, Tim rdsHostListProvider = getRdsHostListProvider("mysql://url/"); - List hosts = rdsHostListProvider.refreshMonitor(); + List hosts = rdsHostListProvider.getFreshTopology(anyBoolean(), anyLong()); assertEquals(expectedMySQL, hosts); rdsHostListProvider = getRdsHostListProvider("postgresql://url/"); - hosts = rdsHostListProvider.refreshMonitor(); + hosts = rdsHostListProvider.getFreshTopology(anyBoolean(), anyLong()); assertEquals(expectedPostgres, hosts); } diff --git a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java index ca297fe42..0b9c7cacc 100644 --- a/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java +++ b/wrapper/src/test/java/software/amazon/jdbc/plugin/failover/ClusterAwareWriterFailoverHandlerTest.java @@ -1,395 +1,374 @@ -// /* -// * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// * -// * Licensed under the Apache License, Version 2.0 (the "License"). -// * You may not use this file except in compliance with the License. -// * You may obtain a copy of the License at -// * -// * http://www.apache.org/licenses/LICENSE-2.0 -// * -// * Unless required by applicable law or agreed to in writing, software -// * distributed under the License is distributed on an "AS IS" BASIS, -// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// * See the License for the specific language governing permissions and -// * limitations under the License. -// */ -// -// package software.amazon.jdbc.plugin.failover; -// -// import static org.junit.jupiter.api.Assertions.assertEquals; -// import static org.junit.jupiter.api.Assertions.assertFalse; -// import static org.junit.jupiter.api.Assertions.assertSame; -// import static org.junit.jupiter.api.Assertions.assertTrue; -// import static org.mockito.ArgumentMatchers.any; -// import static org.mockito.ArgumentMatchers.eq; -// import static org.mockito.ArgumentMatchers.refEq; -// import static org.mockito.Mockito.atLeastOnce; -// import static org.mockito.Mockito.doReturn; -// import static org.mockito.Mockito.spy; -// import static org.mockito.Mockito.verify; -// import static org.mockito.Mockito.when; -// -// import java.sql.Connection; -// import java.sql.SQLException; -// import java.util.Arrays; -// import java.util.EnumSet; -// import java.util.List; -// import java.util.Properties; -// import java.util.concurrent.TimeUnit; -// import org.junit.jupiter.api.AfterEach; -// import org.junit.jupiter.api.BeforeEach; -// import org.junit.jupiter.api.Test; -// import org.mockito.ArgumentMatchers; -// import org.mockito.Mock; -// import org.mockito.MockitoAnnotations; -// import org.mockito.stubbing.Answer; -// import software.amazon.jdbc.HostSpec; -// import software.amazon.jdbc.HostSpecBuilder; -// import software.amazon.jdbc.PluginService; -// import software.amazon.jdbc.dialect.Dialect; -// import software.amazon.jdbc.hostavailability.HostAvailability; -// import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; -// import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; -// import software.amazon.jdbc.hostlistprovider.TopologyUtils; -// import software.amazon.jdbc.util.FullServicesContainer; -// -// class ClusterAwareWriterFailoverHandlerTest { -// @Mock FullServicesContainer mockContainer; -// @Mock FullServicesContainer mockTask1Container; -// @Mock FullServicesContainer mockTask2Container; -// @Mock PluginService mockPluginService; -// @Mock DynamicHostListProvider mockHostListProvider; -// @Mock TopologyUtils mockTopologyUtils; -// @Mock Connection mockConnection; -// @Mock ReaderFailoverHandler mockReaderFailoverHandler; -// @Mock Connection mockWriterConnection; -// @Mock Connection mockNewWriterConnection; -// @Mock Connection mockReaderAConnection; -// @Mock Connection mockReaderBConnection; -// @Mock HostSpec mockInitialHostSpec; -// @Mock HostSpec mockInstanceTemplate; -// @Mock Dialect mockDialect; -// -// private AutoCloseable closeable; -// private final Properties properties = new Properties(); -// private final HostSpec newWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("new-writer-host").build(); -// private final HostSpec writer = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("writer-host").build(); -// private final HostSpec readerA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("reader-a-host").build(); -// private final HostSpec readerB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) -// .host("reader-b-host").build(); -// private final List topology = Arrays.asList(writer, readerA, readerB); -// private final List newTopology = Arrays.asList(newWriterHost, readerA, readerB); -// -// @BeforeEach -// void setUp() { -// closeable = MockitoAnnotations.openMocks(this); -// when(mockContainer.getPluginService()).thenReturn(mockPluginService); -// when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); -// when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); -// when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); -// when(mockPluginService.getInitialConnectionHostSpec()).thenReturn(mockInitialHostSpec); -// when(mockHostListProvider.getInstanceTemplate()).thenReturn(mockInstanceTemplate); -// when(mockHostListProvider.getTopologyUtils()).thenReturn(mockTopologyUtils); -// writer.addAlias("writer-host"); -// newWriterHost.addAlias("new-writer-host"); -// readerA.addAlias("reader-a-host"); -// readerB.addAlias("reader-b-host"); -// } -// -// @AfterEach -// void tearDown() throws Exception { -// closeable.close(); -// } -// -// @Test -// public void testReconnectToWriter_taskBReaderException() throws SQLException { -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockConnection); -// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); -// -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))) -// .thenReturn(topology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertTrue(result.isConnected()); -// assertFalse(result.isNewHost()); -// assertSame(result.getNewConnection(), mockConnection); -// -// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); -// } -// -// private ClusterAwareWriterFailoverHandler getSpyFailoverHandler( -// final int failoverTimeoutMs, -// final int readTopologyIntervalMs, -// final int reconnectWriterIntervalMs) throws SQLException { -// ClusterAwareWriterFailoverHandler handler = new ClusterAwareWriterFailoverHandler( -// mockContainer, -// mockReaderFailoverHandler, -// properties, -// failoverTimeoutMs, -// readTopologyIntervalMs, -// reconnectWriterIntervalMs); -// -// ClusterAwareWriterFailoverHandler spyHandler = spy(handler); -// doReturn(mockTask1Container, mockTask2Container).when(spyHandler).newServicesContainer(); -// return spyHandler; -// } -// -// /** -// * Verify that writer failover handler can re-connect to a current writer node. -// * -// *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. -// * TaskA: successfully re-connect to initial writer; return new connection. -// * TaskB: successfully connect to readerA and then new writer, but it takes more time than taskA. -// * Expected test result: new connection by taskA. -// */ -// @Test -// public void testReconnectToWriter_SlowReaderA() throws SQLException { -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); -// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology).thenReturn(newTopology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(5000); -// return new ReaderFailoverResult(mockReaderAConnection, readerA, true); -// }); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertTrue(result.isConnected()); -// assertFalse(result.isNewHost()); -// assertSame(result.getNewConnection(), mockWriterConnection); -// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); -// } -// -// /** -// * Verify that writer failover handler can re-connect to a current writer node. -// * -// *

Topology: no changes. -// * TaskA: successfully re-connect to writer; return new connection. -// * TaskB: successfully connect to readerA and retrieve topology, but latest writer is not new (defer to taskA). -// * Expected test result: new connection by taskA. -// */ -// @Test -// public void testReconnectToWriter_taskBDefers() throws SQLException { -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(5000); -// return mockWriterConnection; -// }); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); -// -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(topology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 2000, 2000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertTrue(result.isConnected()); -// assertFalse(result.isNewHost()); -// assertSame(result.getNewConnection(), mockWriterConnection); -// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); -// } -// -// /** -// * Verify that writer failover handler can re-connect to a new writer node. -// * -// *

Topology: changes to [new-writer, reader-A, reader-B] for taskB, taskA sees no changes. -// * taskA: successfully re-connect to writer; return connection to initial writer, but it takes more -// * time than taskB. -// * TaskB: successfully connect to readerA and then to new-writer. -// * Expected test result: new connection to writer by taskB. -// */ -// @Test -// public void testConnectToReaderA_SlowWriter() throws SQLException { -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(5000); -// return mockWriterConnection; -// }); -// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); -// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); -// -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertTrue(result.isConnected()); -// assertTrue(result.isNewHost()); -// assertSame(result.getNewConnection(), mockNewWriterConnection); -// assertEquals(3, result.getTopology().size()); -// assertEquals("new-writer-host", result.getTopology().get(0).getHost()); -// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); -// } -// -// /** -// * Verify that writer failover handler can re-connect to a new writer node. -// * -// *

Topology: changes to [new-writer, initial-writer, reader-A, reader-B]. -// * TaskA: successfully reconnect, but initial-writer is now a reader (defer to taskB). -// * TaskB: successfully connect to readerA and then to new-writer. -// * Expected test result: new connection to writer by taskB. -// */ -// @Test -// public void testConnectToReaderA_taskADefers() throws SQLException { -// when(mockPluginService.forceConnect(writer, properties)).thenReturn(mockConnection); -// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); -// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(5000); -// return mockNewWriterConnection; -// }); -// -// final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertTrue(result.isConnected()); -// assertTrue(result.isNewHost()); -// assertSame(result.getNewConnection(), mockNewWriterConnection); -// assertEquals(4, result.getTopology().size()); -// assertEquals("new-writer-host", result.getTopology().get(0).getHost()); -// -// verify(mockTopologyUtils, atLeastOnce()).queryForTopology( -// any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); -// -// assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); -// } -// -// /** -// * Verify that writer failover handler fails to re-connect to any writer node. -// * -// *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. -// * TaskA: fail to re-connect to writer due to failover timeout. -// * TaskB: successfully connect to readerA and then fail to connect to writer due to failover timeout. -// * Expected test result: no connection. -// */ -// @Test -// public void testFailedToConnect_failoverTimeout() throws SQLException { -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(30000); -// return mockWriterConnection; -// }); -// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); -// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) -// .thenAnswer( -// (Answer) -// invocation -> { -// Thread.sleep(30000); -// return mockNewWriterConnection; -// }); -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); -// -// final long startTimeNano = System.nanoTime(); -// final WriterFailoverResult result = target.failover(topology); -// final long durationNano = System.nanoTime() - startTimeNano; -// -// assertFalse(result.isConnected()); -// assertFalse(result.isNewHost()); -// -// verify(mockTopologyUtils, atLeastOnce()).queryForTopology( -// any(Connection.class), eq(mockInitialHostSpec), eq(mockInstanceTemplate)); -// -// // 5s is a max allowed failover timeout; add 1s for inaccurate measurements -// assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); -// } -// -// /** -// * Verify that writer failover handler fails to re-connect to any writer node. -// * -// *

Topology: changes to [new-writer, reader-A, reader-B] for taskB. -// * TaskA: fail to re-connect to writer due to exception. -// * TaskB: successfully connect to readerA and then fail to connect to writer due to exception. -// * Expected test result: no connection. -// */ -// @Test -// public void testFailedToConnect_taskAException_taskBWriterException() throws SQLException { -// final SQLException exception = new SQLException("exception", "08S01", null); -// when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenThrow(exception); -// when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); -// when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); -// when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); -// when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); -// -// when(mockTopologyUtils.queryForTopology( -// any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); -// -// when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) -// .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); -// -// when(mockPluginService.getDialect()).thenReturn(mockDialect); -// when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); -// -// final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); -// final WriterFailoverResult result = target.failover(topology); -// -// assertFalse(result.isConnected()); -// assertFalse(result.isNewHost()); -// -// assertEquals(HostAvailability.NOT_AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); -// } -// } +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package software.amazon.jdbc.plugin.failover; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.ArgumentMatchers.refEq; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.sql.Connection; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.EnumSet; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.TimeUnit; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentMatchers; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.mockito.stubbing.Answer; +import software.amazon.jdbc.HostSpec; +import software.amazon.jdbc.HostSpecBuilder; +import software.amazon.jdbc.PluginService; +import software.amazon.jdbc.dialect.Dialect; +import software.amazon.jdbc.hostavailability.HostAvailability; +import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy; +import software.amazon.jdbc.hostlistprovider.DynamicHostListProvider; +import software.amazon.jdbc.hostlistprovider.TopologyUtils; +import software.amazon.jdbc.util.FullServicesContainer; + +class ClusterAwareWriterFailoverHandlerTest { + @Mock FullServicesContainer mockContainer; + @Mock FullServicesContainer mockTask1Container; + @Mock FullServicesContainer mockTask2Container; + @Mock PluginService mockPluginService; + @Mock DynamicHostListProvider mockHostListProvider; + @Mock TopologyUtils mockTopologyUtils; + @Mock Connection mockConnection; + @Mock ReaderFailoverHandler mockReaderFailoverHandler; + @Mock Connection mockWriterConnection; + @Mock Connection mockNewWriterConnection; + @Mock Connection mockReaderAConnection; + @Mock Connection mockReaderBConnection; + @Mock HostSpec mockInitialHostSpec; + @Mock HostSpec mockInstanceTemplate; + @Mock Dialect mockDialect; + + private AutoCloseable closeable; + private final Properties properties = new Properties(); + private final HostSpec newWriterHost = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("new-writer-host").build(); + private final HostSpec writer = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("writer-host").build(); + private final HostSpec readerA = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("reader-a-host").build(); + private final HostSpec readerB = new HostSpecBuilder(new SimpleHostAvailabilityStrategy()) + .host("reader-b-host").build(); + private final List topology = Arrays.asList(writer, readerA, readerB); + private final List newTopology = Arrays.asList(newWriterHost, readerA, readerB); + + @BeforeEach + void setUp() { + closeable = MockitoAnnotations.openMocks(this); + when(mockContainer.getPluginService()).thenReturn(mockPluginService); + when(mockTask1Container.getPluginService()).thenReturn(mockPluginService); + when(mockTask2Container.getPluginService()).thenReturn(mockPluginService); + when(mockPluginService.getHostListProvider()).thenReturn(mockHostListProvider); + when(mockPluginService.getInitialConnectionHostSpec()).thenReturn(mockInitialHostSpec); + writer.addAlias("writer-host"); + newWriterHost.addAlias("new-writer-host"); + readerA.addAlias("reader-a-host"); + readerB.addAlias("reader-b-host"); + } + + @AfterEach + void tearDown() throws Exception { + closeable.close(); + } + + @Test + public void testReconnectToWriter_taskBReaderException() throws SQLException { + when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockConnection); + when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenThrow(SQLException.class); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))).thenReturn(topology); + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())).thenThrow(SQLException.class); + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); + final WriterFailoverResult result = target.failover(topology); + + assertTrue(result.isConnected()); + assertFalse(result.isNewHost()); + assertSame(result.getNewConnection(), mockConnection); + + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); + } + + private ClusterAwareWriterFailoverHandler getSpyFailoverHandler( + final int failoverTimeoutMs, + final int readTopologyIntervalMs, + final int reconnectWriterIntervalMs) throws SQLException { + ClusterAwareWriterFailoverHandler handler = new ClusterAwareWriterFailoverHandler( + mockContainer, + mockReaderFailoverHandler, + properties, + failoverTimeoutMs, + readTopologyIntervalMs, + reconnectWriterIntervalMs); + + ClusterAwareWriterFailoverHandler spyHandler = spy(handler); + doReturn(mockTask1Container, mockTask2Container).when(spyHandler).newServicesContainer(); + return spyHandler; + } + + /** + * Verify that writer failover handler can re-connect to a current writer node. + * + *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. + * TaskA: successfully re-connect to initial writer; return new connection. + * TaskB: successfully connect to readerA and then new writer, but it takes more time than taskA. + * Expected test result: new connection by taskA. + */ + @Test + public void testReconnectToWriter_SlowReaderA() throws SQLException { + when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenReturn(mockWriterConnection); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); + when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))) + .thenReturn(topology).thenReturn(newTopology); + + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(5000); + return new ReaderFailoverResult(mockReaderAConnection, readerA, true); + }); + + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); + final WriterFailoverResult result = target.failover(topology); + + assertTrue(result.isConnected()); + assertFalse(result.isNewHost()); + assertSame(result.getNewConnection(), mockWriterConnection); + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); + } + + /** + * Verify that writer failover handler can re-connect to a current writer node. + * + *

Topology: no changes. + * TaskA: successfully re-connect to writer; return new connection. + * TaskB: successfully connect to readerA and retrieve topology, but latest writer is not new (defer to taskA). + * Expected test result: new connection by taskA. + */ + @Test + public void testReconnectToWriter_taskBDefers() throws SQLException { + when(mockPluginService.forceConnect(refEq(writer), eq(properties))) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(5000); + return mockWriterConnection; + }); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenThrow(SQLException.class); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))).thenReturn(topology); + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 2000, 2000); + final WriterFailoverResult result = target.failover(topology); + + assertTrue(result.isConnected()); + assertFalse(result.isNewHost()); + assertSame(result.getNewConnection(), mockWriterConnection); + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(writer.getHost())); + } + + /** + * Verify that writer failover handler can re-connect to a new writer node. + * + *

Topology: changes to [new-writer, reader-A, reader-B] for taskB, taskA sees no changes. + * taskA: successfully re-connect to writer; return connection to initial writer, but it takes more + * time than taskB. + * TaskB: successfully connect to readerA and then to new-writer. + * Expected test result: new connection to writer by taskB. + */ + @Test + public void testConnectToReaderA_SlowWriter() throws SQLException { + when(mockPluginService.forceConnect(refEq(writer), eq(properties))) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(5000); + return mockWriterConnection; + }); + when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); + when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenReturn(mockNewWriterConnection); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))).thenReturn(newTopology); + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); + final WriterFailoverResult result = target.failover(topology); + + assertTrue(result.isConnected()); + assertTrue(result.isNewHost()); + assertSame(result.getNewConnection(), mockNewWriterConnection); + assertEquals(3, result.getTopology().size()); + assertEquals("new-writer-host", result.getTopology().get(0).getHost()); + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); + } + + /** + * Verify that writer failover handler can re-connect to a new writer node. + * + *

Topology: changes to [new-writer, initial-writer, reader-A, reader-B]. + * TaskA: successfully reconnect, but initial-writer is now a reader (defer to taskB). + * TaskB: successfully connect to readerA and then to new-writer. + * Expected test result: new connection to writer by taskB. + */ + @Test + public void testConnectToReaderA_taskADefers() throws SQLException { + when(mockPluginService.forceConnect(writer, properties)).thenReturn(mockConnection); + when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); + when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(5000); + return mockNewWriterConnection; + }); + + final List newTopology = Arrays.asList(newWriterHost, writer, readerA, readerB); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))).thenReturn(newTopology); + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(60000, 5000, 5000); + final WriterFailoverResult result = target.failover(topology); + + assertTrue(result.isConnected()); + assertTrue(result.isNewHost()); + assertSame(result.getNewConnection(), mockNewWriterConnection); + assertEquals(4, result.getTopology().size()); + assertEquals("new-writer-host", result.getTopology().get(0).getHost()); + + verify(mockHostListProvider, atLeastOnce()).getCurrentTopology(any(Connection.class), eq(mockInitialHostSpec)); + + assertEquals(HostAvailability.AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); + } + + /** + * Verify that writer failover handler fails to re-connect to any writer node. + * + *

Topology: no changes seen by task A, changes to [new-writer, reader-A, reader-B] for taskB. + * TaskA: fail to re-connect to writer due to failover timeout. + * TaskB: successfully connect to readerA and then fail to connect to writer due to failover timeout. + * Expected test result: no connection. + */ + @Test + public void testFailedToConnect_failoverTimeout() throws SQLException { + when(mockPluginService.forceConnect(refEq(writer), eq(properties))) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(30000); + return mockWriterConnection; + }); + when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); + when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))) + .thenAnswer( + (Answer) + invocation -> { + Thread.sleep(30000); + return mockNewWriterConnection; + }); + when(mockHostListProvider.getCurrentTopology(any(), eq(mockInitialHostSpec))).thenReturn(newTopology); + + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); + + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); + + final long startTimeNano = System.nanoTime(); + final WriterFailoverResult result = target.failover(topology); + final long durationNano = System.nanoTime() - startTimeNano; + + assertFalse(result.isConnected()); + assertFalse(result.isNewHost()); + + verify(mockHostListProvider, atLeastOnce()).getCurrentTopology(any(Connection.class), eq(mockInitialHostSpec)); + + // 5s is a max allowed failover timeout; add 1s for inaccurate measurements + assertTrue(TimeUnit.NANOSECONDS.toMillis(durationNano) < 6000); + } + + /** + * Verify that writer failover handler fails to re-connect to any writer node. + * + *

Topology: changes to [new-writer, reader-A, reader-B] for taskB. + * TaskA: fail to re-connect to writer due to exception. + * TaskB: successfully connect to readerA and then fail to connect to writer due to exception. + * Expected test result: no connection. + */ + @Test + public void testFailedToConnect_taskAException_taskBWriterException() throws SQLException { + final SQLException exception = new SQLException("exception", "08S01", null); + when(mockPluginService.forceConnect(refEq(writer), eq(properties))).thenThrow(exception); + when(mockPluginService.forceConnect(refEq(readerA), eq(properties))).thenReturn(mockReaderAConnection); + when(mockPluginService.forceConnect(refEq(readerB), eq(properties))).thenReturn(mockReaderBConnection); + when(mockPluginService.forceConnect(refEq(newWriterHost), eq(properties))).thenThrow(exception); + when(mockPluginService.isNetworkException(eq(exception), any())).thenReturn(true); + + when(mockTopologyUtils.queryForTopology( + any(), eq(mockInitialHostSpec), eq(mockInstanceTemplate))).thenReturn(newTopology); + + when(mockReaderFailoverHandler.getReaderConnection(ArgumentMatchers.anyList())) + .thenReturn(new ReaderFailoverResult(mockReaderAConnection, readerA, true)); + + when(mockPluginService.getDialect()).thenReturn(mockDialect); + when(mockDialect.getFailoverRestrictions()).thenReturn(EnumSet.noneOf(FailoverRestriction.class)); + + final ClusterAwareWriterFailoverHandler target = getSpyFailoverHandler(5000, 2000, 2000); + final WriterFailoverResult result = target.failover(topology); + + assertFalse(result.isConnected()); + assertFalse(result.isNewHost()); + + assertEquals(HostAvailability.NOT_AVAILABLE, target.getHostAvailabilityMap().get(newWriterHost.getHost())); + } +}