[#2768] Help tracking the connection creator

We create an exception stack when we open a new connection,
so that we can log the stack trace and track more easily which
method we are using in case of error.

Author: DavideD

hibernate-reactive-core/src/main/java/org/hibernate/reactive/common/InternalStateAssertions.java

@@ -54,12 +54,12 @@ public static void assertCurrentThreadMatches(Thread expectedThread) {
 		}
 	}
 
-	public static void assertCurrentContextMatches(Object object, ContextInternal expectedContext) {
+	public static void assertCurrentContextMatches(Object object, ContextInternal expectedContext, Exception creationTrace) {
 		if ( ENFORCE ) {
 			final ContextInternal currentContext = ContextInternal.current();
 			Objects.requireNonNull( currentContext, "Current context cannot be null" );
 			if ( !currentContext.equals( expectedContext ) ) {
-				throw LOG.unexpectedContextDetected( object, expectedContext, currentContext );
+				throw LOG.unexpectedContextDetected( object, expectedContext, currentContext, creationTrace );
 			}
 		}
 	}

hibernate-reactive-core/src/main/java/org/hibernate/reactive/logging/impl/Log.java

@@ -274,8 +274,9 @@ public interface Log extends BasicLogger {
 	@Message(id = 86, value = "Error closing reactive connection")
 	void errorClosingConnection(@Cause Throwable throwable);
 
+	// createStack will help in tracking which method created the object
 	@Message(id = 88, value = "Expected to use the object %1$s on context %2$s but was %3$s")
-	HibernateException unexpectedContextDetected(Object obj, ContextInternal expectedContext, ContextInternal currentContext);
+	HibernateException unexpectedContextDetected(Object obj, ContextInternal expectedContext, ContextInternal currentContext, @Cause Exception createStack);
 
 	// Same method that exists in CoreMessageLogger
 	@LogMessage(level = WARN)

hibernate-reactive-core/src/main/java/org/hibernate/reactive/pool/impl/SqlClientConnection.java

@@ -58,6 +58,7 @@ public class SqlClientConnection implements ReactiveConnection {
 
 	private final SqlStatementLogger sqlStatementLogger;
 	private final SqlExceptionHelper sqlExceptionHelper;
+	private final Exception creationTrace;
 
 	private final Pool pool;
 	private final SqlConnection connection;
@@ -70,12 +71,15 @@ public class SqlClientConnection implements ReactiveConnection {
 			Pool pool,
 			SqlStatementLogger sqlStatementLogger,
 			SqlExceptionHelper sqlExceptionHelper,
-			ContextInternal connectionContext) {
+			ContextInternal connectionContext,
+			// Helps to figure out where and when the connection was created
+			Exception creationTrace) {
 		this.connectionContext = connectionContext;
 		this.pool = pool;
 		this.sqlStatementLogger = sqlStatementLogger;
 		this.connection = connection;
 		this.sqlExceptionHelper = sqlExceptionHelper;
+		this.creationTrace = creationTrace;
 		LOG.tracef( "Connection created for %1$s associated to context %2$s: ", connection, connectionContext );
 	}
 
@@ -348,7 +352,7 @@ public CompletionStage<RowSet<Row>> preparedQueryOutsideTransaction(String sql)
 	}
 
 	private void feedback(String sql) {
-		InternalStateAssertions.assertCurrentContextMatches( this, connectionContext );
+		InternalStateAssertions.assertCurrentContextMatches( this, connectionContext, creationTrace );
 		Objects.requireNonNull( sql, "SQL query cannot be null" );
 		// DDL already gets formatted by the client, so don't reformat it
 		FormatStyle formatStyle = sqlStatementLogger.isFormat() && !sql.contains( System.lineSeparator() )

hibernate-reactive-core/src/main/java/org/hibernate/reactive/pool/impl/SqlClientPool.java

@@ -125,16 +125,18 @@ public CompletionStage<ReactiveConnection> getConnection(String tenantId, SqlExc
 	}
 
 	private CompletionStage<ReactiveConnection> getConnectionFromPool(Pool pool) {
+		final Exception creationTrace = new Exception();
 		return completeFuture(
-				pool.getConnection().map( this::newConnection ),
+				pool.getConnection().map( connection -> newConnection( connection, creationTrace ) ),
 				ReactiveConnection::close
 		);
 	}
 
 	private CompletionStage<ReactiveConnection> getConnectionFromPool(Pool pool, SqlExceptionHelper sqlExceptionHelper) {
+		final Exception creationTrace = new Exception();
 		return completeFuture(
 				pool.getConnection()
-						.map( sqlConnection -> newConnection( sqlConnection, sqlExceptionHelper ) ),
+						.map( sqlConnection -> newConnection( sqlConnection, sqlExceptionHelper, creationTrace ) ),
 				ReactiveConnection::close
 		);
 	}
@@ -211,17 +213,18 @@ private <T> CompletionStage<T> completeFuture(Future<T> future, Consumer<T> onCa
 		return completableFuture;
 	}
 
-	private SqlClientConnection newConnection(SqlConnection connection) {
-		return newConnection( connection, getSqlExceptionHelper() );
+	private SqlClientConnection newConnection(SqlConnection connection, Exception creationTrace) {
+		return newConnection( connection, getSqlExceptionHelper(), creationTrace );
 	}
 
-	private SqlClientConnection newConnection(SqlConnection connection, SqlExceptionHelper sqlExceptionHelper) {
+	private SqlClientConnection newConnection(SqlConnection connection, SqlExceptionHelper sqlExceptionHelper, Exception creationTrace) {
 		return new SqlClientConnection(
 				connection,
 				getPool(),
 				getSqlStatementLogger(),
 				sqlExceptionHelper,
-				ContextInternal.current()
+				ContextInternal.current(),
+				creationTrace
 		);
 	}