HHH-9843 Use optimized cache key implementation in Infinispan 2LC

* When multi-tenancy is not used, entity's @id can be used as key to the cache
* Added Type to CacheDataDescription (in SPI), later used for container key equivalence
* Introduced CacheKeysFactory to SPI
* Pending puts cache is now per region - this is necessary as we need to use custom key equivalence

Author: rvansa

hibernate-core/src/main/java/org/hibernate/cache/internal/CacheDataDescriptionImpl.java

@@ -11,6 +11,7 @@
 import org.hibernate.cache.spi.CacheDataDescription;
 import org.hibernate.mapping.Collection;
 import org.hibernate.mapping.PersistentClass;
+import org.hibernate.type.Type;
 import org.hibernate.type.VersionType;
 
 /**
@@ -22,19 +23,21 @@ public class CacheDataDescriptionImpl implements CacheDataDescription {
 	private final boolean mutable;
 	private final boolean versioned;
 	private final Comparator versionComparator;
+	private final Type keyType;
 
 	/**
 	 * Constructs a CacheDataDescriptionImpl instance.  Generally speaking, code should use one of the
 	 * overloaded {@link #decode} methods rather than direct instantiation.
-	 *
 	 * @param mutable Is the described data mutable?
 	 * @param versioned Is the described data versioned?
 	 * @param versionComparator The described data's version value comparator (if versioned).
+	 * @param keyType
 	 */
-	public CacheDataDescriptionImpl(boolean mutable, boolean versioned, Comparator versionComparator) {
+	public CacheDataDescriptionImpl(boolean mutable, boolean versioned, Comparator versionComparator, Type keyType) {
 		this.mutable = mutable;
 		this.versioned = versioned;
 		this.versionComparator = versionComparator;
+		this.keyType = keyType;
 	}
 
 	@Override
@@ -52,6 +55,11 @@ public Comparator getVersionComparator() {
 		return versionComparator;
 	}
 
+	@Override
+	public Type getKeyType() {
+		return keyType;
+	}
+
 	/**
 	 * Builds a CacheDataDescriptionImpl from the mapping model of an entity class.
 	 *
@@ -65,8 +73,8 @@ public static CacheDataDescriptionImpl decode(PersistentClass model) {
 				model.isVersioned(),
 				model.isVersioned()
 						? ( (VersionType) model.getVersion().getType() ).getComparator()
-						: null
-		);
+						: null,
+				model.getIdentifierProperty().getType());
 	}
 
 	/**
@@ -82,8 +90,8 @@ public static CacheDataDescriptionImpl decode(Collection model) {
 				model.getOwner().isVersioned(),
 				model.getOwner().isVersioned()
 						? ( (VersionType) model.getOwner().getVersion().getType() ).getComparator()
-						: null
-		);
+						: null,
+				model.getKey().getType());
 	}
 
 }

hibernate-core/src/main/java/org/hibernate/cache/internal/DefaultCacheKeysFactory.java

@@ -6,6 +6,7 @@
  */
 package org.hibernate.cache.internal;
 
+import org.hibernate.cache.spi.CacheKeysFactory;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.engine.spi.SessionImplementor;
 import org.hibernate.persister.collection.CollectionPersister;
@@ -48,7 +49,7 @@ public static Object createEntityKey(Object id, EntityPersister persister, Sessi
 	}
 
 	public static Object createNaturalIdKey(Object[] naturalIdValues, EntityPersister persister, SessionImplementor session) {
-		return new OldNaturalIdCacheKey( naturalIdValues, persister, session );
+		return new OldNaturalIdCacheKey( naturalIdValues,  persister.getPropertyTypes(), persister.getNaturalIdentifierProperties(), persister.getRootEntityName(), session );
 	}
 
 	public static Object getEntityId(Object cacheKey) {
@@ -62,4 +63,36 @@ public static Object getCollectionId(Object cacheKey) {
 	public static Object[] getNaturalIdValues(Object cacheKey) {
 		return ((OldNaturalIdCacheKey) cacheKey).getNaturalIdValues();
 	}
+
+	public static CacheKeysFactory INSTANCE = new CacheKeysFactory() {
+		@Override
+		public Object createCollectionKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) {
+			return DefaultCacheKeysFactory.createCollectionKey(id, persister, factory, tenantIdentifier);
+		}
+
+		@Override
+		public Object createEntityKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) {
+			return DefaultCacheKeysFactory.createEntityKey(id, persister, factory, tenantIdentifier);
+		}
+
+		@Override
+		public Object createNaturalIdKey(Object[] naturalIdValues, EntityPersister persister, SessionImplementor session) {
+			return DefaultCacheKeysFactory.createNaturalIdKey(naturalIdValues, persister, session);
+		}
+
+		@Override
+		public Object getEntityId(Object cacheKey) {
+			return DefaultCacheKeysFactory.getEntityId(cacheKey);
+		}
+
+		@Override
+		public Object getCollectionId(Object cacheKey) {
+			return DefaultCacheKeysFactory.getCollectionId(cacheKey);
+		}
+
+		@Override
+		public Object[] getNaturalIdValues(Object cacheKey) {
+			return DefaultCacheKeysFactory.getNaturalIdValues(cacheKey);
+		}
+	};
 }

hibernate-core/src/main/java/org/hibernate/cache/internal/OldNaturalIdCacheKey.java

@@ -15,7 +15,6 @@
 import org.hibernate.engine.spi.SessionImplementor;
 import org.hibernate.internal.util.ValueHolder;
 import org.hibernate.internal.util.compare.EqualsHelper;
-import org.hibernate.persister.entity.EntityPersister;
 import org.hibernate.type.EntityType;
 import org.hibernate.type.Type;
 
@@ -41,24 +40,22 @@ public class OldNaturalIdCacheKey implements Serializable {
 
 	/**
 	 * Construct a new key for a caching natural identifier resolutions into the second level cache.
-	 *
 	 * @param naturalIdValues The naturalIdValues associated with the cached data
-	 * @param persister The persister for the entity
+	 * @param propertyTypes
+	 * @param naturalIdPropertyIndexes
 	 * @param session The originating session
 	 */
 	public OldNaturalIdCacheKey(
 			final Object[] naturalIdValues,
-			final EntityPersister persister,
+			Type[] propertyTypes, int[] naturalIdPropertyIndexes, final String entityName,
 			final SessionImplementor session) {
 
-		this.entityName = persister.getRootEntityName();
+		this.entityName = entityName;
 		this.tenantId = session.getTenantIdentifier();
 
 		this.naturalIdValues = new Serializable[naturalIdValues.length];
 
 		final SessionFactoryImplementor factory = session.getFactory();
-		final int[] naturalIdPropertyIndexes = persister.getNaturalIdentifierProperties();
-		final Type[] propertyTypes = persister.getPropertyTypes();
 
 		final int prime = 31;
 		int result = 1;
@@ -93,7 +90,7 @@ private void initTransients() {
 					public String initialize() {
 						//Complex toString is needed as naturalIds for entities are not simply based on a single value like primary keys
 						//the only same way to differentiate the keys is to included the disassembled values in the string.
-						final StringBuilder toStringBuilder = new StringBuilder( entityName ).append( "##NaturalId[" );
+						final StringBuilder toStringBuilder = new StringBuilder().append( entityName ).append( "##NaturalId[" );
 						for ( int i = 0; i < naturalIdValues.length; i++ ) {
 							toStringBuilder.append( naturalIdValues[i] );
 							if ( i + 1 < naturalIdValues.length ) {

hibernate-core/src/main/java/org/hibernate/cache/internal/SimpleCacheKeysFactory.java

@@ -0,0 +1,54 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.internal;
+
+import org.hibernate.cache.spi.CacheKeysFactory;
+import org.hibernate.engine.spi.SessionFactoryImplementor;
+import org.hibernate.engine.spi.SessionImplementor;
+import org.hibernate.persister.collection.CollectionPersister;
+import org.hibernate.persister.entity.EntityPersister;
+
+/**
+ * Factory that does not fill in the entityName or role
+ *
+ * @author Radim Vansa &lt;[email protected]&gt;
+ */
+public class SimpleCacheKeysFactory implements CacheKeysFactory {
+
+public static CacheKeysFactory INSTANCE = new SimpleCacheKeysFactory();
+
+	@Override
+	public Object createCollectionKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) {
+		return id;
+	}
+
+	@Override
+	public Object createEntityKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) {
+		return id;
+	}
+
+	@Override
+	public Object createNaturalIdKey(Object[] naturalIdValues, EntityPersister persister, SessionImplementor session) {
+		// natural ids always need to be wrapped
+		return new OldNaturalIdCacheKey(naturalIdValues, persister.getPropertyTypes(), persister.getNaturalIdentifierProperties(), null, session);
+	}
+
+	@Override
+	public Object getEntityId(Object cacheKey) {
+		return cacheKey;
+	}
+
+	@Override
+	public Object getCollectionId(Object cacheKey) {
+		return cacheKey;
+	}
+
+	@Override
+	public Object[] getNaturalIdValues(Object cacheKey) {
+		return ((OldNaturalIdCacheKey) cacheKey).getNaturalIdValues();
+	}
+}

hibernate-core/src/main/java/org/hibernate/cache/spi/CacheDataDescription.java

@@ -8,6 +8,8 @@
 
 import java.util.Comparator;
 
+import org.hibernate.type.Type;
+
 /**
  * Describes attributes regarding the type of data to be cached.
  *
@@ -37,4 +39,10 @@ public interface CacheDataDescription {
 	 * @return The comparator for versions, or {@code null}
 	 */
 	public Comparator getVersionComparator();
+
+	/**
+	 * @return Type of the key that will be used as the key in the cache, or {@code null} if the natural comparison
+	 * ({@link Object#hashCode()} and {@link Object#equals(Object)} methods should be used.
+	 */
+	Type getKeyType();
 }

hibernate-core/src/main/java/org/hibernate/cache/spi/CacheKeysFactory.java

@@ -0,0 +1,29 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.spi;
+
+import org.hibernate.engine.spi.SessionFactoryImplementor;
+import org.hibernate.engine.spi.SessionImplementor;
+import org.hibernate.persister.collection.CollectionPersister;
+import org.hibernate.persister.entity.EntityPersister;
+
+/**
+ * @author Radim Vansa &lt;[email protected]&gt;
+ */
+public interface CacheKeysFactory {
+	Object createCollectionKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier);
+
+	Object createEntityKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier);
+
+	Object createNaturalIdKey(Object[] naturalIdValues, EntityPersister persister, SessionImplementor session);
+
+	Object getEntityId(Object cacheKey);
+
+	Object getCollectionId(Object cacheKey);
+
+	Object[] getNaturalIdValues(Object cacheKey);
+}

hibernate-core/src/test/java/org/hibernate/cache/spi/NaturalIdCacheKeyTest.java

@@ -62,7 +62,7 @@ public Object answer(InvocationOnMock invocation) throws Throwable {
         });
 
         final OldNaturalIdCacheKey key = (OldNaturalIdCacheKey) DefaultCacheKeysFactory.createNaturalIdKey( new Object[] {"a", "b", "c"}, entityPersister, sessionImplementor );
-        
+
         final ByteArrayOutputStream baos = new ByteArrayOutputStream();
         final ObjectOutputStream oos = new ObjectOutputStream(baos);
         oos.writeObject(key);