HHH-19286 Ignoring auto-applied conversions on special mappings

Author: beikov

hibernate-core/src/main/java/org/hibernate/boot/model/internal/AbstractPropertyHolder.java

@@ -86,7 +86,7 @@ public abstract class AbstractPropertyHolder implements PropertyHolder {
 	protected abstract AttributeConversionInfo locateAttributeConversionInfo(String path);
 
 	@Override
-	public ConverterDescriptor resolveAttributeConverterDescriptor(MemberDetails attributeMember) {
+	public ConverterDescriptor resolveAttributeConverterDescriptor(MemberDetails attributeMember, boolean autoApply) {
 		final AttributeConversionInfo info = locateAttributeConversionInfo( attributeMember );
 		if ( info != null ) {
 			if ( info.isConversionDisabled() ) {
@@ -102,7 +102,7 @@ public ConverterDescriptor resolveAttributeConverterDescriptor(MemberDetails att
 			}
 		}
 
-		return context.getMetadataCollector()
+		return !autoApply ? null : context.getMetadataCollector()
 				.getConverterRegistry()
 				.getAttributeConverterAutoApplyHandler()
 				.findAutoApplyConverterForAttribute( attributeMember, context );

hibernate-core/src/main/java/org/hibernate/boot/model/internal/BasicValueBinder.java

@@ -21,6 +21,7 @@
 import jakarta.persistence.Temporal;
 import jakarta.persistence.TemporalType;
 import jakarta.persistence.Version;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.hibernate.AnnotationException;
 import org.hibernate.AssertionFailure;
 import org.hibernate.MappingException;
@@ -301,7 +302,7 @@ public void setType(
 			MemberDetails value,
 			TypeDetails typeDetails,
 			String declaringClassName,
-			ConverterDescriptor converterDescriptor) {
+			@Nullable ConverterDescriptor converterDescriptor) {
 		this.memberDetails = value;
 		final boolean isArray = value.isArray();
 		if ( typeDetails == null && !isArray ) {
@@ -1187,10 +1188,6 @@ private void applyJpaConverter(MemberDetails attribute, ConverterDescriptor attr
 	}
 
 	void disallowConverter(MemberDetails attribute, Class<? extends Annotation> annotationType, boolean autoApply) {
-		// NOTE: A really faithful reading of the JPA spec is that we should
-		//       just silently ignore any auto-apply converter which matches
-		//       one of the disallowed attribute types, but for now let's be
-		//       a bit more fussy/helpful, and see how many people complain.
 		if ( attribute.hasDirectAnnotationUsage( annotationType ) ) {
 			throw new AnnotationException( "'AttributeConverter' not allowed for attribute '" + attribute.getName()
 											+ "' annotated '@" + annotationType.getName() + "'"

hibernate-core/src/main/java/org/hibernate/boot/model/internal/PropertyBinder.java

@@ -7,6 +7,7 @@
 import jakarta.persistence.Basic;
 import jakarta.persistence.ElementCollection;
 import jakarta.persistence.EmbeddedId;
+import jakarta.persistence.Enumerated;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
 import jakarta.persistence.Lob;
@@ -24,6 +25,7 @@
 import jakarta.persistence.OneToOne;
 import jakarta.persistence.OrderBy;
 import jakarta.persistence.OrderColumn;
+import jakarta.persistence.Temporal;
 import jakarta.persistence.Version;
 import org.hibernate.AnnotationException;
 import org.hibernate.AssertionFailure;
@@ -266,7 +268,7 @@ private Property makePropertyAndValue() {
 				memberDetails,
 				returnedClass,
 				containerClassName,
-				holder.resolveAttributeConverterDescriptor( memberDetails )
+				holder.resolveAttributeConverterDescriptor( memberDetails, autoApplyConverters() )
 		);
 		basicValueBinder.setReferencedEntityName( referencedEntityName );
 		basicValueBinder.setAccessType( accessType );
@@ -276,6 +278,18 @@ private Property makePropertyAndValue() {
 		return makeProperty();
 	}
 
+	private boolean autoApplyConverters() {
+		// JPA 3.2 section 3.9 says there are exceptions where to auto-apply converters, citing:
+		// The conversion of all basic types is supported except for the following:
+		// Id attributes (including the attributes of embedded ids and derived identities),
+		// version attributes, relationship attributes,
+		// and attributes explicitly annotated as Enumerated or Temporal
+		return !isId
+			&& !isVersion( memberDetails )
+			&& !memberDetails.hasDirectAnnotationUsage( Enumerated.class )
+			&& !memberDetails.hasDirectAnnotationUsage( Temporal.class );
+	}
+
 	@SuppressWarnings({"rawtypes", "unchecked"})
 	private void callAttributeBinders(Property property, Map<String, PersistentClass> persistentClasses) {
 		final List<? extends Annotation> metaAnnotatedTargets =

hibernate-core/src/main/java/org/hibernate/boot/model/internal/PropertyHolder.java

@@ -108,5 +108,5 @@ default ForeignKey getOverriddenForeignKey(String propertyName) {
 	 *
 	 * @return The ConverterDescriptor
 	 */
-	ConverterDescriptor resolveAttributeConverterDescriptor(MemberDetails property);
+	ConverterDescriptor resolveAttributeConverterDescriptor(MemberDetails property, boolean autoApply);
 }

hibernate-core/src/test/java/org/hibernate/orm/test/mapping/converted/converter/IgnoreAutoAppliedConverterForIdAndVersionTest.java

@@ -0,0 +1,107 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.orm.test.mapping.converted.converter;
+
+import jakarta.persistence.AttributeConverter;
+import jakarta.persistence.Converter;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Version;
+import org.hibernate.testing.orm.junit.DomainModel;
+import org.hibernate.testing.orm.junit.JiraKey;
+import org.hibernate.testing.orm.junit.SessionFactory;
+import org.hibernate.testing.orm.junit.SessionFactoryScope;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.Assert.assertEquals;
+
+@JiraKey( value = "HHH-19286" )
+@DomainModel( annotatedClasses = {
+		IgnoreAutoAppliedConverterForIdAndVersionTest.SampleEntity.class,
+		IgnoreAutoAppliedConverterForIdAndVersionTest.NegatingIntegerConverter.class,
+} )
+@SessionFactory
+public class IgnoreAutoAppliedConverterForIdAndVersionTest {
+	public final String sql = "select code from SampleEntity where id = :id";
+
+	@Test
+	public void test(SessionFactoryScope scope) {
+		scope.inTransaction(
+				(session) -> {
+					final SampleEntity sampleEntity = new SampleEntity();
+					sampleEntity.setId( 1 );
+					sampleEntity.setCode( 123 );
+
+					session.persist( sampleEntity );
+				}
+		);
+
+		scope.inTransaction(
+				(session) -> {
+					final Integer code = session.createNativeQuery( sql, Integer.class )
+							.setParameter( "id", 1L )
+							.getSingleResult();
+					assertEquals( -123, (int) code );
+
+					final SampleEntity sampleEntity = session.find( SampleEntity.class, 1 );
+
+					assertEquals( 0, (int) sampleEntity.getVersion() );
+					assertEquals( 123, (int) sampleEntity.getCode() );
+				}
+		);
+	}
+
+	@AfterEach
+	public void dropTestData(SessionFactoryScope scope) {
+		scope.inTransaction( (session) -> session.createQuery( "delete SampleEntity" ).executeUpdate() );
+	}
+
+	@Entity(name = "SampleEntity")
+	public static class SampleEntity {
+		@Id
+		private Integer id;
+		@Version
+		private Integer version;
+		private Integer code;
+
+		public Integer getId() {
+			return id;
+		}
+
+		public void setId(Integer id) {
+			this.id = id;
+		}
+
+		public Integer getVersion() {
+			return version;
+		}
+
+		public void setVersion(Integer version) {
+			this.version = version;
+		}
+
+		public Integer getCode() {
+			return code;
+		}
+
+		public void setCode(Integer code) {
+			this.code = code;
+		}
+	}
+
+	@Converter( autoApply = true )
+	static class NegatingIntegerConverter implements AttributeConverter<Integer,Integer> {
+		@Override
+		public Integer convertToDatabaseColumn(Integer attribute) {
+			return attribute == null ? null : -attribute;
+		}
+
+		@Override
+		public Integer convertToEntityAttribute(Integer dbData) {
+			return dbData == null ? null : -dbData;
+		}
+	}
+}