Merge branch 'main' into feat/continuous-profiling-stop-on-background

Author: stefanosiano

CHANGELOG.md

@@ -8,6 +8,10 @@
 - Continuous Profiling - Add delayed stop ([#4293](https://github.com/getsentry/sentry-java/pull/4293))
 - Continuous Profiling - Out of Experimental ([#4310](https://github.com/getsentry/sentry-java/pull/4310))
 
+### Fixes
+
+- Compress Screenshots on a background thread ([#4295](https://github.com/getsentry/sentry-java/pull/4295))
+
 ## 8.6.0
 
 ### Behavioral Changes

sentry-android-core/src/main/java/io/sentry/android/core/ScreenshotEventProcessor.java

@@ -1,17 +1,19 @@
 package io.sentry.android.core;
 
 import static io.sentry.TypeCheckHint.ANDROID_ACTIVITY;
-import static io.sentry.android.core.internal.util.ScreenshotUtils.takeScreenshot;
+import static io.sentry.android.core.internal.util.ScreenshotUtils.captureScreenshot;
 import static io.sentry.util.IntegrationUtils.addIntegrationToSdkVersion;
 
 import android.app.Activity;
+import android.graphics.Bitmap;
 import io.sentry.Attachment;
 import io.sentry.EventProcessor;
 import io.sentry.Hint;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
 import io.sentry.android.core.internal.util.AndroidCurrentDateProvider;
 import io.sentry.android.core.internal.util.Debouncer;
+import io.sentry.android.core.internal.util.ScreenshotUtils;
 import io.sentry.protocol.SentryTransaction;
 import io.sentry.util.HintUtils;
 import io.sentry.util.Objects;
@@ -87,14 +89,19 @@ public ScreenshotEventProcessor(
       return event;
     }
 
-    final byte[] screenshot =
-        takeScreenshot(
+    final Bitmap screenshot =
+        captureScreenshot(
             activity, options.getThreadChecker(), options.getLogger(), buildInfoProvider);
     if (screenshot == null) {
       return event;
     }
 
-    hint.setScreenshot(Attachment.fromScreenshot(screenshot));
+    hint.setScreenshot(
+        Attachment.fromByteProvider(
+            () -> ScreenshotUtils.compressBitmapToPng(screenshot, options.getLogger()),
+            "screenshot.png",
+            "image/png",
+            false));
     hint.set(ANDROID_ACTIVITY, activity);
     return event;
   }

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/ScreenshotUtils.java

@@ -27,19 +27,44 @@ public class ScreenshotUtils {
 
   private static final long CAPTURE_TIMEOUT_MS = 1000;
 
+  // Used by Hybrid SDKs
+  /**
+   * @noinspection unused
+   */
   public static @Nullable byte[] takeScreenshot(
       final @NotNull Activity activity,
       final @NotNull ILogger logger,
       final @NotNull BuildInfoProvider buildInfoProvider) {
     return takeScreenshot(activity, AndroidThreadChecker.getInstance(), logger, buildInfoProvider);
   }
 
+  // Used by Hybrid SDKs
   @SuppressLint("NewApi")
   public static @Nullable byte[] takeScreenshot(
       final @NotNull Activity activity,
       final @NotNull IThreadChecker threadChecker,
       final @NotNull ILogger logger,
       final @NotNull BuildInfoProvider buildInfoProvider) {
+
+    final @Nullable Bitmap screenshot =
+        captureScreenshot(activity, threadChecker, logger, buildInfoProvider);
+    return compressBitmapToPng(screenshot, logger);
+  }
+
+  public static @Nullable Bitmap captureScreenshot(
+      final @NotNull Activity activity,
+      final @NotNull ILogger logger,
+      final @NotNull BuildInfoProvider buildInfoProvider) {
+    return captureScreenshot(
+        activity, AndroidThreadChecker.getInstance(), logger, buildInfoProvider);
+  }
+
+  @SuppressLint("NewApi")
+  public static @Nullable Bitmap captureScreenshot(
+      final @NotNull Activity activity,
+      final @NotNull IThreadChecker threadChecker,
+      final @NotNull ILogger logger,
+      final @NotNull BuildInfoProvider buildInfoProvider) {
     // We are keeping BuildInfoProvider param for compatibility, as it's being used by
     // cross-platform SDKs
 
@@ -71,7 +96,7 @@ public class ScreenshotUtils {
       return null;
     }
 
-    try (final ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
+    try {
       // ARGB_8888 -> This configuration is very flexible and offers the best quality
       final Bitmap bitmap =
           Bitmap.createBitmap(view.getWidth(), view.getHeight(), Bitmap.Config.ARGB_8888);
@@ -132,10 +157,31 @@ public class ScreenshotUtils {
           return null;
         }
       }
+      return bitmap;
+    } catch (Throwable e) {
+      logger.log(SentryLevel.ERROR, "Taking screenshot failed.", e);
+    }
+    return null;
+  }
 
+  /**
+   * Compresses the supplied Bitmap to a PNG byte array. After compression, the Bitmap will be
+   * recycled.
+   *
+   * @param bitmap The bitmap to compress
+   * @param logger the logger
+   * @return the Bitmap in PNG format, or null if the bitmap was null, recycled or compressing faile
+   */
+  public static @Nullable byte[] compressBitmapToPng(
+      final @Nullable Bitmap bitmap, final @NotNull ILogger logger) {
+    if (bitmap == null || bitmap.isRecycled()) {
+      return null;
+    }
+    try (final ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
       // 0 meaning compress for small size, 100 meaning compress for max quality.
       // Some formats, like PNG which is lossless, will ignore the quality setting.
       bitmap.compress(Bitmap.CompressFormat.PNG, 0, byteArrayOutputStream);
+      bitmap.recycle();
 
       if (byteArrayOutputStream.size() <= 0) {
         logger.log(SentryLevel.DEBUG, "Screenshot is 0 bytes, not attaching the image.");
@@ -145,7 +191,7 @@ public class ScreenshotUtils {
       // screenshot png is around ~100-150 kb
       return byteArrayOutputStream.toByteArray();
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Taking screenshot failed.", e);
+      logger.log(SentryLevel.ERROR, "Compressing bitmap failed.", e);
     }
     return null;
   }

sentry-android-core/src/test/java/io/sentry/android/core/internal/util/ScreenshotUtilTest.kt

@@ -1,12 +1,14 @@
 package io.sentry.android.core.internal.util
 
 import android.app.Activity
+import android.graphics.Bitmap
 import android.os.Build
 import android.os.Bundle
 import android.view.View
 import android.view.Window
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.sentry.ILogger
+import io.sentry.NoOpLogger
 import io.sentry.android.core.BuildInfoProvider
 import junit.framework.TestCase.assertNull
 import org.junit.runner.RunWith
@@ -16,7 +18,9 @@ import org.robolectric.Robolectric.buildActivity
 import org.robolectric.annotation.Config
 import org.robolectric.shadows.ShadowPixelCopy
 import kotlin.test.Test
+import kotlin.test.assertFalse
 import kotlin.test.assertNotNull
+import kotlin.test.assertTrue
 
 @Config(
     shadows = [ShadowPixelCopy::class],
@@ -32,7 +36,7 @@ class ScreenshotUtilTest {
         whenever(activity.isDestroyed).thenReturn(false)
 
         val data =
-            ScreenshotUtils.takeScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
+            ScreenshotUtils.captureScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
         assertNull(data)
     }
 
@@ -44,7 +48,7 @@ class ScreenshotUtilTest {
         whenever(activity.window).thenReturn(mock<Window>())
 
         val data =
-            ScreenshotUtils.takeScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
+            ScreenshotUtils.captureScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
         assertNull(data)
     }
 
@@ -60,7 +64,7 @@ class ScreenshotUtilTest {
         whenever(window.peekDecorView()).thenReturn(decorView)
 
         val data =
-            ScreenshotUtils.takeScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
+            ScreenshotUtils.captureScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
         assertNull(data)
     }
 
@@ -81,7 +85,7 @@ class ScreenshotUtilTest {
         whenever(rootView.height).thenReturn(0)
 
         val data =
-            ScreenshotUtils.takeScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
+            ScreenshotUtils.captureScreenshot(activity, mock<ILogger>(), mock<BuildInfoProvider>())
         assertNull(data)
     }
 
@@ -94,7 +98,7 @@ class ScreenshotUtilTest {
         val buildInfoProvider = mock<BuildInfoProvider>()
         whenever(buildInfoProvider.sdkInfoVersion).thenReturn(Build.VERSION_CODES.O)
 
-        val data = ScreenshotUtils.takeScreenshot(controller.get(), logger, buildInfoProvider)
+        val data = ScreenshotUtils.captureScreenshot(controller.get(), logger, buildInfoProvider)
         assertNotNull(data)
     }
 
@@ -107,9 +111,40 @@ class ScreenshotUtilTest {
         val buildInfoProvider = mock<BuildInfoProvider>()
         whenever(buildInfoProvider.sdkInfoVersion).thenReturn(Build.VERSION_CODES.N)
 
-        val data = ScreenshotUtils.takeScreenshot(controller.get(), logger, buildInfoProvider)
+        val data = ScreenshotUtils.captureScreenshot(controller.get(), logger, buildInfoProvider)
         assertNotNull(data)
     }
+
+    @Test
+    fun `a null bitmap compresses into null`() {
+        val bytes = ScreenshotUtils.compressBitmapToPng(null, NoOpLogger.getInstance())
+        assertNull(bytes)
+    }
+
+    @Test
+    fun `a recycled bitmap compresses into null`() {
+        val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)
+        bitmap.recycle()
+
+        val bytes = ScreenshotUtils.compressBitmapToPng(bitmap, NoOpLogger.getInstance())
+        assertNull(bytes)
+    }
+
+    @Test
+    fun `a valid bitmap compresses into a valid bytearray`() {
+        val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)
+        val bytes = ScreenshotUtils.compressBitmapToPng(bitmap, NoOpLogger.getInstance())
+        assertNotNull(bytes)
+        assertTrue(bytes.isNotEmpty())
+    }
+
+    @Test
+    fun `compressBitmapToPng recycles the supplied bitmap`() {
+        val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)
+        assertFalse(bitmap.isRecycled)
+        ScreenshotUtils.compressBitmapToPng(bitmap, NoOpLogger.getInstance())
+        assertTrue(bitmap.isRecycled)
+    }
 }
 
 class ExampleActivity : Activity() {

sentry-android-integration-tests/sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/EnvelopeTests.kt

@@ -22,6 +22,7 @@ import io.sentry.protocol.SentryTransaction
 import org.junit.Assume
 import org.junit.Assume.assumeNotNull
 import org.junit.runner.RunWith
+import java.io.File
 import java.util.concurrent.TimeUnit
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -229,6 +230,36 @@ class EnvelopeTests : BaseUiTest() {
         Thread.sleep(5000)
     }
 
+    @Test
+    fun sendsNativeTransaction() {
+        var optionsRef: SentryAndroidOptions? = null
+        initSentry(true) { options ->
+            options.tracesSampleRate = 1.0
+            optionsRef = options
+        }
+
+        // based on https://github.com/getsentry/sentry-native/blob/20d5d5f75f1f48228f2f47e2bb99b17f9996ebbf/ndk/lib/src/androidTest/java/io/sentry/ndk/SentryNdkTest.java#L131
+        File(optionsRef!!.outboxPath, "14779dbf-b2f0-4c00-f4e5-4a287abc4267")
+            .writeText(
+                """
+            {"dsn":"https://key@sentry.io/proj","event_id":"729ff878-5539-458d-f657-a1acf423a127","sent_at":"2025-04-02T10:02:04.732577Z"}
+            {"type":"transaction","length":1335}
+            {"event_id":"729ff878-5539-458d-f657-a1acf423a127","platform":"native","transaction":"little.teapot","start_timestamp":"2025-04-02T10:02:04.731697Z","spans":[{"op":"littlest.teapot","span_id":"00028ba394454124","status":"ok","trace_id":"7160e289fe4c4496f02c72bbc7edb392","parent_span_id":"b0dc1649a8ec4101","description":null,"start_timestamp":"2025-04-02T10:02:04.732127Z","timestamp":"2025-04-02T10:02:04.732133Z"},{"op":"littler.teapot","span_id":"b0dc1649a8ec4101","status":"ok","trace_id":"7160e289fe4c4496f02c72bbc7edb392","parent_span_id":"7ad2e40529af4650","description":null,"start_timestamp":"2025-04-02T10:02:04.732118Z","data":{"span_data_says":"hi!"},"timestamp":"2025-04-02T10:02:04.732137Z"}],"type":"transaction","timestamp":"2025-04-02T10:02:04.732142Z","level":"info","contexts":{"trace":{"trace_id":"7160e289fe4c4496f02c72bbc7edb392","span_id":"7ad2e40529af4650","op":"Short and stout here is my handle and here is my spout","status":"ok","data":{"url":"https://example.com"}},"os":{"build":"android14-4-00257-g7e35917775b8-ab9964412","name":"Linux","version":"6.1.23"}},"release":"1.0.0","dist":"dist","environment":"production","sdk":{"name":"io.sentry.ndk","version":"0.8.3","packages":[{"name":"github:getsentry/sentry-native","version":"0.8.3"}],"integrations":["inproc"]},"tags":{},"extra":{},"breadcrumbs":[]}
+                """.trimIndent()
+            )
+
+        relayIdlingResource.increment()
+
+        relay.assert {
+            assertFirstEnvelope {
+                val event: SentryEvent = it.assertItem()
+                it.assertNoOtherItems()
+                assertEquals("little.teapot", event.transaction)
+            }
+            assertNoOtherEnvelopes()
+        }
+    }
+
     private fun swipeList(times: Int) {
         repeat(times) {
             Thread.sleep(100)

sentry/api/sentry.api

@@ -11,14 +11,17 @@ public final class io/sentry/Attachment {
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ZLjava/lang/String;)V
+	public fun <init> (Ljava/util/concurrent/Callable;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)V
 	public fun <init> ([BLjava/lang/String;)V
 	public fun <init> ([BLjava/lang/String;Ljava/lang/String;)V
 	public fun <init> ([BLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)V
 	public fun <init> ([BLjava/lang/String;Ljava/lang/String;Z)V
+	public static fun fromByteProvider (Ljava/util/concurrent/Callable;Ljava/lang/String;Ljava/lang/String;Z)Lio/sentry/Attachment;
 	public static fun fromScreenshot ([B)Lio/sentry/Attachment;
 	public static fun fromThreadDump ([B)Lio/sentry/Attachment;
 	public static fun fromViewHierarchy (Lio/sentry/protocol/ViewHierarchy;)Lio/sentry/Attachment;
 	public fun getAttachmentType ()Ljava/lang/String;
+	public fun getByteProvider ()Ljava/util/concurrent/Callable;
 	public fun getBytes ()[B
 	public fun getContentType ()Ljava/lang/String;
 	public fun getFilename ()Ljava/lang/String;