Clear window reference only on activity stop in profileMeasurements collector (#2407)

* the current window reference in SentryFrameMetricsCollector is cleared only after the activity stops, and no more when the profiler stops

Author: stefanosiano

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- Clear window reference only on activity stop in profileMeasurements collector ([#2407](https://github.com/getsentry/sentry-java/pull/2407))
 - No longer disable OpenTelemetry exporters in default Java Agent config ([#2408](https://github.com/getsentry/sentry-java/pull/2408))
 - Fix `ClassNotFoundException` for `io.sentry.spring.SentrySpringServletContainerInitializer` in `sentry-spring-jakarta` ([#2411](https://github.com/getsentry/sentry-java/issues/2411))
 - Fix `sentry-samples-spring-jakarta` ([#2411](https://github.com/getsentry/sentry-java/issues/2411))

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/SentryFrameMetricsCollector.java

@@ -113,7 +113,10 @@ public void onActivityPaused(@NotNull Activity activity) {}
 
   @Override
   public void onActivityStopped(@NotNull Activity activity) {
-    clearCurrentWindow(activity.getWindow());
+    stopTrackingWindow(activity.getWindow());
+    if (currentWindow != null && currentWindow.get() == activity.getWindow()) {
+      currentWindow = null;
+    }
   }
 
   @Override
@@ -141,15 +144,12 @@ public void stopCollection(final @Nullable String listenerId) {
     }
     Window window = currentWindow != null ? currentWindow.get() : null;
     if (window != null && listenerMap.isEmpty()) {
-      clearCurrentWindow(window);
+      stopTrackingWindow(window);
     }
   }
 
   @SuppressLint("NewApi")
-  private void clearCurrentWindow(final @NotNull Window window) {
-    if (currentWindow != null && currentWindow.get() == window) {
-      currentWindow = null;
-    }
+  private void stopTrackingWindow(final @NotNull Window window) {
     if (trackedWindows.contains(window)) {
       if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.N) {
         try {

sentry-android-core/src/test/java/io/sentry/android/core/internal/util/SentryFrameMetricsCollectorTest.kt

@@ -11,10 +11,12 @@ import io.sentry.ILogger
 import io.sentry.SentryOptions
 import io.sentry.android.core.BuildInfoProvider
 import io.sentry.test.getCtor
+import io.sentry.test.getProperty
 import org.junit.runner.RunWith
 import org.mockito.Mockito.spy
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.whenever
+import java.lang.ref.WeakReference
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -229,4 +231,24 @@ class SentryFrameMetricsCollectorTest {
         collector.stopCollection(id2)
         assertEquals(1, fixture.removeOnFrameMetricsAvailableListenerCounter)
     }
+
+    @Test
+    fun `collector removes current window only when last activity stops`() {
+        val collector = fixture.getSut(context)
+        val id1 = collector.startCollection(mock())
+        collector.onActivityStarted(fixture.activity)
+        collector.onActivityStarted(fixture.activity2)
+
+        // Stopping collecting data doesn't clear current tracked window reference
+        collector.stopCollection(id1)
+        assertNotNull(collector.getProperty<WeakReference<Window>?>("currentWindow"))
+
+        // Stopping first activity doesn't clear current tracked window reference
+        collector.onActivityStopped(fixture.activity)
+        assertNotNull(collector.getProperty<WeakReference<Window>?>("currentWindow"))
+
+        // Stopping last activity clears current tracked window reference
+        collector.onActivityStopped(fixture.activity2)
+        assertNull(collector.getProperty<WeakReference<Window>?>("currentWindow"))
+    }
 }