fix: safe unregister SystemEventsBroadcastReceiver

Author: viyakovlev

sentry-android-core/src/main/java/io/sentry/android/core/SystemEventsBreadcrumbsIntegration.java

@@ -203,13 +203,13 @@ private void scheduleUnregisterReceiver() {
     }
 
     try {
-      options.getExecutorService().submit(() -> unregisterReceiver());
+      options.getExecutorService().submit(() -> unregisterReceiver(options));
     } catch (RejectedExecutionException e) {
-      unregisterReceiver();
+      unregisterReceiver(options);
     }
   }
 
-  private void unregisterReceiver() {
+  private void unregisterReceiver(final @NotNull SentryAndroidOptions options) {
     final @Nullable SystemEventsBroadcastReceiver receiverRef;
     try (final @NotNull ISentryLifecycleToken ignored = receiverLock.acquire()) {
       isStopped = true;
@@ -218,7 +218,17 @@ private void unregisterReceiver() {
     }
 
     if (receiverRef != null) {
-      context.unregisterReceiver(receiverRef);
+      try {
+        context.unregisterReceiver(receiverRef);
+      } catch (IllegalArgumentException exception) {
+        options
+          .getLogger()
+          .log(
+            SentryLevel.ERROR,
+            exception,
+            "Failed to unregister SystemEventsBroadcastReceiver: the receiver is already unregistered or was never registered."
+          );
+      }
     }
   }
 

sentry-android-core/src/test/java/io/sentry/android/core/SystemEventsBreadcrumbsIntegrationTest.kt

@@ -16,15 +16,6 @@ import io.sentry.ISentryExecutorService
 import io.sentry.SentryLevel
 import io.sentry.test.DeferredExecutorService
 import io.sentry.test.ImmediateExecutorService
-import java.util.concurrent.CountDownLatch
-import kotlin.test.AfterTest
-import kotlin.test.BeforeTest
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertFalse
-import kotlin.test.assertNotNull
-import kotlin.test.assertNull
-import kotlin.test.assertTrue
 import org.junit.runner.RunWith
 import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
@@ -41,6 +32,15 @@ import org.robolectric.annotation.Config
 import org.robolectric.shadow.api.Shadow
 import org.robolectric.shadows.ShadowActivityManager
 import org.robolectric.shadows.ShadowBuild
+import java.util.concurrent.CountDownLatch
+import kotlin.test.AfterTest
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertFalse
+import kotlin.test.assertNotNull
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
 
 @RunWith(AndroidJUnit4::class)
 @Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@@ -52,6 +52,7 @@ class SystemEventsBreadcrumbsIntegrationTest {
     lateinit var shadowActivityManager: ShadowActivityManager
 
     fun getSut(
+      contextForSut: Context = context,
       enableSystemEventBreadcrumbs: Boolean = true,
       enableSystemEventBreadcrumbsExtras: Boolean = false,
       executorService: ISentryExecutorService = ImmediateExecutorService(),
@@ -64,7 +65,7 @@ class SystemEventsBreadcrumbsIntegrationTest {
           this.executorService = executorService
         }
       return SystemEventsBreadcrumbsIntegration(
-        context,
+        contextForSut,
         SystemEventsBreadcrumbsIntegration.getDefaultActions().toTypedArray(),
         handler,
       )
@@ -313,6 +314,20 @@ class SystemEventsBreadcrumbsIntegrationTest {
     assertFalse(fixture.options.isEnableSystemEventBreadcrumbs)
   }
 
+  @Test
+  fun `Do not crash if receiver already unregistered`() {
+    val realContext = ApplicationProvider.getApplicationContext<Context>()
+    val sut = fixture.getSut(realContext)
+
+    sut.register(fixture.scopes, fixture.options)
+
+    realContext.unregisterReceiver(sut.receiver)
+
+    val result = runCatching { sut.onBackground() }
+
+    assertFalse(result.isFailure)
+  }
+
   @Test
   fun `when str has full package, return last string after dot`() {
     val sut = fixture.getSut()
@@ -421,9 +436,9 @@ class SystemEventsBreadcrumbsIntegrationTest {
     sut.register(fixture.scopes, fixture.options)
 
     Thread {
-        sut.close()
-        latch.countDown()
-      }
+      sut.close()
+      latch.countDown()
+    }
       .start()
 
     latch.await()
@@ -505,9 +520,9 @@ class SystemEventsBreadcrumbsIntegrationTest {
     assertNotNull(sut.receiver)
 
     Thread {
-        sut.close()
-        latch.countDown()
-      }
+      sut.close()
+      latch.countDown()
+    }
       .start()
 
     latch.await()