Add Android View Hierarchy support

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Attach View Hierarchy to the errored/crashed events ([#2440](https://github.com/getsentry/sentry-java/pull/2440))
 - Collect memory usage in transactions ([#2445](https://github.com/getsentry/sentry-java/pull/2445))
 
 ### Fixes

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

@@ -94,6 +94,19 @@ public class io/sentry/android/core/CurrentActivityHolder {
 	public fun setActivity (Landroid/app/Activity;)V
 }
 
+public final class io/sentry/android/core/CurrentActivityIntegration : android/app/Application$ActivityLifecycleCallbacks, io/sentry/Integration, java/io/Closeable {
+	public fun <init> (Landroid/app/Application;)V
+	public fun close ()V
+	public fun onActivityCreated (Landroid/app/Activity;Landroid/os/Bundle;)V
+	public fun onActivityDestroyed (Landroid/app/Activity;)V
+	public fun onActivityPaused (Landroid/app/Activity;)V
+	public fun onActivityResumed (Landroid/app/Activity;)V
+	public fun onActivitySaveInstanceState (Landroid/app/Activity;Landroid/os/Bundle;)V
+	public fun onActivityStarted (Landroid/app/Activity;)V
+	public fun onActivityStopped (Landroid/app/Activity;)V
+	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
+}
+
 public abstract class io/sentry/android/core/EnvelopeFileObserverIntegration : io/sentry/Integration, java/io/Closeable {
 	public fun <init> ()V
 	public fun close ()V
@@ -126,16 +139,8 @@ public final class io/sentry/android/core/PhoneStateBreadcrumbsIntegration : io/
 	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
 }
 
-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 fun onActivityCreated (Landroid/app/Activity;Landroid/os/Bundle;)V
-	public fun onActivityDestroyed (Landroid/app/Activity;)V
-	public fun onActivityPaused (Landroid/app/Activity;)V
-	public fun onActivityResumed (Landroid/app/Activity;)V
-	public fun onActivitySaveInstanceState (Landroid/app/Activity;Landroid/os/Bundle;)V
-	public fun onActivityStarted (Landroid/app/Activity;)V
-	public fun onActivityStopped (Landroid/app/Activity;)V
+public final class io/sentry/android/core/ScreenshotEventProcessor : io/sentry/EventProcessor {
+	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/android/core/BuildInfoProvider;)V
 	public fun process (Lio/sentry/SentryEvent;Lio/sentry/Hint;)Lio/sentry/SentryEvent;
 }
 
@@ -157,6 +162,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun isAnrEnabled ()Z
 	public fun isAnrReportInDebug ()Z
 	public fun isAttachScreenshot ()Z
+	public fun isAttachViewHierarchy ()Z
 	public fun isCollectAdditionalContext ()Z
 	public fun isEnableActivityLifecycleBreadcrumbs ()Z
 	public fun isEnableActivityLifecycleTracingAutoFinish ()Z
@@ -169,6 +175,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun setAnrReportInDebug (Z)V
 	public fun setAnrTimeoutIntervalMillis (J)V
 	public fun setAttachScreenshot (Z)V
+	public fun setAttachViewHierarchy (Z)V
 	public fun setCollectAdditionalContext (Z)V
 	public fun setDebugImagesLoader (Lio/sentry/android/core/IDebugImagesLoader;)V
 	public fun setEnableActivityLifecycleBreadcrumbs (Z)V
@@ -240,6 +247,12 @@ public final class io/sentry/android/core/UserInteractionIntegration : android/a
 	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
 }
 
+public final class io/sentry/android/core/ViewHierarchyEventProcessor : io/sentry/EventProcessor {
+	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;)V
+	public fun process (Lio/sentry/SentryEvent;Lio/sentry/Hint;)Lio/sentry/SentryEvent;
+	public static fun snapshotViewHierarchy (Landroid/view/View;)Lio/sentry/protocol/ViewHierarchy;
+}
+
 public final class io/sentry/android/core/cache/AndroidEnvelopeCache : io/sentry/cache/EnvelopeCache {
 	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;)V
 	public fun getDirectory ()Ljava/io/File;

sentry-android-core/build.gradle.kts

@@ -110,6 +110,7 @@ dependencies {
     testImplementation(projects.sentryAndroidTimber)
     testImplementation(projects.sentryComposeHelper)
     testImplementation(projects.sentryAndroidNdk)
+    testRuntimeOnly(Config.Libs.composeUi)
     testRuntimeOnly(Config.Libs.timber)
     testRuntimeOnly(Config.Libs.fragment)
 }

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

@@ -134,7 +134,7 @@ static void initializeIntegrationsAndProcessors(
     options.addEventProcessor(
         new DefaultAndroidEventProcessor(context, buildInfoProvider, options));
     options.addEventProcessor(new PerformanceAndroidEventProcessor(options, activityFramesTracker));
-
+    options.addEventProcessor(new ViewHierarchyEventProcessor(options));
     options.setTransportGate(new AndroidTransportGate(context, options.getLogger()));
     final SentryFrameMetricsCollector frameMetricsCollector =
         new SentryFrameMetricsCollector(context, options, buildInfoProvider);
@@ -210,19 +210,20 @@ private static void installDefaultIntegrations(
       options.addIntegration(
           new ActivityLifecycleIntegration(
               (Application) context, buildInfoProvider, activityFramesTracker));
+      options.addIntegration(new CurrentActivityIntegration((Application) context));
       options.addIntegration(new UserInteractionIntegration((Application) context, loadClass));
       if (isFragmentAvailable) {
         options.addIntegration(new FragmentLifecycleIntegration((Application) context, true, true));
       }
-      options.addEventProcessor(
-          new ScreenshotEventProcessor((Application) context, options, buildInfoProvider));
+      options.addEventProcessor(new ScreenshotEventProcessor(options, buildInfoProvider));
     } else {
       options
           .getLogger()
           .log(
               SentryLevel.WARNING,
               "ActivityLifecycle, FragmentLifecycle and UserInteraction Integrations need an Application class to be installed.");
     }
+
     if (isTimberAvailable) {
       options.addIntegration(new SentryTimberIntegration());
     }

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

@@ -0,0 +1,80 @@
+package io.sentry.android.core;
+
+import android.app.Activity;
+import android.app.Application;
+import android.os.Bundle;
+import androidx.annotation.NonNull;
+import io.sentry.IHub;
+import io.sentry.Integration;
+import io.sentry.SentryOptions;
+import io.sentry.util.Objects;
+import java.io.Closeable;
+import java.io.IOException;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+@ApiStatus.Internal
+public final class CurrentActivityIntegration
+    implements Integration, Closeable, Application.ActivityLifecycleCallbacks {
+
+  private final @NotNull Application application;
+
+  public CurrentActivityIntegration(final @NotNull Application application) {
+    this.application = Objects.requireNonNull(application, "Application is required");
+  }
+
+  @Override
+  public void register(@NotNull IHub hub, @NotNull SentryOptions options) {
+    application.registerActivityLifecycleCallbacks(this);
+  }
+
+  @Override
+  public void onActivityCreated(@NonNull Activity activity, @Nullable Bundle savedInstanceState) {
+    setCurrentActivity(activity);
+  }
+
+  @Override
+  public void onActivityStarted(@NonNull Activity activity) {
+    setCurrentActivity(activity);
+  }
+
+  @Override
+  public void onActivityResumed(@NonNull Activity activity) {
+    setCurrentActivity(activity);
+  }
+
+  @Override
+  public void onActivityPaused(@NonNull Activity activity) {
+    cleanCurrentActivity(activity);
+  }
+
+  @Override
+  public void onActivityStopped(@NonNull Activity activity) {
+    cleanCurrentActivity(activity);
+  }
+
+  @Override
+  public void onActivitySaveInstanceState(@NonNull Activity activity, @NonNull Bundle outState) {}
+
+  @Override
+  public void onActivityDestroyed(@NonNull Activity activity) {
+    cleanCurrentActivity(activity);
+  }
+
+  @Override
+  public void close() throws IOException {
+    application.unregisterActivityLifecycleCallbacks(this);
+    CurrentActivityHolder.getInstance().clearActivity();
+  }
+
+  private void cleanCurrentActivity(final @NotNull Activity activity) {
+    if (CurrentActivityHolder.getInstance().getActivity() == activity) {
+      CurrentActivityHolder.getInstance().clearActivity();
+    }
+  }
+
+  private void setCurrentActivity(final @NotNull Activity activity) {
+    CurrentActivityHolder.getInstance().setActivity(activity);
+  }
+}

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

@@ -75,6 +75,7 @@ final class ManifestMetadataReader {
   static final String IDLE_TIMEOUT = "io.sentry.traces.idle-timeout";
 
   static final String ATTACH_SCREENSHOT = "io.sentry.attach-screenshot";
+  static final String ATTACH_VIEW_HIERARCHY = "io.sentry.attach-view-hierarchy";
   static final String CLIENT_REPORTS_ENABLE = "io.sentry.send-client-reports";
   static final String COLLECT_ADDITIONAL_CONTEXT = "io.sentry.additional-context";
 
@@ -220,6 +221,9 @@ static void applyMetadata(
         options.setAttachScreenshot(
             readBool(metadata, logger, ATTACH_SCREENSHOT, options.isAttachScreenshot()));
 
+        options.setAttachViewHierarchy(
+            readBool(metadata, logger, ATTACH_VIEW_HIERARCHY, options.isAttachViewHierarchy()));
+
         options.setSendClientReports(
             readBool(metadata, logger, CLIENT_REPORTS_ENABLE, options.isSendClientReports()));
 

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

@@ -4,66 +4,46 @@
 import static io.sentry.android.core.internal.util.ScreenshotUtils.takeScreenshot;
 
 import android.app.Activity;
-import android.app.Application;
-import android.os.Bundle;
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
 import io.sentry.Attachment;
 import io.sentry.EventProcessor;
 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.Closeable;
-import java.io.IOException;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * ScreenshotEventProcessor responsible for taking a screenshot of the screen when an error is
  * captured.
  */
 @ApiStatus.Internal
-public final class ScreenshotEventProcessor
-    implements EventProcessor, Application.ActivityLifecycleCallbacks, Closeable {
+public final class ScreenshotEventProcessor implements EventProcessor {
 
-  private final @NotNull Application application;
   private final @NotNull SentryAndroidOptions options;
   private final @NotNull BuildInfoProvider buildInfoProvider;
-  private boolean lifecycleCallbackInstalled = true;
 
   public ScreenshotEventProcessor(
-      final @NotNull Application application,
       final @NotNull SentryAndroidOptions options,
       final @NotNull BuildInfoProvider buildInfoProvider) {
-    this.application = Objects.requireNonNull(application, "Application is required");
     this.options = Objects.requireNonNull(options, "SentryAndroidOptions is required");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required");
-
-    application.registerActivityLifecycleCallbacks(this);
   }
 
-  @SuppressWarnings("NullAway")
   @Override
-  public @NotNull SentryEvent process(final @NotNull SentryEvent event, @NotNull Hint hint) {
-    if (!lifecycleCallbackInstalled || !event.isErrored()) {
+  public @NotNull SentryEvent process(final @NotNull SentryEvent event, final @NotNull Hint hint) {
+    if (!event.isErrored()) {
       return event;
     }
     if (!options.isAttachScreenshot()) {
-      application.unregisterActivityLifecycleCallbacks(this);
-      lifecycleCallbackInstalled = false;
-
-      this.options
-          .getLogger()
-          .log(
-              SentryLevel.DEBUG,
-              "attachScreenshot is disabled, ScreenshotEventProcessor isn't installed.");
+      this.options.getLogger().log(SentryLevel.DEBUG, "attachScreenshot is disabled.");
 
       return event;
     }
-    final Activity activity = CurrentActivityHolder.getInstance().getActivity();
+    final @Nullable Activity activity = CurrentActivityHolder.getInstance().getActivity();
     if (activity == null || HintUtils.isFromHybridSdk(hint)) {
       return event;
     }
@@ -77,55 +57,4 @@ public ScreenshotEventProcessor(
     hint.set(ANDROID_ACTIVITY, activity);
     return event;
   }
-
-  @Override
-  public void onActivityCreated(@NonNull Activity activity, @Nullable Bundle savedInstanceState) {
-    CurrentActivityHolder.getInstance().setActivity(activity);
-  }
-
-  @Override
-  public void onActivityStarted(@NonNull Activity activity) {
-    setCurrentActivity(activity);
-  }
-
-  @Override
-  public void onActivityResumed(@NonNull Activity activity) {
-    setCurrentActivity(activity);
-  }
-
-  @Override
-  public void onActivityPaused(@NonNull Activity activity) {
-    cleanCurrentActivity(activity);
-  }
-
-  @Override
-  public void onActivityStopped(@NonNull Activity activity) {
-    cleanCurrentActivity(activity);
-  }
-
-  @Override
-  public void onActivitySaveInstanceState(@NonNull Activity activity, @NonNull Bundle outState) {}
-
-  @Override
-  public void onActivityDestroyed(@NonNull Activity activity) {
-    cleanCurrentActivity(activity);
-  }
-
-  @Override
-  public void close() throws IOException {
-    if (options.isAttachScreenshot()) {
-      application.unregisterActivityLifecycleCallbacks(this);
-      CurrentActivityHolder.getInstance().clearActivity();
-    }
-  }
-
-  private void cleanCurrentActivity(@NonNull Activity activity) {
-    if (CurrentActivityHolder.getInstance().getActivity() == activity) {
-      CurrentActivityHolder.getInstance().clearActivity();
-    }
-  }
-
-  private void setCurrentActivity(@NonNull Activity activity) {
-    CurrentActivityHolder.getInstance().setActivity(activity);
-  }
 }

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

@@ -96,6 +96,9 @@ public final class SentryAndroidOptions extends SentryOptions {
   /** Enables or disables the attach screenshot feature when an error happened. */
   private boolean attachScreenshot;
 
+  /** Enables or disables the attach view hierarchy feature when an error happened. */
+  private boolean attachViewHierarchy;
+
   /**
    * Enables or disables collecting of device information which requires Inter-Process Communication
    * (IPC)
@@ -329,6 +332,14 @@ public void setAttachScreenshot(boolean attachScreenshot) {
     this.attachScreenshot = attachScreenshot;
   }
 
+  public boolean isAttachViewHierarchy() {
+    return attachViewHierarchy;
+  }
+
+  public void setAttachViewHierarchy(boolean attachViewHierarchy) {
+    this.attachViewHierarchy = attachViewHierarchy;
+  }
+
   public boolean isCollectAdditionalContext() {
     return collectAdditionalContext;
   }