HHH-16383 - NaturalIdClass

HHH-7287 - Problem in caching proper natural-id-values when obtaining result by naturalIdQuery

Author: sebersole

documentation/src/main/asciidoc/introduction/Interacting.adoc

@@ -385,7 +385,7 @@ For single-attribute natural ids, whether defined by a basic or embedded type, t
 For multi-attribute natural ids, Hibernate will accept a number of forms:
 
 * If a link:{doc-javadoc-url}org/hibernate/annotations/NaturalIdClass.html[`@NaturalIdClass`] is defined, an instance of the natural id class may be used.
-* A `List` of the individual attribute values, ordered alphabetically by name, may be used.
+* An array of the individual attribute values, ordered alphabetically by name, may be used.
 * A `Map` of the individual attribute values, keyed by the attribute name, may be used.
 
 Each of the operations we've seen so far affects a single entity instance passed as an argument.

documentation/src/main/asciidoc/userguide/chapters/domain/natural_id.adoc

@@ -74,21 +74,6 @@ include::{example-dir-naturalid}/MutableNaturalIdTest.java[tags=naturalid-mutabl
 ====
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 [[natural-id-caching]]
 ==== Natural id resolution caching
 
@@ -138,7 +123,7 @@ When loading by natural id, the type of value accepted depends on the definition
 * For multi-attribute natural ids, Hibernate will accept a number of forms:
 
 ** If a link:{doc-javadoc-url}org/hibernate/annotations/NaturalIdClass.html[`@NaturalIdClass`] is defined, an instance of the natural id class may be used.
-** A `List` of the individual attribute values, ordered alphabetically by name, may be used.
+** An array of the individual attribute values, ordered alphabetically by name, may be used.
 ** A `Map` of the individual attribute values, keyed by the attribute name, may be used.
 
 There are a few differences to be aware of when loading by natural id compared to loading by primary key.  Most importantly, if the natural id is mutable and its values have changed, it is possible for the resolution caching to become out of date until a flush occurs resulting in incorrect results.

hibernate-core/src/test/java/org/hibernate/orm/test/mapping/naturalid/idclass/SimpleNaturalIdClassTests.java

@@ -23,6 +23,7 @@
 
 import java.time.Instant;
 import java.util.List;
+import java.util.Map;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -111,7 +112,7 @@ void testNormalization(SessionFactoryScope factoryScope) {
 		stats.clear();
 
 		factoryScope.inTransaction( (session) -> {
-			session.find( SystemUser.class, new SystemUserKey("steve", "ci"), KeyType.NATURAL );
+			session.find( SystemUser.class, new SystemUserKey("ci", "steve"), KeyType.NATURAL );
 			assertEquals( 1, stats.getNaturalIdStatistics( SystemUser.class.getName() ).getNormalizationCount() );
 		} );
 	}
@@ -126,6 +127,23 @@ void testFindByClassWithToOne(SessionFactoryScope factoryScope) {
 		} );
 	}
 
+	@Test
+	void testFindByCompositeNaturalIdForms(SessionFactoryScope factoryScope) {
+		factoryScope.inTransaction( (session) -> {
+			// by idclass is tested in other methods...
+
+			var customer = session.getReference( Customer.class, 1 );
+
+			// by map
+			session.find( SystemUser.class, Map.of( "system", "ci", "username", "steve" ), KeyType.NATURAL );
+			session.find( Order.class, Map.of( "customer", customer, "invoiceNumber", 1001), KeyType.NATURAL );
+
+			// by array
+			session.find( SystemUser.class, new Object[] {"ci","steve"}, KeyType.NATURAL );
+			session.find( Order.class, new Object[] {customer,1001}, KeyType.NATURAL );
+		} );
+	}
+
 	@SuppressWarnings("FieldCanBeLocal")
 	@Entity(name="User")
 	@Table(name="t_users")

hibernate-core/src/test/java/org/hibernate/orm/test/mapping/naturalid/mutable/MutableNaturalIdTest.java

@@ -5,6 +5,7 @@
 package org.hibernate.orm.test.mapping.naturalid.mutable;
 
 import org.hibernate.HibernateException;
+import org.hibernate.KeyType;
 import org.hibernate.LockMode;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.metamodel.mapping.EntityMappingType;
@@ -20,6 +21,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.lang.reflect.Field;
+import java.util.Map;
 
 import static org.hibernate.cfg.AvailableSettings.GENERATE_STATISTICS;
 import static org.hibernate.cfg.AvailableSettings.USE_QUERY_CACHE;
@@ -401,4 +403,38 @@ public void testModificationInOtherSession(SessionFactoryScope factoryScope) {
 			assertNotNull( session.byNaturalId( User.class ).using( "name", "gavin" ).using( "org", "hb" ).load());
 		} );
 	}
+
+	@Test
+	@JiraKey("HHH-7287")
+	public void testModificationInOtherSession2(SessionFactoryScope factoryScope) {
+		var id = factoryScope.fromTransaction( (session) -> {
+			User u = new User( "gavin", "hb", "secret" );
+			session.persist( u );
+			return u.getId();
+		} );
+
+		// Use transactionless session
+		factoryScope.inSession( (session) -> {
+			// this loads the state into this `session`
+			var byNaturalId = session.find( User.class, Map.of("name", "gavin", "org", "hb"), KeyType.NATURAL );
+			assertNotNull( byNaturalId );
+
+			// CHANGE natural-id values in another session
+			factoryScope.inTransaction( (otherSession) -> {
+				var u = otherSession.find( User.class, id );
+				u.setOrg( "zz" );
+			} );
+			// CHANGE APPLIED
+
+			byNaturalId = session.find( User.class, Map.of("name", "gavin", "org", "hb"), KeyType.NATURAL );
+			assertNotNull( byNaturalId );
+
+			// the internal query will 'see' the new values, because isolation level < SERIALIZABLE
+			var byNaturalId2 = session.find( User.class, Map.of("name", "gavin", "org", "zz"), KeyType.NATURAL );
+			assertSame( byNaturalId, byNaturalId2 );
+
+			// this fails, that's the bug
+			assertNotNull( session.find( User.class, Map.of("name", "gavin", "org", "hb"), KeyType.NATURAL ) );
+		} );
+	}
 }

whats-new.adoc

@@ -22,9 +22,9 @@ The new `KeyType` enum is a `FindOption` that allows `find()` and `findMultiple(
 @Entity
 class Person {
 	@Id
-    Integer id;
+	Integer id;
 	@NaturalId
-    String name;
+	String name;
 	...
 }
 
@@ -77,5 +77,5 @@ Given this model, we can load Person by natural id via:
 ----
 session.find( Order.class,
         new PersonNameKey( "Bilbo", "Baggins" ),
-        KeyType.NATURAL )
+        KeyType.NATURAL );
 ----