Move the connection wrapping to the driver api

vietj · vietj · commit ca464a53effe · 2021-12-08T12:01:49.000+01:00
diff --git a/vertx-db2-client/src/main/java/io/vertx/db2client/impl/DB2PoolImpl.java b/vertx-db2-client/src/main/java/io/vertx/db2client/impl/DB2PoolImpl.java
@@ -18,7 +18,6 @@
 import io.vertx.core.Future;
 import io.vertx.core.Handler;
 import io.vertx.core.impl.CloseFuture;
-import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.db2client.DB2ConnectOptions;
@@ -27,10 +26,8 @@
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
 import io.vertx.sqlclient.SqlConnection;
-import io.vertx.sqlclient.impl.Connection;
 import io.vertx.sqlclient.impl.PoolBase;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
-import io.vertx.sqlclient.spi.ConnectionFactory;
 
 import java.util.function.Supplier;
 
@@ -40,12 +37,6 @@ public DB2PoolImpl(VertxInternal vertx, int pipeliningLimit, PoolOptions poolOpt
     super(vertx, DB2Driver.INSTANCE, baseConnectOptions, connectOptionsProvider, tracer, metrics, pipeliningLimit, poolOptions, closeFuture);
   }
 
-  @SuppressWarnings("rawtypes")
-  @Override
-  protected DB2ConnectionImpl wrap(ContextInternal context, ConnectionFactory factory, Connection conn) {
-    return new DB2ConnectionImpl(context, factory, conn, tracer, metrics);
-  }
-
   @Override
   public DB2Pool connectHandler(Handler<SqlConnection> handler) {
     return (DB2Pool) super.connectHandler(handler);
diff --git a/vertx-db2-client/src/main/java/io/vertx/db2client/spi/DB2Driver.java b/vertx-db2-client/src/main/java/io/vertx/db2client/spi/DB2Driver.java
@@ -17,16 +17,20 @@
 
 import io.vertx.core.Vertx;
 import io.vertx.core.impl.CloseFuture;
+import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.core.spi.metrics.VertxMetrics;
 import io.vertx.db2client.DB2ConnectOptions;
 import io.vertx.db2client.DB2Pool;
 import io.vertx.db2client.impl.DB2ConnectionFactory;
+import io.vertx.db2client.impl.DB2ConnectionImpl;
 import io.vertx.db2client.impl.DB2PoolImpl;
 import io.vertx.db2client.impl.Db2PoolOptions;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Connection;
+import io.vertx.sqlclient.impl.SqlConnectionInternal;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
 import io.vertx.sqlclient.spi.Driver;
 import io.vertx.sqlclient.spi.ConnectionFactory;
@@ -65,4 +69,9 @@ public boolean acceptsOptions(SqlConnectOptions options) {
   public ConnectionFactory createConnectionFactory(Vertx vertx, SqlConnectOptions database) {
     return new DB2ConnectionFactory((VertxInternal) vertx, DB2ConnectOptions.wrap(database));
   }
+
+  @Override
+  public SqlConnectionInternal wrapConnection(ContextInternal context, ConnectionFactory factory, Connection conn, QueryTracer tracer, ClientMetrics metrics) {
+    return new DB2ConnectionImpl(context, factory, conn, tracer, metrics);
+  }
 }
diff --git a/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/impl/MSSQLPoolImpl.java b/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/impl/MSSQLPoolImpl.java
@@ -14,7 +14,6 @@
 import io.vertx.core.Future;
 import io.vertx.core.Handler;
 import io.vertx.core.impl.CloseFuture;
-import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.mssqlclient.MSSQLConnectOptions;
@@ -23,10 +22,8 @@
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
 import io.vertx.sqlclient.SqlConnection;
-import io.vertx.sqlclient.impl.Connection;
 import io.vertx.sqlclient.impl.PoolBase;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
-import io.vertx.sqlclient.spi.ConnectionFactory;
 
 import java.util.function.Supplier;
 
@@ -36,11 +33,6 @@ public MSSQLPoolImpl(VertxInternal vertx, MSSQLConnectOptions baseConnectOptions
     super(vertx, MSSQLDriver.INSTANCE, baseConnectOptions, connectOptionsProvider, tracer, metrics, 1, poolOptions, closeFuture);
   }
 
-  @Override
-  protected MSSQLConnectionImpl wrap(ContextInternal context, ConnectionFactory factory, Connection connection) {
-    return new MSSQLConnectionImpl(context, factory, connection, tracer, metrics);
-  }
-
   @Override
   public MSSQLPool connectHandler(Handler<SqlConnection> handler) {
     return (MSSQLPool) super.connectHandler(handler);
diff --git a/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/spi/MSSQLDriver.java b/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/spi/MSSQLDriver.java
@@ -17,15 +17,19 @@
 
 import io.vertx.core.Vertx;
 import io.vertx.core.impl.CloseFuture;
+import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.core.spi.metrics.VertxMetrics;
 import io.vertx.mssqlclient.MSSQLConnectOptions;
 import io.vertx.mssqlclient.MSSQLPool;
 import io.vertx.mssqlclient.impl.MSSQLConnectionFactory;
+import io.vertx.mssqlclient.impl.MSSQLConnectionImpl;
 import io.vertx.mssqlclient.impl.MSSQLPoolImpl;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Connection;
+import io.vertx.sqlclient.impl.SqlConnectionInternal;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
 import io.vertx.sqlclient.spi.Driver;
 import io.vertx.sqlclient.spi.ConnectionFactory;
@@ -68,4 +72,9 @@ public int appendQueryPlaceholder(StringBuilder queryBuilder, int index, int cur
     queryBuilder.append('@').append('P').append(1 + index);
     return index;
   }
+
+  @Override
+  public SqlConnectionInternal wrapConnection(ContextInternal context, ConnectionFactory factory, Connection conn, QueryTracer tracer, ClientMetrics metrics) {
+    return new MSSQLConnectionImpl(context, factory, conn, tracer, metrics);
+  }
 }
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLPoolImpl.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLPoolImpl.java
@@ -14,7 +14,6 @@
 import io.vertx.core.Future;
 import io.vertx.core.Handler;
 import io.vertx.core.impl.CloseFuture;
-import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.mysqlclient.MySQLConnectOptions;
@@ -23,10 +22,8 @@
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
 import io.vertx.sqlclient.SqlConnection;
-import io.vertx.sqlclient.impl.Connection;
 import io.vertx.sqlclient.impl.PoolBase;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
-import io.vertx.sqlclient.spi.ConnectionFactory;
 
 import java.util.function.Supplier;
 
@@ -36,11 +33,6 @@ public MySQLPoolImpl(VertxInternal vertx, MySQLConnectOptions baseConnectOptions
     super(vertx, MySQLDriver.INSTANCE, baseConnectOptions, connectOptionsProvider, tracer, metrics, 1, poolOptions, closeFuture);
   }
 
-  @Override
-  protected MySQLConnectionImpl wrap(ContextInternal context, ConnectionFactory factory, Connection conn) {
-    return new MySQLConnectionImpl(context, factory, conn, tracer, metrics);
-  }
-
   @Override
   public MySQLPool connectHandler(Handler<SqlConnection> handler) {
     return (MySQLPool) super.connectHandler(handler);
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/spi/MySQLDriver.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/spi/MySQLDriver.java
@@ -17,15 +17,19 @@
 
 import io.vertx.core.Vertx;
 import io.vertx.core.impl.CloseFuture;
+import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.core.spi.metrics.VertxMetrics;
 import io.vertx.mysqlclient.MySQLConnectOptions;
 import io.vertx.mysqlclient.MySQLPool;
 import io.vertx.mysqlclient.impl.MySQLConnectionFactory;
+import io.vertx.mysqlclient.impl.MySQLConnectionImpl;
 import io.vertx.mysqlclient.impl.MySQLPoolImpl;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Connection;
+import io.vertx.sqlclient.impl.SqlConnectionInternal;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
 import io.vertx.sqlclient.spi.Driver;
 import io.vertx.sqlclient.spi.ConnectionFactory;
@@ -62,4 +66,9 @@ public boolean acceptsOptions(SqlConnectOptions options) {
   public ConnectionFactory createConnectionFactory(Vertx vertx, SqlConnectOptions database) {
     return new MySQLConnectionFactory((VertxInternal) vertx, MySQLConnectOptions.wrap(database));
   }
+
+  @Override
+  public SqlConnectionInternal wrapConnection(ContextInternal context, ConnectionFactory factory, Connection conn, QueryTracer tracer, ClientMetrics metrics) {
+    return new MySQLConnectionImpl(context, factory, conn, tracer, metrics);
+  }
 }
diff --git a/vertx-pg-client/src/main/java/io/vertx/pgclient/impl/PgPoolImpl.java b/vertx-pg-client/src/main/java/io/vertx/pgclient/impl/PgPoolImpl.java
@@ -19,17 +19,14 @@
 
 import io.vertx.core.Handler;
 import io.vertx.core.impl.CloseFuture;
-import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.pgclient.*;
 import io.vertx.pgclient.spi.PgDriver;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnection;
-import io.vertx.sqlclient.impl.Connection;
 import io.vertx.sqlclient.impl.PoolBase;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
-import io.vertx.sqlclient.spi.ConnectionFactory;
 
 /**
  * Todo :
@@ -46,11 +43,6 @@ public PgPoolImpl(VertxInternal vertx, PgConnectOptions baseConnectOptions, Quer
     super(vertx, PgDriver.INSTANCE, baseConnectOptions, null, tracer, metrics, pipeliningLimit, poolOptions, closeFuture);
   }
 
-  @Override
-  protected PgConnectionImpl wrap(ContextInternal context, ConnectionFactory factory, Connection conn) {
-    return new PgConnectionImpl((PgConnectionFactory) factory, context, conn, tracer, metrics);
-  }
-
   @Override
   public PgPool connectHandler(Handler<SqlConnection> handler) {
     return (PgPool) super.connectHandler(handler);
diff --git a/vertx-pg-client/src/main/java/io/vertx/pgclient/spi/PgDriver.java b/vertx-pg-client/src/main/java/io/vertx/pgclient/spi/PgDriver.java
@@ -2,16 +2,20 @@
 
 import io.vertx.core.Vertx;
 import io.vertx.core.impl.CloseFuture;
+import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.core.spi.metrics.VertxMetrics;
 import io.vertx.pgclient.PgConnectOptions;
 import io.vertx.pgclient.PgPool;
 import io.vertx.pgclient.impl.PgConnectionFactory;
+import io.vertx.pgclient.impl.PgConnectionImpl;
 import io.vertx.pgclient.impl.PgPoolImpl;
 import io.vertx.pgclient.impl.PgPoolOptions;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Connection;
+import io.vertx.sqlclient.impl.SqlConnectionInternal;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
 import io.vertx.sqlclient.spi.Driver;
 import io.vertx.sqlclient.spi.ConnectionFactory;
@@ -56,4 +60,9 @@ public int appendQueryPlaceholder(StringBuilder queryBuilder, int index, int cur
     queryBuilder.append('$').append(1 + index);
     return index;
   }
+
+  @Override
+  public SqlConnectionInternal wrapConnection(ContextInternal context, ConnectionFactory factory, Connection conn, QueryTracer tracer, ClientMetrics metrics) {
+    return new PgConnectionImpl((PgConnectionFactory) factory, context, conn, tracer, metrics);
+  }
 }
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/PoolBase.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/PoolBase.java
@@ -30,7 +30,6 @@
 import io.vertx.sqlclient.impl.command.CommandBase;
 import io.vertx.sqlclient.impl.pool.SqlConnectionPool;
 import io.vertx.sqlclient.impl.tracing.QueryTracer;
-import io.vertx.sqlclient.spi.ConnectionFactory;
 import io.vertx.sqlclient.spi.Driver;
 
 import java.util.List;
@@ -147,7 +146,7 @@ public Future<SqlConnection> getConnection() {
       });
     }
     return promise.future().map(conn -> {
-      SqlConnectionBase wrapper = wrap(current, conn.factory(), conn);
+      SqlConnectionInternal wrapper = driver.wrapConnection(current, conn.factory(), conn, tracer, metrics);
       conn.init(wrapper);
       return wrapper;
     });
@@ -176,8 +175,6 @@ private void acquire(ContextInternal context, long timeout, Handler<AsyncResult<
     pool.acquire(context, timeout, completionHandler);
   }
 
-  protected abstract SqlConnectionBase wrap(ContextInternal context, ConnectionFactory factory, Connection conn);
-
   @Override
   public void close(Promise<Void> completion) {
     doClose().onComplete(completion);
@@ -200,7 +197,7 @@ public Pool connectHandler(Handler<SqlConnection> handler) {
     if (handler != null) {
       connectionInitializer = conn -> {
         ContextInternal current = vertx.getContext();
-        SqlConnectionBase wrapper = wrap(current, conn.factory(), conn);
+        SqlConnectionInternal wrapper = driver.wrapConnection(current, conn.factory(), conn, tracer, metrics);
         conn.init(wrapper);
         current.dispatch(wrapper, handler);
       };
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/SqlConnectionBase.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/SqlConnectionBase.java
@@ -36,7 +36,7 @@
 /**
  * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
  */
-public class SqlConnectionBase<C extends SqlConnectionBase<C>> extends SqlClientBase implements SqlConnection, Connection.Holder {
+public class SqlConnectionBase<C extends SqlConnectionBase<C>> extends SqlClientBase implements SqlConnectionInternal {
 
   private volatile Handler<Throwable> exceptionHandler;
   private volatile Handler<Void> closeHandler;
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/SqlConnectionInternal.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/SqlConnectionInternal.java
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2011-2021 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+ */
+package io.vertx.sqlclient.impl;
+
+import io.vertx.sqlclient.SqlConnection;
+
+public interface SqlConnectionInternal extends SqlConnection, Connection.Holder {
+}
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/spi/Driver.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/spi/Driver.java
@@ -21,9 +21,14 @@
 import io.vertx.core.impl.CloseFuture;
 import io.vertx.core.impl.ContextInternal;
 import io.vertx.core.impl.VertxInternal;
+import io.vertx.core.spi.metrics.ClientMetrics;
 import io.vertx.sqlclient.Pool;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Connection;
+import io.vertx.sqlclient.impl.SqlConnectionBase;
+import io.vertx.sqlclient.impl.SqlConnectionInternal;
+import io.vertx.sqlclient.impl.tracing.QueryTracer;
 
 import java.util.List;
 
@@ -131,4 +136,8 @@ default int appendQueryPlaceholder(StringBuilder queryBuilder, int index, int cu
     queryBuilder.append("?");
     return current;
   }
+
+  default SqlConnectionInternal wrapConnection(ContextInternal context, ConnectionFactory factory, Connection conn, QueryTracer tracer, ClientMetrics metrics) {
+    return new SqlConnectionBase<>(context, factory, conn, this, tracer, metrics);
+  }
 }
