Add support for disabling LeakCanary notifications

Fixes #2394 Fixes #2398
square · Nov 10, 2022 · ae23910 · ae23910
1 parent e306e5c
commit ae23910
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/leakcanary-android-core/api/leakcanary-android-core.api b/leakcanary-android-core/api/leakcanary-android-core.api
@@ -94,14 +94,15 @@ public final class leakcanary/LeakCanary {
 
 public final class leakcanary/LeakCanary$Config {
 	public fun <init> ()V
-	public fun <init> (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;Z)V
-	public synthetic fun <init> (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZZ)V
+	public synthetic fun <init> (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Z
 	public final fun component10 ()Z
 	public final fun component11 ()Lshark/LeakingObjectFinder;
 	public final fun component12 ()Lleakcanary/HeapDumper;
 	public final fun component13 ()Ljava/util/List;
 	public final fun component14 ()Z
+	public final fun component15 ()Z
 	public final fun component2 ()Z
 	public final fun component3 ()I
 	public final fun component4 ()Ljava/util/List;
@@ -110,8 +111,8 @@ public final class leakcanary/LeakCanary$Config {
 	public final fun component7 ()Lshark/MetadataExtractor;
 	public final fun component8 ()Z
 	public final fun component9 ()I
-	public final fun copy (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;Z)Lleakcanary/LeakCanary$Config;
-	public static synthetic fun copy$default (Lleakcanary/LeakCanary$Config;ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZILjava/lang/Object;)Lleakcanary/LeakCanary$Config;
+	public final fun copy (ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZZ)Lleakcanary/LeakCanary$Config;
+	public static synthetic fun copy$default (Lleakcanary/LeakCanary$Config;ZZILjava/util/List;Ljava/util/List;Lleakcanary/OnHeapAnalyzedListener;Lshark/MetadataExtractor;ZIZLshark/LeakingObjectFinder;Lleakcanary/HeapDumper;Ljava/util/List;ZZILjava/lang/Object;)Lleakcanary/LeakCanary$Config;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getComputeRetainedHeapSize ()Z
 	public final fun getDumpHeap ()Z
@@ -126,6 +127,7 @@ public final class leakcanary/LeakCanary$Config {
 	public final fun getReferenceMatchers ()Ljava/util/List;
 	public final fun getRequestWriteExternalStoragePermission ()Z
 	public final fun getRetainedVisibleThreshold ()I
+	public final fun getShowNotifications ()Z
 	public final fun getUseExperimentalLeakFinders ()Z
 	public fun hashCode ()I
 	public final fun newBuilder ()Lleakcanary/LeakCanary$Config$Builder;
@@ -147,6 +149,7 @@ public final class leakcanary/LeakCanary$Config$Builder {
 	public final fun referenceMatchers (Ljava/util/List;)Lleakcanary/LeakCanary$Config$Builder;
 	public final fun requestWriteExternalStoragePermission (Z)Lleakcanary/LeakCanary$Config$Builder;
 	public final fun retainedVisibleThreshold (I)Lleakcanary/LeakCanary$Config$Builder;
+	public final fun showNotifications (Z)Lleakcanary/LeakCanary$Config$Builder;
 	public final fun useExperimentalLeakFinders (Z)Lleakcanary/LeakCanary$Config$Builder;
 }
 

diff --git a/leakcanary-android-core/src/main/java/leakcanary/LeakCanary.kt b/leakcanary-android-core/src/main/java/leakcanary/LeakCanary.kt
@@ -208,6 +208,15 @@ object LeakCanary {
       }
     ),
 
+    /**
+     * Whether to show LeakCanary notifications. When [showNotifications] is true, LeakCanary
+     * will only display notifications if the app is in foreground and is not an instant, TV or
+     * Wear app.
+     *
+     * Defaults to true.
+     */
+    val showNotifications: Boolean = true,
+
     /**
      * Deprecated: This is a no-op, set a custom [leakingObjectFinder] instead.
      */
@@ -256,6 +265,7 @@ object LeakCanary {
       private var heapDumper = config.heapDumper
       private var eventListeners = config.eventListeners
       private var useExperimentalLeakFinders = config.useExperimentalLeakFinders
+      private var showNotifications = config.showNotifications
 
       /** @see [LeakCanary.Config.dumpHeap] */
       fun dumpHeap(dumpHeap: Boolean) =
@@ -315,6 +325,11 @@ object LeakCanary {
       fun useExperimentalLeakFinders(useExperimentalLeakFinders: Boolean) =
         apply { this.useExperimentalLeakFinders = useExperimentalLeakFinders }
 
+      /** @see [LeakCanary.Config.showNotifications] */
+      fun showNotifications(showNotifications: Boolean) =
+        apply { this.showNotifications = showNotifications }
+
+
       fun build() = config.copy(
         dumpHeap = dumpHeap,
         dumpHeapWhenDebugging = dumpHeapWhenDebugging,
@@ -329,7 +344,8 @@ object LeakCanary {
         leakingObjectFinder = leakingObjectFinder,
         heapDumper = heapDumper,
         eventListeners = eventListeners,
-        useExperimentalLeakFinders = useExperimentalLeakFinders
+        useExperimentalLeakFinders = useExperimentalLeakFinders,
+        showNotifications = showNotifications,
       )
     }
   }

diff --git a/leakcanary-android-core/src/main/java/leakcanary/internal/Notifications.kt b/leakcanary-android-core/src/main/java/leakcanary/internal/Notifications.kt
@@ -24,6 +24,7 @@ import android.os.Build.VERSION.SDK_INT
 import android.os.Build.VERSION_CODES.JELLY_BEAN
 import android.os.Build.VERSION_CODES.O
 import com.squareup.leakcanary.core.R
+import leakcanary.LeakCanary
 import leakcanary.internal.InternalLeakCanary.FormFactor.MOBILE
 
 internal object Notifications {
@@ -34,7 +35,8 @@ internal object Notifications {
   // Watch devices: not sure, but probably not a good idea anyway?
   val canShowNotification: Boolean
     get() = InternalLeakCanary.formFactor == MOBILE &&
-      (!InternalLeakCanary.isInstantApp || InternalLeakCanary.applicationVisible)
+      (!InternalLeakCanary.isInstantApp || InternalLeakCanary.applicationVisible) &&
+      LeakCanary.config.showNotifications
 
   @Suppress("LongParameterList")
   fun showNotification(