Feature: Add ConsistentOverrides errorprone rule #1712
Merged
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
carterkozak
previously requested changes
Apr 1, 2021
|
For sure! I just put a quick scaffold to start the discussion :) |
ferozco
changed the title
|
@carterkozak think this is ready for a look |
carterkozak
reviewed
Apr 5, 2021
There was a problem hiding this comment.
I thought we decided only to require variable names to match the contract for any two parameters that can be switched without breaking compilation, I think that requiring every name to match the interface is unnecessarily strict. You were worried about the StdDeserializer names p and ctxt which would be flagged by this PR in its current state.
Note that this will also need to retain leading underscores as to allow StrictUnusedVariable to work correctly.
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentInterfaces.java
Outdated
Show resolved
Hide resolved
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentInterfaces.java
Outdated
Show resolved
Hide resolved
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentInterfaces.java
Outdated
Show resolved
Hide resolved
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentInterfaces.java
Outdated
Show resolved
Hide resolved
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentInterfaces.java
Outdated
Show resolved
Hide resolved
|
Any updates, @ferozco? |
carterkozak
reviewed
Apr 12, 2021
...line-error-prone/src/test/java/com/palantir/baseline/errorprone/ConsistentOverridesTest.java
Show resolved
Hide resolved
carterkozak
reviewed
Apr 12, 2021
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentOverrides.java
Outdated
Show resolved
Hide resolved
carterkozak
reviewed
Apr 12, 2021
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentOverrides.java
Outdated
Show resolved
Hide resolved
carterkozak
reviewed
Apr 12, 2021
baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentOverrides.java
Outdated
Show resolved
Hide resolved
|
Builds are breaking because of a bintray brown out that should hopefully end soon |
ferozco
changed the title
carterkozak
force-pushed
the
fo/consistent-implementation
branch
from
27d3cae
to
e37661b
Compare
|
👍 |
|
needs one more +1 |
|
👍 |
|
Released 3.79.0 |
This was referenced Jun 22, 2021
Closed
Merged
This was referenced Sep 15, 2021
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.
Before this PR
We've encountered a few cases where folks would implement an interface with methods with multiple parameters of the same type and inadvertently switch the variable names around resulting in unexpected behaviour.
After this PR
==COMMIT_MSG==
Add ConsistentInterfaceImplementation errorprone rule
==COMMIT_MSG==
The rule will catch cases where a sequence of parameters of the same type have the same variable names as the interface but in a different order
Possible downsides?