Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-14944 - Detaching an entity removes natural-id cross-reference from shared cache

This commit is contained in:
Guenther Demetz 2023-05-02 12:13:11 +02:00 committed by Steve Ebersole
parent c102b8321a
commit 5201a45055
5 changed files with 102 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
documentation/src/test/java/org/hibernate/userguide/caching/SecondLevelCacheTest.java
View File

@ -22,23 +22,27 @@ import org.hibernate.CacheMode;
import org.hibernate.Session;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NaturalId;
import org.hibernate.annotations.NaturalIdCache;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.internal.SessionFactoryImpl;
import org.hibernate.jpa.QueryHints;
import org.hibernate.jpa.test.BaseEntityManagerFunctionalTestCase;
import org.hibernate.stat.CacheRegionStatistics;
import org.hibernate.stat.Statistics;
import org.hibernate.testing.TestForIssue;
import org.junit.Ignore;
import org.junit.Test;
import static org.hibernate.testing.transaction.TransactionUtil.doInJPA;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
/**
* @author Vlad Mihalcea
*/
@Ignore
//@FailureExpected( jiraKey = "HHH-12146", message = "No idea why those changes cause this to fail, especially in the way it does" )
public class SecondLevelCacheTest extends BaseEntityManagerFunctionalTestCase {
@ -251,10 +255,89 @@ public class SecondLevelCacheTest extends BaseEntityManagerFunctionalTestCase {
});
}
@Test
@TestForIssue( jiraKey = "HHH-14944") // issue is also reproduceable in Hibernate 5.4
public void testCacheVerifyHits() {
doInJPA( this::entityManagerFactory, entityManager -> {
entityManager.persist( new Person() );
Person aPerson= new Person();
aPerson.setName( "John Doe" );
aPerson.setCode( "unique-code" );
entityManager.persist( aPerson );
Session session = entityManager.unwrap(Session.class);
SessionFactoryImpl sfi = (SessionFactoryImpl) session.getSessionFactory();
sfi.getStatistics().clear();
return aPerson;
});
doInJPA(this::entityManagerFactory, entityManager -> {
log.info("Native load by natural-id, generate first hit");
Session session = entityManager.unwrap(Session.class);
SessionFactoryImpl sfi = (SessionFactoryImpl) session.getSessionFactory();
//tag::caching-entity-natural-id-example[]
Person person = session
.byNaturalId(Person.class)
.using("code", "unique-code")
.load();
assertNotNull(person);
log.info("NaturalIdCacheHitCount: " + sfi.getStatistics().getNaturalIdCacheHitCount());
log.info("SecondLevelCacheHitCount: " + sfi.getStatistics().getSecondLevelCacheHitCount());
assertEquals(1, sfi.getStatistics().getNaturalIdCacheHitCount());
assertEquals(1, sfi.getStatistics().getSecondLevelCacheHitCount());
//end::caching-entity-natural-id-example[]
});
doInJPA(this::entityManagerFactory, entityManager -> {
log.info("Native load by natural-id, generate second hit");
Session session = entityManager.unwrap(Session.class);
SessionFactoryImpl sfi = (SessionFactoryImpl) session.getSessionFactory();
//tag::caching-entity-natural-id-example[]
Person person = session.bySimpleNaturalId(Person.class).load("unique-code");
assertNotNull(person);
// resolve in persistence context (first level cache)
session.bySimpleNaturalId(Person.class).load("unique-code");
log.info("NaturalIdCacheHitCount: " + sfi.getStatistics().getNaturalIdCacheHitCount());
log.info("SecondLevelCacheHitCount: " + sfi.getStatistics().getSecondLevelCacheHitCount());
assertEquals(2, sfi.getStatistics().getNaturalIdCacheHitCount());
assertEquals(2, sfi.getStatistics().getSecondLevelCacheHitCount());
session.clear();
// persistence context (first level cache) empty, should resolve from second level cache
log.info("Native load by natural-id, generate third hit");
person = session.bySimpleNaturalId(Person.class).load("unique-code");
log.info("NaturalIdCacheHitCount: " + sfi.getStatistics().getNaturalIdCacheHitCount());
log.info("SecondLevelCacheHitCount: " + sfi.getStatistics().getSecondLevelCacheHitCount());
assertNotNull(person);
assertEquals(3, sfi.getStatistics().getNaturalIdCacheHitCount());
assertEquals(3, sfi.getStatistics().getSecondLevelCacheHitCount());
//Remove the entity from the persistence context
Long id = person.getId();
entityManager.detach(person); // still it should resolve from second level cache after this
log.info("Native load by natural-id, generate 4. hit");
person = session.bySimpleNaturalId(Person.class).load("unique-code");
log.info("NaturalIdCacheHitCount: " + sfi.getStatistics().getNaturalIdCacheHitCount());
assertEquals("we expected now 4 hits" , 4, sfi.getStatistics().getNaturalIdCacheHitCount());
assertNotNull(person);
session.delete(person); // evicts natural-id from first & second level cache
person = session.bySimpleNaturalId(Person.class).load("unique-code");
assertEquals(4, sfi.getStatistics().getNaturalIdCacheHitCount()); // thus hits should not increment
//end::caching-entity-natural-id-example[]
});
}
//tag::caching-entity-natural-id-mapping-example[]
@Entity(name = "Person")
@Cacheable
@org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NaturalIdCache
public static class Person {
@Id

11
hibernate-core/src/main/java/org/hibernate/engine/internal/NaturalIdXrefDelegate.java
View File

@ -87,13 +87,14 @@ public class NaturalIdXrefDelegate {
/**
* Handle removing cross reference entries for the given natural-id/pk combo
*
* @param persister The persister representing the entity type.
* @param pk The primary key value
* @param persister The persister representing the entity type.
* @param pk The primary key value
* @param naturalIdValues The natural id value(s)
*
* @param removeOnNaturalIdCache remove the entry on shared cache too
*
* @return The cached values, if any. May be different from incoming values.
*/
public Object[] removeNaturalIdCrossReference(EntityPersister persister, Serializable pk, Object[] naturalIdValues) {
public Object[] removeNaturalIdCrossReference(EntityPersister persister, Serializable pk, Object[] naturalIdValues, boolean removeOnNaturalIdCache) {
persister = locatePersisterForKey( persister );
validateNaturalId( persister, naturalIdValues );
@ -108,7 +109,7 @@ public class NaturalIdXrefDelegate {
}
}
if ( persister.hasNaturalIdCache() ) {
if ( removeOnNaturalIdCache && persister.hasNaturalIdCache() ) {
final NaturalIdDataAccess naturalIdCacheAccessStrategy = persister
.getNaturalIdCacheAccessStrategy();
final Object naturalIdCacheKey = naturalIdCacheAccessStrategy.generateCacheKey( naturalIdValues, persister, session() );

9
hibernate-core/src/main/java/org/hibernate/engine/internal/StatefulPersistenceContext.java
View File

@ -2117,8 +2117,8 @@ public class StatefulPersistenceContext implements PersistenceContext {
final Object[] localNaturalIdValues = getNaturalIdXrefDelegate().removeNaturalIdCrossReference(
persister,
id,
naturalIdValues
);
naturalIdValues,
true);
return localNaturalIdValues != null ? localNaturalIdValues : naturalIdValues;
}
@ -2235,11 +2235,12 @@ public class StatefulPersistenceContext implements PersistenceContext {
}
@Override
public void handleEviction(Object object, EntityPersister persister, Serializable identifier) {
public void handleEviction(Object object, EntityPersister persister, Serializable identifier, boolean evictOnNaturalIdCache) {
getNaturalIdXrefDelegate().removeNaturalIdCrossReference(
persister,
identifier,
findCachedNaturalId( persister, identifier )
findCachedNaturalId( persister, identifier ),
evictOnNaturalIdCache
);
}
};

9
hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java
View File

@ -950,11 +950,12 @@ public interface PersistenceContext {
/**
* Called on {@link org.hibernate.Session#evict} to give a chance to clean up natural-id cross refs.
*
* @param object The entity instance.
* @param persister The entity persister
* @param identifier The entity identifier
* @param object The entity instance.
* @param persister The entity persister
* @param identifier The entity identifier
* @param removeOnNaturalIdCache remove the entry on shared cache too
*/
void handleEviction(Object object, EntityPersister persister, Serializable identifier);
void handleEviction(Object object, EntityPersister persister, Serializable identifier, boolean removeOnNaturalIdCache);
}
/**

4
hibernate-core/src/main/java/org/hibernate/event/internal/DefaultEvictEventListener.java
View File

@ -113,8 +113,8 @@ public class DefaultEvictEventListener implements EvictEventListener {
persistenceContext.getNaturalIdHelper().handleEviction(
object,
persister,
key.getIdentifier()
);
key.getIdentifier(),
false);
}
// remove all collections for the entity from the session-level cache