Skip to content

fix(replay): Dispatch session-deadline stop off the replay worker thread #5826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
runningcode wants to merge 4 commits into
base: main
Choose a base branch
from
+40 −1
Open

fix(replay): Dispatch session-deadline stop off the replay worker thread #5826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df5f050
fix(replay): Dispatch session-deadline stop off the replay worker thr…
runningcode Jul 23, 2026
c9c2631
changelog
runningcode Jul 23, 2026
aa8d54f
Merge branch 'main' into no/fix-replay-deadline-stop-anr
romtsn Jul 24, 2026
608c130
Update CHANGELOG.md
romtsn Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

### Fixes

- Fix background ANR when a session replay reaches its duration deadline: the resulting `stop()` (and its segment encoding) no longer runs on the replay worker thread while holding the replay lifecycle lock, which could block a foreground `start()` on the main thread ([#5826](https://github.com/getsentry/sentry-java/pull/5826))
- Release `MediaMuxer` when the replay video encoder fails to start to avoid a resource leak ([#5607](https://github.com/getsentry/sentry-java/pull/5607))

### Performance
Expand Down
8 changes: 7 additions & 1 deletion ...y-android-replay/src/main/java/io/sentry/android/replay/capture/SessionCaptureStrategy.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import io.sentry.android.replay.ReplayCache
import io.sentry.android.replay.ScreenshotRecorderConfig
import io.sentry.android.replay.capture.CaptureStrategy.ReplaySegment
import io.sentry.android.replay.util.ReplayRunnable
import io.sentry.android.replay.util.submitSafely
import io.sentry.protocol.SentryId
import io.sentry.transport.ICurrentDateProvider
import io.sentry.util.FileUtils
Expand Down Expand Up @@ -134,8 +135,13 @@ internal class SessionCaptureStrategy(
}

if ((now - replayStartTimestamp.get() >= options.sessionReplay.sessionDuration)) {
options.replayController.stop()
options.logger.log(INFO, "Session replay deadline exceeded (1h), stopping recording")
// dispatch off the replay worker thread, otherwise stop() would run the final segment
// encoding synchronously while holding the replay lifecycle lock, blocking a foreground
// start() on the main thread (ANR)
options.executorService.submitSafely(options, "$TAG.stop") {
options.replayController.stop()
}

@cursor cursor Bot Jul 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale deadline stop races new session

Low Severity

The deadline stop() is queued on options.executorService with no replay-id or generation check, and unlike the LifecycleWatcher end-session path it cannot be cancelled. If the current session is stopped and a new one starts before that task runs, the deferred stop() tears down the new session.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 608c130. Configure here.

}
}
)
Expand Down
32 changes: 32 additions & 0 deletions ...droid-replay/src/test/java/io/sentry/android/replay/capture/SessionCaptureStrategyTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import io.sentry.protocol.SentryId
import io.sentry.rrweb.RRWebBreadcrumbEvent
import io.sentry.rrweb.RRWebMetaEvent
import io.sentry.rrweb.RRWebOptionsEvent
import io.sentry.test.DeferredExecutorService
import io.sentry.test.ImmediateExecutorService
import io.sentry.transport.CurrentDateProvider
import io.sentry.transport.ICurrentDateProvider
import java.io.File
Expand Down Expand Up @@ -66,6 +68,7 @@ class SessionCaptureStrategyTest {
setReplayController(
mock { on { breadcrumbConverter }.thenReturn(DefaultReplayBreadcrumbConverter()) }
)
executorService = ImmediateExecutorService()
}
val scope = Scope(options)
val scopes =
Expand Down Expand Up @@ -291,6 +294,35 @@ class SessionCaptureStrategyTest {
verify(fixture.options.replayController).stop()
}

@Test
fun `onScreenshotRecorded dispatches deadline stop off the calling thread`() {
val deferredExecutor = DeferredExecutorService()
fixture.options.executorService = deferredExecutor
var count = 0
val strategy =
fixture.getSut(
dateProvider = {
if (count++ == 2) {
System.currentTimeMillis() + (fixture.options.sessionReplay.sessionDuration * 2)
} else {
System.currentTimeMillis()
}
}
)
strategy.start()
strategy.onConfigurationChanged(mock<ScreenshotRecorderConfig>())

strategy.onScreenshotRecorded(mock<Bitmap>()) {}

// stop must not run inline on the caller (replay worker) thread, otherwise it would encode the
// final segment while holding the lifecycle lock and block a foreground start() (ANR)
verify(fixture.options.replayController, never()).stop()

deferredExecutor.runAll()

verify(fixture.options.replayController).stop()
}

@Test
fun `onConfigurationChanged creates new segment and updates config`() {
val strategy = fixture.getSut()
Expand Down
Loading