fix(replay): Copy bitmap before passing to ReplaySnapshotObserver (JAVA-504)

runningcode · claude · runningcode · commit 4a829fe19875 · 2026-05-13T13:24:36.000+02:00
Consumers of the observer API receive a copy of the bitmap instead of
the replay system's shared instance. This eliminates race conditions
and crashes when consumers store or use the bitmap asynchronously.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/sentry-android-integration-tests/sentry-uitest-android/src/androidTestReplay/java/io/sentry/uitest/android/ReplaySnapshotTest.kt b/sentry-android-integration-tests/sentry-uitest-android/src/androidTestReplay/java/io/sentry/uitest/android/ReplaySnapshotTest.kt
@@ -52,6 +52,7 @@ class ReplaySnapshotTest : BaseUiTest() {
         val file = File(snapshotsDir, "${name}_$frameTimestamp.png")
         file.outputStream().use { out -> bitmap.compress(Bitmap.CompressFormat.PNG, 100, out) }
       }
+      bitmap.recycle()
       frameReceived.countDown()
     }
 
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayIntegration.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayIntegration.kt
@@ -313,10 +313,14 @@ public class ReplayIntegration(
     captureStrategy?.onScreenshotRecorded(bitmap) { frameTimeStamp ->
       val observer = snapshotObserver
       if (observer != null) {
-        try {
-          observer.onSnapshotCaptured(bitmap, frameTimeStamp, screen)
-        } catch (e: Throwable) {
-          options.logger.log(ERROR, "Error in ReplaySnapshotObserver", e)
+        val copy = bitmap.copy(bitmap.config!!, false)
+        if (copy != null) {
+          try {
+            observer.onSnapshotCaptured(copy, frameTimeStamp, screen)
+          } catch (e: Throwable) {
+            options.logger.log(ERROR, "Error in ReplaySnapshotObserver", e)
+            copy.recycle()
+          }
         }
       }
       addFrame(bitmap, frameTimeStamp, screen)
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/SessionReplayOptions.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/SessionReplayOptions.kt
@@ -36,9 +36,8 @@ public var SentryReplayOptions.maskAllImages: Boolean
  * Observer that is notified when a replay snapshot is captured. The snapshot bitmap has masking
  * already applied.
  *
- * **Bitmap lifecycle:** The bitmap is owned by the replay system and may be reused. Do not store a
- * reference to it or access it after this method returns — copy the pixel data (e.g., compress to a
- * file) within this method if you need it later. Do not recycle the bitmap.
+ * **Bitmap lifecycle:** The bitmap is a copy owned by the caller. You may store it or use it on
+ * another thread. Call [Bitmap.recycle] when you no longer need it to free native memory promptly.
  *
  * The callback runs on a background thread (the replay executor).
  */
diff --git a/sentry-android-replay/src/test/java/io/sentry/android/replay/ReplayIntegrationTest.kt b/sentry-android-replay/src/test/java/io/sentry/android/replay/ReplayIntegrationTest.kt
@@ -63,6 +63,7 @@ import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.argThat
 import org.mockito.kotlin.check
 import org.mockito.kotlin.doAnswer
+import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
@@ -1000,12 +1001,18 @@ class ReplayIntegrationTest {
       receivedBitmap = bitmap
     }
 
-    replay.onScreenshotRecorded(mock<Bitmap>())
+    val copyBitmap = mock<Bitmap>()
+    val sourceBitmap =
+      mock<Bitmap> {
+        on { config } doReturn ARGB_8888
+        on { copy(any(), any()) } doReturn copyBitmap
+      }
+    replay.onScreenshotRecorded(sourceBitmap)
 
     assertTrue(callbackInvoked)
     assertEquals(1720693523997, receivedTimestamp)
     assertEquals("MainActivity", receivedScreen)
-    assertTrue(receivedBitmap is Bitmap)
+    assertEquals(copyBitmap, receivedBitmap)
   }
 
   @Test
@@ -1028,7 +1035,12 @@ class ReplayIntegrationTest {
 
     replay.snapshotObserver = ReplaySnapshotObserver { _, _, _ -> throw RuntimeException("test") }
 
-    replay.onScreenshotRecorded(mock<Bitmap>())
+    val sourceBitmap =
+      mock<Bitmap> {
+        on { config } doReturn ARGB_8888
+        on { copy(any(), any()) } doReturn mock<Bitmap>()
+      }
+    replay.onScreenshotRecorded(sourceBitmap)
 
     verify(fixture.replayCache).addFrame(any<Bitmap>(), any(), anyOrNull())
   }

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ class ReplaySnapshotTest : BaseUiTest() {`
`52`	`52`	`val file = File(snapshotsDir, "${name}_$frameTimestamp.png")`
`53`	`53`	`file.outputStream().use { out -> bitmap.compress(Bitmap.CompressFormat.PNG, 100, out) }`
`54`	`54`	`}`
	`55`	`+ bitmap.recycle()`
`55`	`56`	`frameReceived.countDown()`
`56`	`57`	`}`
`57`	`58`
Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,8 @@ public var SentryReplayOptions.maskAllImages: Boolean`
`36`	`36`	`* Observer that is notified when a replay snapshot is captured. The snapshot bitmap has masking`
`37`	`37`	`* already applied.`
`38`	`38`	`*`
`39`		`- * Bitmap lifecycle: The bitmap is owned by the replay system and may be reused. Do not store a`
`40`		`- * reference to it or access it after this method returns — copy the pixel data (e.g., compress to a`
`41`		`- * file) within this method if you need it later. Do not recycle the bitmap.`
	`39`	`+ * Bitmap lifecycle: The bitmap is a copy owned by the caller. You may store it or use it on`
	`40`	`+ * another thread. Call [Bitmap.recycle] when you no longer need it to free native memory promptly.`
`42`	`41`	`*`
`43`	`42`	`* The callback runs on a background thread (the replay executor).`
`44`	`43`	`*/`