Implement refactoring improvements and adapt topology and custom endpoint caches and monitors (#1371)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: aaron-congo

CHANGELOG.md

@@ -304,7 +304,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### :magic_wand: Added
 - Developer plugin to help test various scenarios including events like network outages and database cluster failover. This plugin is NOT intended to be used in production environments and is only for testing ([PR #531](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/531)).
 - Documentation:
-  - Developer plugin. See [UsingTheJdbcDriver](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins) and [UsingTheDeveloperPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheDeveloperPlugin.md).
+  - Developer plugin. See [UsingTheJdbcDriver](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins) and [UsingTheDeveloperPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheDeveloperPlugin.md).
   - MySQL code samples ([PR #532](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/532)).
   - Add a Table of Contents section for the sample codes on README.md. See [README.md](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/README.md#examples).
   - Sample tutorial and code example for Vert.x. See the [tutorial](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/examples/VertxExample/README.md) and [code example](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/examples/VertxExample/src/main/java/com/example/starter/MainVerticle.java).

README.md

@@ -86,7 +86,7 @@ You can find our driver by searching in The Central Repository with GroupId and
 | `failureDetectionEnabled`              |                           `HostMonitoringConnectionPlugin.FAILURE_DETECTION_ENABLED`                           |              [HostMonitoringPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)               |
 | `failureDetectionInterval`             |                          `HostMonitoringConnectionPlugin.FAILURE_DETECTION_INTERVAL`                           |              [HostMonitoringPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)               |
 | `failureDetectionTime`                 |                            `HostMonitoringConnectionPlugin.FAILURE_DETECTION_TIME`                             |              [HostMonitoringPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)               |
-| `monitorDisposalTime`                  |                                 `MonitorServiceImpl.MONITOR_DISPOSAL_TIME_MS`                                  |              [HostMonitoringPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)               |
+| `monitorDisposalTime`                  |                               `HostMonitorServiceImpl.MONITOR_DISPOSAL_TIME_MS`                                |              [HostMonitoringPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)               |
 | `iamDefaultPort`                       |                                   `IamAuthConnectionPlugin.IAM_DEFAULT_PORT`                                   |           [IamAuthenticationPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)            |
 | `iamHost`                              |                                       `IamAuthConnectionPlugin.IAM_HOST`                                       |           [IamAuthenticationPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)            |
 | `iamRegion`                            |                                      `IamAuthConnectionPlugin.IAM_REGION`                                      |           [IamAuthenticationPlugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)            |

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/ConnectionPluginManagerBenchmarks.java

@@ -65,15 +65,16 @@
 import software.amazon.jdbc.benchmarks.testplugin.BenchmarkPluginFactory;
 import software.amazon.jdbc.dialect.Dialect;
 import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy;
+import software.amazon.jdbc.profile.ConfigurationProfile;
+import software.amazon.jdbc.profile.ConfigurationProfileBuilder;
+import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
+import software.amazon.jdbc.util.FullServicesContainer;
 import software.amazon.jdbc.util.telemetry.DefaultTelemetryFactory;
 import software.amazon.jdbc.util.telemetry.GaugeCallable;
 import software.amazon.jdbc.util.telemetry.TelemetryContext;
 import software.amazon.jdbc.util.telemetry.TelemetryCounter;
 import software.amazon.jdbc.util.telemetry.TelemetryFactory;
 import software.amazon.jdbc.util.telemetry.TelemetryGauge;
-import software.amazon.jdbc.profile.ConfigurationProfile;
-import software.amazon.jdbc.profile.ConfigurationProfileBuilder;
-import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
 import software.amazon.jdbc.wrapper.ConnectionWrapper;
 
 @State(Scope.Benchmark)
@@ -94,6 +95,7 @@ public class ConnectionPluginManagerBenchmarks {
 
   @Mock ConnectionProvider mockConnectionProvider;
   @Mock ConnectionWrapper mockConnectionWrapper;
+  @Mock FullServicesContainer mockServicesContainer;
   @Mock PluginService mockPluginService;
   @Mock PluginManagerService mockPluginManagerService;
   @Mock TelemetryFactory mockTelemetryFactory;
@@ -138,6 +140,7 @@ public void setUpIteration() throws Exception {
     when(mockResultSet.getString(eq(FIELD_SESSION_ID))).thenReturn(WRITER_SESSION_ID);
     when(mockResultSet.getString(eq(FIELD_SERVER_ID)))
         .thenReturn("myInstance1.domain.com", "myInstance2.domain.com", "myInstance3.domain.com");
+    when(mockServicesContainer.getPluginService()).thenReturn(mockPluginService);
     when(mockPluginService.getCurrentConnection()).thenReturn(mockConnection);
     when(mockPluginService.getTelemetryFactory()).thenReturn(mockTelemetryFactory);
 
@@ -163,11 +166,11 @@ public void setUpIteration() throws Exception {
         null,
         mockConnectionWrapper,
         telemetryFactory);
-    pluginManager.init(mockPluginService, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
+    pluginManager.init(mockServicesContainer, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
 
     pluginManagerWithNoPlugins = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, telemetryFactory);
-    pluginManagerWithNoPlugins.init(mockPluginService, propertiesWithoutPlugins, mockPluginManagerService, null);
+    pluginManagerWithNoPlugins.init(mockServicesContainer, propertiesWithoutPlugins, mockPluginManagerService, null);
   }
 
   @TearDown(Level.Iteration)
@@ -179,15 +182,15 @@ public void tearDownIteration() throws Exception {
   public ConnectionPluginManager initConnectionPluginManagerWithNoPlugins() throws SQLException {
     final ConnectionPluginManager manager = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, mockTelemetryFactory);
-    manager.init(mockPluginService, propertiesWithoutPlugins, mockPluginManagerService, configurationProfile);
+    manager.init(mockServicesContainer, propertiesWithoutPlugins, mockPluginManagerService, configurationProfile);
     return manager;
   }
 
   @Benchmark
   public ConnectionPluginManager initConnectionPluginManagerWithPlugins() throws SQLException {
     final ConnectionPluginManager manager = new ConnectionPluginManager(mockConnectionProvider, null,
         mockConnectionWrapper, mockTelemetryFactory);
-    manager.init(mockPluginService, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
+    manager.init(mockServicesContainer, propertiesWithPlugins, mockPluginManagerService, configurationProfile);
     return manager;
   }
 

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/PluginBenchmarks.java

@@ -63,6 +63,9 @@
 import software.amazon.jdbc.dialect.Dialect;
 import software.amazon.jdbc.hostavailability.SimpleHostAvailabilityStrategy;
 import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
+import software.amazon.jdbc.util.connection.ConnectionService;
+import software.amazon.jdbc.util.monitoring.MonitorService;
+import software.amazon.jdbc.util.storage.StorageService;
 import software.amazon.jdbc.util.telemetry.GaugeCallable;
 import software.amazon.jdbc.util.telemetry.TelemetryContext;
 import software.amazon.jdbc.util.telemetry.TelemetryCounter;
@@ -89,7 +92,11 @@ public class PluginBenchmarks {
   private final HostSpec writerHostSpec = new HostSpecBuilder(new SimpleHostAvailabilityStrategy())
       .host(TEST_HOST).port(TEST_PORT).build();
 
+  @Mock private StorageService mockStorageService;
+  @Mock private MonitorService mockMonitorService;
+  @Mock private ConnectionService mockConnectionService;
   @Mock private PluginService mockPluginService;
+  @Mock private TargetDriverDialect mockTargetDriverDialect;
   @Mock private Dialect mockDialect;
   @Mock private ConnectionPluginManager mockConnectionPluginManager;
   @Mock private TelemetryFactory mockTelemetryFactory;
@@ -158,59 +165,48 @@ public void initAndReleaseBaseLine() {
 
   @Benchmark
   public ConnectionWrapper initAndReleaseWithExecutionTimePlugin() throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useExecutionTimePlugin(),
-        CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper = getConnectionWrapper(useExecutionTimePlugin(), CONNECTION_STRING)) {
       wrapper.releaseResources();
       return wrapper;
     }
   }
 
-  @Benchmark
-  public ConnectionWrapper initAndReleaseWithAuroraHostListPlugin() throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useAuroraHostListPlugin(),
-        CONNECTION_STRING,
+  private ConnectionWrapper getConnectionWrapper(Properties props, String connString) throws SQLException {
+    return new TestConnectionWrapper(
+        props,
+        connString,
+        mockConnectionProvider,
+        mockTargetDriverDialect,
         mockConnectionPluginManager,
         mockTelemetryFactory,
         mockPluginService,
         mockHostListProviderService,
-        mockPluginManagerService)) {
+        mockPluginManagerService,
+        mockStorageService,
+        mockMonitorService,
+        mockConnectionService);
+  }
+
+  @Benchmark
+  public ConnectionWrapper initAndReleaseWithAuroraHostListPlugin() throws SQLException {
+    try (ConnectionWrapper wrapper = getConnectionWrapper(useAuroraHostListPlugin(), CONNECTION_STRING)) {
       wrapper.releaseResources();
       return wrapper;
     }
   }
 
   @Benchmark
   public ConnectionWrapper initAndReleaseWithExecutionTimeAndAuroraHostListPlugins() throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useExecutionTimeAndAuroraHostListPlugins(),
-        CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper =
+             getConnectionWrapper(useExecutionTimeAndAuroraHostListPlugins(), CONNECTION_STRING)) {
       wrapper.releaseResources();
       return wrapper;
     }
   }
 
   @Benchmark
   public ConnectionWrapper initAndReleaseWithReadWriteSplittingPlugin() throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useReadWriteSplittingPlugin(),
-        CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper = getConnectionWrapper(useReadWriteSplittingPlugin(), CONNECTION_STRING)) {
       wrapper.releaseResources();
       return wrapper;
     }
@@ -219,14 +215,8 @@ public ConnectionWrapper initAndReleaseWithReadWriteSplittingPlugin() throws SQL
   @Benchmark
   public ConnectionWrapper initAndReleaseWithAuroraHostListAndReadWriteSplittingPlugin()
       throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useAuroraHostListAndReadWriteSplittingPlugin(),
-        PG_CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper =
+             getConnectionWrapper(useAuroraHostListAndReadWriteSplittingPlugin(), PG_CONNECTION_STRING)) {
       wrapper.releaseResources();
       return wrapper;
     }
@@ -237,14 +227,7 @@ public ConnectionWrapper initAndReleaseWithReadWriteSplittingPlugin_internalConn
     HikariPooledConnectionProvider provider =
         new HikariPooledConnectionProvider((hostSpec, props) -> new HikariConfig());
     Driver.setCustomConnectionProvider(provider);
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useReadWriteSplittingPlugin(),
-        CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper = getConnectionWrapper(useReadWriteSplittingPlugin(), CONNECTION_STRING)) {
       wrapper.releaseResources();
       ConnectionProviderManager.releaseResources();
       Driver.resetCustomConnectionProvider();
@@ -258,14 +241,8 @@ public ConnectionWrapper initAndReleaseWithAuroraHostListAndReadWriteSplittingPl
     HikariPooledConnectionProvider provider =
         new HikariPooledConnectionProvider((hostSpec, props) -> new HikariConfig());
     Driver.setCustomConnectionProvider(provider);
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useAuroraHostListAndReadWriteSplittingPlugin(),
-        PG_CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService)) {
+    try (ConnectionWrapper wrapper = getConnectionWrapper(
+        useAuroraHostListAndReadWriteSplittingPlugin(), PG_CONNECTION_STRING)) {
       wrapper.releaseResources();
       ConnectionProviderManager.releaseResources();
       Driver.resetCustomConnectionProvider();
@@ -275,14 +252,7 @@ public ConnectionWrapper initAndReleaseWithAuroraHostListAndReadWriteSplittingPl
 
   @Benchmark
   public Statement executeStatementBaseline() throws SQLException {
-    try (ConnectionWrapper wrapper = new TestConnectionWrapper(
-        useExecutionTimePlugin(),
-        CONNECTION_STRING,
-        mockConnectionPluginManager,
-        mockTelemetryFactory,
-        mockPluginService,
-        mockHostListProviderService,
-        mockPluginManagerService);
+    try (ConnectionWrapper wrapper = getConnectionWrapper(useExecutionTimePlugin(), CONNECTION_STRING);
          Statement statement = wrapper.createStatement()) {
       return statement;
     }
@@ -291,14 +261,7 @@ public Statement executeStatementBaseline() throws SQLException {
   @Benchmark
   public ResultSet executeStatementWithExecutionTimePlugin() throws SQLException {
     try (
-        ConnectionWrapper wrapper = new TestConnectionWrapper(
-            useExecutionTimePlugin(),
-            CONNECTION_STRING,
-            mockConnectionPluginManager,
-            mockTelemetryFactory,
-            mockPluginService,
-            mockHostListProviderService,
-            mockPluginManagerService);
+        ConnectionWrapper wrapper = getConnectionWrapper(useExecutionTimePlugin(), CONNECTION_STRING);
         Statement statement = wrapper.createStatement();
         ResultSet resultSet = statement.executeQuery("some sql")) {
       return resultSet;
@@ -308,14 +271,7 @@ public ResultSet executeStatementWithExecutionTimePlugin() throws SQLException {
   @Benchmark
   public ResultSet executeStatementWithTelemetryDisabled() throws SQLException {
     try (
-        ConnectionWrapper wrapper = new TestConnectionWrapper(
-            disabledTelemetry(),
-            CONNECTION_STRING,
-            mockConnectionPluginManager,
-            mockTelemetryFactory,
-            mockPluginService,
-            mockHostListProviderService,
-            mockPluginManagerService);
+        ConnectionWrapper wrapper = getConnectionWrapper(disabledTelemetry(), CONNECTION_STRING);
         Statement statement = wrapper.createStatement();
         ResultSet resultSet = statement.executeQuery("some sql")) {
       return resultSet;
@@ -325,14 +281,7 @@ public ResultSet executeStatementWithTelemetryDisabled() throws SQLException {
   @Benchmark
   public ResultSet executeStatementWithTelemetry() throws SQLException {
     try (
-        ConnectionWrapper wrapper = new TestConnectionWrapper(
-            useTelemetry(),
-            CONNECTION_STRING,
-            mockConnectionPluginManager,
-            mockTelemetryFactory,
-            mockPluginService,
-            mockHostListProviderService,
-            mockPluginManagerService);
+        ConnectionWrapper wrapper = getConnectionWrapper(useTelemetry(), CONNECTION_STRING);
         Statement statement = wrapper.createStatement();
         ResultSet resultSet = statement.executeQuery("some sql")) {
       return resultSet;

benchmarks/src/jmh/java/software/amazon/jdbc/benchmarks/testplugin/TestConnectionWrapper.java

@@ -20,24 +20,44 @@
 import java.util.Properties;
 import org.checkerframework.checker.nullness.qual.NonNull;
 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.targetdriverdialect.TargetDriverDialect;
+import software.amazon.jdbc.util.connection.ConnectionService;
+import software.amazon.jdbc.util.monitoring.MonitorService;
+import software.amazon.jdbc.util.storage.StorageService;
 import software.amazon.jdbc.util.telemetry.TelemetryFactory;
 import software.amazon.jdbc.wrapper.ConnectionWrapper;
 
 // Test class allowing for mocks to be used with ConnectionWrapper logic
 public class TestConnectionWrapper extends ConnectionWrapper {
 
-  public TestConnectionWrapper(@NonNull Properties props,
-      @NonNull String url,
-      @NonNull ConnectionPluginManager connectionPluginManager,
+  public TestConnectionWrapper(
+      @NonNull final Properties props,
+      @NonNull final String url,
+      @NonNull final ConnectionProvider defaultConnectionProvider,
+      @NonNull final TargetDriverDialect driverDialect,
+      @NonNull final ConnectionPluginManager connectionPluginManager,
       @NonNull final TelemetryFactory telemetryFactory,
-      @NonNull PluginService pluginService,
-      @NonNull HostListProviderService hostListProviderService,
-      @NonNull PluginManagerService pluginManagerService)
+      @NonNull final PluginService pluginService,
+      @NonNull final HostListProviderService hostListProviderService,
+      @NonNull final PluginManagerService pluginManagerService,
+      @NonNull final StorageService storageService,
+      @NonNull final MonitorService monitorService,
+      @NonNull final ConnectionService connectionService)
       throws SQLException {
-    super(props, url, connectionPluginManager, telemetryFactory, pluginService, hostListProviderService,
-        pluginManagerService);
+    super(
+        props,
+        url,
+        defaultConnectionProvider,
+        driverDialect,
+        connectionPluginManager,
+        telemetryFactory,
+        pluginService,
+        hostListProviderService,
+        pluginManagerService,
+        storageService, monitorService, connectionService);
   }
 }