Add Android View Hierarchy support

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

@@ -4,7 +4,6 @@
 import android.view.View;
 import android.view.ViewGroup;
 import android.view.Window;
-import androidx.annotation.NonNull;
 import io.sentry.Attachment;
 import io.sentry.EventProcessor;
 import io.sentry.Hint;
@@ -14,10 +13,6 @@
 import io.sentry.protocol.ViewHierarchy;
 import io.sentry.protocol.ViewHierarchyNode;
 import io.sentry.util.Objects;
-import java.io.BufferedWriter;
-import java.io.ByteArrayOutputStream;
-import java.io.OutputStreamWriter;
-import java.io.Writer;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.List;
@@ -62,39 +57,20 @@ public ViewHierarchyEventProcessor(final @NotNull SentryAndroidOptions options)
     }
 
     final @Nullable View decorView = window.peekDecorView();
-    options.getLogger().log(SentryLevel.INFO, "Missing decor view for view hierarchy snapshot.");
     if (decorView == null) {
+      options.getLogger().log(SentryLevel.INFO, "Missing decor view for view hierarchy snapshot.");
       return event;
     }
 
     try {
       final @NotNull ViewHierarchy viewHierarchy = snapshotViewHierarchy(decorView);
-      attachViewHierarchy(viewHierarchy, hint);
+      hint.setViewHierarchy(Attachment.fromViewHierarchy(viewHierarchy));
     } catch (Throwable t) {
       options.getLogger().log(SentryLevel.ERROR, "Failed to process view hierarchy.", t);
     }
     return event;
   }
 
-  private void attachViewHierarchy(@NonNull ViewHierarchy viewHierarchy, @NonNull Hint hint) {
-    hint.setViewHierarchy(
-        Attachment.fromViewHierarchy(
-            () -> {
-              try {
-                try (final ByteArrayOutputStream stream = new ByteArrayOutputStream();
-                    final Writer writer =
-                        new BufferedWriter(new OutputStreamWriter(stream, UTF_8))) {
-
-                  options.getSerializer().serialize(viewHierarchy, writer);
-                  return stream.toByteArray();
-                }
-              } catch (Throwable t) {
-                options.getLogger().log(SentryLevel.ERROR, "Could not serialize ViewHierarchy", t);
-                throw t;
-              }
-            }));
-  }
-
   @NotNull
   public static ViewHierarchy snapshotViewHierarchy(@NotNull final View view) {
     final List<ViewHierarchyNode> windows = new ArrayList<>(1);

sentry/api/sentry.api

@@ -4,25 +4,25 @@ public final class io/sentry/AsyncHttpTransportFactory : io/sentry/ITransportFac
 }
 
 public final class io/sentry/Attachment {
+	public fun <init> (Lio/sentry/JsonSerializable;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)V
 	public fun <init> (Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 	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 fromScreenshot ([B)Lio/sentry/Attachment;
-	public static fun fromViewHierarchy (Ljava/util/concurrent/Callable;)Lio/sentry/Attachment;
+	public static fun fromViewHierarchy (Lio/sentry/protocol/ViewHierarchy;)Lio/sentry/Attachment;
 	public fun getAttachmentType ()Ljava/lang/String;
 	public fun getBytes ()[B
-	public fun getBytesFactory ()Ljava/util/concurrent/Callable;
 	public fun getContentType ()Ljava/lang/String;
 	public fun getFilename ()Ljava/lang/String;
 	public fun getPathname ()Ljava/lang/String;
+	public fun getSerializable ()Lio/sentry/JsonSerializable;
 }
 
 public final class io/sentry/Baggage {
@@ -1278,7 +1278,7 @@ public final class io/sentry/SentryEnvelopeHeader$JsonKeys {
 }
 
 public final class io/sentry/SentryEnvelopeItem {
-	public static fun fromAttachment (Lio/sentry/Attachment;J)Lio/sentry/SentryEnvelopeItem;
+	public static fun fromAttachment (Lio/sentry/ISerializer;Lio/sentry/ILogger;Lio/sentry/Attachment;J)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromClientReport (Lio/sentry/ISerializer;Lio/sentry/clientreport/ClientReport;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromEvent (Lio/sentry/ISerializer;Lio/sentry/SentryBaseEvent;)Lio/sentry/SentryEnvelopeItem;
 	public static fun fromProfilingTrace (Lio/sentry/ProfilingTraceData;JLio/sentry/ISerializer;)Lio/sentry/SentryEnvelopeItem;

sentry/src/main/java/io/sentry/Attachment.java

@@ -1,15 +1,15 @@
 package io.sentry;
 
+import io.sentry.protocol.ViewHierarchy;
 import java.io.File;
-import java.util.concurrent.Callable;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /** You can use an attachment to store additional files alongside an event or transaction. */
 public final class Attachment {
 
   private @Nullable byte[] bytes;
-  private final @Nullable Callable<byte[]> bytesFactory;
+  private final @Nullable JsonSerializable serializable;
   private @Nullable String pathname;
   private final @NotNull String filename;
   private final @Nullable String contentType;
@@ -83,7 +83,7 @@ public Attachment(
       final @Nullable String attachmentType,
       final boolean addToTransactions) {
     this.bytes = bytes;
-    this.bytesFactory = null;
+    this.serializable = null;
     this.filename = filename;
     this.contentType = contentType;
     this.attachmentType = attachmentType;
@@ -94,21 +94,21 @@ public Attachment(
    * Initializes an Attachment with bytes factory, a filename, a content type, and
    * addToTransactions.
    *
-   * @param bytesFactory The bytes factory providing the data when being called
+   * @param serializable A json serializable holding the attachment payload
    * @param filename The name of the attachment to display in Sentry.
    * @param contentType The content type of the attachment.
    * @param attachmentType the attachment type.
    * @param addToTransactions <code>true</code> if the SDK should add this attachment to every
    *     {@link ITransaction} or set to <code>false</code> if it shouldn't.
    */
   public Attachment(
-      final @NotNull Callable<byte[]> bytesFactory,
+      final @NotNull JsonSerializable serializable,
       final @NotNull String filename,
       final @Nullable String contentType,
       final @Nullable String attachmentType,
       final boolean addToTransactions) {
     this.bytes = null;
-    this.bytesFactory = bytesFactory;
+    this.serializable = serializable;
     this.filename = filename;
     this.contentType = contentType;
     this.attachmentType = attachmentType;
@@ -185,7 +185,7 @@ public Attachment(
       final boolean addToTransactions) {
     this.pathname = pathname;
     this.filename = filename;
-    this.bytesFactory = null;
+    this.serializable = null;
     this.contentType = contentType;
     this.attachmentType = attachmentType;
     this.addToTransactions = addToTransactions;
@@ -211,7 +211,7 @@ public Attachment(
       final boolean addToTransactions) {
     this.pathname = pathname;
     this.filename = filename;
-    this.bytesFactory = null;
+    this.serializable = null;
     this.contentType = contentType;
     this.addToTransactions = addToTransactions;
   }
@@ -239,7 +239,7 @@ public Attachment(
       final @Nullable String attachmentType) {
     this.pathname = pathname;
     this.filename = filename;
-    this.bytesFactory = null;
+    this.serializable = null;
     this.contentType = contentType;
     this.addToTransactions = addToTransactions;
     this.attachmentType = attachmentType;
@@ -259,8 +259,8 @@ public Attachment(
    *
    * @return the bytes factory responsible for providing the bytes.
    */
-  public @Nullable Callable<byte[]> getBytesFactory() {
-    return bytesFactory;
+  public @Nullable JsonSerializable getSerializable() {
+    return serializable;
   }
 
   /**
@@ -323,12 +323,12 @@ boolean isAddToTransactions() {
   /**
    * Creates a new View Hierarchy Attachment
    *
-   * @param bytesFactory the serialized View Hierarchy
+   * @param viewHierarchy the View Hierarchy
    * @return the Attachment
    */
-  public static @NotNull Attachment fromViewHierarchy(final Callable<byte[]> bytesFactory) {
+  public static @NotNull Attachment fromViewHierarchy(final ViewHierarchy viewHierarchy) {
     return new Attachment(
-        bytesFactory,
+        viewHierarchy,
         "view-hierarchy.json",
         "application/json",
         VIEW_HIERARCHY_ATTACHMENT_TYPE,

sentry/src/main/java/io/sentry/SentryClient.java

@@ -278,7 +278,11 @@ private boolean shouldSendSessionUpdateForDroppedEvent(
     if (attachments != null) {
       for (final Attachment attachment : attachments) {
         final SentryEnvelopeItem attachmentItem =
-            SentryEnvelopeItem.fromAttachment(attachment, options.getMaxAttachmentSize());
+            SentryEnvelopeItem.fromAttachment(
+                options.getSerializer(),
+                options.getLogger(),
+                attachment,
+                options.getMaxAttachmentSize());
         envelopeItems.add(attachmentItem);
       }
     }

sentry/src/main/java/io/sentry/SentryEnvelopeItem.java

@@ -165,7 +165,10 @@ public static SentryEnvelopeItem fromUserFeedback(
   }
 
   public static SentryEnvelopeItem fromAttachment(
-      final @NotNull Attachment attachment, final long maxAttachmentSize) {
+      final @NotNull ISerializer serializer,
+      final @NotNull ILogger logger,
+      final @NotNull Attachment attachment,
+      final long maxAttachmentSize) {
 
     final CachedItem cachedItem =
         new CachedItem(
@@ -174,10 +177,24 @@ public static SentryEnvelopeItem fromAttachment(
                 final byte[] data = attachment.getBytes();
                 ensureAttachmentSizeLimit(data.length, maxAttachmentSize, attachment.getFilename());
                 return data;
-              } else if (attachment.getBytesFactory() != null) {
-                final byte[] data = attachment.getBytesFactory().call();
-                ensureAttachmentSizeLimit(data.length, maxAttachmentSize, attachment.getFilename());
-                return data;
+              } else if (attachment.getSerializable() != null) {
+                final JsonSerializable serializable = attachment.getSerializable();
+                try {
+                  try (final ByteArrayOutputStream stream = new ByteArrayOutputStream();
+                      final Writer writer =
+                          new BufferedWriter(new OutputStreamWriter(stream, UTF_8))) {
+
+                    serializer.serialize(serializable, writer);
+
+                    final byte[] data = stream.toByteArray();
+                    ensureAttachmentSizeLimit(
+                        data.length, maxAttachmentSize, attachment.getFilename());
+                    return data;
+                  }
+                } catch (Throwable t) {
+                  logger.log(SentryLevel.ERROR, "Could not serialize attachment serializable", t);
+                  throw t;
+                }
               } else if (attachment.getPathname() != null) {
                 return readBytesFromFile(attachment.getPathname(), maxAttachmentSize);
               }

sentry/src/test/java/io/sentry/AttachmentTest.kt

@@ -1,5 +1,6 @@
 package io.sentry
 
+import io.sentry.protocol.ViewHierarchy
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
@@ -115,14 +116,14 @@ class AttachmentTest {
 
     @Test
     fun `creates attachment from view hierarchy`() {
-        val bytes = byteArrayOf(1, 2, 3)
-        val attachment = Attachment.fromViewHierarchy { bytes }
+        val hierarchy = ViewHierarchy("android", emptyList())
+        val attachment = Attachment.fromViewHierarchy(hierarchy)
 
         assertEquals("view-hierarchy.json", attachment.filename)
         assertEquals("application/json", attachment.contentType)
         assertEquals(false, attachment.isAddToTransactions)
         assertEquals("event.view_hierarchy", attachment.attachmentType)
         assertNull(attachment.bytes)
-        assertEquals(bytes, attachment.bytesFactory!!.call())
+        assertEquals(hierarchy, attachment.serializable)
     }
 }

sentry/src/test/java/io/sentry/JsonSerializerTest.kt

@@ -45,14 +45,15 @@ class JsonSerializerTest {
         val serializer: ISerializer
         val hub = mock<IHub>()
         val traceFile = Files.createTempFile("test", "here").toFile()
+        val options = SentryOptions()
 
         init {
-            val options = SentryOptions()
             options.dsn = "https://key@sentry.io/proj"
             options.setLogger(logger)
-            options.setDebug(true)
+            options.isDebug = true
             whenever(hub.options).thenReturn(options)
             serializer = JsonSerializer(options)
+            options.setSerializer(serializer)
             options.setEnvelopeReader(EnvelopeReader(serializer))
         }
     }
@@ -946,9 +947,9 @@ class JsonSerializerTest {
 
         val message = "hello"
         val attachment = Attachment(message.toByteArray(), "bytes.txt")
-        val validAttachmentItem = SentryEnvelopeItem.fromAttachment(attachment, 5)
+        val validAttachmentItem = SentryEnvelopeItem.fromAttachment(fixture.serializer, fixture.options.logger, attachment, 5)
 
-        val invalidAttachmentItem = SentryEnvelopeItem.fromAttachment(Attachment("no"), 5)
+        val invalidAttachmentItem = SentryEnvelopeItem.fromAttachment(fixture.serializer, fixture.options.logger, Attachment("no"), 5)
         val envelope = SentryEnvelope(header, listOf(invalidAttachmentItem, validAttachmentItem))
 
         val actualJson = serializeToString(envelope)

sentry/src/test/java/io/sentry/SentryClientTest.kt

@@ -15,6 +15,7 @@ import io.sentry.protocol.SentryException
 import io.sentry.protocol.SentryId
 import io.sentry.protocol.SentryTransaction
 import io.sentry.protocol.User
+import io.sentry.protocol.ViewHierarchy
 import io.sentry.test.callMethod
 import io.sentry.transport.ITransport
 import io.sentry.transport.ITransportGate
@@ -1423,7 +1424,7 @@ class SentryClientTest {
     @Test
     fun `view hierarchy is added to the envelope from the hint`() {
         val sut = fixture.getSut()
-        val attachment = Attachment.fromViewHierarchy { byteArrayOf() }
+        val attachment = Attachment.fromViewHierarchy(ViewHierarchy("android_view_system", emptyList()))
         val hint = Hint().also { it.viewHierarchy = attachment }
 
         sut.captureEvent(SentryEvent(), hint)
@@ -1443,7 +1444,7 @@ class SentryClientTest {
     fun `view hierarchy is dropped from hint via before send`() {
         fixture.sentryOptions.beforeSend = CustomBeforeSendCallback()
         val sut = fixture.getSut()
-        val attachment = Attachment.fromViewHierarchy { byteArrayOf() }
+        val attachment = Attachment.fromViewHierarchy(ViewHierarchy("android_view_system", emptyList()))
         val hint = Hint().also { it.viewHierarchy = attachment }
 
         sut.captureEvent(SentryEvent(), hint)