removed AndroidContinuousProfiler.stopAllProfiles

stefanosiano · stefanosiano · commit 8283fc091172 · 2025-04-07T12:55:29.000+02:00
added AndroidContinuousProfiler.close param isTerminating
diff --git a/sentry-android-core/api/sentry-android-core.api b/sentry-android-core/api/sentry-android-core.api
@@ -42,14 +42,13 @@ public final class io/sentry/android/core/ActivityLifecycleIntegration : android
 
 public class io/sentry/android/core/AndroidContinuousProfiler : io/sentry/IContinuousProfiler, io/sentry/transport/RateLimiter$IRateLimitObserver {
 	public fun <init> (Lio/sentry/android/core/BuildInfoProvider;Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;Lio/sentry/ILogger;Ljava/lang/String;ILio/sentry/ISentryExecutorService;)V
-	public fun close ()V
+	public fun close (Z)V
 	public fun getProfilerId ()Lio/sentry/protocol/SentryId;
 	public fun getRootSpanCounter ()I
 	public fun isRunning ()Z
 	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
 }
 
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/AndroidContinuousProfiler.java b/sentry-android-core/src/main/java/io/sentry/android/core/AndroidContinuousProfiler.java
@@ -323,20 +323,14 @@ public void reevaluateSampling() {
   }
 
   @Override
-  public void stopAllProfiles() {
+  public void close(final boolean isTerminating) {
     try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
       rootSpanCounter = 0;
       shouldStop = true;
-    }
-  }
-
-  @Override
-  public void close() {
-    try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
-      rootSpanCounter = 0;
-      shouldStop = true;
-      stop(false);
-      isClosed.set(true);
+      if (isTerminating) {
+        stop(false);
+        isClosed.set(true);
+      }
     }
   }
 
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java b/sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java
@@ -268,7 +268,7 @@ private static void setupProfiler(
       // This is a safeguard, but it should never happen, as the app start profiler should be the
       // continuous one.
       if (appStartContinuousProfiler != null) {
-        appStartContinuousProfiler.close();
+        appStartContinuousProfiler.close(true);
       }
       if (appStartTransactionProfiler != null) {
         options.setTransactionProfiler(appStartTransactionProfiler);
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/LifecycleWatcher.java b/sentry-android-core/src/main/java/io/sentry/android/core/LifecycleWatcher.java
@@ -122,7 +122,7 @@ public void run() {
                   scopes.endSession();
                 }
                 scopes.getOptions().getReplayController().stop();
-                scopes.getOptions().getContinuousProfiler().stopAllProfiles();
+                scopes.getOptions().getContinuousProfiler().close(false);
               }
             };
 
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/SentryPerformanceProvider.java b/sentry-android-core/src/main/java/io/sentry/android/core/SentryPerformanceProvider.java
@@ -95,7 +95,7 @@ public void shutdown() {
       final @Nullable IContinuousProfiler appStartContinuousProfiler =
           AppStartMetrics.getInstance().getAppStartContinuousProfiler();
       if (appStartContinuousProfiler != null) {
-        appStartContinuousProfiler.close();
+        appStartContinuousProfiler.close(true);
       }
     }
   }
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
@@ -225,7 +225,7 @@ public void clear() {
     }
     appStartProfiler = null;
     if (appStartContinuousProfiler != null) {
-      appStartContinuousProfiler.close();
+      appStartContinuousProfiler.close(true);
     }
     appStartContinuousProfiler = null;
     appStartSamplingDecision = null;
@@ -333,7 +333,7 @@ private void checkCreateTimeOnMain() {
                   appStartProfiler = null;
                 }
                 if (appStartContinuousProfiler != null && appStartContinuousProfiler.isRunning()) {
-                  appStartContinuousProfiler.close();
+                  appStartContinuousProfiler.close(true);
                   appStartContinuousProfiler = null;
                 }
               }
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/AndroidContinuousProfilerTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/AndroidContinuousProfilerTest.kt
@@ -389,7 +389,7 @@ class AndroidContinuousProfilerTest {
         profiler.startProfiler(ProfileLifecycle.MANUAL, fixture.mockTracesSampler)
         assertTrue(profiler.isRunning)
 
-        profiler.close()
+        profiler.close(true)
         assertFalse(profiler.isRunning)
 
         // The timeout scheduled job should be cleared
@@ -471,15 +471,15 @@ class AndroidContinuousProfilerTest {
     }
 
     @Test
-    fun `stopAllProfiles stops all profiles after chunk is finished`() {
+    fun `close without terminating 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()
+        profiler.close(false)
         assertTrue(profiler.isRunning)
-        // However, stopAllProfiles already resets the rootSpanCounter
+        // However, close() already resets the rootSpanCounter
         assertEquals(0, profiler.rootSpanCounter)
 
         // We run the executor service to trigger the chunk finish, and the profiler shouldn't restart
@@ -494,7 +494,7 @@ class AndroidContinuousProfilerTest {
         assertTrue(profiler.isRunning)
 
         // We close the profiler, which should prevent sending additional chunks
-        profiler.close()
+        profiler.close(true)
 
         // The executor used to send the chunk doesn't do anything
         fixture.executor.runAll()
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt
@@ -446,7 +446,7 @@ class AndroidOptionsInitializerTest {
         assertEquals(fixture.sentryOptions.continuousProfiler, NoOpContinuousProfiler.getInstance())
 
         // app start profiler is closed, because it will never be used
-        verify(appStartContinuousProfiler).close()
+        verify(appStartContinuousProfiler).close(eq(true))
 
         // AppStartMetrics should be cleared
         assertNull(AppStartMetrics.getInstance().appStartProfiler)
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/LifecycleWatcherTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/LifecycleWatcherTest.kt
@@ -16,6 +16,7 @@ import io.sentry.transport.ICurrentDateProvider
 import org.mockito.ArgumentCaptor
 import org.mockito.kotlin.any
 import org.mockito.kotlin.check
+import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
 import org.mockito.kotlin.timeout
@@ -109,7 +110,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()
+        verify(fixture.continuousProfiler, timeout(10000)).close(eq(false))
     }
 
     @Test
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
@@ -16,6 +16,7 @@ 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.any
 import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
@@ -273,7 +274,7 @@ class AppStartMetricsTest {
         // Job on main thread checks if activity was launched
         Shadows.shadowOf(Looper.getMainLooper()).idle()
 
-        verify(profiler).close()
+        verify(profiler).close(eq(true))
     }
 
     @Test
@@ -301,7 +302,7 @@ class AppStartMetricsTest {
         // Job on main thread checks if activity was launched
         Shadows.shadowOf(Looper.getMainLooper()).idle()
 
-        verify(profiler, never()).close()
+        verify(profiler, never()).close(any())
     }
 
     @Test
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -744,12 +744,11 @@ public abstract interface class io/sentry/IConnectionStatusProvider$IConnectionS
 }
 
 public abstract interface class io/sentry/IContinuousProfiler {
-	public abstract fun close ()V
+	public abstract fun close (Z)V
 	public abstract fun getProfilerId ()Lio/sentry/protocol/SentryId;
 	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,13 +1436,12 @@ public final class io/sentry/NoOpConnectionStatusProvider : io/sentry/IConnectio
 }
 
 public final class io/sentry/NoOpContinuousProfiler : io/sentry/IContinuousProfiler {
-	public fun close ()V
+	public fun close (Z)V
 	public static fun getInstance ()Lio/sentry/NoOpContinuousProfiler;
 	public fun getProfilerId ()Lio/sentry/protocol/SentryId;
 	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
 }
 
diff --git a/sentry/src/main/java/io/sentry/IContinuousProfiler.java b/sentry/src/main/java/io/sentry/IContinuousProfiler.java
@@ -14,14 +14,15 @@ void startProfiler(
 
   void stopProfiler(final @NotNull ProfileLifecycle profileLifecycle);
 
-  /** Cancel the profiler and stops it. Used on SDK close. */
-  void close();
+  /**
+   * Cancel the profiler and stops it.
+   *
+   * @param isTerminating whether the profiler is terminating and won't be restarted or not.
+   */
+  void close(final boolean isTerminating);
 
   void reevaluateSampling();
 
-  /** Stops all profiles currently running, regardless of the profileLifecycle that started them. */
-  void stopAllProfiles();
-
   @NotNull
   SentryId getProfilerId();
 }
diff --git a/sentry/src/main/java/io/sentry/NoOpContinuousProfiler.java b/sentry/src/main/java/io/sentry/NoOpContinuousProfiler.java
@@ -27,10 +27,7 @@ public void startProfiler(
       final @NotNull TracesSampler tracesSampler) {}
 
   @Override
-  public void stopAllProfiles() {}
-
-  @Override
-  public void close() {}
+  public void close(final boolean isTerminating) {}
 
   @Override
   public void reevaluateSampling() {}
diff --git a/sentry/src/main/java/io/sentry/Scopes.java b/sentry/src/main/java/io/sentry/Scopes.java
@@ -405,7 +405,7 @@ public void close(final boolean isRestarting) {
         configureScope(ScopeType.ISOLATION, scope -> scope.clear());
         getOptions().getBackpressureMonitor().close();
         getOptions().getTransactionProfiler().close();
-        getOptions().getContinuousProfiler().close();
+        getOptions().getContinuousProfiler().close(true);
         getOptions().getCompositePerformanceCollector().close();
         final @NotNull ISentryExecutorService executorService = getOptions().getExecutorService();
         if (isRestarting) {
diff --git a/sentry/src/test/java/io/sentry/NoOpContinuousProfilerTest.kt b/sentry/src/test/java/io/sentry/NoOpContinuousProfilerTest.kt
@@ -17,18 +17,14 @@ 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)
     }
 
     @Test
     fun `close does not throw`() =
-        profiler.close()
+        profiler.close(true)
 
     @Test
     fun `getProfilerId returns Empty SentryId`() {
diff --git a/sentry/src/test/java/io/sentry/ScopesTest.kt b/sentry/src/test/java/io/sentry/ScopesTest.kt
@@ -1826,7 +1826,7 @@ class ScopesTest {
         verify(backpressureMonitorMock).close()
         verify(executor).close(any())
         verify(profiler).close()
-        verify(continuousProfiler).close()
+        verify(continuousProfiler).close(eq(true))
         verify(performanceCollector).close()
     }
 

Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ private static void setupProfiler(`
`268`	`268`	`// This is a safeguard, but it should never happen, as the app start profiler should be the`
`269`	`269`	`// continuous one.`
`270`	`270`	`if (appStartContinuousProfiler != null) {`
`271`		`- appStartContinuousProfiler.close();`
	`271`	`+ appStartContinuousProfiler.close(true);`
`272`	`272`	`}`
`273`	`273`	`if (appStartTransactionProfiler != null) {`
`274`	`274`	`options.setTransactionProfiler(appStartTransactionProfiler);`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ public void run() {`
`122`	`122`	`scopes.endSession();`
`123`	`123`	`}`
`124`	`124`	`scopes.getOptions().getReplayController().stop();`
`125`		`- scopes.getOptions().getContinuousProfiler().stopAllProfiles();`
	`125`	`+ scopes.getOptions().getContinuousProfiler().close(false);`
`126`	`126`	`}`
`127`	`127`	`};`
`128`	`128`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public void shutdown() {`
`95`	`95`	`final @Nullable IContinuousProfiler appStartContinuousProfiler =`
`96`	`96`	`AppStartMetrics.getInstance().getAppStartContinuousProfiler();`
`97`	`97`	`if (appStartContinuousProfiler != null) {`
`98`		`- appStartContinuousProfiler.close();`
	`98`	`+ appStartContinuousProfiler.close(true);`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ public void clear() {`
`225`	`225`	`}`
`226`	`226`	`appStartProfiler = null;`
`227`	`227`	`if (appStartContinuousProfiler != null) {`
`228`		`- appStartContinuousProfiler.close();`
	`228`	`+ appStartContinuousProfiler.close(true);`
`229`	`229`	`}`
`230`	`230`	`appStartContinuousProfiler = null;`
`231`	`231`	`appStartSamplingDecision = null;`
`@@ -333,7 +333,7 @@ private void checkCreateTimeOnMain() {`
`333`	`333`	`appStartProfiler = null;`
`334`	`334`	`}`
`335`	`335`	`if (appStartContinuousProfiler != null && appStartContinuousProfiler.isRunning()) {`
`336`		`- appStartContinuousProfiler.close();`
	`336`	`+ appStartContinuousProfiler.close(true);`
`337`	`337`	`appStartContinuousProfiler = null;`
`338`	`338`	`}`
`339`	`339`	`}`