Fix false positive in AnnotateNullableParameters when parameter der…#868
Open
stefanodallapalma wants to merge 3 commits into
Conversation
…eferenced before null check
…ers` Replace cursor-message state with plain instance fields keyed by `JavaType.Variable` so scope-shadowed identifiers stay distinct, drop the redundant method-invocation/unary arms of `handleCondition` (now reached via the standard visitor traversal), and remove the narrative comments that duplicated what the code already says.
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
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.
Fix false positive in
AnnotateNullableParameterswhen parameter dereferenced before null checkCo-authored with Factory Droid 0.102.0.
Problem
The
AnnotateNullableParametersrecipe had a false positive: it would annotate parameters as@Nullableeven when they were dereferenced (via method calls or field access) before being null-checked. This could lead to incorrect annotations that suggest a parameter can be null when it would actually cause aNullPointerException.Example of the false positive from actual code:
Previously, the recipe would incorrectly add
@CheckForNulltopostingAddendumRecordeven thoughpostingAddendumRecord.getLineNumber()is called before the null check, making the annotation misleading.Solution
Refactored the internal visitor to track both null checks and dereferences in a single pass:
Renamed visitor:
NullCheckVisitor→NullCheckAndDereferenceVisitorto reflect its expanded responsibilitiesState tracking via Cursor messaging: Replaced the reduce pattern with stateful tracking using three keys:
NULL_CHECKED_KEY- parameters that have been null-checkedDEREFERENCED_KEY- parameters that have been dereferenced before null-checkNULL_CHECK_STATE_KEY- tracks null-check status during AST traversalDereference detection: Added
visitFieldAccessand enhancedvisitMethodInvocationto detect when parameters are dereferenced via:param.method()param.fieldRefined null-checking method handling: Separated
Objects.requireNonNullElseandObjects.requireNonNullElseGetintoFIRST_ARG_NULLABLE_MATCHERSsince only their first argument can be null (second is the non-null fallback)Final filtering:
getNullCheckedIdentifiers()now filters out parameters that were dereferenced before being null-checkedTesting
noChangeWhenParameterDereferencedBeforeNullCheck()- verifies the recipe doesn't annotate parameters dereferenced before null checksAll existing tests pass, confirming backward compatibility.
Requested reviewer
@timtebeek