fix(replay): Do not capture replay for cached events (#4474)

* fix(replay): Do not capture replay for cached events

* Changelog

* Formatting

* Wording

* Still caputre replay for outbox events

Author: romtsn

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Send UI Profiling app start chunk when it finishes ([#4423](https://github.com/getsentry/sentry-java/pull/4423))
 - Republish Javadoc [#4457](https://github.com/getsentry/sentry-java/pull/4457)
 - Finalize `OkHttpEvent` even if no active span in `SentryOkHttpInterceptor` [#4469](https://github.com/getsentry/sentry-java/pull/4469)
+- Session Replay: Do not capture current replay for cached events from the past ([#4474](https://github.com/getsentry/sentry-java/pull/4474))
 - Session Replay: Correctly capture Dialogs and non full-sized windows ([#4354](https://github.com/getsentry/sentry-java/pull/4354))
 - Session Replay: Fix inconsistent `segment_id` ([#4471](https://github.com/getsentry/sentry-java/pull/4471))
 

sentry/src/main/java/io/sentry/SentryClient.java

@@ -3,7 +3,9 @@
 import io.sentry.clientreport.DiscardReason;
 import io.sentry.exception.SentryEnvelopeException;
 import io.sentry.hints.AbnormalExit;
+import io.sentry.hints.ApplyScopeData;
 import io.sentry.hints.Backfillable;
+import io.sentry.hints.Cached;
 import io.sentry.hints.DiskFlushNotification;
 import io.sentry.hints.TransactionEnd;
 import io.sentry.logger.ILoggerBatchProcessor;
@@ -210,9 +212,12 @@ private boolean shouldApplyScopeData(final @NotNull CheckIn event, final @NotNul
     }
 
     final boolean isBackfillable = HintUtils.hasType(hint, Backfillable.class);
-    // if event is backfillable we don't wanna trigger capture replay, because it's an event from
-    // the past
-    if (event != null && !isBackfillable && (event.isErrored() || event.isCrashed())) {
+    final boolean isCached =
+        HintUtils.hasType(hint, Cached.class) && !HintUtils.hasType(hint, ApplyScopeData.class);
+    // if event is backfillable or cached we don't wanna trigger capture replay, because it's
+    // an event from the past. If it's cached, but with ApplyScopeData, it comes from the outbox
+    // folder and we still want to capture replay (e.g. a native captureException error)
+    if (event != null && !isBackfillable && !isCached && (event.isErrored() || event.isCrashed())) {
       options.getReplayController().captureReplay(event.isCrashed());
     }
 

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

@@ -2991,6 +2991,52 @@ class SentryClientTest {
         assertFalse(called)
     }
 
+    @Test
+    fun `does not captureReplay for cached events`() {
+        var called = false
+        fixture.sentryOptions.setReplayController(object : ReplayController by NoOpReplayController.getInstance() {
+            override fun captureReplay(isTerminating: Boolean?) {
+                called = true
+            }
+        })
+        val sut = fixture.getSut()
+
+        sut.captureEvent(
+            SentryEvent().apply {
+                exceptions = listOf(
+                    SentryException().apply {
+                        mechanism = Mechanism().apply { isHandled = false }
+                    }
+                )
+            },
+            HintUtils.createWithTypeCheckHint(CachedHint())
+        )
+        assertFalse(called)
+    }
+
+    @Test
+    fun `captures replay for cached events with apply scope`() {
+        var called = false
+        fixture.sentryOptions.setReplayController(object : ReplayController by NoOpReplayController.getInstance() {
+            override fun captureReplay(isTerminating: Boolean?) {
+                called = true
+            }
+        })
+        val sut = fixture.getSut()
+
+        sut.captureEvent(
+            SentryEvent().apply {
+                exceptions = listOf(
+                    SentryException().apply {
+                        mechanism = Mechanism().apply { isHandled = false }
+                    }
+                )
+            },
+            HintUtils.createWithTypeCheckHint(CachedWithApplyScopeHint())
+        )
+        assertTrue(called)
+    }
+
     @Test
     fun `when beforeSendReplay is set, callback is invoked`() {
         var invoked = false
@@ -3502,6 +3548,10 @@ class SentryClientTest {
     private class BackfillableHint : Backfillable {
         override fun shouldEnrich(): Boolean = false
     }
+
+    private class CachedHint : Cached
+
+    private class CachedWithApplyScopeHint : Cached, ApplyScopeData
 }
 
 class DropEverythingEventProcessor : EventProcessor {