Fix logging with panache in entities #22734
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In case an entity class uses `io.quarkus.logging.Log`, it requires two bytecode transformations: the Hibernate transformation, and the logging transformation. Unfortunately, `HibernateEntityEnhancer` needs to break the chain of class visitors to be able to call into the Hibernate Enhancer API. To be able to pretend that it's still a regular `ClassVisitor`, it serializes the intermediate state to a `byte[]`, runs the Hibernate enhancer, and then builds a whole new `ClassReader` to continue in the original chain. This new `ClassReader` is missing the options set on the original `ClassReader`, which causes a failure in the logging transformation, because that uses `LocalVariablesSorter`. This commit introduces `QuarkusClassVisitor`, a new superclass for class visitors that require access to some contextual data. The bytecode transformation machinery puts the `ClassReader` options into each `QuarkusClassVisitor` instance before the bytecode transformation process begins. Finally, `HibernateEntityEnhancer` extends this new class, so that when it creates the new `ClassReader`, it can pass the correct options.
quarkus-bot
bot
added
area/core
area/hibernate-orm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In case an entity class uses
io.quarkus.logging.Log, it requirestwo bytecode transformations: the Hibernate transformation, and
the logging transformation. Unfortunately,
HibernateEntityEnhancerneeds to break the chain of class visitors to be able to call into
the Hibernate Enhancer API. To be able to pretend that it's still
a regular
ClassVisitor, it serializes the intermediate stateto a
byte[], runs the Hibernate enhancer, and then builds a wholenew
ClassReaderto continue in the original chain. This newClassReaderis missing the options set on the originalClassReader,which causes a failure in the logging transformation, because that
uses
LocalVariablesSorter.This commit introduces
QuarkusClassVisitor, a new superclassfor class visitors that require access to some contextual data.
The bytecode transformation machinery puts the
ClassReaderoptions into each
QuarkusClassVisitorinstance beforethe bytecode transformation process begins. Finally,
HibernateEntityEnhancerextends this new class, so that whenit creates the new
ClassReader, it can pass the correct options.Fixes #22157