Add DataSourcePoolNewConnectionListener to set up newly created connection by DataSourcePool.

Author: Ryszard-Trojnacki

ebean-datasource-api/src/main/java/io/ebean/datasource/DataSourceBuilder.java

@@ -379,6 +379,11 @@ default DataSourceBuilder listener(DataSourcePoolListener listener) {
   @Deprecated(forRemoval = true)
   DataSourceBuilder setListener(DataSourcePoolListener listener);
 
+  /**
+   * Set the connection listener to use.
+   */
+  DataSourceBuilder connectionListener(DataSourcePoolNewConnectionListener connectionListener);
+
   /**
    * Set a SQL statement used to test the database is accessible.
    * <p>
@@ -933,6 +938,11 @@ default String driverClassName() {
      */
     DataSourcePoolListener getListener();
 
+    /**
+     * Return the new connection listener to use.
+     */
+    DataSourcePoolNewConnectionListener getConnectionListener();
+
     /**
      * Return a SQL statement used to test the database is accessible.
      * <p>

ebean-datasource-api/src/main/java/io/ebean/datasource/DataSourceConfig.java

@@ -84,6 +84,7 @@ public class DataSourceConfig implements DataSourceBuilder.Settings {
   private List<String> initSql;
   private DataSourceAlert alert;
   private DataSourcePoolListener listener;
+  private DataSourcePoolNewConnectionListener connectionListener;
   private Properties clientInfo;
   private String applicationName;
   private boolean shutdownOnJvmExit;
@@ -477,6 +478,17 @@ public DataSourceConfig setListener(DataSourcePoolListener listener) {
     return this;
   }
 
+  @Override
+  public DataSourcePoolNewConnectionListener getConnectionListener() {
+    return connectionListener;
+  }
+
+  @Override
+  public DataSourceBuilder connectionListener(DataSourcePoolNewConnectionListener connectionListener) {
+    this.connectionListener= connectionListener;
+    return this;
+  }
+
   @Override
   public String getHeartbeatSql() {
     return heartbeatSql;

ebean-datasource-api/src/main/java/io/ebean/datasource/DataSourcePoolNewConnectionListener.java

@@ -0,0 +1,21 @@
+package io.ebean.datasource;
+
+import java.sql.Connection;
+
+/**
+ * A {@link DataSourcePool} listener which allows you to hook on the create connections process of the pool.
+ */
+public interface DataSourcePoolNewConnectionListener {
+  /**
+   * Called after a connection has been created, before any initialization.
+   * @param connection the created connection
+   */
+  default void onCreatedConnection(Connection connection) {}
+
+  /**
+   * Called after a connection has been initialized (after onCreatedConnection) and all settings applied.
+   * @param connection the created connection
+   */
+  default void onAfterInitialized(Connection connection) {}
+
+}

ebean-datasource/src/main/java/io/ebean/datasource/pool/ConnectionPool.java

@@ -46,6 +46,7 @@ interface Heartbeat {
    */
   private final DataSourceAlert notify;
   private final DataSourcePoolListener poolListener;
+  private final DataSourcePoolNewConnectionListener connectionListener;
   private final List<String> initSql;
   private final String user;
   private final String schema;
@@ -109,6 +110,7 @@ interface Heartbeat {
     this.name = name;
     this.notify = params.getAlert();
     this.poolListener = params.getListener();
+    this.connectionListener = params.getConnectionListener();
     this.autoCommit = params.isAutoCommit();
     this.readOnly = params.isReadOnly();
     this.failOnStart = params.isFailOnStart();
@@ -434,6 +436,9 @@ private void testConnection() {
    * Initializes the connection we got from the driver.
    */
   private Connection initConnection(Connection conn) throws SQLException {
+    if(connectionListener!=null) {
+      connectionListener.onCreatedConnection(conn);
+    }
     conn.setAutoCommit(autoCommit);
     // isolation level is set globally for all connections (at least for H2) and
     // you will need admin rights - so we do not change it, if it already matches.
@@ -470,6 +475,9 @@ private Connection initConnection(Connection conn) throws SQLException {
         }
       }
     }
+    if(connectionListener!=null) {
+      connectionListener.onAfterInitialized(conn);
+    }
     return conn;
   }
 

ebean-datasource/src/test/java/io/ebean/datasource/pool/ConnectionPoolNewConnectionListenerTest.java

@@ -0,0 +1,112 @@
+package io.ebean.datasource.pool;
+
+import io.ebean.datasource.DataSourceConfig;
+import io.ebean.datasource.DataSourcePoolNewConnectionListener;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
+
+import java.sql.Connection;
+import java.util.HashMap;
+import static org.junit.jupiter.api.Assertions.*;
+
+class ConnectionPoolNewConnectionListenerTest {
+  private ConnectionPool pool;
+
+  private final HashMap<Connection, Integer> createdConnections = new HashMap<>();
+  private final HashMap<Connection, Integer> afterConnections = new HashMap<>();
+
+  ConnectionPoolNewConnectionListenerTest() {
+    pool = createPool();
+  }
+
+
+  private ConnectionPool createPool() {
+
+    DataSourceConfig config = new DataSourceConfig();
+    config.setDriver("org.h2.Driver");
+    config.setUrl("jdbc:h2:mem:tests");
+    config.setUsername("sa");
+    config.setPassword("");
+    config.setMinConnections(1);
+    config.setMaxConnections(5);
+    config.connectionListener(new DataSourcePoolNewConnectionListener() {
+      @Override
+      public void onCreatedConnection(Connection connection) {
+        synchronized (createdConnections) {
+          createdConnections.put(connection, 1 + createdConnections.getOrDefault(connection, 0));
+          createdConnections.notifyAll();
+        }
+      }
+
+      @Override
+      public void onAfterInitialized(Connection connection) {
+        synchronized (afterConnections) {
+          afterConnections.put(connection, 1 + afterConnections.getOrDefault(connection, 0));
+          afterConnections.notifyAll();
+        }
+      }
+    });
+
+    return new ConnectionPool("initialize", config);
+  }
+
+  @AfterEach
+  public void after() {
+    pool.shutdown();
+  }
+
+  @Test
+  public void initializeNewConnectionTest() {
+    // Min connections is 1 so one should be created on pool initialization
+    synchronized (createdConnections) {
+      assertEquals(1, createdConnections.size());
+      assertEquals(1, afterConnections.size());
+    }
+
+    try (Connection connection = pool.getConnection()) {
+      assertNotNull(connection);
+      synchronized (createdConnections) {
+        assertEquals(1, createdConnections.size());
+      }
+      synchronized (afterConnections) {
+        assertEquals(1, afterConnections.size());
+      }
+    } catch (Exception e) {
+      fail(e.getMessage());
+    }
+
+    try (Connection connection = pool.getConnection()) {
+      assertNotNull(connection);
+      synchronized (createdConnections) {
+        assertEquals(1, createdConnections.size());
+      }
+      synchronized (afterConnections) {
+        assertEquals(1, afterConnections.size());
+      }
+
+      try (Connection connection2 = pool.getConnection()) {
+        assertNotNull(connection2);
+        synchronized (createdConnections) {
+          assertEquals(2, createdConnections.size());
+        }
+        synchronized (afterConnections) {
+          assertEquals(2, afterConnections.size());
+        }
+      }
+    } catch (Exception e) {
+      fail(e.getMessage());
+    }
+    synchronized (createdConnections) {
+      for (var entry : createdConnections.entrySet()) {
+        // It should be always 1
+        assertEquals(1, entry.getValue());
+      }
+    }
+    synchronized (afterConnections) {
+      for (var entry : afterConnections.entrySet()) {
+        // It should be always 1
+        assertEquals(1, entry.getValue());
+      }
+    }
+  }
+}