Skip to content

Commit 0bd7432

Browse files
graememorganError Prone Team
graememorgan
authored and
Error Prone Team
committed
Rollforward of 654d1db: Handle Joiner.on(...) in AbstractToString.
Not yet handling the Iterable overload; that's a bit more involved given the lack of prior art. Handily there was a 'isInVarargsPosition' _right there_. PiperOrigin-RevId: 604758974
1 parent 5f20325 commit 0bd7432

12 files changed

Lines changed: 135 additions & 2 deletions

File tree

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

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import static com.google.errorprone.util.ASTHelpers.getSymbol;
2626
import static com.google.errorprone.util.ASTHelpers.getType;
2727

28+
import com.google.errorprone.ErrorProneFlags;
2829
import com.google.errorprone.VisitorState;
2930
import com.google.errorprone.annotations.FormatMethod;
3031
import com.google.errorprone.bugpatterns.BugChecker.BinaryTreeMatcher;
@@ -42,6 +43,7 @@
4243
import com.sun.source.tree.Tree.Kind;
4344
import com.sun.source.util.TreePath;
4445
import com.sun.tools.javac.code.Type;
46+
import com.sun.tools.javac.code.Type.ArrayType;
4547
import com.sun.tools.javac.code.Type.MethodType;
4648
import java.util.List;
4749
import java.util.Optional;
@@ -117,6 +119,15 @@ protected abstract Optional<Fix> toStringFix(
117119
.named("append")
118120
.withParameters("java.lang.Object"));
119121

122+
private static final Matcher<ExpressionTree> JOINER =
123+
instanceMethod().onDescendantOf("com.google.common.base.Joiner").named("join");
124+
125+
private final boolean handleJoiner;
126+
127+
protected AbstractToString(ErrorProneFlags flags) {
128+
this.handleJoiner = flags.getBoolean("AbstractToString:Joiner").orElse(true);
129+
}
130+
120131
private static boolean isInVarargsPosition(
121132
ExpressionTree argTree, MethodInvocationTree methodInvocationTree, VisitorState state) {
122133
int parameterCount = getSymbol(methodInvocationTree).getParameters().size();
@@ -127,6 +138,17 @@ private static boolean isInVarargsPosition(
127138
&& arguments.indexOf(argTree) >= parameterCount - 1;
128139
}
129140

141+
private static boolean isVarargsArray(
142+
ExpressionTree argTree, MethodInvocationTree methodInvocationTree, VisitorState state) {
143+
int parameterCount = getSymbol(methodInvocationTree).getParameters().size();
144+
List<? extends ExpressionTree> arguments = methodInvocationTree.getArguments();
145+
// Don't match if we're passing an array into a varargs parameter, but do match if there are
146+
// other parameters along with it.
147+
return arguments.size() == parameterCount
148+
&& state.getTypes().isArray(getType(argTree))
149+
&& arguments.indexOf(argTree) == parameterCount - 1;
150+
}
151+
130152
@Override
131153
public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
132154
if (PRINT_STRING.matches(tree, state)) {
@@ -168,6 +190,22 @@ public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState
168190
handleStringifiedTree(argTree, ToStringKind.FLOGGER, state);
169191
}
170192
}
193+
if (handleJoiner && JOINER.matches(tree, state)) {
194+
var symbol = getSymbol(tree);
195+
if (symbol.isVarArgs()) {
196+
for (ExpressionTree argTree : tree.getArguments()) {
197+
if (isVarargsArray(argTree, tree, state)) {
198+
handleStringifiedTree(
199+
((ArrayType) getType(argTree)).getComponentType(),
200+
argTree,
201+
argTree,
202+
ToStringKind.IMPLICIT,
203+
state);
204+
}
205+
handleStringifiedTree(argTree, ToStringKind.IMPLICIT, state);
206+
}
207+
}
208+
}
171209
return NO_MATCH;
172210
}
173211

@@ -202,7 +240,11 @@ private void handleStringifiedTree(
202240

203241
private void handleStringifiedTree(
204242
Tree parent, ExpressionTree tree, ToStringKind toStringKind, VisitorState state) {
205-
Type type = type(tree);
243+
handleStringifiedTree(type(tree), parent, tree, toStringKind, state);
244+
}
245+
246+
private void handleStringifiedTree(
247+
Type type, Tree parent, ExpressionTree tree, ToStringKind toStringKind, VisitorState state) {
206248
if (type.getKind() == TypeKind.NULL
207249
|| !typePredicate().apply(type, state)
208250
|| allowableToStringKind(toStringKind)) {

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

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

2222
import com.google.errorprone.BugPattern;
23+
import com.google.errorprone.ErrorProneFlags;
2324
import com.google.errorprone.VisitorState;
2425
import com.google.errorprone.fixes.Fix;
2526
import com.google.errorprone.fixes.SuggestedFix;
@@ -28,6 +29,7 @@
2829
import com.sun.source.tree.ExpressionTree;
2930
import com.sun.source.tree.Tree;
3031
import java.util.Optional;
32+
import javax.inject.Inject;
3133

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

45+
@Inject
46+
AnnotationMirrorToString(ErrorProneFlags flags) {
47+
super(flags);
48+
}
49+
4350
@Override
4451
protected TypePredicate typePredicate() {
4552
return TYPE_PREDICATE;

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

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

2222
import com.google.errorprone.BugPattern;
23+
import com.google.errorprone.ErrorProneFlags;
2324
import com.google.errorprone.VisitorState;
2425
import com.google.errorprone.fixes.Fix;
2526
import com.google.errorprone.fixes.SuggestedFix;
@@ -28,6 +29,7 @@
2829
import com.sun.source.tree.ExpressionTree;
2930
import com.sun.source.tree.Tree;
3031
import java.util.Optional;
32+
import javax.inject.Inject;
3133

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

45+
@Inject
46+
AnnotationValueToString(ErrorProneFlags flags) {
47+
super(flags);
48+
}
49+
4350
@Override
4451
protected TypePredicate typePredicate() {
4552
return TYPE_PREDICATE;

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

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

2222
import com.google.errorprone.BugPattern;
23+
import com.google.errorprone.ErrorProneFlags;
2324
import com.google.errorprone.VisitorState;
2425
import com.google.errorprone.fixes.Fix;
2526
import com.google.errorprone.fixes.SuggestedFix;
@@ -32,6 +33,7 @@
3233
import com.sun.tools.javac.code.Type;
3334
import com.sun.tools.javac.code.Types;
3435
import java.util.Optional;
36+
import javax.inject.Inject;
3537

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

4850
private static final TypePredicate IS_ARRAY = TypePredicates.isArray();
4951

52+
@Inject
53+
ArrayToString(ErrorProneFlags flags) {
54+
super(flags);
55+
}
56+
5057
@Override
5158
protected TypePredicate typePredicate() {
5259
return IS_ARRAY;

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

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

2828
import com.google.common.collect.ImmutableSet;
2929
import com.google.errorprone.BugPattern;
30+
import com.google.errorprone.ErrorProneFlags;
3031
import com.google.errorprone.VisitorState;
3132
import com.google.errorprone.fixes.Fix;
3233
import com.google.errorprone.predicates.TypePredicate;
@@ -35,6 +36,7 @@
3536
import com.sun.source.tree.Tree;
3637
import com.sun.tools.javac.code.Type;
3738
import java.util.Optional;
39+
import javax.inject.Inject;
3840

3941
/** Flags calls to {@code toString} on lite protos. */
4042
@BugPattern(
@@ -69,6 +71,11 @@ public final class LiteProtoToString extends AbstractToString {
6971
.add("v", "d", "i")
7072
.build();
7173

74+
@Inject
75+
LiteProtoToString(ErrorProneFlags flags) {
76+
super(flags);
77+
}
78+
7279
@Override
7380
protected TypePredicate typePredicate() {
7481
return LiteProtoToString::matches;

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

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

2121
import com.google.common.collect.Iterables;
2222
import com.google.errorprone.BugPattern;
23+
import com.google.errorprone.ErrorProneFlags;
2324
import com.google.errorprone.VisitorState;
2425
import com.google.errorprone.fixes.Fix;
2526
import com.google.errorprone.fixes.SuggestedFixes;
@@ -32,6 +33,7 @@
3233
import com.sun.tools.javac.code.Types;
3334
import com.sun.tools.javac.util.Names;
3435
import java.util.Optional;
36+
import javax.inject.Inject;
3537

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

77+
@Inject
78+
ObjectToString(ErrorProneFlags flags) {
79+
super(flags);
80+
}
81+
7582
@Override
7683
protected TypePredicate typePredicate() {
7784
return ObjectToString::finalNoOverrides;

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

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

2222
import com.google.errorprone.BugPattern;
23+
import com.google.errorprone.ErrorProneFlags;
2324
import com.google.errorprone.VisitorState;
2425
import com.google.errorprone.fixes.Fix;
2526
import com.google.errorprone.predicates.TypePredicate;
2627
import com.sun.source.tree.ExpressionTree;
2728
import com.sun.source.tree.Tree;
2829
import java.util.Optional;
30+
import javax.inject.Inject;
2931

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

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

40+
@Inject
41+
StreamToString(ErrorProneFlags flags) {
42+
super(flags);
43+
}
44+
3845
@Override
3946
protected TypePredicate typePredicate() {
4047
return STREAM;

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

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

2525
import com.google.errorprone.BugPattern;
26+
import com.google.errorprone.ErrorProneFlags;
2627
import com.google.errorprone.VisitorState;
2728
import com.google.errorprone.fixes.Fix;
2829
import com.google.errorprone.matchers.Matcher;
@@ -32,6 +33,7 @@
3233
import com.sun.source.tree.Tree;
3334
import com.sun.tools.javac.code.Type;
3435
import java.util.Optional;
36+
import javax.inject.Inject;
3537

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

63+
@Inject
64+
SymbolToString(ErrorProneFlags flags) {
65+
super(flags);
66+
}
67+
6168
@Override
6269
protected TypePredicate typePredicate() {
6370
return SymbolToString::symbolToStringInBugChecker;

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

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

2626
import com.google.errorprone.BugPattern;
27+
import com.google.errorprone.ErrorProneFlags;
2728
import com.google.errorprone.VisitorState;
2829
import com.google.errorprone.fixes.Fix;
2930
import com.google.errorprone.fixes.SuggestedFix;
@@ -67,7 +68,9 @@ public class TreeToString extends AbstractToString {
6768
.withParameters("java.lang.Object");
6869

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

7275
@Override
7376
protected TypePredicate typePredicate() {

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

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

2525
import com.google.errorprone.BugPattern;
26+
import com.google.errorprone.ErrorProneFlags;
2627
import com.google.errorprone.VisitorState;
2728
import com.google.errorprone.fixes.Fix;
2829
import com.google.errorprone.matchers.Matcher;
@@ -32,6 +33,7 @@
3233
import com.sun.source.tree.Tree;
3334
import com.sun.tools.javac.code.Type;
3435
import java.util.Optional;
36+
import javax.inject.Inject;
3537

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

63+
@Inject
64+
TypeToString(ErrorProneFlags flags) {
65+
super(flags);
66+
}
67+
6168
@Override
6269
protected TypePredicate typePredicate() {
6370
return TypeToString::typeToStringInBugChecker;

0 commit comments

Comments
 (0)