Fix 🦶🔫: Validate visitNonNull
arguments
#4016
Merged
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.
I often find myself shooting myself in the foot passing the wrong
Cursor
tovisitNonNull
.This is a very easy mistake to make and often leads to quite a bit of confusion.
This fixes that by validating that a parent cursor is being passed, not the current cursor.
Signed-off-by: Jonathan Leitschuh [email protected]
What's changed?
Adds a bit of sanity validation to
visitNonNull(Tree tree, P p, Cursor parent)
AFAIK this method is really only called when composing one visitor of another visitor, and
isn't called in the hot-path for normal LST tree traversal.
What's your motivation?
Reduce how often I and other's new to OpenRewrite make the mistake of passing the
Cursor
for the tree, instead of passing the parent cursor.Anything in particular you'd like reviewers to focus on?
Anyone you would like to review specifically?
Have you considered any alternatives or workarounds?
Any additional context
Checklist