Fixed bugs in Kotlin Android Lint CleanupDetector

#KT-14780 Fixed
#KT-14677 Fixed

(cherry picked from commit f591b4958e4a836d37d70c2ad8ff15e626c6342a)
This commit is contained in:
Vyacheslav Gerasimov
2017-01-24 13:27:00 +03:00
parent 68b223211c
commit d0f1b81bfa
7 changed files with 307 additions and 126 deletions
@@ -54,6 +54,12 @@ public class KotlinLintTestGenerated extends AbstractKotlinLintTest {
doTest(fileName); doTest(fileName);
} }
@TestMetadata("closeCursor.kt")
public void testCloseCursor() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/closeCursor.kt");
doTest(fileName);
}
@TestMetadata("commitFragment.kt") @TestMetadata("commitFragment.kt")
public void testCommitFragment() throws Exception { public void testCommitFragment() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/commitFragment.kt"); String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/commitFragment.kt");
@@ -150,6 +156,12 @@ public class KotlinLintTestGenerated extends AbstractKotlinLintTest {
doTest(fileName); doTest(fileName);
} }
@TestMetadata("velocityTrackerRecycle.kt")
public void testVelocityTrackerRecycle() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/velocityTrackerRecycle.kt");
doTest(fileName);
}
@TestMetadata("viewConstructor.kt") @TestMetadata("viewConstructor.kt")
public void testViewConstructor() throws Exception { public void testViewConstructor() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/viewConstructor.kt"); String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lint/viewConstructor.kt");
+36
View File
@@ -0,0 +1,36 @@
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintRecycleInspection
@file:Suppress("UNUSED_VARIABLE")
import android.app.Activity
import android.os.Bundle
class MainActivity : Activity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val cursor = contentResolver.<warning descr="This `Cursor` should be freed up after use with `#close()`">query</warning>(null, null, null, null, null)
// WARNING
contentResolver.<warning descr="This `Cursor` should be freed up after use with `#close()`">query</warning>(null, null, null, null, null)
// OK, closed in chained call
contentResolver.query(null, null, null, null, null).close()
// KT-14677: Kotlin Lint: "Missing recycle() calls" report cursor with `use()` call
val cursorUsed = contentResolver.query(null, null, null, null, null)
cursorUsed.use { }
// OK, used in chained call
contentResolver.query(null, null, null, null, null).use {
}
// KT-13372: Android Lint for Kotlin: false positive "Cursor should be freed" inside 'if' expression
if (true) {
val c = contentResolver.query(null, null, null, null, null)
c.close()
}
}
}
+10 -2
View File
@@ -1,7 +1,10 @@
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintCommitTransactionInspection // INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintCommitTransactionInspection
@file:Suppress("UNUSED_VARIABLE")
import android.app.Activity import android.app.Activity
import android.app.FragmentTransaction import android.app.FragmentTransaction
import android.app.FragmentManager
import android.os.Bundle import android.os.Bundle
class MainActivity : Activity() { class MainActivity : Activity() {
@@ -17,8 +20,7 @@ class MainActivity : Activity() {
transaction2.commit() transaction2.commit()
//WARNING //WARNING
@Suppress("UNUSED_VARIABLE") val transaction3 = fragmentManager.<warning descr="This transaction should be completed with a `commit()` call">beginTransaction</warning>()
val transaction3 = fragmentManager.<warning>beginTransaction</warning>()
//OK //OK
fragmentManager.beginTransaction().commit() fragmentManager.beginTransaction().commit()
@@ -30,4 +32,10 @@ class MainActivity : Activity() {
a.commit() a.commit()
} }
} }
// KT-14780: Kotlin Lint: "Missing commit() calls" false positive when the result of `commit()` is assigned or used as receiver
fun testResultOfCommit(fm: FragmentManager) {
val r1 = fm.beginTransaction().hide(fm.findFragmentByTag("aTag")).commit()
val r2 = fm.beginTransaction().hide(fm.findFragmentByTag("aTag")).commit().toString()
}
} }
+5
View File
@@ -66,4 +66,9 @@ class SharedPrefsText(context: Context) : Activity() {
val editor = preferences.<warning descr="`SharedPreferences.edit()` without a corresponding `commit()` or `apply()` call"><warning descr="`SharedPreferences.edit()` without a corresponding `commit()` or `apply()` call">edit()</warning></warning> val editor = preferences.<warning descr="`SharedPreferences.edit()` without a corresponding `commit()` or `apply()` call"><warning descr="`SharedPreferences.edit()` without a corresponding `commit()` or `apply()` call">edit()</warning></warning>
editor.putString("foo", "bar") editor.putString("foo", "bar")
} }
fun testResultOfCommit() {
val r1 = PreferenceManager.getDefaultSharedPreferences(this).edit().putString("wat", "wat").commit()
val r2 = PreferenceManager.getDefaultSharedPreferences(this).edit().putString("wat", "wat").commit().toString()
}
} }
+23
View File
@@ -0,0 +1,23 @@
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintRecycleInspection
@file:Suppress("UNUSED_VARIABLE")
import android.app.Activity
import android.os.Bundle
import android.view.VelocityTracker
class MainActivity : Activity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
VelocityTracker.<warning descr="This `VelocityTracker` should be recycled after use with `#recycle()`">obtain</warning>()
VelocityTracker.obtain().recycle()
val v1 = VelocityTracker.<warning descr="This `VelocityTracker` should be recycled after use with `#recycle()`">obtain</warning>()
val v2 = VelocityTracker.obtain()
v2.recycle()
}
}
@@ -19,7 +19,6 @@ package com.android.tools.klint.checks;
import static com.android.SdkConstants.CLASS_CONTENTPROVIDER; import static com.android.SdkConstants.CLASS_CONTENTPROVIDER;
import static com.android.SdkConstants.CLASS_CONTEXT; import static com.android.SdkConstants.CLASS_CONTEXT;
import static com.android.tools.klint.detector.api.LintUtils.skipParentheses; import static com.android.tools.klint.detector.api.LintUtils.skipParentheses;
import static com.intellij.psi.util.PsiTreeUtil.getParentOfType;
import static org.jetbrains.uast.UastUtils.getOutermostQualified; import static org.jetbrains.uast.UastUtils.getOutermostQualified;
import static org.jetbrains.uast.UastUtils.getParentOfType; import static org.jetbrains.uast.UastUtils.getParentOfType;
import static org.jetbrains.uast.UastUtils.getQualifiedChain; import static org.jetbrains.uast.UastUtils.getQualifiedChain;
@@ -47,6 +46,7 @@ import com.intellij.psi.PsiType;
import com.intellij.psi.PsiVariable; import com.intellij.psi.PsiVariable;
import com.intellij.psi.util.InheritanceUtil; import com.intellij.psi.util.InheritanceUtil;
import com.intellij.util.containers.Predicate;
import org.jetbrains.uast.UBinaryExpression; import org.jetbrains.uast.UBinaryExpression;
import org.jetbrains.uast.UCallExpression; import org.jetbrains.uast.UCallExpression;
import org.jetbrains.uast.UDoWhileExpression; import org.jetbrains.uast.UDoWhileExpression;
@@ -83,16 +83,16 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
/** Problems with missing recycle calls */ /** Problems with missing recycle calls */
public static final Issue RECYCLE_RESOURCE = Issue.create( public static final Issue RECYCLE_RESOURCE = Issue.create(
"Recycle", //$NON-NLS-1$ "Recycle", //$NON-NLS-1$
"Missing `recycle()` calls", "Missing `recycle()` calls",
"Many resources, such as TypedArrays, VelocityTrackers, etc., " + "Many resources, such as TypedArrays, VelocityTrackers, etc., " +
"should be recycled (with a `recycle()` call) after use. This lint check looks " + "should be recycled (with a `recycle()` call) after use. This lint check looks " +
"for missing `recycle()` calls.", "for missing `recycle()` calls.",
Category.PERFORMANCE, Category.PERFORMANCE,
7, 7,
Severity.WARNING, Severity.WARNING,
IMPLEMENTATION); IMPLEMENTATION);
/** Problems with missing commit calls. */ /** Problems with missing commit calls. */
@@ -141,6 +141,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
private static final String QUERY_WITH_FACTORY = "queryWithFactory"; //$NON-NLS-1$ private static final String QUERY_WITH_FACTORY = "queryWithFactory"; //$NON-NLS-1$
private static final String RAW_QUERY_WITH_FACTORY = "rawQueryWithFactory"; //$NON-NLS-1$ private static final String RAW_QUERY_WITH_FACTORY = "rawQueryWithFactory"; //$NON-NLS-1$
private static final String CLOSE = "close"; //$NON-NLS-1$ private static final String CLOSE = "close"; //$NON-NLS-1$
private static final String USE = "use"; //$NON-NLS-1$
private static final String EDIT = "edit"; //$NON-NLS-1$ private static final String EDIT = "edit"; //$NON-NLS-1$
private static final String MOTION_EVENT_CLS = "android.view.MotionEvent"; //$NON-NLS-1$ private static final String MOTION_EVENT_CLS = "android.view.MotionEvent"; //$NON-NLS-1$
@@ -173,6 +174,8 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
"android.content.SharedPreferences"; //$NON-NLS-1$ "android.content.SharedPreferences"; //$NON-NLS-1$
private static final String ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR = private static final String ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR =
"android.content.SharedPreferences.Editor"; //$NON-NLS-1$ "android.content.SharedPreferences.Editor"; //$NON-NLS-1$
private static final String CLOSABLE = "java.io.Closeable"; //$NON-NLS-1$
/** Constructs a new {@link CleanupDetector} */ /** Constructs a new {@link CleanupDetector} */
public CleanupDetector() { public CleanupDetector() {
@@ -245,7 +248,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
} }
JavaEvaluator evaluator = context.getEvaluator(); JavaEvaluator evaluator = context.getEvaluator();
if ((OBTAIN.equals(name) || OBTAIN_NO_HISTORY.equals(name)) && if ((OBTAIN.equals(name) || OBTAIN_NO_HISTORY.equals(name)) &&
InheritanceUtil.isInheritor(containingClass, false, MOTION_EVENT_CLS)) { InheritanceUtil.isInheritor(containingClass, false, MOTION_EVENT_CLS)) {
checkRecycled(context, node, MOTION_EVENT_CLS, RECYCLE); checkRecycled(context, node, MOTION_EVENT_CLS, RECYCLE);
} else if (OBTAIN.equals(name) && InheritanceUtil.isInheritor(containingClass, false, PARCEL_CLS)) { } else if (OBTAIN.equals(name) && InheritanceUtil.isInheritor(containingClass, false, PARCEL_CLS)) {
checkRecycled(context, node, PARCEL_CLS, RECYCLE); checkRecycled(context, node, PARCEL_CLS, RECYCLE);
@@ -253,10 +256,10 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
InheritanceUtil.isInheritor(containingClass, false, VELOCITY_TRACKER_CLS)) { InheritanceUtil.isInheritor(containingClass, false, VELOCITY_TRACKER_CLS)) {
checkRecycled(context, node, VELOCITY_TRACKER_CLS, RECYCLE); checkRecycled(context, node, VELOCITY_TRACKER_CLS, RECYCLE);
} else if ((OBTAIN_STYLED_ATTRIBUTES.equals(name) } else if ((OBTAIN_STYLED_ATTRIBUTES.equals(name)
|| OBTAIN_ATTRIBUTES.equals(name) || OBTAIN_ATTRIBUTES.equals(name)
|| OBTAIN_TYPED_ARRAY.equals(name)) && || OBTAIN_TYPED_ARRAY.equals(name)) &&
(InheritanceUtil.isInheritor(containingClass, false, CLASS_CONTEXT) || (InheritanceUtil.isInheritor(containingClass, false, CLASS_CONTEXT) ||
InheritanceUtil.isInheritor(containingClass, false, SdkConstants.CLASS_RESOURCES))) { InheritanceUtil.isInheritor(containingClass, false, SdkConstants.CLASS_RESOURCES))) {
PsiType returnType = method.getReturnType(); PsiType returnType = method.getReturnType();
if (returnType instanceof PsiClassType) { if (returnType instanceof PsiClassType) {
PsiClass cls = ((PsiClassType)returnType).resolve(); PsiClass cls = ((PsiClassType)returnType).resolve();
@@ -265,16 +268,16 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
} }
} }
} else if (ACQUIRE_CPC.equals(name) && InheritanceUtil.isInheritor(containingClass, } else if (ACQUIRE_CPC.equals(name) && InheritanceUtil.isInheritor(containingClass,
false, CONTENT_RESOLVER_CLS)) { false, CONTENT_RESOLVER_CLS)) {
checkRecycled(context, node, CONTENT_PROVIDER_CLIENT_CLS, RELEASE); checkRecycled(context, node, CONTENT_PROVIDER_CLIENT_CLS, RELEASE);
} else if ((QUERY.equals(name) } else if ((QUERY.equals(name)
|| RAW_QUERY.equals(name) || RAW_QUERY.equals(name)
|| QUERY_WITH_FACTORY.equals(name) || QUERY_WITH_FACTORY.equals(name)
|| RAW_QUERY_WITH_FACTORY.equals(name)) || RAW_QUERY_WITH_FACTORY.equals(name))
&& (InheritanceUtil.isInheritor(containingClass, false, SQLITE_DATABASE_CLS) || && (InheritanceUtil.isInheritor(containingClass, false, SQLITE_DATABASE_CLS) ||
InheritanceUtil.isInheritor(containingClass, false, CONTENT_RESOLVER_CLS) || InheritanceUtil.isInheritor(containingClass, false, CONTENT_RESOLVER_CLS) ||
InheritanceUtil.isInheritor(containingClass, false, CLASS_CONTENTPROVIDER) || InheritanceUtil.isInheritor(containingClass, false, CLASS_CONTENTPROVIDER) ||
InheritanceUtil.isInheritor(containingClass, false, CONTENT_PROVIDER_CLIENT_CLS))) { InheritanceUtil.isInheritor(containingClass, false, CONTENT_PROVIDER_CLIENT_CLS))) {
// Other potential cursors-returning methods that should be tracked: // Other potential cursors-returning methods that should be tracked:
// android.app.DownloadManager#query // android.app.DownloadManager#query
// android.content.ContentProviderClient#query // android.content.ContentProviderClient#query
@@ -289,53 +292,11 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
// android.provider.DocumentsProvider#querySearchDocuments // android.provider.DocumentsProvider#querySearchDocuments
// android.provider.MediaStore$Images$Media#query // android.provider.MediaStore$Images$Media#query
// android.widget.FilterQueryProvider#runQuery // android.widget.FilterQueryProvider#runQuery
checkRecycled(context, node, CURSOR_CLS, CLOSE); checkClosedOrUsed(context, node, CURSOR_CLS);
} }
} }
private static void checkRecycled(@NonNull final JavaContext context, @NonNull UCallExpression node, private static void reportRecycleResource(JavaContext context, String recycleType, String recycleName, @NonNull UCallExpression node) {
@NonNull final String recycleType, @NonNull final String recycleName) {
PsiVariable boundVariable = getVariableElement(node);
if (boundVariable == null) {
return;
}
UMethod method = getParentOfType(node, UMethod.class, true);
if (method == null) {
return;
}
FinishVisitor visitor = new FinishVisitor(context, boundVariable) {
@Override
protected boolean isCleanupCall(@NonNull UCallExpression call) {
String methodName = call.getMethodName();
if (!recycleName.equals(methodName)) {
return false;
}
PsiMethod method = call.resolve();
if (method != null) {
PsiClass containingClass = method.getContainingClass();
if (InheritanceUtil.isInheritor(containingClass, false, recycleType)) {
// Yes, called the right recycle() method; now make sure
// we're calling it on the right variable
UExpression operand = call.getReceiver();
if (operand instanceof UReferenceExpression) {
PsiElement resolved = ((UReferenceExpression) operand).resolve();
//noinspection SuspiciousMethodCalls
if (resolved != null && mVariables.contains(resolved)) {
return true;
}
}
}
}
return false;
}
};
method.accept(visitor);
if (visitor.isCleanedUp() || visitor.variableEscapes()) {
return;
}
String className = recycleType.substring(recycleType.lastIndexOf('.') + 1); String className = recycleType.substring(recycleType.lastIndexOf('.') + 1);
String message; String message;
if (RECYCLE.equals(recycleName)) { if (RECYCLE.equals(recycleName)) {
@@ -355,14 +316,156 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
context.report(RECYCLE_RESOURCE, node, location, message); context.report(RECYCLE_RESOURCE, node, location, message);
} }
private static void checkClosedOrUsed(@NonNull final JavaContext context, @NonNull UCallExpression node,
@NonNull final String recycleType) {
if (isCleanedUpInChain(node, new Predicate<UCallExpression>() {
@Override
public boolean apply(@org.jetbrains.annotations.Nullable UCallExpression call) {
return isCloseMethodCall(call) || isUseMethodCall(call);
}
})) {
return;
}
PsiVariable boundVariable = getVariableElement(node);
if (boundVariable == null) {
reportRecycleResource(context, recycleType, CLOSE, node);
return;
}
UMethod method = getParentOfType(node, UMethod.class, true);
if (method == null) {
return;
}
FinishVisitor visitor = new FinishVisitor(context, boundVariable) {
@Override
protected boolean isCleanupCall(@NonNull UCallExpression call) {
if (isUseMethodCall(call) || isCloseMethodCall(call)) {
UExpression receiver = call.getReceiver();
if (receiver instanceof UReferenceExpression) {
PsiElement resolved = ((UReferenceExpression) receiver).resolve();
//noinspection SuspiciousMethodCalls
if (resolved != null && mVariables.contains(resolved)) {
return true;
}
}
}
return false;
}
};
method.accept(visitor);
if (visitor.isCleanedUp() || visitor.variableEscapes()) {
return;
}
reportRecycleResource(context, recycleType, CLOSE, node);
}
private static boolean isCloseMethodCall(UCallExpression call) {
return isValidCleanupMethodCall(call, CLOSE, CLOSABLE);
}
private static boolean isUseMethodCall(UCallExpression call) {
return USE.equals(call.getMethodName());
}
private static boolean isValidCleanupMethodCall(@NonNull UCallExpression call, @NonNull String methodName, @NonNull String className) {
if (!methodName.equals(call.getMethodName())) {
return false;
}
PsiMethod method = call.resolve();
if (method == null) {
return false;
}
return InheritanceUtil.isInheritor(method.getContainingClass(), false, className);
}
private static boolean isCleanedUpInChain(UExpression expression, Predicate<UCallExpression> isCleanupCallPredicate) {
List<UExpression> chain = getQualifiedChain(getOutermostQualified(expression));
boolean skip = true;
for (UExpression e : chain) {
if (e == expression) {
skip = false;
continue;
}
if (skip) {
continue;
}
if (e instanceof UCallExpression) {
UCallExpression call = (UCallExpression) e;
if (isCleanupCallPredicate.apply(call)) {
return true;
}
}
}
return false;
}
private static void checkRecycled(@NonNull final JavaContext context, @NonNull UCallExpression node,
@NonNull final String recycleType, @NonNull final String recycleName) {
if (isCleanedUpInChain(node, new Predicate<UCallExpression>() {
@Override
public boolean apply(@org.jetbrains.annotations.Nullable UCallExpression call) {
return isValidCleanupMethodCall(call, recycleName, recycleType);
}
})) {
return;
}
PsiVariable boundVariable = getVariableElement(node);
if (boundVariable == null) {
reportRecycleResource(context, recycleType, recycleName, node);
return;
}
UMethod method = getParentOfType(node, UMethod.class, true);
if (method == null) {
return;
}
FinishVisitor visitor = new FinishVisitor(context, boundVariable) {
@Override
protected boolean isCleanupCall(@NonNull UCallExpression call) {
if (isValidCleanupMethodCall(call, recycleName, recycleType)) {
// Yes, called the right recycle() method; now make sure
// we're calling it on the right variable
UExpression operand = call.getReceiver();
if (operand instanceof UReferenceExpression) {
PsiElement resolved = ((UReferenceExpression) operand).resolve();
//noinspection SuspiciousMethodCalls
if (resolved != null && mVariables.contains(resolved)) {
return true;
}
}
}
return false;
}
};
method.accept(visitor);
if (visitor.isCleanedUp() || visitor.variableEscapes()) {
return;
}
reportRecycleResource(context, recycleType, recycleName, node);
}
private static void checkTransactionCommits(@NonNull JavaContext context, private static void checkTransactionCommits(@NonNull JavaContext context,
@NonNull UCallExpression node, @NonNull PsiMethod calledMethod) { @NonNull UCallExpression node, @NonNull PsiMethod calledMethod) {
if (isBeginTransaction(context, calledMethod)) { if (isBeginTransaction(context, calledMethod)) {
PsiVariable boundVariable = getVariableElement(node, true); if (isCommittedInChainedCalls(context, node)) {
if (boundVariable == null && isCommittedInChainedCalls(context, node)) {
return; return;
} }
PsiVariable boundVariable = getVariableElement(node, true);
if (boundVariable != null) { if (boundVariable != null) {
UMethod method = getParentOfType(node, UMethod.class, true); UMethod method = getParentOfType(node, UMethod.class, true);
if (method == null) { if (method == null) {
@@ -385,9 +488,9 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
if (resolved != null && mVariables.contains(resolved)) { if (resolved != null && mVariables.contains(resolved)) {
return true; return true;
} else if (resolved instanceof PsiMethod } else if (resolved instanceof PsiMethod
&& operand instanceof UCallExpression && operand instanceof UCallExpression
&& isCommittedInChainedCalls(mContext, && isCommittedInChainedCalls(mContext,
(UCallExpression) operand)) { (UCallExpression) operand)) {
// Check that the target of the committed chains is the // Check that the target of the committed chains is the
// right variable! // right variable!
while (operand instanceof UCallExpression) { while (operand instanceof UCallExpression) {
@@ -428,26 +531,20 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
} }
} }
private static boolean isCommittedInChainedCalls(@NonNull JavaContext context, private static boolean isCommittedInChainedCalls(@NonNull final JavaContext context,
@NonNull UCallExpression node) { @NonNull UCallExpression node) {
// Look for chained calls since the FragmentManager methods all return "this" // Look for chained calls since the FragmentManager methods all return "this"
// to allow constructor chaining, e.g. // to allow constructor chaining, e.g.
// getFragmentManager().beginTransaction().addToBackStack("test") // getFragmentManager().beginTransaction().addToBackStack("test")
// .disallowAddToBackStack().hide(mFragment2).setBreadCrumbShortTitle("test") // .disallowAddToBackStack().hide(mFragment2).setBreadCrumbShortTitle("test")
// .show(mFragment2).setCustomAnimations(0, 0).commit(); // .show(mFragment2).setCustomAnimations(0, 0).commit();
List<UExpression> chain = getQualifiedChain(getOutermostQualified(node));
if (!chain.isEmpty()) {
UExpression lastExpression = chain.get(chain.size() - 1);
if (lastExpression instanceof UCallExpression) {
UCallExpression methodInvocation = (UCallExpression) lastExpression;
if (isTransactionCommitMethodCall(context, methodInvocation)
|| isShowFragmentMethodCall(context, methodInvocation)) {
return true;
}
}
}
return false; return isCleanedUpInChain(node, new Predicate<UCallExpression>() {
@Override
public boolean apply(@org.jetbrains.annotations.Nullable UCallExpression call) {
return isTransactionCommitMethodCall(context, call) || isShowFragmentMethodCall(context, call);
}
});
} }
private static boolean isTransactionCommitMethodCall(@NonNull JavaContext context, private static boolean isTransactionCommitMethodCall(@NonNull JavaContext context,
@@ -455,18 +552,18 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
String methodName = call.getMethodName(); String methodName = call.getMethodName();
return (COMMIT.equals(methodName) || COMMIT_ALLOWING_LOSS.equals(methodName)) && return (COMMIT.equals(methodName) || COMMIT_ALLOWING_LOSS.equals(methodName)) &&
isMethodOnFragmentClass(context, call, isMethodOnFragmentClass(context, call,
FRAGMENT_TRANSACTION_CLS, FRAGMENT_TRANSACTION_CLS,
FRAGMENT_TRANSACTION_V4_CLS, FRAGMENT_TRANSACTION_V4_CLS,
true); true);
} }
private static boolean isShowFragmentMethodCall(@NonNull JavaContext context, private static boolean isShowFragmentMethodCall(@NonNull JavaContext context,
@NonNull UCallExpression call) { @NonNull UCallExpression call) {
String methodName = call.getMethodName(); String methodName = call.getMethodName();
return SHOW.equals(methodName) return SHOW.equals(methodName)
&& isMethodOnFragmentClass(context, call, && isMethodOnFragmentClass(context, call,
DIALOG_FRAGMENT, DIALOG_V4_FRAGMENT, true); DIALOG_FRAGMENT, DIALOG_V4_FRAGMENT, true);
} }
private static boolean isMethodOnFragmentClass( private static boolean isMethodOnFragmentClass(
@@ -506,7 +603,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
@Override @Override
protected boolean isCleanupCall(@NonNull UCallExpression call) { protected boolean isCleanupCall(@NonNull UCallExpression call) {
if (isEditorApplyMethodCall(mContext, call) if (isEditorApplyMethodCall(mContext, call)
|| isEditorCommitMethodCall(mContext, call)) { || isEditorCommitMethodCall(mContext, call)) {
List<UExpression> chain = getQualifiedChain(getOutermostQualified(call)); List<UExpression> chain = getQualifiedChain(getOutermostQualified(call));
if (chain.isEmpty()) { if (chain.isEmpty()) {
return false; return false;
@@ -519,9 +616,9 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
if (resolved != null && mVariables.contains(resolved)) { if (resolved != null && mVariables.contains(resolved)) {
return true; return true;
} else if (resolved instanceof PsiMethod } else if (resolved instanceof PsiMethod
&& operand instanceof UCallExpression && operand instanceof UCallExpression
&& isEditorCommittedInChainedCalls(mContext, && isEditorCommittedInChainedCalls(mContext,
(UCallExpression) operand)) { (UCallExpression) operand)) {
// Check that the target of the committed chains is the // Check that the target of the committed chains is the
// right variable! // right variable!
while (operand instanceof UCallExpression) { while (operand instanceof UCallExpression) {
@@ -551,7 +648,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
} }
String message = "`SharedPreferences.edit()` without a corresponding `commit()` or " String message = "`SharedPreferences.edit()` without a corresponding `commit()` or "
+ "`apply()` call"; + "`apply()` call";
context.report(SHARED_PREF, node, context.getUastLocation(node), message); context.report(SHARED_PREF, node, context.getUastLocation(node), message);
} }
} }
@@ -569,21 +666,14 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
return false; return false;
} }
private static boolean isEditorCommittedInChainedCalls(@NonNull JavaContext context, private static boolean isEditorCommittedInChainedCalls(@NonNull final JavaContext context,
@NonNull UCallExpression node) { @NonNull UCallExpression node) {
List<UExpression> chain = getQualifiedChain(getOutermostQualified(node)); return isCleanedUpInChain(node, new Predicate<UCallExpression>() {
if (!chain.isEmpty()) { @Override
UExpression lastExpression = chain.get(chain.size() - 1); public boolean apply(@org.jetbrains.annotations.Nullable UCallExpression call) {
if (lastExpression instanceof UCallExpression) { return isEditorCommitMethodCall(context, call) || isEditorApplyMethodCall(context, call);
UCallExpression methodInvocation = (UCallExpression) lastExpression;
if (isEditorCommitMethodCall(context, methodInvocation)
|| isEditorApplyMethodCall(context, methodInvocation)) {
return true;
}
} }
} });
return false;
} }
private static boolean isEditorCommitMethodCall(@NonNull JavaContext context, private static boolean isEditorCommitMethodCall(@NonNull JavaContext context,
@@ -595,7 +685,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
PsiClass containingClass = method.getContainingClass(); PsiClass containingClass = method.getContainingClass();
JavaEvaluator evaluator = context.getEvaluator(); JavaEvaluator evaluator = context.getEvaluator();
if (InheritanceUtil.isInheritor(containingClass, false, if (InheritanceUtil.isInheritor(containingClass, false,
ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR)) { ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR)) {
suggestApplyIfApplicable(context, call); suggestApplyIfApplicable(context, call);
return true; return true;
} }
@@ -614,7 +704,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
PsiClass containingClass = method.getContainingClass(); PsiClass containingClass = method.getContainingClass();
JavaEvaluator evaluator = context.getEvaluator(); JavaEvaluator evaluator = context.getEvaluator();
return InheritanceUtil.isInheritor(containingClass, false, return InheritanceUtil.isInheritor(containingClass, false,
ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR); ANDROID_CONTENT_SHARED_PREFERENCES_EDITOR);
} }
} }
@@ -636,10 +726,10 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
boolean returnValueIgnored = true; boolean returnValueIgnored = true;
if (parent instanceof UCallExpression if (parent instanceof UCallExpression
|| parent instanceof UVariable || parent instanceof UVariable
|| parent instanceof UBinaryExpression || parent instanceof UBinaryExpression
|| parent instanceof UUnaryExpression || parent instanceof UUnaryExpression
|| parent instanceof UReturnExpression) { || parent instanceof UReturnExpression) {
returnValueIgnored = false; returnValueIgnored = false;
} else if (parent instanceof UIfExpression) { } else if (parent instanceof UIfExpression) {
UExpression condition = ((UIfExpression) parent).getCondition(); UExpression condition = ((UIfExpression) parent).getCondition();
@@ -654,8 +744,8 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
if (returnValueIgnored) { if (returnValueIgnored) {
String message = "Consider using `apply()` instead; `commit` writes " String message = "Consider using `apply()` instead; `commit` writes "
+ "its data to persistent storage immediately, whereas " + "its data to persistent storage immediately, whereas "
+ "`apply` will handle it in the background"; + "`apply` will handle it in the background";
context.report(SHARED_PREF, node, context.getUastLocation(node), message); context.report(SHARED_PREF, node, context.getUastLocation(node), message);
} }
} }
@@ -683,7 +773,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
if ((parentParent instanceof UQualifiedReferenceExpression)) { if ((parentParent instanceof UQualifiedReferenceExpression)) {
parent = skipParentheses(parentParent.getContainingElement()); parent = skipParentheses(parentParent.getContainingElement());
} else if (parentParent instanceof UVariable } else if (parentParent instanceof UVariable
|| parentParent instanceof UBinaryExpression) { || parentParent instanceof UBinaryExpression) {
parent = parentParent; parent = parentParent;
break; break;
} else { } else {
@@ -719,7 +809,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
PsiClass containingClass = method.getContainingClass(); PsiClass containingClass = method.getContainingClass();
JavaEvaluator evaluator = context.getEvaluator(); JavaEvaluator evaluator = context.getEvaluator();
if (InheritanceUtil.isInheritor(containingClass, false, FRAGMENT_MANAGER_CLS) if (InheritanceUtil.isInheritor(containingClass, false, FRAGMENT_MANAGER_CLS)
|| InheritanceUtil.isInheritor(containingClass, false, FRAGMENT_MANAGER_V4_CLS)) { || InheritanceUtil.isInheritor(containingClass, false, FRAGMENT_MANAGER_V4_CLS)) {
return true; return true;
} }
} }
@@ -852,7 +942,7 @@ public class CleanupDetector extends Detector implements Detector.UastScanner {
PsiElement lhs = UastUtils.tryResolve(expression.getLeftOperand()); PsiElement lhs = UastUtils.tryResolve(expression.getLeftOperand());
//noinspection SuspiciousMethodCalls //noinspection SuspiciousMethodCalls
if (lhs != null && !lhs.equals(mOriginalVariableNode) if (lhs != null && !lhs.equals(mOriginalVariableNode)
&& mVariables.contains(lhs)) { && mVariables.contains(lhs)) {
//noinspection SuspiciousMethodCalls //noinspection SuspiciousMethodCalls
mVariables.remove(lhs); mVariables.remove(lhs);
} }
@@ -22,6 +22,7 @@ import com.intellij.psi.PsiElement
import com.intellij.psi.PsiFile import com.intellij.psi.PsiFile
import com.intellij.psi.PsiVariable import com.intellij.psi.PsiVariable
import com.intellij.psi.impl.source.tree.LeafPsiElement import com.intellij.psi.impl.source.tree.LeafPsiElement
import com.intellij.psi.util.PsiTreeUtil
import org.jetbrains.kotlin.asJava.LightClassUtil import org.jetbrains.kotlin.asJava.LightClassUtil
import org.jetbrains.kotlin.asJava.classes.KtLightClass import org.jetbrains.kotlin.asJava.classes.KtLightClass
import org.jetbrains.kotlin.asJava.elements.FakeFileForLightClass import org.jetbrains.kotlin.asJava.elements.FakeFileForLightClass
@@ -187,6 +188,9 @@ internal object KotlinConverter {
is KtCatchClause -> el<UCatchClause> { KotlinUCatchClause(element, parent) } is KtCatchClause -> el<UCatchClause> { KotlinUCatchClause(element, parent) }
is KtExpression -> KotlinConverter.convertExpression(element, parent, requiredType) is KtExpression -> KotlinConverter.convertExpression(element, parent, requiredType)
is KtLambdaArgument -> KotlinConverter.convertExpression(element.getLambdaExpression(), parent, requiredType) is KtLambdaArgument -> KotlinConverter.convertExpression(element.getLambdaExpression(), parent, requiredType)
is KtContainerNode -> element.getExpression()?.let {
KotlinConverter.convertExpression(it, parent, requiredType)
} ?: UastEmptyExpression
else -> { else -> {
if (element is LeafPsiElement && element.elementType == KtTokens.IDENTIFIER) { if (element is LeafPsiElement && element.elementType == KtTokens.IDENTIFIER) {
el<UIdentifier> { UIdentifier(element, parent) } el<UIdentifier> { UIdentifier(element, parent) }
@@ -313,4 +317,7 @@ internal object KotlinConverter {
val result = declarations.first() as TDeclaration val result = declarations.first() as TDeclaration
return result return result
} }
internal fun KtContainerNode.getExpression(): KtExpression? =
PsiTreeUtil.getChildOfType(this, KtExpression::class.java)
} }