Skip to content

Commit d272dfa

Browse files
graememorganError Prone Team
authored and
Error Prone Team
committed
Automated rollback of commit 654d1db.
*** Reason for rollback *** That did not handle varargs well: specifically array arguments in a varargs position. I'll fix and roll forward. *** Original change description *** Handle Joiner.on(...) in AbstractToString. Not yet handling the Iterable overload; that's a bit more involved given the lack of prior art. *** PiperOrigin-RevId: 591308763
1 parent 654d1db commit d272dfa

11 files changed

+1
-95
lines changed

core/src/main/java/com/google/errorprone/bugpatterns/AbstractToString.java

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@
2424
import static com.google.errorprone.util.ASTHelpers.getReceiver;
2525
import static com.google.errorprone.util.ASTHelpers.getSymbol;
2626
import static com.google.errorprone.util.ASTHelpers.getType;
27-
import static com.google.errorprone.util.ASTHelpers.isSubtype;
2827

29-
import com.google.errorprone.ErrorProneFlags;
3028
import com.google.errorprone.VisitorState;
3129
import com.google.errorprone.annotations.FormatMethod;
3230
import com.google.errorprone.bugpatterns.BugChecker.BinaryTreeMatcher;
@@ -117,15 +115,6 @@ protected abstract Optional<Fix> toStringFix(
117115
.named("append")
118116
.withParameters("java.lang.Object"));
119117

120-
private static final Matcher<ExpressionTree> JOINER =
121-
instanceMethod().onDescendantOf("com.google.common.base.Joiner").named("join");
122-
123-
private final boolean handleJoiner;
124-
125-
protected AbstractToString(ErrorProneFlags flags) {
126-
this.handleJoiner = flags.getBoolean("AbstractToString:Joiner").orElse(true);
127-
}
128-
129118
private static boolean isInVarargsPosition(
130119
ExpressionTree argTree, MethodInvocationTree methodInvocationTree, VisitorState state) {
131120
int parameterCount = getSymbol(methodInvocationTree).getParameters().size();
@@ -177,14 +166,6 @@ public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState
177166
handleStringifiedTree(argTree, ToStringKind.FLOGGER, state);
178167
}
179168
}
180-
if (handleJoiner && JOINER.matches(tree, state)) {
181-
var symbol = getSymbol(tree);
182-
if (!isSubtype(symbol.params().get(0).type, state.getSymtab().iterableType, state)) {
183-
for (ExpressionTree argTree : tree.getArguments()) {
184-
handleStringifiedTree(argTree, ToStringKind.IMPLICIT, state);
185-
}
186-
}
187-
}
188169
return NO_MATCH;
189170
}
190171

core/src/main/java/com/google/errorprone/bugpatterns/AnnotationMirrorToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
import static com.google.errorprone.fixes.SuggestedFixes.qualifyType;
2121

2222
import com.google.errorprone.BugPattern;
23-
import com.google.errorprone.ErrorProneFlags;
2423
import com.google.errorprone.VisitorState;
2524
import com.google.errorprone.fixes.Fix;
2625
import com.google.errorprone.fixes.SuggestedFix;
@@ -29,7 +28,6 @@
2928
import com.sun.source.tree.ExpressionTree;
3029
import com.sun.source.tree.Tree;
3130
import java.util.Optional;
32-
import javax.inject.Inject;
3331

3432
/** A {@link BugChecker}; see the associated {@link BugPattern} annotation for details. */
3533
@BugPattern(
@@ -42,11 +40,6 @@ public class AnnotationMirrorToString extends AbstractToString {
4240
private static final TypePredicate TYPE_PREDICATE =
4341
TypePredicates.isExactType("javax.lang.model.element.AnnotationMirror");
4442

45-
@Inject
46-
AnnotationMirrorToString(ErrorProneFlags flags) {
47-
super(flags);
48-
}
49-
5043
@Override
5144
protected TypePredicate typePredicate() {
5245
return TYPE_PREDICATE;

core/src/main/java/com/google/errorprone/bugpatterns/AnnotationValueToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
import static com.google.errorprone.fixes.SuggestedFixes.qualifyType;
2121

2222
import com.google.errorprone.BugPattern;
23-
import com.google.errorprone.ErrorProneFlags;
2423
import com.google.errorprone.VisitorState;
2524
import com.google.errorprone.fixes.Fix;
2625
import com.google.errorprone.fixes.SuggestedFix;
@@ -29,7 +28,6 @@
2928
import com.sun.source.tree.ExpressionTree;
3029
import com.sun.source.tree.Tree;
3130
import java.util.Optional;
32-
import javax.inject.Inject;
3331

3432
/** A {@link BugChecker}; see the associated {@link BugPattern} annotation for details. */
3533
@BugPattern(
@@ -42,11 +40,6 @@ public class AnnotationValueToString extends AbstractToString {
4240
private static final TypePredicate TYPE_PREDICATE =
4341
TypePredicates.isExactType("javax.lang.model.element.AnnotationValue");
4442

45-
@Inject
46-
AnnotationValueToString(ErrorProneFlags flags) {
47-
super(flags);
48-
}
49-
5043
@Override
5144
protected TypePredicate typePredicate() {
5245
return TYPE_PREDICATE;

core/src/main/java/com/google/errorprone/bugpatterns/ArrayToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod;
2121

2222
import com.google.errorprone.BugPattern;
23-
import com.google.errorprone.ErrorProneFlags;
2423
import com.google.errorprone.VisitorState;
2524
import com.google.errorprone.fixes.Fix;
2625
import com.google.errorprone.fixes.SuggestedFix;
@@ -33,7 +32,6 @@
3332
import com.sun.tools.javac.code.Type;
3433
import com.sun.tools.javac.code.Types;
3534
import java.util.Optional;
36-
import javax.inject.Inject;
3735

3836
/**
3937
* @author [email protected] (Mike Edgar)
@@ -49,11 +47,6 @@ public class ArrayToString extends AbstractToString {
4947

5048
private static final TypePredicate IS_ARRAY = TypePredicates.isArray();
5149

52-
@Inject
53-
ArrayToString(ErrorProneFlags flags) {
54-
super(flags);
55-
}
56-
5750
@Override
5851
protected TypePredicate typePredicate() {
5952
return IS_ARRAY;

core/src/main/java/com/google/errorprone/bugpatterns/LiteProtoToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727

2828
import com.google.common.collect.ImmutableSet;
2929
import com.google.errorprone.BugPattern;
30-
import com.google.errorprone.ErrorProneFlags;
3130
import com.google.errorprone.VisitorState;
3231
import com.google.errorprone.fixes.Fix;
3332
import com.google.errorprone.predicates.TypePredicate;
@@ -36,7 +35,6 @@
3635
import com.sun.source.tree.Tree;
3736
import com.sun.tools.javac.code.Type;
3837
import java.util.Optional;
39-
import javax.inject.Inject;
4038

4139
/** Flags calls to {@code toString} on lite protos. */
4240
@BugPattern(
@@ -71,11 +69,6 @@ public final class LiteProtoToString extends AbstractToString {
7169
.add("v", "d", "i")
7270
.build();
7371

74-
@Inject
75-
LiteProtoToString(ErrorProneFlags flags) {
76-
super(flags);
77-
}
78-
7972
@Override
8073
protected TypePredicate typePredicate() {
8174
return LiteProtoToString::matches;

core/src/main/java/com/google/errorprone/bugpatterns/ObjectToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020

2121
import com.google.common.collect.Iterables;
2222
import com.google.errorprone.BugPattern;
23-
import com.google.errorprone.ErrorProneFlags;
2423
import com.google.errorprone.VisitorState;
2524
import com.google.errorprone.fixes.Fix;
2625
import com.google.errorprone.fixes.SuggestedFixes;
@@ -33,7 +32,6 @@
3332
import com.sun.tools.javac.code.Types;
3433
import com.sun.tools.javac.util.Names;
3534
import java.util.Optional;
36-
import javax.inject.Inject;
3735

3836
/**
3937
* Warns against calling toString() on Objects which don't have toString() method overridden and
@@ -74,11 +72,6 @@ private static boolean finalNoOverrides(Type type, VisitorState state) {
7472
&& m.overrides(toString, type.tsym, types, /* checkResult= */ false)));
7573
}
7674

77-
@Inject
78-
ObjectToString(ErrorProneFlags flags) {
79-
super(flags);
80-
}
81-
8275
@Override
8376
protected TypePredicate typePredicate() {
8477
return ObjectToString::finalNoOverrides;

core/src/main/java/com/google/errorprone/bugpatterns/StreamToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,12 @@
2020
import static com.google.errorprone.predicates.TypePredicates.isDescendantOf;
2121

2222
import com.google.errorprone.BugPattern;
23-
import com.google.errorprone.ErrorProneFlags;
2423
import com.google.errorprone.VisitorState;
2524
import com.google.errorprone.fixes.Fix;
2625
import com.google.errorprone.predicates.TypePredicate;
2726
import com.sun.source.tree.ExpressionTree;
2827
import com.sun.source.tree.Tree;
2928
import java.util.Optional;
30-
import javax.inject.Inject;
3129

3230
/** A {@link BugChecker}; see the associated {@link BugPattern} annotation for details. */
3331
@BugPattern(
@@ -37,11 +35,6 @@ public class StreamToString extends AbstractToString {
3735

3836
private static final TypePredicate STREAM = isDescendantOf("java.util.stream.Stream");
3937

40-
@Inject
41-
StreamToString(ErrorProneFlags flags) {
42-
super(flags);
43-
}
44-
4538
@Override
4639
protected TypePredicate typePredicate() {
4740
return STREAM;

core/src/main/java/com/google/errorprone/bugpatterns/SymbolToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import static com.google.errorprone.util.ASTHelpers.isBugCheckerCode;
2424

2525
import com.google.errorprone.BugPattern;
26-
import com.google.errorprone.ErrorProneFlags;
2726
import com.google.errorprone.VisitorState;
2827
import com.google.errorprone.fixes.Fix;
2928
import com.google.errorprone.matchers.Matcher;
@@ -33,7 +32,6 @@
3332
import com.sun.source.tree.Tree;
3433
import com.sun.tools.javac.code.Type;
3534
import java.util.Optional;
36-
import javax.inject.Inject;
3735

3836
/**
3937
* Flags {@code com.sun.tools.javac.code.Symbol#toString} usage in {@link BugChecker}s.
@@ -60,11 +58,6 @@ private static boolean symbolToStringInBugChecker(Type type, VisitorState state)
6058
return IS_SYMBOL.apply(type, state) && STRING_EQUALS.matches(parentTree, state);
6159
}
6260

63-
@Inject
64-
SymbolToString(ErrorProneFlags flags) {
65-
super(flags);
66-
}
67-
6861
@Override
6962
protected TypePredicate typePredicate() {
7063
return SymbolToString::symbolToStringInBugChecker;

core/src/main/java/com/google/errorprone/bugpatterns/TreeToString.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import static com.google.errorprone.util.ASTHelpers.isSubtype;
2525

2626
import com.google.errorprone.BugPattern;
27-
import com.google.errorprone.ErrorProneFlags;
2827
import com.google.errorprone.VisitorState;
2928
import com.google.errorprone.fixes.Fix;
3029
import com.google.errorprone.fixes.SuggestedFix;
@@ -68,9 +67,7 @@ public class TreeToString extends AbstractToString {
6867
.withParameters("java.lang.Object");
6968

7069
@Inject
71-
TreeToString(ErrorProneFlags flags) {
72-
super(flags);
73-
}
70+
TreeToString() {}
7471

7572
@Override
7673
protected TypePredicate typePredicate() {

core/src/main/java/com/google/errorprone/bugpatterns/TypeToString.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import static com.google.errorprone.util.ASTHelpers.isBugCheckerCode;
2424

2525
import com.google.errorprone.BugPattern;
26-
import com.google.errorprone.ErrorProneFlags;
2726
import com.google.errorprone.VisitorState;
2827
import com.google.errorprone.fixes.Fix;
2928
import com.google.errorprone.matchers.Matcher;
@@ -33,7 +32,6 @@
3332
import com.sun.source.tree.Tree;
3433
import com.sun.tools.javac.code.Type;
3534
import java.util.Optional;
36-
import javax.inject.Inject;
3735

3836
/**
3937
* Flags {@code com.sun.tools.javac.code.Type#toString} usage in {@link BugChecker}s.
@@ -60,11 +58,6 @@ private static boolean typeToStringInBugChecker(Type type, VisitorState state) {
6058
return IS_TYPE.apply(type, state) && STRING_EQUALS.matches(parentTree, state);
6159
}
6260

63-
@Inject
64-
TypeToString(ErrorProneFlags flags) {
65-
super(flags);
66-
}
67-
6861
@Override
6962
protected TypePredicate typePredicate() {
7063
return TypeToString::typeToStringInBugChecker;

core/src/test/java/com/google/errorprone/bugpatterns/StreamToStringTest.java

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -82,20 +82,4 @@ public void withinStreamClass() {
8282
"}")
8383
.doTest();
8484
}
85-
86-
@Test
87-
public void viaJoiner() {
88-
compilationHelper
89-
.addSourceLines(
90-
"Test.java",
91-
"import com.google.common.base.Joiner;",
92-
"import java.util.stream.Stream;",
93-
"class Test {",
94-
" public String s(Stream<String> xs) {",
95-
" // BUG: Diagnostic contains:",
96-
" return Joiner.on(\"foo\").join(xs, xs);",
97-
" }",
98-
"}")
99-
.doTest();
100-
}
10185
}

0 commit comments

Comments
 (0)