#136 - Allow control over whether to track implementors

Author: sebersole

buildSrc/src/main/groovy/testing.gradle

@@ -12,6 +12,7 @@ dependencies {
 	testImplementation jakartaLibs.jpa
 	testImplementation testLibs.junit5Api
 	testImplementation testLibs.assertjCore
+	testImplementation testLibs.junit5Params
 
 	testImplementation testLibs.junit5Engine
 	testImplementation testLibs.log4j

hibernate-models-bytebuddy/src/main/java/org/hibernate/models/bytebuddy/internal/ByteBuddyContextProvider.java

@@ -9,6 +9,7 @@
 import org.hibernate.models.bytebuddy.Settings;
 import org.hibernate.models.internal.BasicModelsContextImpl;
 import org.hibernate.models.spi.ClassLoading;
+import org.hibernate.models.spi.ModelsConfiguration;
 import org.hibernate.models.spi.ModelsContext;
 import org.hibernate.models.spi.RegistryPrimer;
 import org.hibernate.models.spi.ModelsContextProvider;
@@ -27,12 +28,13 @@ public ModelsContext produceContext(
 			RegistryPrimer registryPrimer,
 			Map<Object, Object> configProperties) {
 		final TypePool typePool = resolveTypePool( configProperties );
+		final boolean trackImplementors = ModelsConfiguration.shouldTrackImplementors( configProperties );
 
 		if ( typePool != null ) {
-			return new ByteBuddyModelsContextImpl( typePool, classLoading, registryPrimer );
+			return new ByteBuddyModelsContextImpl( typePool, trackImplementors, classLoading, registryPrimer );
 		}
 
-		return new BasicModelsContextImpl( classLoading, registryPrimer );
+		return new BasicModelsContextImpl( classLoading, trackImplementors, registryPrimer );
 	}
 
 	private TypePool resolveTypePool(Map<Object, Object> configProperties) {

hibernate-models-bytebuddy/src/main/java/org/hibernate/models/bytebuddy/internal/ByteBuddyModelsContextImpl.java

@@ -21,6 +21,8 @@
 
 import net.bytebuddy.pool.TypePool;
 
+import static org.hibernate.models.internal.ModelsClassLogging.MODELS_CLASS_LOGGER;
+
 /**
  * Implementation of ByteBuddyModelsContext
  *
@@ -39,13 +41,16 @@ public class ByteBuddyModelsContextImpl
 
 	public ByteBuddyModelsContextImpl(
 			TypePool typePool,
+			boolean trackImplementors,
 			ClassLoading classLoading,
 			RegistryPrimer registryPrimer) {
 		super( classLoading );
 
+		MODELS_CLASS_LOGGER.debugf( "Using Byte Buddy support" );
+
 		this.typePool = typePool;
 
-		this.classDetailsRegistry = new ClassDetailsRegistryImpl( this );
+		this.classDetailsRegistry = new ClassDetailsRegistryImpl( this, trackImplementors );
 		this.descriptorRegistry = new AnnotationDescriptorRegistryStandard( this );
 
 		primeRegistries( registryPrimer );
@@ -68,7 +73,11 @@ public MutableAnnotationDescriptorRegistry getAnnotationDescriptorRegistry() {
 
 	@Override
 	public StorableContext toStorableForm() {
-		return new StorableContextImpl( classDetailsRegistry.classDetailsMap(), descriptorRegistry.descriptorMap() );
+		return new StorableContextImpl(
+				classDetailsRegistry.isTrackingImplementors(),
+				classDetailsRegistry.classDetailsMap(),
+				descriptorRegistry.descriptorMap()
+		);
 	}
 
 	@Override

hibernate-models-bytebuddy/src/main/java/org/hibernate/models/bytebuddy/internal/ClassDetailsRegistryImpl.java

@@ -18,8 +18,8 @@
 public class ClassDetailsRegistryImpl extends AbstractClassDetailsRegistry {
 	private final ClassDetailsBuilderImpl classDetailsBuilder;
 
-	public ClassDetailsRegistryImpl(ByteBuddyModelsContextImpl context) {
-		super( context );
+	public ClassDetailsRegistryImpl(ByteBuddyModelsContextImpl context, boolean trackImplementors) {
+		super( trackImplementors, context );
 		this.classDetailsBuilder = new ClassDetailsBuilderImpl( context );
 	}
 

hibernate-models-bytebuddy/src/test/java/org/hibernate/models/testing/shared/intg/ByteBuddyModelsContextFactory.java

@@ -29,7 +29,7 @@ public ByteBuddyModelsContext createModelContext(
 			RegistryPrimer registryPrimer,
 			Class<?>... modelClasses) {
 		final TypePool byteBuddyTypePool = buildTypePool( modelClasses );
-		return new ByteBuddyModelsContextImpl( byteBuddyTypePool, SIMPLE_CLASS_LOADING, registryPrimer );
+		return new ByteBuddyModelsContextImpl( byteBuddyTypePool, true, SIMPLE_CLASS_LOADING, registryPrimer );
 	}
 
 	public static TypePool buildTypePool(Class<?>... modelClasses) {

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/JandexClassDetailsRegistry.java

@@ -23,8 +23,8 @@ public class JandexClassDetailsRegistry extends AbstractClassDetailsRegistry {
 	private final IndexView jandexIndex;
 	private final ClassDetailsBuilder classDetailsBuilder;
 
-	public JandexClassDetailsRegistry(IndexView jandexIndex, ModelsContext context) {
-		super( context );
+	public JandexClassDetailsRegistry(IndexView jandexIndex, boolean trackImplementors, ModelsContext context) {
+		super( trackImplementors, context );
 		this.jandexIndex = jandexIndex;
 		this.classDetailsBuilder = new JandexClassDetailsBuilderImpl( jandexIndex, context );
 	}

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/JandexModelsContextImpl.java

@@ -40,17 +40,18 @@ public class JandexModelsContextImpl extends AbstractModelsContext implements Ja
 
 	public JandexModelsContextImpl(
 			IndexView jandexIndex,
+			boolean trackImplementors,
 			ClassLoading classLoading,
 			RegistryPrimer registryPrimer) {
 		super( classLoading );
 
+		MODELS_CLASS_LOGGER.debugf( "Using Jandex support" );
+
 		assert jandexIndex != null;
 		this.jandexIndex = jandexIndex;
 
-		MODELS_CLASS_LOGGER.debugf( "Using Jandex support" );
-
 		this.descriptorRegistry = new JandexAnnotationDescriptorRegistry( this );
-		this.classDetailsRegistry = new JandexClassDetailsRegistry( jandexIndex, this );
+		this.classDetailsRegistry = new JandexClassDetailsRegistry( jandexIndex, trackImplementors,this );
 
 		primeRegistries( registryPrimer );
 	}
@@ -104,6 +105,10 @@ public <V> JandexValueExtractor<V> getJandexValueExtractor(ValueTypeDescriptor<V
 
 	@Override
 	public StorableContext toStorableForm() {
-		return new StorableContextImpl( classDetailsRegistry.classDetailsMap(), descriptorRegistry.descriptorMap() );
+		return new StorableContextImpl(
+				classDetailsRegistry.isTrackingImplementors(),
+				classDetailsRegistry.classDetailsMap(),
+				descriptorRegistry.descriptorMap()
+		);
 	}
 }

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/JandexModelsContextProvider.java

@@ -9,6 +9,7 @@
 import org.hibernate.models.internal.BasicModelsContextImpl;
 import org.hibernate.models.jandex.Settings;
 import org.hibernate.models.spi.ClassLoading;
+import org.hibernate.models.spi.ModelsConfiguration;
 import org.hibernate.models.spi.ModelsContext;
 import org.hibernate.models.spi.RegistryPrimer;
 import org.hibernate.models.spi.ModelsContextProvider;
@@ -29,12 +30,13 @@ public ModelsContext produceContext(
 			RegistryPrimer registryPrimer,
 			Map<Object, Object> configProperties) {
 		final IndexView jandexIndex = resolveJandexIndex( configProperties );
+		final boolean trackImplementors = ModelsConfiguration.shouldTrackImplementors( configProperties );
 
 		if ( jandexIndex != null ) {
-			return new JandexModelsContextImpl( jandexIndex, classLoading, registryPrimer );
+			return new JandexModelsContextImpl( jandexIndex, trackImplementors, classLoading, registryPrimer );
 		}
 
-		return new BasicModelsContextImpl( classLoading, registryPrimer );
+		return new BasicModelsContextImpl( classLoading, trackImplementors, registryPrimer );
 
 	}
 

hibernate-models-jandex/src/test/java/org/hibernate/models/testing/shared/intg/JandexModelsContextFactoryImpl.java

@@ -29,7 +29,7 @@ public JandexModelsContextImpl createModelContext(
 			RegistryPrimer registryPrimer,
 			Class<?>... modelClasses) {
 		final Index jandexIndex = buildJandexIndex( SIMPLE_CLASS_LOADING, modelClasses );
-		return new JandexModelsContextImpl( jandexIndex, SIMPLE_CLASS_LOADING, registryPrimer );
+		return new JandexModelsContextImpl( jandexIndex, true,  SIMPLE_CLASS_LOADING, registryPrimer );
 	}
 
 	public static Index buildJandexIndex(ClassLoading classLoadingAccess, Class<?>... modelClasses) {

hibernate-models/src/main/java/org/hibernate/models/Settings.java

@@ -0,0 +1,20 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.models;
+
+import org.hibernate.models.spi.ClassDetailsRegistry;
+
+/**
+ * @author Steve Ebersole
+ */
+public interface Settings {
+	/**
+	 * Controls whether to track {@linkplain ClassDetailsRegistry#getDirectImplementors implementors}.
+	 * This tracking has the potential to grow quite large, so this setting allows to
+	 * enable/disable it.  By default, this is {@code false}.
+	 */
+	@Incubating
+	String TRACK_IMPLEMENTORS = "hibernate.models.trackImplementors";
+}