Update LeakCanary to 2.10

Also added the now required "description" parameter when watching instances. Fixes #580
uber · May 16, 2023 · b6140c5 · b6140c5
1 parent b06d260
commit b6140c5
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 34 deletions.
diff --git a/android/demos/memory-leaks/src/main/java/com/uber/rib/SampleApplication.java b/android/demos/memory-leaks/src/main/java/com/uber/rib/SampleApplication.java
@@ -16,12 +16,10 @@
 package com.uber.rib;
 
 import android.app.Application;
-import com.squareup.leakcanary.LeakCanary;
-import com.squareup.leakcanary.RefWatcher;
 import com.uber.rib.core.ActivityDelegate;
 import com.uber.rib.core.HasActivityDelegate;
 import com.uber.rib.core.RibRefWatcher;
-import java.util.concurrent.TimeUnit;
+import leakcanary.AppWatcher;
 
 public class SampleApplication extends Application implements HasActivityDelegate {
 
@@ -31,24 +29,17 @@ public class SampleApplication extends Application implements HasActivityDelegat
   public void onCreate() {
     activityDelegate = new SampleActivityDelegate();
     super.onCreate();
-    if (!LeakCanary.isInAnalyzerProcess(this)) {
-      // This process is dedicated to LeakCanary for heap analysis. You should not init your app in
-      // this process.
-      installLeakCanary();
-    }
+    installLeakCanary();
   }
 
   /** Install leak canary for both activities and RIBs. */
   private void installLeakCanary() {
-    final RefWatcher refWatcher =
-        LeakCanary.refWatcher(this).watchDelay(2, TimeUnit.SECONDS).buildAndInstall();
-    LeakCanary.install(this);
     RibRefWatcher.getInstance()
         .setReferenceWatcher(
             new RibRefWatcher.ReferenceWatcher() {
               @Override
-              public void watch(Object object) {
-                refWatcher.watch(object);
+              public void watch(Object object, String description) {
+                AppWatcher.INSTANCE.getObjectWatcher().expectWeaklyReachable(object, description);
               }
 
               @Override

diff --git a/android/gradle/dependencies.gradle b/android/gradle/dependencies.gradle
@@ -125,7 +125,7 @@ def external = [
     roboelectricBase: "org.robolectric:robolectric:${versions.robolectric}",
     rxbinding: 'com.jakewharton.rxbinding2:rxbinding:2.0.0',
     rxkotlin: 'io.reactivex.rxjava2:rxkotlin:2.2.0',
-    leakcanaryDebug: 'com.squareup.leakcanary:leakcanary-android:1.5.4',
+    leakcanaryDebug: 'com.squareup.leakcanary:leakcanary-android:2.10',
 
 ]
 

diff --git a/android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibRefWatcher.kt b/android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/RibRefWatcher.kt
@@ -34,17 +34,30 @@ public open class RibRefWatcher {
     referenceWatcher = watcher
   }
 
+  @Deprecated(
+    "Add the description parameter",
+    replaceWith = ReplaceWith("watchDeletedObject(objectToWatch, description)"),
+  )
+  public open fun watchDeletedObject(
+    objectToWatch: Any?,
+  ) {
+    watchDeletedObject(objectToWatch, "missing description")
+  }
+
   /**
    * Watch this object to verify it has no inbound references.
    *
    * @param objectToWatch the object to watch.
    */
-  public open fun watchDeletedObject(objectToWatch: Any?) {
+  public open fun watchDeletedObject(
+    objectToWatch: Any?,
+    description: String,
+  ) {
     if (objectToWatch == null) {
       return
     }
     if (isLeakCanaryEnabled || uLeakEnabled) {
-      referenceWatcher?.watch(objectToWatch)
+      referenceWatcher?.watch(objectToWatch, description)
     }
   }
 
@@ -97,7 +110,7 @@ public open class RibRefWatcher {
      *
      * @param objectToWatch the object to watch.
      */
-    public fun watch(objectToWatch: Any)
+    public fun watch(objectToWatch: Any, description: String)
 
     /**
      * Method to pipe breadcrumbs into the Breadcrumb logger.

diff --git a/android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/Router.kt b/android/libraries/rib-base/src/main/kotlin/com/uber/rib/core/Router.kt
@@ -141,7 +141,10 @@ protected constructor(
   public open fun detachChild(childRouter: Router<*>) {
     val isChildRemoved = children.remove(childRouter)
     val interactor = childRouter.interactor
-    ribRefWatcher.watchDeletedObject(interactor)
+    ribRefWatcher.watchDeletedObject(
+      interactor,
+      "detached child router ${childRouter.javaClass.name}",
+    )
     ribRefWatcher.logBreadcrumb(
       "DETACHED",
       childRouter.javaClass.simpleName,

diff --git a/android/libraries/rib-base/src/test/kotlin/com/uber/rib/core/InteractorAndRouterTest.kt b/android/libraries/rib-base/src/test/kotlin/com/uber/rib/core/InteractorAndRouterTest.kt
@@ -146,13 +146,13 @@ class InteractorAndRouterTest {
     val childInteractor = TestInteractorB()
     val childRouter = TestRouterB(childInteractor, component)
     router.attachChild(childRouter)
-    verify(ribRefWatcher, never()).watchDeletedObject(any())
+    verify(ribRefWatcher, never()).watchDeletedObject(any(), "")
 
     // Action: Detach the child interactor.
     router.detachChild(childRouter)
 
     // Verify: the reference watcher observes the detached interactor and child.
-    verify(ribRefWatcher).watchDeletedObject(eq(childInteractor))
+    verify(ribRefWatcher).watchDeletedObject(eq(childInteractor), "")
   }
 
   @Test
@@ -166,13 +166,13 @@ class InteractorAndRouterTest {
       }
     val rootRouter = TestRouterB(component, TestInteractorB(), ribRefWatcher)
     val child = addTwoNestedChildInteractors()
-    verify(ribRefWatcher, never()).watchDeletedObject(any())
+    verify(ribRefWatcher, never()).watchDeletedObject(any(), "")
 
     // Action: Detach all child interactors.
     rootRouter.detachChild(child)
 
     // Verify: called four times. Twice for each interactor.
-    verify(ribRefWatcher, times(2)).watchDeletedObject(any())
+    verify(ribRefWatcher, times(2)).watchDeletedObject(any(), "")
   }
 
   private fun addTwoNestedChildInteractors(): Router<TestInteractorB> {

diff --git a/android/libraries/rib-base/src/test/kotlin/com/uber/rib/core/RibRefWatcherTest.kt b/android/libraries/rib-base/src/test/kotlin/com/uber/rib/core/RibRefWatcherTest.kt
@@ -36,14 +36,14 @@ class RibRefWatcherTest {
   fun watchDeletedObject_whenObjectIsNull_shouldDoNothing() {
     ribRefWatcher.enableLeakCanary()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(null)
+    ribRefWatcher.watchDeletedObject(null, "")
     verifyNoInteractions(referenceWatcher)
   }
 
   @Test
   fun watchDeletedObject_whenReferenceWatcherIsNull_shouldDoNothing() {
     ribRefWatcher.enableLeakCanary()
-    ribRefWatcher.watchDeletedObject(Any())
+    ribRefWatcher.watchDeletedObject(Any(), "")
     verifyNoInteractions(referenceWatcher)
   }
 
@@ -52,30 +52,30 @@ class RibRefWatcherTest {
     ribRefWatcher.enableLeakCanary()
     val obj = Any()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(obj)
-    verify(referenceWatcher).watch(obj)
+    ribRefWatcher.watchDeletedObject(obj, "")
+    verify(referenceWatcher).watch(obj, "")
   }
 
   @Test
   fun watchDeletedObject_whenNonNullRefWithDisabledLeakCanary_shouldDoNothing() {
     val obj = Any()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(obj)
-    verify(referenceWatcher, never()).watch(obj)
+    ribRefWatcher.watchDeletedObject(obj, "")
+    verify(referenceWatcher, never()).watch(obj, "")
   }
 
   @Test
   fun watchDeletedObject_whenObjectIsNullWithULeak_shouldDoNothing() {
     ribRefWatcher.enableULeakLifecycleTracking()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(null)
+    ribRefWatcher.watchDeletedObject(null, "")
     verifyNoInteractions(referenceWatcher)
   }
 
   @Test
   fun watchDeletedObject_whenReferenceWatcherIsNullULeakEnabled_shouldDoNothing() {
     ribRefWatcher.enableULeakLifecycleTracking()
-    ribRefWatcher.watchDeletedObject(Any())
+    ribRefWatcher.watchDeletedObject(Any(), "")
     verifyNoInteractions(referenceWatcher)
   }
 
@@ -84,15 +84,15 @@ class RibRefWatcherTest {
     ribRefWatcher.enableULeakLifecycleTracking()
     val obj = Any()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(obj)
-    verify(referenceWatcher).watch(obj)
+    ribRefWatcher.watchDeletedObject(obj, "")
+    verify(referenceWatcher).watch(obj, "")
   }
 
   @Test
   fun watchDeletedObject_whenNonNullRefULeakDisabled_shouldDoNothing() {
     val obj = Any()
     ribRefWatcher.setReferenceWatcher(referenceWatcher)
-    ribRefWatcher.watchDeletedObject(obj)
-    verify(referenceWatcher, never()).watch(obj)
+    ribRefWatcher.watchDeletedObject(obj, "")
+    verify(referenceWatcher, never()).watch(obj, "")
   }
 }