empathicqubit/Signal-Android
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Add blockingGet linter.

Browse source
This commit is contained in:
Alex Hart 2022-07-27 14:29:58 -03:00 • committed by Greyson Parrelli
parent a52b64281c
commit bc7908a4a5
2 changed files with 72 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
lintchecks/src/main/java/org/signal/lint/BlockingGetDetector.java Normal file
View file

@ -0,0 +1,70 @@
package org.signal.lint;
import com.android.tools.lint.client.api.JavaEvaluator;
import com.android.tools.lint.detector.api.Category;
import com.android.tools.lint.detector.api.Detector;
import com.android.tools.lint.detector.api.Implementation;
import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.JavaContext;
import com.android.tools.lint.detector.api.Scope;
import com.android.tools.lint.detector.api.Severity;
import com.intellij.psi.PsiMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.uast.UCallExpression;
import java.util.List;
/**
* Detects usages of Rx observable stream's blockingGet method. This is considered harmful, as
* blockingGet will take any error it emits and throw it as a runtime error. The alternative options
* are to:
*
* 1. Provide a synchronous method instead of relying on an observable method.
* 2. Pass the observable to the caller to allow them to wait on it via a flatMap or other operator.
* 3. Utilize safeBlockingGet, which will bubble up the interrupted exception.
*
* Note that (1) is the most preferred route here.
*/
@SuppressWarnings("UnstableApiUsage")
public final class BlockingGetDetector extends Detector implements Detector.UastScanner {
static final Issue UNSAFE_BLOCKING_GET = Issue.create("UnsafeBlockingGet",
"BlockingGet is considered unsafe and should be avoided.",
"Prefer exposing the Observable instead. If you need to block, use RxExtensions.safeBlockingGet",
Category.MESSAGES,
5,
Severity.WARNING,
new Implementation(BlockingGetDetector.class, Scope.JAVA_FILE_SCOPE));
@Override
public List<String> getApplicableMethodNames() {
return List.of("blockingGet");
}
@Override
public void visitMethodCall(@NotNull JavaContext context, @NotNull UCallExpression node, @NotNull PsiMethod method) {
JavaEvaluator evaluator = context.getEvaluator();
if (evaluator.isMemberInClass(method, "io.reactivex.rxjava3.core.Single")) {
context.report(UNSAFE_BLOCKING_GET,
context.getLocation(node),
"Using 'Single#blockingGet' instead of 'RxExtensions.safeBlockingGet'",
null);
}
if (evaluator.isMemberInClass(method, "io.reactivex.rxjava3.core.Observable")) {
context.report(UNSAFE_BLOCKING_GET,
context.getLocation(node),
"Using 'Observable#blockingGet' instead of 'RxExtensions.safeBlockingGet'",
null);
}
if (evaluator.isMemberInClass(method, "io.reactivex.rxjava3.core.Flowable")) {
context.report(UNSAFE_BLOCKING_GET,
context.getLocation(node),
"Using 'Flowable#blockingGet' instead of 'RxExtensions.safeBlockingGet'",
null);
}
}
}

3
lintchecks/src/main/java/org/signal/lint/Registry.java
View file

@ -16,7 +16,8 @@ public final class Registry extends IssueRegistry {
SignalLogDetector.LOG_NOT_APP,
SignalLogDetector.INLINE_TAG,
VersionCodeDetector.VERSION_CODE_USAGE,
AlertDialogBuilderDetector.ALERT_DIALOG_BUILDER_USAGE);
AlertDialogBuilderDetector.ALERT_DIALOG_BUILDER_USAGE,
BlockingGetDetector.UNSAFE_BLOCKING_GET);
}
@Override