Model Lombok-generated equals methods as having a @Nullable parameter #874
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
msridhar
commented
Dec 6, 2023
Comment on lines
+89
to
+110
|
|
||
| /** | ||
| * Mark the first argument of Lombok-generated {@code equals} methods as {@code @Nullable}, since | ||
| * Lombok does not generate the annotation. | ||
| */ | ||
| @Override | ||
| public Nullness[] onOverrideMethodInvocationParametersNullability( | ||
| VisitorState state, | ||
| Symbol.MethodSymbol methodSymbol, | ||
| boolean isAnnotated, | ||
| Nullness[] argumentPositionNullness) { | ||
| if (ASTHelpers.hasAnnotation(methodSymbol, LOMBOK_GENERATED_ANNOTATION_NAME, state)) { | ||
| // We assume that Lombok-generated equals methods with a single argument override | ||
| // Object.equals and are not an overload. | ||
| if (methodSymbol.getSimpleName().contentEquals("equals") | ||
| && methodSymbol.params().size() == 1) { | ||
| // The parameter is not annotated with @Nullable, but it should be. | ||
| argumentPositionNullness[0] = Nullness.NULLABLE; | ||
| } | ||
| } | ||
| return argumentPositionNullness; | ||
| } |
There was a problem hiding this comment.
This is the only real logic change
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #874 +/- ##
============================================
- Coverage 87.06% 87.03% -0.04%
- Complexity 1924 1926 +2
============================================
Files 77 77
Lines 6225 6231 +6
Branches 1209 1212 +3
============================================
+ Hits 5420 5423 +3
- Misses 403 405 +2
- Partials 402 403 +1 ☔ View full report in Codecov by Sentry. |
msridhar
added a commit
to msridhar/NullAway
that referenced
this pull request
Dec 27, 2023
msridhar
added a commit
that referenced
this pull request
Dec 27, 2023
#886) …arameter (#874)" This reverts commit 5fbee1f. It turns out that this change requires a couple of other changes along with it, including #880 and better overall checking of overriding of `equals()` methods. We want to get a release out soon, so temporarily revert this change; we will restore it after cutting the release.
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.
See the new test in
UsesDTO. Without this change, NullAway reports an incorrect warning for this code that passes a@Nullableparameter to a Lombok-generatedequals()method.The real logic change in this PR is very small. Most of the changes are required to make a
VisitorStateobject available in aHandlermethod.