compiler: Default to @generated=omit #12080
Merged
Conversation
This file contains hidden or 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
After many years of issue 9179 being open, there's been nothing to show that we need the javax.annotations.Generated annotation. Most tools use file paths and a few check for annotations with "Generated" in the name. ErrorProne has a few that check for javax.annotations.Generated, but only UnnecessarilyFullyQualified looks like it'd be a problem and it is disabled by default. We're not getting any more information, no users have reported issues with `@generated=omit`, and the existing dependency is annoying users, so just drop it. Given we will still retain the GrpcGenerated annotation, it seems highly likely things are already okay. Even if there are problems they would probably be addressed by adding a io.grpc.stub.annotations.Generated annotation or small tweaks. In the short-term, (non-Bazel) users can use `@generated=javax`, but long-term we could consider removing the option assuming we've resolved any outstanding issues. We will want to update the examples and the README to remove the org.apache.tomcat:annotations-api dependency after the next release. Fixes grpc#9179
This was referenced May 20, 2025
| @@ -15,12 +15,3 @@ java_library( | |||
| artifact("org.codehaus.mojo:animal-sniffer-annotations"), | |||
| ], | |||
| ) | |||
|
|
|||
| # javax.annotation.Generated is not included in the default root modules in 9, | |||
There was a problem hiding this comment.
As we are removing this we should not say in the PR description that bazel users can still use generated="javax" in the short term, right?
Update: (after seeing the boq CL) Or we are saying they can get the javax annotations emitted but should not actually check for its presence in the classpath?
There was a problem hiding this comment.
I mentioned that only non-Bazel users can use that workaround, but I could have called it out more.
(non-Bazel) users can use
@generated=javax
But yes, Bazel users don't get a choice.
We don't support any toolchain overriding in Bazel currently, so our toolchain is always used:
grpc-java/java_grpc_library.bzl
Lines 136 to 138 in 2fb0957
We can change all Bazel usages to include the @generated=javax, but there's not a mechanism to let specific people override it... I guess except for someone patching our repository.
kannanjgithub
approved these changes
May 21, 2025
AgraVator
pushed a commit
to AgraVator/grpc-java
that referenced
this pull request
May 27, 2025
After many years of issue 9179 being open, there's been nothing to show that we need the javax.annotations.Generated annotation. Most tools use file paths and a few check for annotations with "Generated" in the name. ErrorProne has a few that check for javax.annotations.Generated, but only UnnecessarilyFullyQualified looks like it'd be a problem and it is disabled by default. We're not getting any more information, no users have reported issues with `@generated=omit`, and the existing dependency is annoying users, so just drop it. Given we will still retain the GrpcGenerated annotation, it seems highly likely things are already okay. Even if there are problems they would probably be addressed by adding a io.grpc.stub.annotations.Generated annotation or small tweaks. In the short-term, (non-Bazel) users can use `@generated=javax`, but long-term we could consider removing the option assuming we've resolved any outstanding issues. We will want to update the examples and the README to remove the org.apache.tomcat:annotations-api dependency after the next release. Fixes grpc#9179
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.
After many years of issue 9179 being open, there's been nothing to show that we need the javax.annotations.Generated annotation. Most tools use file paths and a few check for annotations with "Generated" in the name. ErrorProne has a few that check for precisely "Generated", but only UnnecessarilyFullyQualified looks like it'd be a problem and it is disabled by default. We're not getting any more information, no users have reported issues with
@generated=omit, and the existing dependency is annoying users, so just drop it.Given we will still retain the GrpcGenerated annotation, it seems highly likely things are already okay. Even if there are problems they would probably be addressed by adding a io.grpc.stub.annotations.Generated annotation or small tweaks. In the short-term, (non-Bazel) users can use
@generated=javax, but long-term we could consider removing the option assuming we've resolved any outstanding issues.We will want to update the examples and the README to remove the org.apache.tomcat:annotations-api dependency after the next release.
Fixes #9179