Make possible screenshots on hybrid sdks (react-native)

sentry-android-core/api/sentry-android-core.api

@@ -107,6 +107,8 @@ public final class io/sentry/android/core/PhoneStateBreadcrumbsIntegration : io/
 public final class io/sentry/android/core/ScreenshotEventProcessor : android/app/Application$ActivityLifecycleCallbacks, io/sentry/EventProcessor, java/io/Closeable {
 	public fun <init> (Landroid/app/Application;Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/android/core/BuildInfoProvider;)V
 	public fun close ()V
+	public static fun createInstance (Landroid/app/Application;Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/android/core/BuildInfoProvider;)Lio/sentry/android/core/ScreenshotEventProcessor;
+	public static fun getInstance ()Lio/sentry/android/core/ScreenshotEventProcessor;
 	public fun onActivityCreated (Landroid/app/Activity;Landroid/os/Bundle;)V
 	public fun onActivityDestroyed (Landroid/app/Activity;)V
 	public fun onActivityPaused (Landroid/app/Activity;)V
@@ -115,6 +117,8 @@ public final class io/sentry/android/core/ScreenshotEventProcessor : android/app
 	public fun onActivityStarted (Landroid/app/Activity;)V
 	public fun onActivityStopped (Landroid/app/Activity;)V
 	public fun process (Lio/sentry/SentryEvent;Lio/sentry/Hint;)Lio/sentry/SentryEvent;
+	public fun setCurrentActivity (Landroid/app/Activity;)V
+	public fun takeScreenshot ()[B
 }
 
 public final class io/sentry/android/core/SentryAndroid {

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

@@ -210,7 +210,8 @@ private static void installDefaultIntegrations(
         options.addIntegration(new FragmentLifecycleIntegration((Application) context, true, true));
       }
       options.addEventProcessor(
-          new ScreenshotEventProcessor((Application) context, options, buildInfoProvider));
+          ScreenshotEventProcessor.createInstance(
+              (Application) context, options, buildInfoProvider));
     } else {
       options
           .getLogger()

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

@@ -17,6 +17,7 @@
 import io.sentry.Hint;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
+import io.sentry.util.HintUtils;
 import io.sentry.util.Objects;
 import java.io.ByteArrayOutputStream;
 import java.io.Closeable;
@@ -33,6 +34,8 @@
 public final class ScreenshotEventProcessor
     implements EventProcessor, Application.ActivityLifecycleCallbacks, Closeable {
 
+  private static @NotNull ScreenshotEventProcessor instance;
+
   private final @NotNull Application application;
   private final @NotNull SentryAndroidOptions options;
   private @Nullable WeakReference<Activity> currentActivity;
@@ -51,10 +54,86 @@ public ScreenshotEventProcessor(
     application.registerActivityLifecycleCallbacks(this);
   }
 
+  public static ScreenshotEventProcessor createInstance(
+      final @NotNull Application application,
+      final @NotNull SentryAndroidOptions options,
+      final @NotNull BuildInfoProvider buildInfoProvider) {
+    ScreenshotEventProcessor.instance =
+        new ScreenshotEventProcessor(application, options, buildInfoProvider);
+    return ScreenshotEventProcessor.instance;
+  }
+
+  public static ScreenshotEventProcessor getInstance() {
+    return ScreenshotEventProcessor.instance;
+  }
+
+  public void setCurrentActivity(@NonNull Activity activity) {
+    if (currentActivity != null && currentActivity.get() == activity) {
+      return;
+    }
+    currentActivity = new WeakReference<>(activity);
+  }
+
+  public byte[] takeScreenshot() {
+    if (currentActivity == null) {
+      return null;
+    }
+
+    final Activity activity = currentActivity.get();
+    if (!isActivityValid(activity)
+        || activity.getWindow() == null
+        || activity.getWindow().getDecorView() == null
+        || activity.getWindow().getDecorView().getRootView() == null) {
+      this.options
+          .getLogger()
+          .log(SentryLevel.DEBUG, "Activity isn't valid, not taking screenshot.");
+      return null;
+    }
+
+    final View view = activity.getWindow().getDecorView().getRootView();
+    if (view.getWidth() <= 0 || view.getHeight() <= 0) {
+      this.options
+          .getLogger()
+          .log(SentryLevel.DEBUG, "View's width and height is zeroed, not taking screenshot.");
+      return null;
+    }
+
+    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);
+
+      final Canvas canvas = new Canvas(bitmap);
+      view.draw(canvas);
+
+      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);
+
+      if (byteArrayOutputStream.size() <= 0) {
+        this.options
+            .getLogger()
+            .log(SentryLevel.DEBUG, "Screenshot is 0 bytes, not attaching the image.");
+        return null;
+      }
+
+      // screenshot png is around ~100-150 kb
+      return byteArrayOutputStream.toByteArray();
+    } catch (Throwable e) {
+      this.options.getLogger().log(SentryLevel.ERROR, "Taking screenshot failed.", e);
+    }
+    return null;
+  }
+
   @SuppressWarnings("NullAway")
   @Override
   public @NotNull SentryEvent process(final @NotNull SentryEvent event, @NotNull Hint hint) {
-    if (!lifecycleCallbackInstalled) {
+    if (HintUtils.getIsFromHybridSdk(hint)
+        || !lifecycleCallbackInstalled
+        || !event.isErrored()
+        || currentActivity == null) {
       return event;
     }
     if (!options.isAttachScreenshot()) {
@@ -70,53 +149,13 @@ public ScreenshotEventProcessor(
       return event;
     }
 
-    if (event.isErrored() && currentActivity != null) {
-      final Activity activity = currentActivity.get();
-      if (isActivityValid(activity)
-          && activity.getWindow() != null
-          && activity.getWindow().getDecorView() != null
-          && activity.getWindow().getDecorView().getRootView() != null) {
-        final View view = activity.getWindow().getDecorView().getRootView();
-
-        if (view.getWidth() > 0 && view.getHeight() > 0) {
-          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);
-
-            final Canvas canvas = new Canvas(bitmap);
-            view.draw(canvas);
-
-            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);
-
-            if (byteArrayOutputStream.size() > 0) {
-              // screenshot png is around ~100-150 kb
-              hint.setScreenshot(Attachment.fromScreenshot(byteArrayOutputStream.toByteArray()));
-              hint.set(ANDROID_ACTIVITY, activity);
-            } else {
-              this.options
-                  .getLogger()
-                  .log(SentryLevel.DEBUG, "Screenshot is 0 bytes, not attaching the image.");
-            }
-          } catch (Throwable e) {
-            this.options.getLogger().log(SentryLevel.ERROR, "Taking screenshot failed.", e);
-          }
-        } else {
-          this.options
-              .getLogger()
-              .log(SentryLevel.DEBUG, "View's width and height is zeroed, not taking screenshot.");
-        }
-      } else {
-        this.options
-            .getLogger()
-            .log(SentryLevel.DEBUG, "Activity isn't valid, not taking screenshot.");
-      }
+    final byte[] screenshot = takeScreenshot();
+    if (screenshot == null) {
+      return event;
     }
 
+    hint.setScreenshot(Attachment.fromScreenshot(screenshot));
+    hint.set(ANDROID_ACTIVITY, currentActivity.get());
     return event;
   }
 
@@ -167,13 +206,6 @@ private void cleanCurrentActivity(@NonNull Activity activity) {
     }
   }
 
-  private void setCurrentActivity(@NonNull Activity activity) {
-    if (currentActivity != null && currentActivity.get() == activity) {
-      return;
-    }
-    currentActivity = new WeakReference<>(activity);
-  }
-
   @SuppressLint("NewApi")
   private boolean isActivityValid(@Nullable Activity activity) {
     if (activity == null) {

sentry/api/sentry.api

@@ -1897,6 +1897,9 @@ public final class io/sentry/TypeCheckHint {
 	public static final field OKHTTP_RESPONSE Ljava/lang/String;
 	public static final field OPEN_FEIGN_REQUEST Ljava/lang/String;
 	public static final field OPEN_FEIGN_RESPONSE Ljava/lang/String;
+	public static final field SENTRY_DART_SDK_NAME Ljava/lang/String;
+	public static final field SENTRY_IS_FROM_HYBRID_SDK Ljava/lang/String;
+	public static final field SENTRY_REACT_NATIVE_SDK_NAME Ljava/lang/String;
 	public static final field SENTRY_SYNTHETIC_EXCEPTION Ljava/lang/String;
 	public static final field SENTRY_TYPE_CHECK_HINT Ljava/lang/String;
 	public static final field SERVLET_REQUEST Ljava/lang/String;
@@ -3301,12 +3304,15 @@ public final class io/sentry/util/FileUtils {
 
 public final class io/sentry/util/HintUtils {
 	public static fun createWithTypeCheckHint (Ljava/lang/Object;)Lio/sentry/Hint;
+	public static fun getIsFromHybridSdk (Lio/sentry/Hint;)Z
 	public static fun getSentrySdkHint (Lio/sentry/Hint;)Ljava/lang/Object;
 	public static fun hasType (Lio/sentry/Hint;Ljava/lang/Class;)Z
 	public static fun runIfDoesNotHaveType (Lio/sentry/Hint;Ljava/lang/Class;Lio/sentry/util/HintUtils$SentryNullableConsumer;)V
 	public static fun runIfHasType (Lio/sentry/Hint;Ljava/lang/Class;Lio/sentry/util/HintUtils$SentryConsumer;)V
 	public static fun runIfHasType (Lio/sentry/Hint;Ljava/lang/Class;Lio/sentry/util/HintUtils$SentryConsumer;Lio/sentry/util/HintUtils$SentryHintFallback;)V
 	public static fun runIfHasTypeLogIfNot (Lio/sentry/Hint;Ljava/lang/Class;Lio/sentry/ILogger;Lio/sentry/util/HintUtils$SentryConsumer;)V
+	public static fun setIsFromHybridSdk (Lio/sentry/Hint;Ljava/lang/String;)V
+	public static fun setIsFromHybridSdk (Lio/sentry/Hint;Z)V
 	public static fun setTypeCheckHint (Lio/sentry/Hint;Ljava/lang/Object;)V
 	public static fun shouldApplyScopeData (Lio/sentry/Hint;)Z
 }

sentry/src/main/java/io/sentry/OutboxSender.java

@@ -133,6 +133,9 @@ private void processEnvelope(final @NotNull SentryEnvelope envelope, final @NotN
           if (event == null) {
             logEnvelopeItemNull(item, currentItem);
           } else {
+            if (event.getSdk() != null) {
+              HintUtils.setIsFromHybridSdk(hint, event.getSdk().getName());
+            }
             if (envelope.getHeader().getEventId() != null
                 && !envelope.getHeader().getEventId().equals(event.getEventId())) {
               logUnexpectedEventId(envelope, event.getEventId(), currentItem);

sentry/src/main/java/io/sentry/TypeCheckHint.java

@@ -7,6 +7,14 @@ public final class TypeCheckHint {
 
   @ApiStatus.Internal public static final String SENTRY_TYPE_CHECK_HINT = "sentry:typeCheckHint";
 
+  @ApiStatus.Internal
+  public static final String SENTRY_IS_FROM_HYBRID_SDK = "sentry:isFromHybridSdk";
+
+  @ApiStatus.Internal
+  public static final String SENTRY_REACT_NATIVE_SDK_NAME = "sentry.javascript.react-native";
+
+  @ApiStatus.Internal public static final String SENTRY_DART_SDK_NAME = "sentry.dart";
+
   /** Used for Synthetic exceptions. */
   public static final String SENTRY_SYNTHETIC_EXCEPTION = "syntheticException";
 

sentry/src/main/java/io/sentry/util/HintUtils.java

@@ -1,5 +1,8 @@
 package io.sentry.util;
 
+import static io.sentry.TypeCheckHint.SENTRY_DART_SDK_NAME;
+import static io.sentry.TypeCheckHint.SENTRY_IS_FROM_HYBRID_SDK;
+import static io.sentry.TypeCheckHint.SENTRY_REACT_NATIVE_SDK_NAME;
 import static io.sentry.TypeCheckHint.SENTRY_TYPE_CHECK_HINT;
 
 import io.sentry.Hint;
@@ -16,6 +19,24 @@ public final class HintUtils {
 
   private HintUtils() {}
 
+  @ApiStatus.Internal
+  public static void setIsFromHybridSdk(Hint hint, String sdkName) {
+    if (sdkName.startsWith(SENTRY_REACT_NATIVE_SDK_NAME)
+        || sdkName.startsWith(SENTRY_DART_SDK_NAME)) {
+      HintUtils.setIsFromHybridSdk(hint, true);
+    }
+  }
+
+  @ApiStatus.Internal
+  public static void setIsFromHybridSdk(Hint hint, boolean isFromHybridSdk) {
+    hint.set(SENTRY_IS_FROM_HYBRID_SDK, isFromHybridSdk);
+  }
+
+  @ApiStatus.Internal
+  public static boolean getIsFromHybridSdk(Hint hint) {
+    return Boolean.TRUE.equals(hint.getAs(SENTRY_IS_FROM_HYBRID_SDK, Boolean.class));
+  }
+
   @ApiStatus.Internal
   public static Hint createWithTypeCheckHint(Object typeCheckHint) {
     Hint hint = new Hint();