HHH-18829 Auto generate record ID class if no explicit @IdClass #9220

cigaly · 2024-11-08T13:06:56Z

This is "sketch" of the problem solution on the side of Hibernate Processor.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.

https://hibernate.atlassian.net/browse/HHH-18384

cigaly · 2024-11-08T15:07:38Z

Last two commits are idea for potential solution on Hibernate Core side.

gavinking · 2024-11-08T18:20:00Z

tooling/metamodel-generator/src/main/java/org/hibernate/processor/ClassWriter.java

+			pw.println( ") {}" );
+			pw.println();
+		}
+	}


This is nice and simple, for sure, but it's kind-of a layer-breaker. It would be better to make a new subclass of AnnotationMeta for this, even though I admit that's a PITA.

[I don't love the architecture, but it's not terrible, and it's what we've inherited.

You're right, but I think that generated ID class should be member of generated entity (or embeddable?) meta class. Then it should be implementing MetaAttribute which is less than half PITA :-)

Additional thing is that order of record components should be preserved. At least one test in core failed due to that.

cigaly · 2024-11-17T12:30:16Z

@gavinking Can you, please check those two tests that are now failing? I think that both are either wrong or hiding problem some other than something caused by changes in this PR.

First one is org.hibernate.orm.test.annotations.derivedidentities.bidirectional.CompositeDerivedIdentityTest#testBidirectonalKeyManyToOneId. This one is failing on line 96:

        OrderLine orderLineGotten = session.get( OrderLine.class, orderLine );

Javadoc for org.hibernate.Session#get(java.lang.Class<T>, java.lang.Object) says that id parameter is "persistent instance or null". Here it is complete entity itself. I do not know if this may be acceptable, but same test will fail if comment is removed from @IdClass(OrderLinePK.class) in org.hibernate.orm.test.annotations.derivedidentities.bidirectional.OrderLine, so I have no reason to believe that this has been caused by PK changes.

The other failing test is org.hibernate.orm.test.boot.models.hbm.joinformula.JoinColumnAndFormulaTests#testHbmXmlTransformed. In mainbranch it is annotated with @FailureExpected because of the problem described in HHH-18384. For some reasons (unknown to me, at least for now), changes in this PR fix (at least partially) this problem, so exception has not been thrown. I've suggested solution to mentioned problem in PR #9273

gavinking · 2024-11-23T16:52:05Z

@cigaly OK, so this makes perfect sense actually.

Historically Hibernate already allowed you to have an entity class without an @IdClass, in which case the only way you could do a find-by-id was to pass an instance of the entity itself. (Yes, of course this is highly inelegant.)

But now you're generating an @IdClass for this entity, so that test is broken.

What I would suggest is to simply @Exclude that package from annotation processing.

cigaly · 2024-11-23T20:39:40Z

OK, I've added @Exclude to those three entity classes. Now just one test is failing, but this can be fixed by another PR.

It seems, according to both JPA specification and Hibernate User Guide that composite ID must be either @EmbeddedId or @IdClass. Really confusing sometimes :-)

gavinking · 2024-11-23T21:27:33Z

Yes it's an ancient undocumented misfeature but occasionally it's sorta nice to not have to write a composite of class if you don't plan on loading the entity by id. I sometimes take advantage of it when I'm just playing around.

cigaly · 2024-11-25T11:52:11Z

Yes, backward compatibility ... on one side you must keep it, but on other you can live with it :-)

Anyway, please correct me if I am wrong ... if we simplify OrderLinePK as

public record OrderLinePK( Order order, Product product){}

and remove comment from @IdClass(OrderLinePK.class) in OrderLine,
and finally replace in org.hibernate.orm.test.annotations.derivedidentities.bidirectional.CompositeDerivedIdentityTest#testBidirectonalKeyManyToOneId line

OrderLine orderLineGotten = session.get( OrderLine.class, orderLine );

with

OrderLine orderLineGotten = session.get( OrderLine.class, new OrderLinePK( orderLine.getOrder(), orderLine.getProduct() ) );

test should pass as it is passing when entity is used instead of id?

Is that correct or I've missed something important?

gavinking · 2024-12-05T08:30:18Z

@cigaly can you rebase this on main and squash it down into a couple of commits please?

cigaly · 2024-12-05T10:30:22Z

@gavinking Squashed. There are no conflicts with main branch. All tests were passing on this branch, I am now running tests on merged branch.

@exclude

- Hibernate Processor - generate ID class in metadata class if entity not annotated with @IdClass; order of record components must match order of properties in entity class - Hibernate Core - check if ID class has been properly generated with preserved order of components - Annotated existing test entity classes with @exclude when ID class can not be generated without causing compilation errors

- Hibernate Processor - create ID class in meta data class if entity class with more than one ID component is not annotated with @IdClass; property order must be preserved - Hibernate Core - if entity class has more than one ID component, but is not annotated with @IdClass entity binder should try to use ID class from metamodel if generated

hibernate-github-bot · 2024-12-05T16:51:01Z

Thanks for your pull request!

This pull request appears to follow the contribution rules.

› This message was automatically generated.

gavinking · 2024-12-05T18:34:22Z

Merged, thanks Cedomir!

gavinking reviewed Nov 8, 2024

View reviewed changes

cigaly force-pushed the HHH-18829 branch 2 times, most recently from 0070126 to 424ba15 Compare November 16, 2024 20:39

cigaly mentioned this pull request Nov 17, 2024

HHH-18693 Hibernate Processor does not handle inner types #9098

Merged

cigaly force-pushed the HHH-18829 branch 2 times, most recently from 7a06415 to 821a63a Compare November 23, 2024 14:53

cigaly force-pushed the HHH-18829 branch 2 times, most recently from bb58e6f to 074cf68 Compare December 2, 2024 09:52

cigaly marked this pull request as ready for review December 2, 2024 09:53

cigaly force-pushed the HHH-18829 branch from 074cf68 to c41799b Compare December 5, 2024 10:27

cigaly added 2 commits December 5, 2024 17:34

gavinking force-pushed the HHH-18829 branch from 43005e1 to 467a4ec Compare December 5, 2024 16:57

gavinking merged commit 445f95f into hibernate:main Dec 5, 2024
22 of 23 checks passed

Uh oh!

HHH-18829 Auto generate record ID class if no explicit @IdClass #9220

HHH-18829 Auto generate record ID class if no explicit @IdClass #9220

Uh oh!

Conversation

cigaly commented Nov 8, 2024 • edited by gavinking Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cigaly commented Nov 8, 2024

Uh oh!

gavinking Nov 8, 2024

Choose a reason for hiding this comment

Uh oh!

cigaly Nov 14, 2024

Choose a reason for hiding this comment

Uh oh!

cigaly commented Nov 17, 2024 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gavinking commented Nov 23, 2024

Uh oh!

cigaly commented Nov 23, 2024

Uh oh!

gavinking commented Nov 23, 2024

Uh oh!

cigaly commented Nov 25, 2024

Uh oh!

gavinking commented Dec 5, 2024

Uh oh!

cigaly commented Dec 5, 2024

Uh oh!

hibernate-github-bot bot commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

gavinking commented Dec 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cigaly commented Nov 8, 2024 •

edited by gavinking

Loading

cigaly commented Nov 17, 2024 •

edited by atlassian bot

Loading

hibernate-github-bot bot commented Dec 5, 2024 •

edited

Loading