Add labels for receivers in LoadedAPK

Fixes #2091
square · Mar 26, 2021 · 233066b · 233066b
1 parent 295f948
commit 233066b
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 25 deletions.
diff --git a/leakcanary-android-sample/src/main/java/com/example/leakcanary/MainActivity.kt b/leakcanary-android-sample/src/main/java/com/example/leakcanary/MainActivity.kt
@@ -17,9 +17,13 @@ package com.example.leakcanary
 
 import android.app.Activity
 import android.app.AlertDialog
+import android.content.BroadcastReceiver
+import android.content.Context
 import android.content.Intent
+import android.content.IntentFilter
 import android.os.Build.VERSION.SDK_INT
 import android.os.Bundle
+import android.os.Handler
 import android.os.StatFs
 import android.os.SystemClock
 import android.view.View
@@ -30,14 +34,39 @@ import kotlin.random.Random
 
 class MainActivity : Activity() {
 
+  private var leakyReceiver = false
+
   override fun onCreate(savedInstanceState: Bundle?) {
     super.onCreate(savedInstanceState)
     setContentView(R.layout.main_activity)
 
     val app = application as ExampleApplication
-    val leakedView = findViewById<View>(R.id.helper_text)
-
     findViewById<Button>(R.id.recreate_activity_button).setOnClickListener { recreate() }
+    findViewById<Button>(R.id.leak_activity_button).setOnClickListener {
+      val leakedView = findViewById<View>(R.id.helper_text)
+      when (Random.nextInt(4)) {
+        // Leak from application class
+        0 -> app.leakedViews.add(leakedView)
+        // Leak from Kotlin object singleton
+        1 -> LeakingSingleton.leakedViews.add(leakedView)
+        2 -> {
+          // Leak from local variable on thread
+          val ref = AtomicReference(this)
+          val thread = Thread {
+            val activity = ref.get()
+            ref.set(null)
+            while (true) {
+              print(activity)
+              SystemClock.sleep(1000)
+            }
+          }
+          thread.name = "Leaking local variables"
+          thread.start()
+        }
+        // Leak from thread fields
+        else -> LeakingThread.thread.leakedViews.add(leakedView)
+      }
+    }
     findViewById<Button>(R.id.show_dialog_button).setOnClickListener {
       AlertDialog.Builder(this)
         .setTitle("Leaky dialog")
@@ -49,28 +78,25 @@ class MainActivity : Activity() {
     findViewById<Button>(R.id.start_service_button).setOnClickListener {
       startService(Intent(this, LeakingService::class.java))
     }
+    findViewById<Button>(R.id.leak_receiver_button).setOnClickListener {
+      leakyReceiver = true
+      recreate()
+    }
+  }
 
-    when (Random.nextInt(4)) {
-      // Leak from application class
-      0 -> app.leakedViews.add(leakedView)
-      // Leak from Kotlin object singleton
-      1 -> LeakingSingleton.leakedViews.add(leakedView)
-      2 -> {
-        // Leak from local variable on thread
-        val ref = AtomicReference(this)
-        val thread = Thread {
-          val activity = ref.get()
-          ref.set(null)
-          while (true) {
-            print(activity)
-            SystemClock.sleep(1000)
-          }
-        }
-        thread.name = "Leaking local variables"
-        thread.start()
-      }
-      // Leak from thread fields
-      else -> LeakingThread.thread.leakedViews.add(leakedView)
+  class NoOpBroadcastReceiver : BroadcastReceiver() {
+    override fun onReceive(
+      context: Context,
+      intent: Intent
+    ) = Unit
+  }
+
+  override fun onDestroy() {
+    super.onDestroy()
+    if (leakyReceiver) {
+      Handler().postDelayed({
+        registerReceiver(NoOpBroadcastReceiver(), IntentFilter())
+      }, 500)
     }
   }
 }
diff --git a/leakcanary-android-sample/src/main/res/layout/main_activity.xml b/leakcanary-android-sample/src/main/res/layout/main_activity.xml
@@ -34,7 +34,14 @@
       android:layout_width="wrap_content"
       android:layout_gravity="center"
       android:layout_height="wrap_content"
-      android:text="@string/recreate_activity_button_text"
+      android:text="Recreate Activity"
+      />
+  <Button
+      android:id="@+id/leak_activity_button"
+      android:layout_width="wrap_content"
+      android:layout_gravity="center"
+      android:layout_height="wrap_content"
+      android:text="Leak Activity"
       />
   <Button
       android:id="@+id/show_dialog_button"
@@ -50,5 +57,13 @@
       android:layout_height="wrap_content"
       android:text="@string/start_service_button_text"
       />
+  <Button
+      android:id="@+id/leak_receiver_button"
+      android:layout_width="wrap_content"
+      android:layout_gravity="center"
+      android:layout_height="wrap_content"
+      android:text="Create &amp; leak Receiver"
+      />
+
 
 </LinearLayout>
diff --git a/leakcanary-android-sample/src/main/res/values/strings.xml b/leakcanary-android-sample/src/main/res/values/strings.xml
@@ -19,6 +19,5 @@
     tools:ignore="MissingTranslation">
   <string name="app_name">Example App</string>
   <string name="helper_text">Press this button or rotate the screen to create leaks. Pressing back or creating 5 leaks will trigger a heap dump.</string>
-  <string name="recreate_activity_button_text">Recreate &amp; Leak Activity</string>
   <string name="start_service_button_text">Create &amp; Leak Service</string>
 </resources>
diff --git a/shark-android/api/shark-android.api b/shark-android/api/shark-android.api
@@ -28,6 +28,7 @@ public abstract class shark/AndroidObjectInspectors : java/lang/Enum, shark/Obje
 	public static final field EDITOR Lshark/AndroidObjectInspectors;
 	public static final field FRAGMENT Lshark/AndroidObjectInspectors;
 	public static final field INPUT_METHOD_MANAGER Lshark/AndroidObjectInspectors;
+	public static final field LOADED_APK Lshark/AndroidObjectInspectors;
 	public static final field MAIN_THREAD Lshark/AndroidObjectInspectors;
 	public static final field MESSAGE Lshark/AndroidObjectInspectors;
 	public static final field MESSAGE_QUEUE Lshark/AndroidObjectInspectors;

diff --git a/shark-android/src/main/java/shark/AndroidObjectInspectors.kt b/shark-android/src/main/java/shark/AndroidObjectInspectors.kt
@@ -515,6 +515,48 @@ enum class AndroidObjectInspectors : ObjectInspector {
     }
   },
 
+  LOADED_APK {
+    override fun inspect(
+      reporter: ObjectReporter
+    ) {
+      reporter.whenInstanceOf("android.app.LoadedApk") { instance ->
+        val receiversMap = instance["android.app.LoadedApk", "mReceivers"]!!.valueAsInstance!!
+        val receiversArray = receiversMap["android.util.ArrayMap", "mArray"]!!.valueAsObjectArray!!
+        val receiverContextList = receiversArray.readElements().toList()
+
+        val allReceivers = (receiverContextList.indices step 2).map { index ->
+          val context = receiverContextList[index]
+          if (context.isNonNullReference) {
+            val contextReceiversMap = receiverContextList[index + 1].asObject!!.asInstance!!
+            val contextReceivers = contextReceiversMap["android.util.ArrayMap", "mArray"]!!
+              .valueAsObjectArray!!
+              .readElements()
+              .toList()
+
+            val receivers =
+              (contextReceivers.indices step 2).mapNotNull { contextReceivers[it].asObject?.asInstance }
+            val contextInstance = context.asObject!!.asInstance!!
+            val contextString =
+              "${contextInstance.instanceClassSimpleName}@${contextInstance.objectId}"
+            contextString to receivers.map {  "${it.instanceClassSimpleName}@${it.objectId}" }
+          } else {
+            null
+          }
+        }.filterNotNull().toList()
+
+        if (allReceivers.isNotEmpty()) {
+          labels += "Receivers"
+          allReceivers.forEach { (contextString, receiverStrings) ->
+            labels += "..$contextString"
+            receiverStrings.forEach { receiverString ->
+              labels += "....$receiverString"
+            }
+          }
+        }
+      }
+    }
+  },
+
   MORTAR_PRESENTER {
     override fun inspect(
       reporter: ObjectReporter