Merge f2ea2f0 into 4670d89

runningcode · web-flow · commit 23ac7bcbd20b · 2026-07-23T10:33:01.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -201,6 +201,7 @@
 - Use `System.nanoTime()` for cron check-in duration measurement to avoid incorrect durations from wall-clock adjustments ([#5611](https://github.com/getsentry/sentry-java/pull/5611))
 - Fix crash when `getHistoricalProcessStartReasons` is called from an isolated or wrong-userId process ([#5597](https://github.com/getsentry/sentry-java/pull/5597))
 - Release `MediaMuxer` when a replay segment has no encodable frames to avoid a resource leak ([#5583](https://github.com/getsentry/sentry-java/pull/5583))
+- Release `MediaMuxer` when the replay video encoder fails to start to avoid a resource leak ([#5607](https://github.com/getsentry/sentry-java/pull/5607))
 
 ### Dependencies
 
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt
@@ -162,7 +162,16 @@ public class ReplayCache(private val options: SentryOptions, private val replayI
               bitRate = bitRate,
             ),
           )
-          .also { it.start() }
+          .apply {
+            // the constructor already opened the MediaMuxer, so release it if start() fails,
+            // otherwise the encoder is never assigned and its resources leak (CloseGuard warning)
+            try {
+              start()
+            } catch (t: Throwable) {
+              release()
+              throw t
+            }
+          }
       }
 
     val step = 1000 / frameRate.toLong()
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/video/SimpleMp4FrameMuxer.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/video/SimpleMp4FrameMuxer.kt
@@ -67,9 +67,9 @@ internal class SimpleMp4FrameMuxer(path: String, fps: Float) : SimpleFrameMuxer
   }
 
   override fun release() {
-    // stop() throws if the muxer was never started (e.g. no frame was ever muxed), so we guard it
-    // to ensure release() is always reached and the underlying resources are freed
-    if (started) {
+    // stop() throws unless the muxer was started AND at least one sample was written, so we guard it
+    // to ensure muxer.release() is always reached and the underlying resources are freed
+    if (started && videoFrames > 0) {
       muxer.stop()
     }
     muxer.release()
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/video/SimpleVideoEncoder.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/video/SimpleVideoEncoder.kt
@@ -287,12 +287,14 @@ internal class SimpleVideoEncoder(
       onClose?.invoke()
       drainCodec(true)
       mediaCodec.stop()
+    } catch (e: RuntimeException) {
+      options.logger.log(DEBUG, "Failed to properly release video encoder", e)
+    } finally {
+      // always release the native resources, even if draining/stopping the codec above threw (e.g.
+      // when the encoder failed to fully start), otherwise they leak (CloseGuard warning)
       mediaCodec.release()
       surface?.release()
-
       frameMuxer.release()
-    } catch (e: Throwable) {
-      options.logger.log(DEBUG, "Failed to properly release video encoder", e)
     }
   }
 }
diff --git a/sentry-android-replay/src/test/java/io/sentry/android/replay/ReplayCacheTest.kt b/sentry-android-replay/src/test/java/io/sentry/android/replay/ReplayCacheTest.kt
@@ -28,6 +28,7 @@ import java.util.concurrent.atomic.AtomicReference
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
@@ -36,6 +37,7 @@ import org.junit.rules.TemporaryFolder
 import org.junit.runner.RunWith
 import org.robolectric.annotation.Config
 import org.robolectric.shadows.ShadowBitmapFactory
+import org.robolectric.shadows.ShadowCloseGuard
 
 @RunWith(AndroidJUnit4::class)
 @Config(sdk = [26], shadows = [ReplayShadowMediaCodec::class])
@@ -56,6 +58,7 @@ class ReplayCacheTest {
   @BeforeTest
   fun `set up`() {
     ReplayShadowMediaCodec.framesToEncode = 5
+    ReplayShadowMediaCodec.throwOnStart = false
     ShadowBitmapFactory.setAllowInvalidImageData(true)
   }
 
@@ -93,6 +96,26 @@ class ReplayCacheTest {
     assertNull(video)
   }
 
+  @Test
+  fun `releases the muxer when the encoder fails to start`() {
+    ReplayShadowMediaCodec.throwOnStart = true
+    val replayCache = fixture.getSut(tmpDir)
+
+    val bitmap = Bitmap.createBitmap(1, 1, ARGB_8888)
+    replayCache.addFrame(bitmap, 1)
+
+    ShadowCloseGuard.reset()
+    assertFailsWith<IllegalStateException> {
+      replayCache.createVideoOf(5000L, 0, 0, 100, 200, 1, 20_000)
+    }
+
+    val muxerLeaks =
+      ShadowCloseGuard.getErrors().filter { error ->
+        error.stackTrace.any { it.className.contains("MediaMuxer") }
+      }
+    assertTrue(muxerLeaks.isEmpty(), "MediaMuxer was not released: $muxerLeaks")
+  }
+
   @Test
   fun `deletes frames after creating a video`() {
     ReplayShadowMediaCodec.framesToEncode = 3
diff --git a/sentry-android-replay/src/test/java/io/sentry/android/replay/util/ReplayShadowMediaCodec.kt b/sentry-android-replay/src/test/java/io/sentry/android/replay/util/ReplayShadowMediaCodec.kt
@@ -15,12 +15,16 @@ class ReplayShadowMediaCodec : ShadowMediaCodec() {
   companion object {
     var frameRate = 1
     var framesToEncode = 5
+    var throwOnStart = false
   }
 
   private val encoded = AtomicBoolean(false)
 
   @Implementation
   fun start() {
+    if (throwOnStart) {
+      throw IllegalStateException("Simulated codec start failure")
+    }
     super.native_start()
   }
 

Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,9 @@ internal class SimpleMp4FrameMuxer(path: String, fps: Float) : SimpleFrameMuxer`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`override fun release() {`
`70`		`- // stop() throws if the muxer was never started (e.g. no frame was ever muxed), so we guard it`
`71`		`- // to ensure release() is always reached and the underlying resources are freed`
`72`		`- if (started) {`
	`70`	`+ // stop() throws unless the muxer was started AND at least one sample was written, so we guard it`
	`71`	`+ // to ensure muxer.release() is always reached and the underlying resources are freed`
	`72`	`+ if (started && videoFrames > 0) {`
`73`	`73`	`muxer.stop()`
`74`	`74`	`}`
`75`	`75`	`muxer.release()`
Original file line number	Diff line number	Diff line change
`@@ -287,12 +287,14 @@ internal class SimpleVideoEncoder(`
`287`	`287`	`onClose?.invoke()`
`288`	`288`	`drainCodec(true)`
`289`	`289`	`mediaCodec.stop()`
	`290`	`+ } catch (e: RuntimeException) {`
	`291`	`+ options.logger.log(DEBUG, "Failed to properly release video encoder", e)`
	`292`	`+ } finally {`
	`293`	`+ // always release the native resources, even if draining/stopping the codec above threw (e.g.`
	`294`	`+ // when the encoder failed to fully start), otherwise they leak (CloseGuard warning)`
`290`	`295`	`mediaCodec.release()`
`291`	`296`	`surface?.release()`
`292`		`-`
`293`	`297`	`frameMuxer.release()`
`294`		`- } catch (e: Throwable) {`
`295`		`- options.logger.log(DEBUG, "Failed to properly release video encoder", e)`
`296`	`298`	`}`
`297`	`299`	`}`
`298`	`300`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,16 @@ class ReplayShadowMediaCodec : ShadowMediaCodec() {`
`15`	`15`	`companion object {`
`16`	`16`	`var frameRate = 1`
`17`	`17`	`var framesToEncode = 5`
	`18`	`+ var throwOnStart = false`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`private val encoded = AtomicBoolean(false)`
`21`	`22`
`22`	`23`	`@Implementation`
`23`	`24`	`fun start() {`
	`25`	`+ if (throwOnStart) {`
	`26`	`+ throw IllegalStateException("Simulated codec start failure")`
	`27`	`+ }`
`24`	`28`	`super.native_start()`
`25`	`29`	`}`
`26`	`30`