New ANRv2 implementation based on ApplicationExitInfo (#2697)

Author: romtsn

CHANGELOG.md

@@ -2,9 +2,18 @@
 
 ## Unreleased
 
-## Features
+### Features
 
 - Add Screenshot and ViewHierarchy to integrations list ([#2698](https://github.com/getsentry/sentry-java/pull/2698))
+- New ANR detection based on [ApplicationExitInfo API](https://developer.android.com/reference/android/app/ApplicationExitInfo) ([#2697](https://github.com/getsentry/sentry-java/pull/2697))
+    - This implementation completely replaces the old one (based on a watchdog) on devices running Android 11 and above:
+      - New implementation provides more precise ANR events/ANR rate detection as well as system thread dump information. The new implementation reports ANRs exactly as Google Play Console, without producing false positives or missing important background ANR events.
+      - However, despite producing many false positives, the old implementation is capable of better enriching ANR errors (which is not available with the new implementation), for example:
+        - Capturing screenshots at the time of ANR event;
+        - Capturing transactions and profiling data corresponding to the ANR event;
+        - Auxiliary information (such as current memory load) at the time of ANR event.
+      - If you would like us to provide support for the old approach working alongside the new one on Android 11 and above (e.g. for raising events for slow code on main thread), consider upvoting [this issue](https://github.com/getsentry/sentry-java/issues/2693).
+    - The old watchdog implementation will continue working for older API versions (Android < 11)
 
 ### Fixes
 

sentry-android-core/.gitignore

@@ -1,3 +1,5 @@
 INSTALLATION
 last_crash
+.options-cache/
+.scope-cache/
 /sentry

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

@@ -55,6 +55,29 @@ public final class io/sentry/android/core/AnrIntegration : io/sentry/Integration
 	public final fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
 }
 
+public final class io/sentry/android/core/AnrIntegrationFactory {
+	public fun <init> ()V
+	public static fun create (Landroid/content/Context;Lio/sentry/android/core/BuildInfoProvider;)Lio/sentry/Integration;
+}
+
+public final class io/sentry/android/core/AnrV2EventProcessor : io/sentry/BackfillingEventProcessor {
+	public fun <init> (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/android/core/BuildInfoProvider;)V
+	public fun process (Lio/sentry/SentryEvent;Lio/sentry/Hint;)Lio/sentry/SentryEvent;
+}
+
+public class io/sentry/android/core/AnrV2Integration : io/sentry/Integration, java/io/Closeable {
+	public fun <init> (Landroid/content/Context;)V
+	public fun close ()V
+	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
+}
+
+public final class io/sentry/android/core/AnrV2Integration$AnrV2Hint : io/sentry/hints/BlockingFlushHint, io/sentry/hints/AbnormalExit, io/sentry/hints/Backfillable {
+	public fun <init> (JLio/sentry/ILogger;JZZ)V
+	public fun mechanism ()Ljava/lang/String;
+	public fun shouldEnrich ()Z
+	public fun timestamp ()Ljava/lang/Long;
+}
+
 public final class io/sentry/android/core/AppComponentsBreadcrumbsIntegration : android/content/ComponentCallbacks2, io/sentry/Integration, java/io/Closeable {
 	public fun <init> (Landroid/content/Context;)V
 	public fun close ()V
@@ -297,9 +320,11 @@ public final class io/sentry/android/core/ViewHierarchyEventProcessor : io/sentr
 }
 
 public final class io/sentry/android/core/cache/AndroidEnvelopeCache : io/sentry/cache/EnvelopeCache {
+	public static final field LAST_ANR_REPORT Ljava/lang/String;
 	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;)V
 	public fun getDirectory ()Ljava/io/File;
 	public static fun hasStartupCrashMarker (Lio/sentry/SentryOptions;)Z
+	public static fun lastReportedAnr (Lio/sentry/SentryOptions;)Ljava/lang/Long;
 	public fun store (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)V
 }
 

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

@@ -19,6 +19,8 @@
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.android.fragment.FragmentLifecycleIntegration;
 import io.sentry.android.timber.SentryTimberIntegration;
+import io.sentry.cache.PersistingOptionsObserver;
+import io.sentry.cache.PersistingScopeObserver;
 import io.sentry.compose.gestures.ComposeGestureTargetLocator;
 import io.sentry.internal.gestures.GestureTargetLocator;
 import io.sentry.transport.NoOpEnvelopeCache;
@@ -139,6 +141,7 @@ static void initializeIntegrationsAndProcessors(
     options.addEventProcessor(new PerformanceAndroidEventProcessor(options, activityFramesTracker));
     options.addEventProcessor(new ScreenshotEventProcessor(options, buildInfoProvider));
     options.addEventProcessor(new ViewHierarchyEventProcessor(options));
+    options.addEventProcessor(new AnrV2EventProcessor(context, options, buildInfoProvider));
     options.setTransportGate(new AndroidTransportGate(context, options.getLogger()));
     final SentryFrameMetricsCollector frameMetricsCollector =
         new SentryFrameMetricsCollector(context, options, buildInfoProvider);
@@ -170,6 +173,11 @@ static void initializeIntegrationsAndProcessors(
       options.addCollector(new AndroidCpuCollector(options.getLogger(), buildInfoProvider));
     }
     options.setTransactionPerformanceCollector(new DefaultTransactionPerformanceCollector(options));
+
+    if (options.getCacheDirPath() != null) {
+      options.addScopeObserver(new PersistingScopeObserver(options));
+      options.addOptionsObserver(new PersistingOptionsObserver(options));
+    }
   }
 
   private static void installDefaultIntegrations(
@@ -213,7 +221,7 @@ private static void installDefaultIntegrations(
     // AppLifecycleIntegration has to be installed before AnrIntegration, because AnrIntegration
     // relies on AppState set by it
     options.addIntegration(new AppLifecycleIntegration());
-    options.addIntegration(new AnrIntegration(context));
+    options.addIntegration(AnrIntegrationFactory.create(context, buildInfoProvider));
 
     // registerActivityLifecycleCallbacks is only available if Context is an AppContext
     if (context instanceof Application) {

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

@@ -10,6 +10,7 @@
 import io.sentry.SentryOptions;
 import io.sentry.exception.ExceptionMechanismException;
 import io.sentry.hints.AbnormalExit;
+import io.sentry.hints.TransactionEnd;
 import io.sentry.protocol.Mechanism;
 import io.sentry.util.HintUtils;
 import io.sentry.util.Objects;
@@ -141,7 +142,7 @@ public void close() throws IOException {
    * href="https://develop.sentry.dev/sdk/sessions/#crashed-abnormal-vs-errored">Develop Docs</a>
    * because we don't know whether the app has recovered after it or not.
    */
-  static final class AnrHint implements AbnormalExit {
+  static final class AnrHint implements AbnormalExit, TransactionEnd {
 
     private final boolean isBackgroundAnr;
 

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

@@ -0,0 +1,21 @@
+package io.sentry.android.core;
+
+import android.content.Context;
+import android.os.Build;
+import io.sentry.Integration;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+@ApiStatus.Internal
+public final class AnrIntegrationFactory {
+
+  @NotNull
+  public static Integration create(
+      final @NotNull Context context, final @NotNull BuildInfoProvider buildInfoProvider) {
+    if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.R) {
+      return new AnrV2Integration(context);
+    } else {
+      return new AnrIntegration(context);
+    }
+  }
+}