org.hibernate.bytecode.enhance.spi.EnhancementException: Enhancement of [org.acme.domain.MyEntity] failed

[KaiSuchomel]

Describe the bug

Exception occurs during Build:
org.hibernate.bytecode.enhance.spi.EnhancementException: Enhancement of [org.acme.domain.MyEntity] failed because no field named [modelType] could be found for property accessor method [getModelType]. To fix this, make sure all property accessor methods have a matching field.

Expected behavior

The Build should succeed.

Actual behavior

When building the project:
ERROR] Caused by: java.util.concurrent.ExecutionException: org.hibernate.bytecode.enhance.spi.EnhancementException: Enhancement of [org.acme.domain.MyEntity] failed because no field named [modelType] could be found for property accessor method [getModelType]. To fix this, make sure all property accessor methods have a matching field.

How to Reproduce?

Reproducer: https://github.com/KaiSuchomel/quarkus-test/tree/hibernate
Just build the project with maven.
Simple Entity:

@Entity
public class MyEntity {

    @Id
    private UUID id;

    public UUID getId() {
        return id;
    }

    public void setId(UUID id) {
        this.id = id;
    }

    public void getXXX() {
    }

    @PrePersist
    public void setId(){
        id = UUID.randomUUID();
    }
    
    public String getModelType() {
        return "MyEntity";
    }
}

After changing the PrePersist setter to a seperate name the build is working:

@Entity
public class MyEntity {

    @Id
    private UUID id;

    public UUID getId() {
        return id;
    }

    public void setId(UUID id) {
        this.id = id;
    }

    public void getXXX() {
    }

    @PrePersist
    public void prePersistSetId(){
        id = UUID.randomUUID();
    }
    
    public String getModelType() {
        return "MyEntity";
    }
}

Output of uname -a or ver

Darwin Mac-C6VD4H4XT3 24.1.0 Darwin Kernel Version 24.1.0: Thu Oct 10 21:00:32 PDT 2024; root:xnu-11215.41.3~2/RELEASE_ARM64_T6030 arm64

Output of java -version

openjdk version "21.0.5" 2024-10-15 OpenJDK Runtime Environment Homebrew (build 21.0.5) OpenJDK 64-Bit Server VM Homebrew (build 21.0.5, mixed mode, sharing)

Quarkus version or git rev

3.17.2 --> hibernate-core 6.6.3

Build tool (ie. output of mvnw --version or gradlew --version)

Maven home: /opt/homebrew/Cellar/maven/3.9.9/libexec Java version: 21.0.5, vendor: Homebrew, runtime: /opt/homebrew/Cellar/openjdk@21/21.0.5/libexec/openjdk.jdk/Contents/Home Default locale: de_DE, platform encoding: UTF-8 OS name: "mac os x", version: "15.1.1", arch: "aarch64", family: "mac"

Additional information

@yrodiere Can you please check. Thx.
See: hibernate/hibernate-orm@b5221e2#diff-5f775bce3db8bc5527104f2eba37fef522276d3bed00a3276545528ab233c380R16

[quarkus-bot]

/cc @gsmet (hibernate-orm), @yrodiere (hibernate-orm)

[mbladel]

Hello @KaiSuchomel, thank you for reporting the issue and providing a simple mapping which reproduces your problem.

The error you're facing is caused by a recent change in Hibernate's bytecode-enhancement logic: https://hibernate.atlassian.net/browse/HHH-16572. The new check is needed because support for bytecode enhanced entities with AccessType.PROPERTY (using getter/setter methods instead of fields) does not function properly unless the field names exactly match the method names - in Quarkus this can be especially problematic since enhancement is done at build-time and we expect all entities to be enhanced at runtime.

Using setX, where X is a persistent property name, as the method name in your entity classes is generally not a good idea, especially when using bytecode-enhancement, as the method could be mistaken as a setter for that field. So the "workaround" you found is more than valid and I would suggest keeping that as-is.

Regardless, I believe the check should work in this case since:

1. The entity is using AccessType.FIELD, since the @Id annotation is placed on the id field;
2. The pre-persist method setId corresponds to an actually existing field
3. The pre-persist method setId has no arguments, so it cannot be an actual setter

We should open an issue on Hibernate ORM's Jira to keep track of this and possibly improve the check.

Edit: created https://hibernate.atlassian.net/browse/HHH-18904

[geoand]

@mbladel does #44909 share the same root cause?

[mbladel]

@geoand I believe so, yes, I've added a link to that issue and its reproducer to the ORM Jira - thanks for the ping.

[wcicola]

I've recently encountered a similar issue that seems to be related, but haven't yet seen a report of this exact manifestation of it either here or on the Hibernate Jira.

If an entity:

1. Is mapped using AccessType.PROPERTY,
2. Extends a class with fields that are accessible to subclasses, and
3. Tries to map those accessible superclass fields using annotations on its own getters/setters

Then the build fails also with a similar EnhancementException.

I can put together a full repro project and/or post on the Hibernate Jira if it would help, but the only required code for reproduction is a Quarkus 3.17.2+ project using quarkus-hibernate-orm and with these two classes:

package test.entity;

import jakarta.persistence.MappedSuperclass;

@MappedSuperclass
public abstract class AbstractEntity {

	protected Long oid;
}

package test.entity;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.Id;

@Entity
public class EntityTest extends AbstractEntity {

	@Id
	@Column(name = "ID")
	public Long getOid() {

		return oid;
	}

	public void setOid(Long oid) {

		this.oid = oid;
	}
}

The result of mvn package:

[ERROR] Caused by: org.hibernate.bytecode.enhance.spi.EnhancementException: Enhancement of [test.entity.EntityTest] failed because no field named [oid] could be found for property accessor method [getOid]. To fix this, make sure all property accessor methods have a matching field.

Basically, the bytecode enhancement process seems to now be only considering fields declared in the class that contains the getters/setters, whereas it previously detected inherited fields without issue. The same code builds fine using Quarkus 3.17.0 or lower.

[yrodiere]

@wcicola the present issue was fixed in https://hibernate.atlassian.net/browse/HHH-18904, which means it's fixed in Quarkus 3.17.6 (through #45235). I unfortunately forgot to close issues fixed in the latest ORM version, I'll get to it right now.

Could you please test this with Quarkus 3.17.6, and if your problem still occurs, open a new issue? Preferably, directly on hibernate.atlassian.net and with a reproducer based on this.

Thank you.

[mbladel]

@wcicola I think I know where the bug might come from on the Hibernate ORM side, I believe it's not a Quarkus-related issue.

+1 on what @yrodiere said, please open an issue on Hibernate's issue tracker and include a simple reproducer test case with the problematic mappings.

[wcicola]

@yrodiere @mbladel Many thanks! I'll get that put together and posted today, as it does also happen with Quarkus 3.17.6. Thanks again!