feat: add jitter to max lifetime in connection pool

Author: priyanshu-d11

vertx-sql-client/src/main/generated/io/vertx/sqlclient/PoolOptionsConverter.java

@@ -44,6 +44,11 @@ static void fromJson(Iterable<java.util.Map.Entry<String, Object>> json, PoolOpt
             obj.setMaxLifetime(((Number)member.getValue()).intValue());
           }
           break;
+        case "jitter":
+          if (member.getValue() instanceof Number) {
+            obj.setJitter(((Number)member.getValue()).intValue());
+          }
+          break;
         case "poolCleanerPeriod":
           if (member.getValue() instanceof Number) {
             obj.setPoolCleanerPeriod(((Number)member.getValue()).intValue());
@@ -93,6 +98,7 @@ static void toJson(PoolOptions obj, java.util.Map<String, Object> json) {
       json.put("maxLifetimeUnit", obj.getMaxLifetimeUnit().name());
     }
     json.put("maxLifetime", obj.getMaxLifetime());
+    json.put("jitter", obj.getJitter());
     json.put("poolCleanerPeriod", obj.getPoolCleanerPeriod());
     if (obj.getConnectionTimeoutUnit() != null) {
       json.put("connectionTimeoutUnit", obj.getConnectionTimeoutUnit().name());

vertx-sql-client/src/main/java/io/vertx/sqlclient/PoolOptions.java

@@ -93,6 +93,11 @@ public class PoolOptions {
    */
   public static final int DEFAULT_EVENT_LOOP_SIZE = 0;
 
+  /**
+   * Default jitter value = 0
+   */
+  public static final int DEFAULT_JITTER = 0;
+
   private int maxSize = DEFAULT_MAX_SIZE;
   private int maxWaitQueueSize = DEFAULT_MAX_WAIT_QUEUE_SIZE;
   private int idleTimeout = DEFAULT_IDLE_TIMEOUT;
@@ -105,6 +110,7 @@ public class PoolOptions {
   private boolean shared = DEFAULT_SHARED_POOL;
   private String name = DEFAULT_NAME;
   private int eventLoopSize = DEFAULT_EVENT_LOOP_SIZE;
+  private int jitter = DEFAULT_JITTER;
 
   public PoolOptions() {
   }
@@ -241,6 +247,29 @@ public PoolOptions setMaxLifetime(int maxLifetime) {
     return this;
   }
 
+  /**
+   * Get the jitter value that will be applied to maxLifetime.
+   *
+   * @return the jitter value in milliseconds
+   */
+  public int getJitter() {
+    return this.jitter;
+  }
+
+  /**
+   * Set the jitter value, to be applied to maxLifetime.
+   *
+   * @param jitter the jitter value
+   * @return a reference to this, so the API can be used fluently
+   */
+  public PoolOptions setJitter(int jitter) {
+    if (jitter < 0) {
+      throw new IllegalArgumentException("jitter must be >= 0");
+    }
+    this.jitter = jitter;
+    return this;
+  }
+
   /**
    * @return the connection pool cleaner period in ms.
    */

vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/pool/SqlConnectionPool.java

@@ -32,6 +32,7 @@
 import io.vertx.sqlclient.spi.DatabaseMetadata;
 
 import java.util.List;
+import java.util.concurrent.ThreadLocalRandom;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
@@ -56,6 +57,7 @@ public class SqlConnectionPool {
   private final boolean pipelined;
   private final long idleTimeout;
   private final long maxLifetime;
+  private final long jitter;
   private final int maxSize;
 
   public SqlConnectionPool(Function<Context, Future<SqlConnection>> connectionProvider,
@@ -66,6 +68,7 @@ public SqlConnectionPool(Function<Context, Future<SqlConnection>> connectionProv
                            VertxInternal vertx,
                            long idleTimeout,
                            long maxLifetime,
+                           long jitter,
                            int maxSize,
                            boolean pipelined,
                            int maxWaitQueueSize,
@@ -82,6 +85,7 @@ public SqlConnectionPool(Function<Context, Future<SqlConnection>> connectionProv
     this.pipelined = pipelined;
     this.idleTimeout = idleTimeout;
     this.maxLifetime = maxLifetime;
+    this.jitter = jitter;
     this.maxSize = maxSize;
     this.hook = hook;
     this.connectionProvider = connectionProvider;
@@ -309,7 +313,8 @@ public class PooledConnection implements Connection, Connection.Holder {
       this.factory = factory;
       this.conn = conn;
       this.listener = listener;
-      this.lifetimeEvictionTimestamp = maxLifetime > 0 ? System.currentTimeMillis() + maxLifetime : Long.MAX_VALUE;
+      long randomizedJitter = jitter > 0 ? ThreadLocalRandom.current().nextLong(-jitter, -jitter + 1) : 0;
+      this.lifetimeEvictionTimestamp = maxLifetime > 0 ? System.currentTimeMillis() + maxLifetime + randomizedJitter : Long.MAX_VALUE;
       refresh();
     }
 

vertx-sql-client/src/main/java/io/vertx/sqlclient/internal/pool/PoolImpl.java

@@ -49,6 +49,7 @@ public class PoolImpl extends SqlClientBase implements Pool, Closeable {
   private final long idleTimeout;
   private final long connectionTimeout;
   private final long maxLifetime;
+  private final long jitter;
   private final long cleanerPeriod;
   private final boolean pipelined;
   private final Handler<SqlConnection> connectionInitializer;
@@ -80,11 +81,12 @@ public PoolImpl(VertxInternal vertx,
     this.idleTimeout = MILLISECONDS.convert(poolOptions.getIdleTimeout(), poolOptions.getIdleTimeoutUnit());
     this.connectionTimeout = MILLISECONDS.convert(poolOptions.getConnectionTimeout(), poolOptions.getConnectionTimeoutUnit());
     this.maxLifetime = MILLISECONDS.convert(poolOptions.getMaxLifetime(), poolOptions.getMaxLifetimeUnit());
+    this.jitter = MILLISECONDS.convert(poolOptions.getJitter(), poolOptions.getMaxLifetimeUnit());
     this.cleanerPeriod = poolOptions.getPoolCleanerPeriod();
     this.timerID = -1L;
     this.pipelined = pipelined;
     this.vertx = vertx;
-    this.pool = new SqlConnectionPool(connectionProvider, poolMetrics, hook, afterAcquire, beforeRecycle, vertx, idleTimeout, maxLifetime, poolOptions.getMaxSize(), pipelined, poolOptions.getMaxWaitQueueSize(), poolOptions.getEventLoopSize());
+    this.pool = new SqlConnectionPool(connectionProvider, poolMetrics, hook, afterAcquire, beforeRecycle, vertx, idleTimeout, maxLifetime, jitter, poolOptions.getMaxSize(), pipelined, poolOptions.getMaxWaitQueueSize(), poolOptions.getEventLoopSize());
     this.closeFuture = closeFuture;
     this.connectionInitializer = connectionInitializer;
   }