Merge pull request #48639 from yrodiere/i48631

Automatically register custom value generators for reflection

Author: gsmet

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/ClassNames.java

@@ -62,6 +62,10 @@ private static DotName createConstant(String fqcn) {
     public static final DotName HIBERNATE_CACHE = createConstant("org.hibernate.Cache");
     public static final DotName PERSISTENCE_UNIT_UTIL = createConstant("jakarta.persistence.PersistenceUnitUtil");
 
+    public static final DotName GENERIC_GENERATOR = createConstant("org.hibernate.annotations.GenericGenerator");
+    public static final DotName ID_GENERATOR_TYPE = createConstant("org.hibernate.annotations.IdGeneratorType");
+    public static final DotName VALUE_GENERATION_TYPE = createConstant("org.hibernate.annotations.ValueGenerationType");
+
     public static final DotName INTERCEPTOR = createConstant("org.hibernate.Interceptor");
     public static final DotName STATEMENT_INSPECTOR = createConstant("org.hibernate.resource.jdbc.spi.StatementInspector");
     public static final DotName FORMAT_MAPPER = createConstant("org.hibernate.type.format.FormatMapper");

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/GraalVMFeatures.java

@@ -26,6 +26,8 @@ NativeImageFeatureBuildItem staticNativeImageFeature() {
 
     // TODO try to limit registration to those that are actually needed, based on configuration + mapping.
     //   https://github.com/quarkusio/quarkus/pull/32433#issuecomment-1497615958
+    //   See also io.quarkus.hibernate.orm.deployment.JpaJandexScavenger.enlistClassReferences for
+    //   the beginning of a solution (which only handles custom types, not references by name such as 'sequence').
     @BuildStep
     ReflectiveClassBuildItem registerGeneratorAndOptimizerClassesForReflections() {
         return ReflectiveClassBuildItem

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/JpaJandexScavenger.java

@@ -94,6 +94,10 @@ public JpaModelBuildItem discoverModelAndRegisterForReflection() throws BuildExc
             enlistPotentialCdiBeanClasses(collector, annotation);
         }
 
+        enlistPotentialClassReferences(collector, ClassNames.GENERIC_GENERATOR, "type", "strategy");
+        enlistPotentialClassReferences(collector, ClassNames.ID_GENERATOR_TYPE, "value");
+        enlistPotentialClassReferences(collector, ClassNames.VALUE_GENERATION_TYPE, "generatedBy");
+
         for (JpaModelPersistenceUnitContributionBuildItem persistenceUnitContribution : persistenceUnitContributions) {
             enlistExplicitMappings(collector, persistenceUnitContribution);
         }
@@ -214,10 +218,16 @@ private void enlistOrmXmlMappingManagedClass(Collector collector, String package
             String nodeName) {
         String name = safeGetClassName(packagePrefix, managed, nodeName);
         enlistExplicitClass(collector, name);
-        if (managed instanceof JaxbEntity) {
+        if (managed instanceof JaxbEntity entity) {
             // The call to 'enlistExplicitClass' above may not
             // detect that this class is an entity if it is not annotated
             collector.entityTypes.add(name);
+
+            // Generators may be instantiated reflectively
+            if (entity.getGenericGenerator() != null) {
+                var generator = entity.getGenericGenerator();
+                enlistPotentialClassReference(collector, generator == null ? null : generator.getClazz());
+            }
         }
 
         enlistOrmXmlMappingListeners(collector, packagePrefix, managed.getEntityListenerContainer());
@@ -437,6 +447,47 @@ private void enlistPotentialCdiBeanClasses(Collector collector, DotName dotName)
         }
     }
 
+    private void enlistPotentialClassReferences(Collector collector, DotName dotName, String... referenceAttributes) {
+        Collection<AnnotationInstance> jpaAnnotations = index.getAnnotations(dotName);
+
+        if (jpaAnnotations == null) {
+            return;
+        }
+
+        for (AnnotationInstance annotation : jpaAnnotations) {
+            for (String referenceAttribute : referenceAttributes) {
+                var referenceValue = annotation.value(referenceAttribute);
+                if (referenceValue == null) {
+                    continue;
+                }
+                String reference = switch (referenceValue.kind()) {
+                    case CLASS -> referenceValue.asClass().name().toString();
+                    case STRING -> {
+                        String stringRef = referenceValue.asString();
+                        if (stringRef.isEmpty() || index.getClassByName(stringRef) == null) {
+                            // No reference, or reference to a built-in strategy name like 'sequence'
+                            // (which we can't resolve here and handle through GraalVMFeatures.registerGeneratorAndOptimizerClassesForReflections)
+                            yield null;
+                        }
+                        yield stringRef;
+                    }
+                    default -> null;
+                };
+                enlistPotentialClassReference(collector, reference);
+            }
+        }
+    }
+
+    /**
+     * Add the class to the reflective list with only constructor and method access.
+     */
+    private void enlistPotentialClassReference(Collector collector, String reference) {
+        if (reference == null) {
+            return;
+        }
+        collector.javaTypes.add(reference);
+    }
+
     /**
      * Add the class to the reflective list with full method and field access.
      * Add the superclasses recursively as well as the interfaces.

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/EntityWithCustomGenericGeneratorReferencedAsClass.java

@@ -0,0 +1,15 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+
+import org.hibernate.annotations.GenericGenerator;
+
+@Entity
+public class EntityWithCustomGenericGeneratorReferencedAsClass {
+    @Id
+    @GeneratedValue(generator = "referenced-as-class")
+    @GenericGenerator(name = "referenced-as-class", type = MyCustomGenericGeneratorReferencedAsClass.class)
+    public String id;
+}

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/EntityWithCustomGenericGeneratorReferencedAsClassName.java

@@ -0,0 +1,15 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+
+import org.hibernate.annotations.GenericGenerator;
+
+@Entity
+public class EntityWithCustomGenericGeneratorReferencedAsClassName {
+    @Id
+    @GeneratedValue(generator = "referenced-as-class-name")
+    @GenericGenerator(name = "referenced-as-class-name", strategy = "io.quarkus.it.jpa.generatedvalue.MyCustomGenericGeneratorReferencedAsClassName")
+    public String id;
+}

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/EntityWithCustomIdGeneratorType.java

@@ -0,0 +1,13 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+
+@Entity
+public class EntityWithCustomIdGeneratorType {
+    @Id
+    @GeneratedValue
+    @MyCustomIdGeneratorAnnotation
+    public String id;
+}

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/EntityWithCustomValueGeneratorType.java

@@ -0,0 +1,15 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+
+@Entity
+public class EntityWithCustomValueGeneratorType {
+    @Id
+    @GeneratedValue
+    public Integer id;
+
+    @MyCustomValueGeneratorAnnotation
+    public String customGenerated;
+}

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/GeneratedValueResource.java

@@ -43,6 +43,30 @@ public String test() throws Exception {
                 e -> assertThat(e.generated).isNotNull(),
                 e -> assertThat(e.generatedColumn).isNotNull());
 
+        var entity2 = new EntityWithCustomIdGeneratorType();
+        assertThat(entity2.id).isNull();
+        em.persist(entity2);
+        em.flush();
+        assertThat(entity2.id).isEqualTo(MyCustomIdGenerator.STUB_VALUE);
+
+        var entity3 = new EntityWithCustomValueGeneratorType();
+        assertThat(entity3.customGenerated).isNull();
+        em.persist(entity3);
+        em.flush();
+        assertThat(entity3.customGenerated).isEqualTo(MyCustomValueGenerator.STUB_VALUE);
+
+        var entity4 = new EntityWithCustomGenericGeneratorReferencedAsClass();
+        assertThat(entity4.id).isNull();
+        em.persist(entity4);
+        em.flush();
+        assertThat(entity4.id).isEqualTo(MyCustomGenericGeneratorReferencedAsClass.STUB_VALUE);
+
+        var entity5 = new EntityWithCustomGenericGeneratorReferencedAsClassName();
+        assertThat(entity5.id).isNull();
+        em.persist(entity5);
+        em.flush();
+        assertThat(entity5.id).isEqualTo(MyCustomGenericGeneratorReferencedAsClassName.STUB_VALUE);
+
         return "OK";
     }
 }

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/MyCustomGenericGeneratorReferencedAsClass.java

@@ -0,0 +1,13 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.id.IdentifierGenerator;
+
+public class MyCustomGenericGeneratorReferencedAsClass implements IdentifierGenerator {
+    public static String STUB_VALUE = MyCustomGenericGeneratorReferencedAsClass.class.getName() + "_STUB_VALUE";
+
+    @Override
+    public Object generate(SharedSessionContractImplementor session, Object object) {
+        return STUB_VALUE;
+    }
+}

integration-tests/jpa/src/main/java/io/quarkus/it/jpa/generatedvalue/MyCustomGenericGeneratorReferencedAsClassName.java

@@ -0,0 +1,13 @@
+package io.quarkus.it.jpa.generatedvalue;
+
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.id.IdentifierGenerator;
+
+public class MyCustomGenericGeneratorReferencedAsClassName implements IdentifierGenerator {
+    public static String STUB_VALUE = MyCustomGenericGeneratorReferencedAsClassName.class.getName() + "_STUB_VALUE";
+
+    @Override
+    public Object generate(SharedSessionContractImplementor session, Object object) {
+        return STUB_VALUE;
+    }
+}