Warn extension authors if build step and recorder are in the same package #34006
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
…kage This is meant to guard against cases where a call to a recorder method cannot be proxied (due to packaging rules) leading to a real call to the recorder method being performed in the build step method. For public recorder methods, the method call is always proxyable, thus by warning about same package use, we nudge extension authors towards using public methods in their recorder classes. Note that we cannot simply reject package private methods in recorder since these methods could very well be used in code that is not called at build time. Relates to: quarkusio#33957
|
@gsmet I really think we should include this as it can save extension hours of wasted time (and us from debugging such issues) |
gastaldi
approved these changes
Jun 20, 2023
| @@ -390,6 +396,10 @@ private void validateRecordBuildSteps(TypeElement clazz) { | |||
| } | |||
| } | |||
|
|
|||
| private Name getPackageName(TypeElement clazz) { | |||
| return processingEnv.getElementUtils().getPackageOf(clazz).getQualifiedName(); | |||
There was a problem hiding this comment.
What is returned if a class is in the default package?
There was a problem hiding this comment.
It returns PackageElement that represents the default package.
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.
This is meant to guard against cases where a call to a recorder method cannot be proxied (due to packaging rules) leading to a real call to the recorder method being performed in the build step method.
For public recorder methods, the method call is always proxyable, thus by warning about same package use, we nudge extension authors towards using public methods in their recorder classes.
Note that we cannot simply reject package private
methods in recorder since these methods could very well be used in code that is not called at build time.
Relates to: #33957