Add debug images to ANR events

The images are parsed from the build ids and filenames in the thread
dump's stack frames.

Author: Lauri Alanko

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

@@ -23,6 +23,8 @@
 import io.sentry.hints.AbnormalExit;
 import io.sentry.hints.Backfillable;
 import io.sentry.hints.BlockingFlushHint;
+import io.sentry.protocol.DebugImage;
+import io.sentry.protocol.DebugMeta;
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentryThread;
@@ -40,6 +42,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
@@ -267,6 +270,11 @@ private void reportAsSentryEvent(
         event.setMessage(sentryMessage);
       } else if (result.type == ParseResult.Type.DUMP) {
         event.setThreads(result.threads);
+        if (!result.debugImages.isEmpty()) {
+          final DebugMeta debugMeta = new DebugMeta();
+          debugMeta.setImages(new ArrayList<>(result.debugImages.values()));
+          event.setDebugMeta(debugMeta);
+        }
       }
       event.setLevel(SentryLevel.FATAL);
       event.setTimestamp(DateUtils.getDateTime(anrTimestamp));
@@ -319,7 +327,7 @@ private void reportAsSentryEvent(
           // fall back to not reporting them
           return new ParseResult(ParseResult.Type.NO_DUMP);
         }
-        return new ParseResult(ParseResult.Type.DUMP, dump, threads);
+        return new ParseResult(ParseResult.Type.DUMP, dump, threads, threadDumpParser.getDebugImages());
       } catch (Throwable e) {
         options.getLogger().log(SentryLevel.WARNING, "Failed to parse ANR thread dump", e);
         return new ParseResult(ParseResult.Type.ERROR, dump);
@@ -403,24 +411,36 @@ enum Type {
     final Type type;
     final byte[] dump;
     final @Nullable List<SentryThread> threads;
+    final @Nullable Map<String, DebugImage> debugImages;
 
     ParseResult(final @NotNull Type type) {
       this.type = type;
       this.dump = null;
       this.threads = null;
+      this.debugImages = null;
     }
 
     ParseResult(final @NotNull Type type, final byte[] dump) {
       this.type = type;
       this.dump = dump;
       this.threads = null;
+      this.debugImages = null;
     }
 
     ParseResult(
         final @NotNull Type type, final byte[] dump, final @Nullable List<SentryThread> threads) {
       this.type = type;
       this.dump = dump;
       this.threads = threads;
+      this.debugImages = null;
+    }
+
+    ParseResult(
+        final @NotNull Type type, final byte[] dump, final @Nullable List<SentryThread> threads, final @Nullable Map<String, DebugImage> debugImages) {
+      this.type = type;
+      this.dump = dump;
+      this.threads = threads;
+      this.debugImages = debugImages;
     }
   }
 }

sentry-android-core/src/main/java/io/sentry/android/core/internal/threaddump/ThreadDumpParser.java

@@ -22,12 +22,19 @@
 import io.sentry.SentryLockReason;
 import io.sentry.SentryOptions;
 import io.sentry.SentryStackTraceFactory;
+import io.sentry.protocol.DebugImage;
 import io.sentry.protocol.SentryStackFrame;
 import io.sentry.protocol.SentryStackTrace;
 import io.sentry.protocol.SentryThread;
+import java.math.BigInteger;
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+import java.nio.BufferUnderflowException;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.regex.Matcher;
@@ -91,10 +98,36 @@ public class ThreadDumpParser {
 
   private final @NotNull SentryStackTraceFactory stackTraceFactory;
 
+  private final @NotNull Map<String, DebugImage> debugImages;
+
   public ThreadDumpParser(final @NotNull SentryOptions options, final boolean isBackground) {
     this.options = options;
     this.isBackground = isBackground;
     this.stackTraceFactory = new SentryStackTraceFactory(options);
+    this.debugImages = new HashMap<String, DebugImage>();
+  }
+
+  @NotNull
+  public Map<String, DebugImage> getDebugImages() {
+    return debugImages;
+  }
+
+  @Nullable
+  private static String buildIdToDebugId(String buildId) {
+    try {
+      // Abuse BigInteger as a hex string parser. Extra byte needed to handle leading zeros.
+      final ByteBuffer buf = ByteBuffer.wrap(new BigInteger("10" + buildId, 16).toByteArray());
+      buf.get();
+      return String.format("%08x-%04x-%04x-%04x-%04x%08x",
+                           buf.order(ByteOrder.LITTLE_ENDIAN).getInt(),
+                           buf.getShort(),
+                           buf.getShort(),
+                           buf.order(ByteOrder.BIG_ENDIAN).getShort(),
+                           buf.getShort(),
+                           buf.getInt());
+    } catch (NumberFormatException | BufferUnderflowException e) {
+      return null;
+    }
   }
 
   @NotNull
@@ -217,6 +250,19 @@ private SentryStackTrace parseStacktrace(
         frame.setInstructionAddr("0x" + nativeRe.group("pc"));
         frame.setPlatform("native");
 
+        final String buildId = nativeRe.group("buildid");
+        final String debugId = buildId == null ? null : buildIdToDebugId(buildId);
+        if (debugId != null) {
+          if (!debugImages.containsKey(debugId)) {
+            final DebugImage debugImage = new DebugImage();
+            debugImage.setDebugId(debugId);
+            debugImage.setType("elf");
+            debugImage.setCodeFile(nativeRe.group("filename"));
+            debugImage.setCodeId(buildId);
+            debugImages.put(debugId, debugImage);
+          }
+        }
+
         frames.add(frame);
         lastJavaFrame = null;
       } else if (matches(javaRe, text)) {

sentry-android-core/src/test/java/io/sentry/android/core/AnrV2IntegrationTest.kt

@@ -307,6 +307,12 @@ class AnrV2IntegrationTest {
                 assertEquals(64, firstFrame.lineno)
 		assertEquals("0x00000000000530b8", firstFrame.instructionAddr)
 		assertEquals("native", firstFrame.platform)
+
+		val image = it.debugMeta?.images?.find {
+		    it.debugId == "741f3301-bbb0-b92c-58bd-c15282b8ec7b"
+		}
+		assertNotNull(image)
+		assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
             },
             argThat<Hint> {
                 val hint = HintUtils.getSentrySdkHint(this)

sentry-android-core/src/test/java/io/sentry/android/core/internal/threaddump/ThreadDumpParserTest.kt

@@ -146,6 +146,13 @@ class ThreadDumpParserTest {
 	assertEquals("kotlinx.coroutines.DispatchedTask.run", deletedFrame.function)
 	assertEquals(1816, deletedFrame.lineno)
 	assertEquals("0x00000000020b89d8", deletedFrame.instructionAddr)
+
+	val debugImages = parser.debugImages
+	val image = debugImages["499d48ba-c085-17cf-3209-da67405662f9"]
+	assertNotNull(image)
+	assertEquals("499d48ba-c085-17cf-3209-da67405662f9", image.debugId)
+	assertEquals("/apex/com.android.runtime/lib64/bionic/libc.so", image.codeFile)
+	assertEquals("ba489d4985c0cf173209da67405662f9", image.codeId)
     }
 
     @Test