app going in the background now stops the continuous profiler

Author: stefanosiano

sentry-android-core/api/sentry-android-core.api

@@ -49,6 +49,7 @@ public class io/sentry/android/core/AndroidContinuousProfiler : io/sentry/IConti
 	public fun onRateLimitChanged (Lio/sentry/transport/RateLimiter;)V
 	public fun reevaluateSampling ()V
 	public fun startProfiler (Lio/sentry/ProfileLifecycle;Lio/sentry/TracesSampler;)V
+	public fun stopAllProfiles ()V
 	public fun stopProfiler (Lio/sentry/ProfileLifecycle;)V
 }
 

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

@@ -322,6 +322,15 @@ public void reevaluateSampling() {
     shouldSample = true;
   }
 
+  @Override
+  public void stopAllProfiles() {
+    try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
+      rootSpanCounter = 0;
+      shouldStop = true;
+    }
+  }
+
+  @Override
   public void close() {
     try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
       rootSpanCounter = 0;

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

@@ -122,6 +122,7 @@ public void run() {
                   scopes.endSession();
                 }
                 scopes.getOptions().getReplayController().stop();
+                scopes.getOptions().getContinuousProfiler().stopAllProfiles();
               }
             };
 

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

@@ -470,6 +470,23 @@ class AndroidContinuousProfilerTest {
         verify(fixture.scopes).captureProfileChunk(any())
     }
 
+    @Test
+    fun `stopAllProfiles stops all profiles after chunk is finished`() {
+        val profiler = fixture.getSut()
+        profiler.startProfiler(ProfileLifecycle.MANUAL, fixture.mockTracesSampler)
+        profiler.startProfiler(ProfileLifecycle.TRACE, fixture.mockTracesSampler)
+        assertTrue(profiler.isRunning)
+        // We are scheduling the profiler to stop at the end of the chunk, so it should still be running
+        profiler.stopAllProfiles()
+        assertTrue(profiler.isRunning)
+        // However, stopAllProfiles already resets the rootSpanCounter
+        assertEquals(0, profiler.rootSpanCounter)
+
+        // We run the executor service to trigger the chunk finish, and the profiler shouldn't restart
+        fixture.executor.runAll()
+        assertFalse(profiler.isRunning)
+    }
+
     @Test
     fun `profiler does not send chunks after close`() {
         val profiler = fixture.getSut()

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

@@ -3,6 +3,7 @@ package io.sentry.android.core
 import androidx.lifecycle.LifecycleOwner
 import io.sentry.Breadcrumb
 import io.sentry.DateUtils
+import io.sentry.IContinuousProfiler
 import io.sentry.IScope
 import io.sentry.IScopes
 import io.sentry.ReplayController
@@ -38,6 +39,7 @@ class LifecycleWatcherTest {
         val dateProvider = mock<ICurrentDateProvider>()
         val options = SentryOptions()
         val replayController = mock<ReplayController>()
+        val continuousProfiler = mock<IContinuousProfiler>()
 
         fun getSUT(
             sessionIntervalMillis: Long = 0L,
@@ -52,6 +54,7 @@ class LifecycleWatcherTest {
                 argumentCaptor.value.run(scope)
             }
             options.setReplayController(replayController)
+            options.setContinuousProfiler(continuousProfiler)
             whenever(scopes.options).thenReturn(options)
 
             return LifecycleWatcher(
@@ -106,6 +109,7 @@ class LifecycleWatcherTest {
         watcher.onStop(fixture.ownerMock)
         verify(fixture.scopes, timeout(10000)).endSession()
         verify(fixture.replayController, timeout(10000)).stop()
+        verify(fixture.continuousProfiler, timeout(10000)).stopAllProfiles()
     }
 
     @Test

sentry/api/sentry.api

@@ -753,6 +753,7 @@ public abstract interface class io/sentry/IContinuousProfiler {
 	public abstract fun isRunning ()Z
 	public abstract fun reevaluateSampling ()V
 	public abstract fun startProfiler (Lio/sentry/ProfileLifecycle;Lio/sentry/TracesSampler;)V
+	public abstract fun stopAllProfiles ()V
 	public abstract fun stopProfiler (Lio/sentry/ProfileLifecycle;)V
 }
 
@@ -1437,6 +1438,7 @@ public final class io/sentry/NoOpContinuousProfiler : io/sentry/IContinuousProfi
 	public fun isRunning ()Z
 	public fun reevaluateSampling ()V
 	public fun startProfiler (Lio/sentry/ProfileLifecycle;Lio/sentry/TracesSampler;)V
+	public fun stopAllProfiles ()V
 	public fun stopProfiler (Lio/sentry/ProfileLifecycle;)V
 }
 

sentry/src/main/java/io/sentry/IContinuousProfiler.java

@@ -19,6 +19,9 @@ void startProfiler(
 
   void reevaluateSampling();
 
+  /** Stops all profiles currently running, regardless of the profileLifecycle that started them. */
+  void stopAllProfiles();
+
   @NotNull
   SentryId getProfilerId();
 }

sentry/src/main/java/io/sentry/NoOpContinuousProfiler.java

@@ -26,6 +26,9 @@ public void startProfiler(
       final @NotNull ProfileLifecycle profileLifecycle,
       final @NotNull TracesSampler tracesSampler) {}
 
+  @Override
+  public void stopAllProfiles() {}
+
   @Override
   public void close() {}
 

sentry/src/test/java/io/sentry/NoOpContinuousProfilerTest.kt

@@ -17,6 +17,10 @@ class NoOpContinuousProfilerTest {
     fun `stop does not throw`() =
         profiler.stopProfiler(mock())
 
+    @Test
+    fun `stopAllProfiles does not throw`() =
+        profiler.stopAllProfiles()
+
     @Test
     fun `isRunning returns false`() {
         assertFalse(profiler.isRunning)