Preliminary support for Panache2 #10411

FroMage · 2025-06-25T14:27:33Z

Supports Panache2, which comes in a new package io.quarkus.hibernate.panache (since it supports both ORM and HR, they are not in the package name anymore). With new entity supertype, as well as repository supertypes and way of working.

Rough example entity:

@Entity
public class MyEntity extends WithId.AutoLong implements PanacheEntity.Stateless {
  public String name;

  public interface Repo {
    @Find
    MyEntity findSomeone(String name);
  }
}

This will generate the following:

@StaticMetamodel(MyEntity.class)
@Generated("org.hibernate.processor.HibernateProcessor")
public abstract class MyEntity_ extends WithId_ {

	/**
	 * Implements repository {@link org.acme.MyEntity.Repo}
	 **/
	@Dependent
	@Generated("org.hibernate.processor.HibernateProcessor")
	public static class Repo_ implements Repo {
	
	
		
		protected final @Nonnull Session session;
		
		@Inject
		public Repo_(@Nonnull Session session) {
			this.session = session;
		}
		
		public @Nonnull Session getSession() {
			return session;
		}
		
		/**
		 * Find {@link MyEntity} by {@link MyEntity#name name}.
		 *
		 * @see org.acme.MyEntity.Repo#findByName(String)
		 **/
		@Override
		public MyEntity findByName(String name) {
			var _builder = session.getCriteriaBuilder();
			var _query = _builder.createQuery(MyEntity.class);
			var _entity = _query.from(MyEntity.class);
			_query.where(
					name==null
						? _entity.get(MyEntity_.name).isNull()
						: _builder.equal(_entity.get(MyEntity_.name), name)
			);
			return session.createSelectionQuery(_query)
					.getSingleResult();
		}
	
	}
	
	/**
	 * @see #name
	 **/
	public static final String NAME = "name";

	
	/**
	 * Static metamodel type for {@link org.acme.MyEntity}
	 **/
	public static volatile EntityType<MyEntity> class_;
	
	/**
	 * Static metamodel for attribute {@link org.acme.MyEntity#name}
	 **/
	public static volatile SingularAttribute<MyEntity, String> name;
	
	public static Repo repo() {
		return CDI.current().select(Repo.class).get();
	}
	
	public static PanacheManagedBlockingRepository managedBlocking() {
		return CDI.current().select(PanacheManagedBlockingRepository.class).get();
	}
	
	@Dependent
	@Generated("org.hibernate.processor.HibernateProcessor")
	public static class PanacheManagedBlockingRepository implements io.quarkus.hibernate.panache.managed.blocking.PanacheManagedBlockingRepositoryBase<MyEntity, java.lang.Long> {
	}
	
	public static PanacheStatelessBlockingRepository statelessBlocking() {
		return CDI.current().select(PanacheStatelessBlockingRepository.class).get();
	}
	
	@Dependent
	@Generated("org.hibernate.processor.HibernateProcessor")
	public static class PanacheStatelessBlockingRepository implements io.quarkus.hibernate.panache.stateless.blocking.PanacheStatelessBlockingRepositoryBase<MyEntity, java.lang.Long> {
	}
	
	public static PanacheManagedReactiveRepository managedReactive() {
		return CDI.current().select(PanacheManagedReactiveRepository.class).get();
	}
	
	@Dependent
	@Generated("org.hibernate.processor.HibernateProcessor")
	public static class PanacheManagedReactiveRepository implements io.quarkus.hibernate.panache.managed.reactive.PanacheManagedReactiveRepositoryBase<MyEntity, java.lang.Long> {
	}
	
	public static PanacheStatelessReactiveRepository statelessReactive() {
		return CDI.current().select(PanacheStatelessReactiveRepository.class).get();
	}
	
	@Dependent
	@Generated("org.hibernate.processor.HibernateProcessor")
	public static class PanacheStatelessReactiveRepository implements io.quarkus.hibernate.panache.stateless.reactive.PanacheStatelessReactiveRepositoryBase<MyEntity, java.lang.Long> {
	}

}

To recap:

Detects Panache2 package and types
Scans nested interfaces in entities to find repositories
Generates accessors for nested repos
Generates implementations and accessors for managed/stateless/blocking/reactive repos (reactive only if HR is detected)
Switch to using Session instead of EntityManager for Panache1&2 since that's what Quarkus switched to a while ago

There are tests for all this, but they're in Quarkus, and can only be merged once this gets merged. This is because @yrodiere gets an allergic skin reaction with cyclic dependencies, and assures me that the ORM CI now invokes the Quarkus CI, so even though you won't see the tests when you run them locally, they will eventually be run as part of the ORM CI.

Let me know what you think, @gavinking and if you want me to change anything.

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.

- Detect Panache2 in classpath - Detect Panache2 types for entities and repositories

Since repositories can be nested in entities, we can use the outer type

Comes with 4 out of the box: - managed/blocking (generated) - managed/reactive (generated if reactive-common is in the CP) - stateless/blocking (generated) - stateless/reactive (generated if reactive-common is in the CP) - whatever nested repositories from the entity -- and if they implement one of the first four, we use this instead of the generated one

… Uni to decide for reactive session

hibernate-github-bot · 2025-06-25T14:27:42Z

Thanks for your pull request!

This pull request does not follow the contribution rules. Could you have a look?

❌ All commit messages should start with a JIRA issue key matching pattern HHH-\d+
↳ Offending commits: [7205879, c3e659d, 12697ff, dbcbc50, 623cbf8, 41f262b, 1a8fbb7, aaa58e5]

› This message was automatically generated.

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

gavinking · 2025-06-25T19:52:10Z

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

@@ -373,7 +382,7 @@ private void processClasses(RoundEnvironment roundEnvironment) {
 			try {
 				final AnnotationMetaEntity metaEntity =
 						AnnotationMetaEntity.create( typeElement, context,
-								parentMetadata( typeElement, context::getMetaEntity ) );
+								parentMetadata( typeElement, context::getMetaEntity ), null );


How about overloading AnnotationMetaEntity.create() instead of passing null?

I was waiting for Java to get defaulted params.

gavinking · 2025-06-25T19:56:31Z

...tamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java

+			switch(typedIdMember.getKind()) {
+				case ARRAY:
+				case DECLARED:
+				case BOOLEAN:
+				case BYTE:
+				case CHAR:
+				case SHORT:
+				case INT:
+				case LONG:
+				case FLOAT:
+				case DOUBLE:
+					return typedIdMember;
+				case EXECUTABLE:
+					return ((ExecutableType) typedIdMember).getReturnType();


switch expression?

gavinking · 2025-06-25T19:58:13Z

...tamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java

+	private @Nullable Element findIdMember() {
+		if ( primaryEntity == null ) {
+			message( element,
+					"No primary entity defined to find id member",
+					Diagnostic.Kind.ERROR );
+			return null;
+		}
+		for ( Element member : context.getAllMembers( primaryEntity ) ) {
+			if ( hasAnnotation( member, ID, EMBEDDED_ID ) ) {
+				return member;
+			}
+		}
+		message( element,
+				"Could not find any member annotated with @Id or @EmbeddedId",
+				Diagnostic.Kind.ERROR );
+		return null;
+	}


Shouldn't you also look for an @IdClass here?

I should definitely.

gavinking · 2025-06-25T19:59:42Z

Rough example entity:

@Entity
public class MyEntity extends WithId.AutoLong implements PanacheEntity.Stateless {
  public String name;

  public interface Repo {
    @Find
    MyEntity findSomeone(String name);
  }
}

Is this code example missing a @Repository annotation?

yrodiere · 2025-06-26T08:14:31Z

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

@@ -253,9 +253,16 @@ private boolean handleSettings(ProcessingEnvironment environment) {
 		PackageElement quarkusOrmPanachePackage =
 				context.getProcessingEnvironment().getElementUtils()
 						.getPackageElement( "io.quarkus.hibernate.orm.panache" );
+		PackageElement quarkusPanache2Package =
+				context.getProcessingEnvironment().getElementUtils()
+						.getPackageElement( "io.quarkus.hibernate.panache" );


We discussed at some point going with "Quarkus Data" instead of "Panache 2"... Are you sure you still want to go with this name and package? io.quarkus.data.hibernate could work too, in that case?

Maybe this is a discussion we should take offline.

Did we? Or are you just trying to trick me because you know my memory doesn't go that far? 🤔

FroMage · 2025-06-26T08:58:58Z

Rough example entity:
Is this code example missing a @Repository annotation?

Well no, this is with the ORM @Find annotation, so I don't need a @Repository (JD)

gavinking · 2025-06-26T10:07:43Z

Well no, this is with the ORM @Find annotation, so I don't need a @Repository (JD)

Ah OK, I see.

gavinking · 2025-06-26T10:08:20Z

@FroMage the bot is nagging you about your } else if (s.

Sanne · 2025-06-26T21:11:52Z

@FroMage the bot is also nagging you about not removing the dual-licensing notice in the PR description ;)

…sor/util/TypeUtils.java Co-authored-by: Gavin King <gavin@hibernate.org>

...tamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java

+		TypeElement primaryEntityForTest = primaryEntity;
+		if ( idMember != null && primaryEntityForTest != null ) {
+			TypeMirror typedIdMember = this.context.getTypeUtils().asMemberOf((DeclaredType) primaryEntityForTest.asType(), idMember);
+			TypeMirror idType = null;


FroMage added 7 commits June 25, 2025 15:41

Support Panache2

7205879

- Detect Panache2 in classpath - Detect Panache2 types for entities and repositories

For Panache2, allow repositories to have a primary entity auto-detected

c3e659d

Since repositories can be nested in entities, we can use the outer type

Detect repositories nested in entities, for Panache2

12697ff

Avoid inspecting private interface methods

dbcbc50

Make sure inheritance test works with interfaces

41f262b

For Panache 2 repositories, look for any annotated method returning a…

1a8fbb7

… Uni to decide for reactive session

gavinking reviewed Jun 25, 2025

View reviewed changes

yrodiere reviewed Jun 26, 2025

View reviewed changes

Update tooling/metamodel-generator/src/main/java/org/hibernate/proces…

aaa58e5

…sor/util/TypeUtils.java Co-authored-by: Gavin King <gavin@hibernate.org>

github-advanced-security bot found potential problems Jun 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Preliminary support for Panache2 #10411

Preliminary support for Panache2 #10411

Uh oh!

FroMage commented Jun 25, 2025 •

edited

Loading

Uh oh!

hibernate-github-bot bot commented Jun 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

gavinking Jun 25, 2025

Uh oh!

FroMage Jun 27, 2025

Uh oh!

gavinking Jun 27, 2025

Uh oh!

gavinking Jun 25, 2025

Uh oh!

gavinking Jun 25, 2025

Uh oh!

FroMage Jun 26, 2025

Uh oh!

gavinking commented Jun 25, 2025

Uh oh!

yrodiere Jun 26, 2025

Uh oh!

FroMage Jun 26, 2025

Uh oh!

FroMage commented Jun 26, 2025

Uh oh!

gavinking commented Jun 26, 2025

Uh oh!

gavinking commented Jun 26, 2025

Uh oh!

Sanne commented Jun 26, 2025

Uh oh!

Check notice

Uh oh!

Preliminary support for Panache2 #10411

Are you sure you want to change the base?

Preliminary support for Panache2 #10411

Uh oh!

Conversation

FroMage commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hibernate-github-bot bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gavinking commented Jun 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FroMage commented Jun 26, 2025

Uh oh!

gavinking commented Jun 26, 2025

Uh oh!

gavinking commented Jun 26, 2025

Uh oh!

Sanne commented Jun 26, 2025

Uh oh!

Check notice

Uh oh!

FroMage commented Jun 25, 2025 •

edited

Loading

hibernate-github-bot bot commented Jun 25, 2025 •

edited

Loading