feat(replay): make screenshot optimizations opt-in #761
+308
−29
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| 'posthog-android': minor | ||
| --- | ||
|
|
||
| Add an experimental `sessionReplayConfig.optimizeScreenshots` option to reduce screenshot overhead with a reusable bitmap at half the width and height. It defaults to `false`, preserving full-resolution ARGB_8888 capture. When enabled, RGB_565 reduces image detail and removes alpha, making transparent window regions appear black; captures are skipped while a timed-out PixelCopy still owns the reusable bitmap. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1501,23 +1501,27 @@ public class PostHogReplayIntegration( | |
| scaleY: Float, | ||
| ) { | ||
| set( | ||
| floor(rect.left * scaleX), | ||
| floor(rect.top * scaleY), | ||
| ceil(rect.right * scaleX), | ||
| ceil(rect.bottom * scaleY), | ||
| ) | ||
| } | ||
|
|
||
| private fun Bitmap.paintScreenshotMasks( | ||
| rects: List<Rect>, | ||
| sourceWidth: Int, | ||
| sourceHeight: Int, | ||
| scaleMasks: Boolean, | ||
| canPaintMask: () -> Boolean = { true }, | ||
| ): Boolean { | ||
| if (!isValid()) { | ||
| this@PostHogReplayIntegration.config.logger.log("Session Replay Bitmap is invalid.") | ||
| return false | ||
| } | ||
| if (sourceWidth <= 0 || sourceHeight <= 0) { | ||
| return false | ||
| } | ||
|
|
||
| val canvas = | ||
| try { | ||
|
|
@@ -1527,14 +1531,18 @@ public class PostHogReplayIntegration( | |
| return false | ||
| } | ||
|
|
||
| val scaleX = if (scaleMasks) width.toFloat() / sourceWidth else 1f | ||
| val scaleY = if (scaleMasks) height.toFloat() / sourceHeight else 1f | ||
| val maskRect = RectF() | ||
| for (rect in rects) { | ||
| if (!canPaintMask()) { | ||
| return false | ||
| } | ||
| if (scaleMasks) { | ||
| maskRect.setScaledScreenshotMask(rect, scaleX, scaleY) | ||
| } else { | ||
| maskRect.set(rect) | ||
| } | ||
| canvas.drawRoundRect(maskRect, 10f * scaleX, 10f * scaleY, paint) | ||
| } | ||
| return true | ||
|
|
@@ -1544,6 +1552,7 @@ public class PostHogReplayIntegration( | |
| bitmap: Bitmap, | ||
| drawState: WindowDrawState, | ||
| armedCapture: ArmedMaskCapture, | ||
| optimizeScreenshots: Boolean, | ||
| ): Boolean { | ||
| val postWalk = MaskWalk() | ||
| // A layout pass or an invalidating draw sample already sealed the verdict as discard, | ||
|
|
@@ -1564,12 +1573,13 @@ public class PostHogReplayIntegration( | |
| config.logger.log("Session Replay screenshot discarded due to screen changes.") | ||
| return false | ||
| } | ||
| return bitmap.paintScreenshotMasks(postWalk.rects, width, height, optimizeScreenshots) | ||
| } | ||
|
|
||
| private fun View.maskLegacyScreenshot( | ||
| bitmap: Bitmap, | ||
| drawState: WindowDrawState, | ||
| optimizeScreenshots: Boolean, | ||
| ): Boolean { | ||
| val unsafeRedraw = { drawState.isOnDrawnCalled && !drawState.isOnlyAnimationRedraw } | ||
| if (unsafeRedraw()) { | ||
|
|
@@ -1584,7 +1594,7 @@ public class PostHogReplayIntegration( | |
| return false | ||
| } | ||
|
|
||
| return bitmap.paintScreenshotMasks(walk.rects, width, height, optimizeScreenshots) { | ||
| val safe = !unsafeRedraw() | ||
| if (!safe) { | ||
| config.logger.log("Session Replay screenshot discarded due to screen changes.") | ||
|
|
@@ -1682,28 +1692,43 @@ public class PostHogReplayIntegration( | |
| return null | ||
| } | ||
|
|
||
| val optimizeScreenshots = config.sessionReplayConfig.optimizeScreenshots | ||
| val bitmap: Bitmap | ||
| val bitmapLease: PixelCopyBitmapBuffer.Lease? | ||
| val handler: Handler | ||
| try { | ||
| handler = ensurePixelCopyHandler() | ||
| if (optimizeScreenshots) { | ||
| bitmapLease = | ||
| pixelCopyBitmapBuffer.acquire( | ||
| downscaledScreenshotDimension(view.width), | ||
| downscaledScreenshotDimension(view.height), | ||
| ) ?: run { | ||
| finishScreenshotCapture(drawState, armedCapture, verifyMaskAlignment) | ||
| config.logger.log("Session Replay screenshot skipped because the previous PixelCopy is still in progress.") | ||
| recordScreenshotDiscarded(drawState) | ||
| return null | ||
| } | ||
| bitmap = bitmapLease.bitmap | ||
| } else { | ||
| bitmapLease = null | ||
| bitmap = Bitmap.createBitmap(view.width, view.height, Bitmap.Config.ARGB_8888) | ||
|
Contributor
There was a problem hiding this comment.
If a default-mode PixelCopy times out, its fresh full-resolution bitmap is left for the callback to recycle. If Knowledge Base Used: Android session replay Prompt To Fix With AIThis is a comment left during a code review.
Path: posthog-android/src/main/java/com/posthog/android/replay/PostHogReplayIntegration.kt
Line: 1715
Comment:
**Pending bitmaps can leak**
If a default-mode PixelCopy times out, its fresh full-resolution bitmap is left for the callback to recycle. If `uninstall()` quits the callback thread before that callback is delivered, the bitmap is not recycled and is not tracked by `pixelCopyBitmapBuffer.close()`. Multiple delayed captures can therefore retain large ARGB_8888 bitmaps without deterministic cleanup. Please retain ownership of pending default-mode bitmaps so uninstall can release them explicitly.
**Knowledge Base Used:** [Android session replay](https://app.greptile.com/posthog-org-19734/-/custom-context/knowledge-base/posthog/posthog-android/-/docs/android-session-replay.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly. |
||
| } | ||
| } catch (e: Throwable) { | ||
| finishScreenshotCapture(drawState, armedCapture, verifyMaskAlignment) | ||
| config.logger.log("Session Replay screenshot setup failed: $e.") | ||
| recordScreenshotDiscarded(drawState) | ||
| return null | ||
| } | ||
|
|
||
| fun releaseBitmap() { | ||
| if (bitmapLease != null) { | ||
| bitmapLease.release() | ||
| } else { | ||
| bitmap.recycle() | ||
| } | ||
| } | ||
|
|
||
| val latch = CountDownLatch(1) | ||
| val requestState = PixelCopyRequestState() | ||
|
|
||
|
|
@@ -1728,9 +1753,9 @@ public class PostHogReplayIntegration( | |
| } else if (!requestState.isAbandoned()) { | ||
| succeeded = | ||
| if (armedCapture != null) { | ||
| view.maskVerifiedScreenshot(bitmap, drawState, armedCapture, optimizeScreenshots) | ||
| } else { | ||
| view.maskLegacyScreenshot(bitmap, drawState, optimizeScreenshots) | ||
| } | ||
| } | ||
| } catch (e: Throwable) { | ||
|
|
@@ -1739,7 +1764,7 @@ public class PostHogReplayIntegration( | |
| val releaseInCallback = requestState.complete(succeeded) | ||
| try { | ||
| if (releaseInCallback) { | ||
| releaseBitmap() | ||
| } | ||
| } finally { | ||
| latch.countDown() | ||
|
|
@@ -1751,7 +1776,7 @@ public class PostHogReplayIntegration( | |
| } catch (e: Throwable) { | ||
| config.logger.log("Session Replay PixelCopy failed: $e.") | ||
| if (requestState.complete(false)) { | ||
| releaseBitmap() | ||
| } | ||
| latch.countDown() | ||
| } | ||
|
|
@@ -1792,7 +1817,7 @@ public class PostHogReplayIntegration( | |
| } finally { | ||
| finishScreenshotCapture(drawState, armedCapture, verifyMaskAlignment) | ||
| if (releaseFromWaiter) { | ||
| releaseBitmap() | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Low: Unbounded bitmap retention after PixelCopy timeouts
When optimizations are disabled, every capture allocates a new full-resolution bitmap. A timed-out request retains that bitmap until its callback arrives, but unlike the lease-backed path, it does not prevent subsequent captures from allocating more; repeated UI redraws during stalled callbacks can therefore exhaust the host app's memory. Keep full-resolution ARGB_8888 capture while applying equivalent single-request backpressure or another explicit bound to outstanding bitmaps.