WG - Panache.Next

[FroMage]

Objective

The main objective of this working group is to bring forth the next version of Panache.

The Problem

Panache is great for many things, but over time, we realised the following limitations:

• We have three distinct versions : Hibernate ORM, Hibernate Reactive and Mongo (blocking and reactive)
• It is impossible to use the same entities with Hibernate ORM and Hibernate Reactive
• Stateless sessions are not supported
• Hibernate Processor annotations, and Jakarta Data are not supported
• We have triplicate types such as Sort and Order between Panache, ORM and Jakarta Data
• We have two ways to place entity query operations : on the entity itself, or in repositories
• Entity query operations require type-system hacks which makes them less type-safe than we want with var and for-each and especially with reactive operations.

The proposed Solution

We propose a new Panache version that will solve all these issues:

• Unify all variants in a single module, supporting blocking, reactive, stateless and stateful sessions
• Provide an entity toplevel class for each 4 modes of operation, yet allow access to the other modes
• Move all entity query operations from the entity class to the repository class
• Provide a repository toplevel class for each 4 modes of operation, yet allow access to the other modes
• Provide easy access to any type of repository by placing them as nested interfaces in the entity class, via a generated accessor on the entity metamodel class
• Provide out of the box accessors for the 4 modes of operation repositories on the entity metamodel class
• Support Jakarta Data and Hibernate Processor type-safe annotations
• Optional: Support of Mongo via the coming ORM JDBC support
• Optional: provide JD repository type alternatives for the missing three modes
• Optional: provide a way to convert Panache 1 to Panache.Next

Definition of Done

• Deliver the new Panache extension as a stable state (after preview/experimental versions for feedback)
• Tests
• Documentation
• Codestart
• REST Data with Panache support
• Renarde support
• Quarkus Insights

Scope of Work

It is currently out of scope to retrofit this with the existing Panache modules. This will be a new module with no backward compatibility (though most type-unsafe operations will carry on as-is so will be familiar).

Organizing the Work

Communication and Transparency:

This will be done via GitHub issues on the Quarkus core project.

Point of Contact:

Stéphane Épardaud

Expected Timeline:

Most of the R&D and design has been done over the last two years. Remains now to merge it, document it, test it and tweak it until it's done.

Existing issues

• ORM annotation processor PR Preliminary support for Panache2 hibernate/hibernate-orm#10411
• Panache 2 issue Panache 2 #46096

[FroMage]

Remains to be decided what to call this. For now it's Hibernate with Panache (as opposed to the current Hibernate ORM/Reactive with Panache) but @yrodiere wanted to call this Quarkus Data.

[cescoffier]

Working group board created: WG - Panache.Next (view)