HHH-18325: Prevent comparison between proxied and non-proxied statements

Some JDBC connection pools create a dynamic reflective Proxy wrapper
around connections in the pool, plus the generated statements and the
result sets those statements create, with the proxies allowing for
methods calls to be intercepted by the connection pool for the purposes
of returning items to the pool when they're released rather than
destroying the underlying database connection. Tomcat's JDBC pool
implementation does not correctly wrap the full chain of objects,
meaning the raw Statement can be retrieved from a ResultSet rather than
returning the proxied statement. This results in the ResourceRegistry
cache attempting to store both the proxied Statement and the non-proxied
Statement in its cache, but encountering an exception when the HashMap
encounters two entries with the same HashCode and then attempts to
differentiate them with an `equals` call which Tomcat's wrapper expects
both instances to be proxied connections. To overcome this issue in
Tomcat, as well as any other pool implementation which may use Proxy
classes but leak the un-proxied entries, the original PreparedStatement
used to create the ResultSet is being passed into the
GeneratedValuesHelper for passing into the ResourceRegistry, rather than
the GeneratedValues helper attempting to extract the Statement from the
ResultSet.

Author: mc1arke

hibernate-core/hibernate-core.gradle

@@ -70,6 +70,7 @@ dependencies {
     testImplementation libs.jackson
     testRuntimeOnly libs.jacksonXml
     testRuntimeOnly libs.jacksonJsr310
+    testImplementation testLibs.tomcatJdbc
 
     testAnnotationProcessor project( ':hibernate-jpamodelgen' )
 

hibernate-core/src/main/java/org/hibernate/generator/values/internal/GeneratedValuesHelper.java

@@ -69,6 +69,7 @@ public class GeneratedValuesHelper {
 	 * Reads the {@link EntityPersister#getGeneratedProperties(EventType) generated values}
 	 * for the specified {@link ResultSet}.
 	 *
+	 * @param statement The prepared statement the result set was generated from
 	 * @param resultSet The result set from which to extract the generated values
 	 * @param persister The entity type which we're reading the generated values for
 	 * @param wrapperOptions The session
@@ -79,6 +80,7 @@ public class GeneratedValuesHelper {
 	 * @throws HibernateException Indicates a problem reading back a generated value
 	 */
 	public static GeneratedValues getGeneratedValues(
+			PreparedStatement statement,
 			ResultSet resultSet,
 			EntityPersister persister,
 			EventType timing,
@@ -100,6 +102,7 @@ public static GeneratedValues getGeneratedValues(
 
 		final GeneratedValuesImpl generatedValues = new GeneratedValuesImpl( generatedProperties );
 		final Object[] results = readGeneratedValues(
+				statement,
 				resultSet,
 				persister,
 				mappingProducer,
@@ -125,6 +128,7 @@ public static GeneratedValues getGeneratedValues(
 	 * Utility method that reads the generated values from the specified {@link ResultSet}
 	 * using the {@link JdbcValuesMappingProducer} provided in input.
 	 *
+	 * @param statement the prepared statement that the result set was generated from
 	 * @param resultSet the result set containing the generated values
 	 * @param persister the current entity persister
 	 * @param mappingProducer the mapping producer to use when reading generated values
@@ -133,23 +137,18 @@ public static GeneratedValues getGeneratedValues(
 	 * @return an object array containing the generated values, order is consistent with the generated model parts list
 	 */
 	private static Object[] readGeneratedValues(
+			PreparedStatement statement,
 			ResultSet resultSet,
 			EntityPersister persister,
 			JdbcValuesMappingProducer mappingProducer,
 			SharedSessionContractImplementor session) {
 		final ExecutionContext executionContext = new BaseExecutionContext( session );
 
-		final DirectResultSetAccess directResultSetAccess;
-		try {
-			directResultSetAccess = new DirectResultSetAccess(
-					session,
-					(PreparedStatement) resultSet.getStatement(),
-					resultSet
-			);
-		}
-		catch (SQLException e) {
-			throw new HibernateException( "Could not retrieve statement from generated values result set", e );
-		}
+		final DirectResultSetAccess directResultSetAccess = new DirectResultSetAccess(
+				session,
+				statement,
+				resultSet
+		);
 
 		final JdbcValues jdbcValues = new JdbcValuesResultSetImpl(
 				directResultSetAccess,

hibernate-core/src/main/java/org/hibernate/id/insert/AbstractSelectingDelegate.java

@@ -68,16 +68,16 @@ protected void bindParameters(Object entity, PreparedStatement ps, SharedSession
 	@Deprecated( forRemoval = true, since = "6.5" )
 	protected Object extractGeneratedValues(ResultSet resultSet, SharedSessionContractImplementor session)
 			throws SQLException {
-		final GeneratedValues generatedValues = extractReturningValues( resultSet, session );
+		final GeneratedValues generatedValues = extractReturningValues((PreparedStatement) resultSet.getStatement(), resultSet, session );
 		return generatedValues.getGeneratedValue( persister.getIdentifierMapping() );
 	}
 
 	/**
 	 * Extract the generated key value from the given result set after execution of {@link #getSelectSQL()}.
 	 */
-	private GeneratedValues extractReturningValues(ResultSet resultSet, SharedSessionContractImplementor session)
+	private GeneratedValues extractReturningValues(PreparedStatement statement, ResultSet resultSet, SharedSessionContractImplementor session)
 			throws SQLException {
-		return getGeneratedValues( resultSet, persister, getTiming(), session );
+		return getGeneratedValues( statement, resultSet, persister, getTiming(), session );
 	}
 
 	@Override
@@ -118,7 +118,7 @@ public GeneratedValues performMutation(
 
 			final ResultSet resultSet = session.getJdbcCoordinator().getResultSetReturn().extract( idSelect, idSelectSql );
 			try {
-				return extractReturningValues( resultSet, session );
+				return extractReturningValues( idSelect, resultSet, session );
 			}
 			catch (SQLException e) {
 				throw jdbcServices.getSqlExceptionHelper().convert(
@@ -174,7 +174,7 @@ public final GeneratedValues performInsertReturning(String sql, SharedSessionCon
 				bindParameters( binder.getEntity(), idSelect, session );
 				ResultSet resultSet = jdbcCoordinator.getResultSetReturn().extract( idSelect, selectSQL );
 				try {
-					return extractReturningValues( resultSet, session );
+					return extractReturningValues( idSelect, resultSet, session );
 				}
 				finally {
 					jdbcCoordinator.getLogicalConnection().getResourceRegistry().release( resultSet, idSelect );

hibernate-core/src/main/java/org/hibernate/id/insert/GetGeneratedKeysDelegate.java

@@ -118,7 +118,7 @@ public GeneratedValues performMutation(
 			try {
 				final ResultSet resultSet = preparedStatement.getGeneratedKeys();
 				try {
-					return getGeneratedValues( resultSet, persister, getTiming(), session );
+					return getGeneratedValues( preparedStatement, resultSet, persister, getTiming(), session );
 				}
 				catch (SQLException e) {
 					throw jdbcServices.getSqlExceptionHelper().convert(
@@ -170,7 +170,7 @@ public GeneratedValues executeAndExtractReturning(
 		try {
 			final ResultSet resultSet = preparedStatement.getGeneratedKeys();
 			try {
-				return getGeneratedValues( resultSet, persister, getTiming(), session );
+				return getGeneratedValues( preparedStatement, resultSet, persister, getTiming(), session );
 			}
 			catch (SQLException e) {
 				throw jdbcServices.getSqlExceptionHelper().convert(

hibernate-core/src/main/java/org/hibernate/id/insert/InsertReturningDelegate.java

@@ -95,7 +95,7 @@ protected GeneratedValues executeAndExtractReturning(
 
 		final ResultSet resultSet = jdbcCoordinator.getResultSetReturn().execute( preparedStatement, sql );
 		try {
-			return getGeneratedValues( resultSet, persister, getTiming(), session );
+			return getGeneratedValues( preparedStatement, resultSet, persister, getTiming(), session );
 		}
 		catch (SQLException e) {
 			throw jdbcServices.getSqlExceptionHelper().convert(

hibernate-core/src/main/java/org/hibernate/id/insert/SybaseJConnGetGeneratedKeysDelegate.java

@@ -60,7 +60,7 @@ public GeneratedValues executeAndExtractReturning(
 
 		ResultSet resultSet = jdbcCoordinator.getResultSetReturn().execute( preparedStatement, sql );
 		try {
-			return getGeneratedValues( resultSet, persister, getTiming(), session );
+			return getGeneratedValues( preparedStatement, resultSet, persister, getTiming(), session );
 		}
 		catch (SQLException e) {
 			throw jdbcServices.getSqlExceptionHelper().convert(