added AppStartMetrics automatically unregister lifecycle callback

stefanosiano · stefanosiano · commit 082edcbda9d9 · 2024-07-12T16:23:37.000+02:00
added foreground check to SentryAndroid.init
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroid.java b/sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroid.java
@@ -1,6 +1,7 @@
 package io.sentry.android.core;
 
 import android.annotation.SuppressLint;
+import android.app.Application;
 import android.content.Context;
 import android.os.Process;
 import android.os.SystemClock;
@@ -135,6 +136,10 @@ public static synchronized void init(
                 appStartTimeSpan.setStartedAt(Process.getStartUptimeMillis());
               }
             }
+            if (context.getApplicationContext() instanceof Application) {
+              appStartMetrics.registerApplicationForegroundCheck(
+                  (Application) context.getApplicationContext());
+            }
             final @NotNull TimeSpan sdkInitTimeSpan = appStartMetrics.getSdkInitTimeSpan();
             if (sdkInitTimeSpan.hasNotStarted()) {
               sdkInitTimeSpan.setStartedAt(sdkInitMillis);
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/performance/AppStartMetrics.java b/sentry-android-core/src/main/java/io/sentry/android/core/performance/AppStartMetrics.java
@@ -243,6 +243,7 @@ public void registerApplicationForegroundCheck(final @NotNull Application applic
               if (onCreateTime == null) {
                 appLaunchedInForeground = false;
               }
+              application.unregisterActivityLifecycleCallbacks(instance);
             });
   }
 
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidTest.kt
@@ -331,6 +331,15 @@ class SentryAndroidTest {
         verify(client, times(1)).captureSession(any(), any())
     }
 
+    @Test
+    fun `When initializing Sentry a callback is added to application by appStartMetrics`() {
+        val mockContext = ContextUtilsTestHelper.createMockContext(true)
+        SentryAndroid.init(mockContext) {
+            it.dsn = "https://key@sentry.io/123"
+        }
+        verify(mockContext.applicationContext as Application).registerActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
+    }
+
     private fun initSentryWithForegroundImportance(
         inForeground: Boolean,
         optionsConfig: (SentryAndroidOptions) -> Unit = {},
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/performance/AppStartMetricsTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/performance/AppStartMetricsTest.kt
@@ -9,7 +9,10 @@ import io.sentry.android.core.SentryAndroidOptions
 import io.sentry.android.core.SentryShadowProcess
 import org.junit.Before
 import org.junit.runner.RunWith
+import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
+import org.mockito.kotlin.never
+import org.mockito.kotlin.verify
 import org.robolectric.Shadows
 import org.robolectric.annotation.Config
 import java.util.concurrent.TimeUnit
@@ -201,4 +204,45 @@ class AppStartMetricsTest {
         val timeSpan = AppStartMetrics.getInstance().getAppStartTimeSpanWithFallback(options)
         assertFalse(timeSpan.hasStarted())
     }
+
+    @Test
+    fun `when registerApplicationForegroundCheck, a callback is registered to application`() {
+        val application = mock<Application>()
+        AppStartMetrics.getInstance().registerApplicationForegroundCheck(application)
+        verify(application).registerActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
+    }
+
+    @Test
+    fun `when registerApplicationForegroundCheck, a job is posted on main thread to unregistered the callback`() {
+        val application = mock<Application>()
+        AppStartMetrics.getInstance().registerApplicationForegroundCheck(application)
+        verify(application).registerActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
+        verify(application, never()).unregisterActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
+        Shadows.shadowOf(Looper.getMainLooper()).idle()
+        verify(application).unregisterActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
+    }
+
+    @Test
+    fun `registerApplicationForegroundCheck set foreground state to false if no activity is running`() {
+        val application = mock<Application>()
+        AppStartMetrics.getInstance().isAppLaunchedInForeground = true
+        AppStartMetrics.getInstance().registerApplicationForegroundCheck(application)
+        assertTrue(AppStartMetrics.getInstance().isAppLaunchedInForeground)
+        // Main thread performs the check and sets the flag to false if no activity was created
+        Shadows.shadowOf(Looper.getMainLooper()).idle()
+        assertFalse(AppStartMetrics.getInstance().isAppLaunchedInForeground)
+    }
+
+    @Test
+    fun `registerApplicationForegroundCheck keeps foreground state to true if an activity is running`() {
+        val application = mock<Application>()
+        AppStartMetrics.getInstance().isAppLaunchedInForeground = true
+        AppStartMetrics.getInstance().registerApplicationForegroundCheck(application)
+        assertTrue(AppStartMetrics.getInstance().isAppLaunchedInForeground)
+        // An activity was created
+        AppStartMetrics.getInstance().onActivityCreated(mock(), null)
+        // Main thread performs the check and keeps the flag to true
+        Shadows.shadowOf(Looper.getMainLooper()).idle()
+        assertTrue(AppStartMetrics.getInstance().isAppLaunchedInForeground)
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -243,6 +243,7 @@ public void registerApplicationForegroundCheck(final @NotNull Application applic`
`243`	`243`	`if (onCreateTime == null) {`
`244`	`244`	`appLaunchedInForeground = false;`
`245`	`245`	`}`
	`246`	`+ application.unregisterActivityLifecycleCallbacks(instance);`
`246`	`247`	`});`
`247`	`248`	`}`
`248`	`249`