Add lock attribute to the frame protocol

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add `lock` attribute to the `SentryStackFrame` protocol to better highlight offending frames in the UI ([#2761](https://github.com/getsentry/sentry-java/pull/2761))
+
 ## 6.21.0
 
 ### Features

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

@@ -155,7 +155,7 @@ private SentryThread parseThread(final @NotNull Lines lines) {
   private SentryStackTrace parseStacktrace(
       final @NotNull Lines lines, final @NotNull SentryThread thread) {
     final List<SentryStackFrame> frames = new ArrayList<>();
-    boolean isLastFrameJava = false;
+    SentryStackFrame lastJavaFrame = null;
 
     final Matcher nativeRe = NATIVE_RE.matcher("");
     final Matcher nativeNoLocRe = NATIVE_NO_LOC_RE.matcher("");
@@ -182,13 +182,13 @@ private SentryStackTrace parseStacktrace(
         frame.setSymbol(nativeRe.group(2));
         frame.setLineno(getInteger(nativeRe, 3, null));
         frames.add(frame);
-        isLastFrameJava = false;
+        lastJavaFrame = null;
       } else if (matches(nativeNoLocRe, text)) {
         final SentryStackFrame frame = new SentryStackFrame();
         frame.setPackage(nativeNoLocRe.group(1));
         frame.setSymbol(nativeNoLocRe.group(2));
         frames.add(frame);
-        isLastFrameJava = false;
+        lastJavaFrame = null;
       } else if (matches(javaRe, text)) {
         final SentryStackFrame frame = new SentryStackFrame();
         final String packageName = javaRe.group(1);
@@ -200,7 +200,7 @@ private SentryStackTrace parseStacktrace(
         frame.setLineno(getUInteger(javaRe, 5, null));
         frame.setInApp(stackTraceFactory.isInApp(module));
         frames.add(frame);
-        isLastFrameJava = true;
+        lastJavaFrame = frame;
       } else if (matches(jniRe, text)) {
         final SentryStackFrame frame = new SentryStackFrame();
         final String packageName = jniRe.group(1);
@@ -210,57 +210,63 @@ private SentryStackTrace parseStacktrace(
         frame.setFunction(jniRe.group(3));
         frame.setInApp(stackTraceFactory.isInApp(module));
         frames.add(frame);
-        isLastFrameJava = true;
+        lastJavaFrame = frame;
       } else if (matches(lockedRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.LOCKED);
           lock.setAddress(lockedRe.group(1));
           lock.setPackageName(lockedRe.group(2));
           lock.setClassName(lockedRe.group(3));
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (matches(waitingOnRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.WAITING);
           lock.setAddress(waitingOnRe.group(1));
           lock.setPackageName(waitingOnRe.group(2));
           lock.setClassName(waitingOnRe.group(3));
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (matches(sleepingOnRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.SLEEPING);
           lock.setAddress(sleepingOnRe.group(1));
           lock.setPackageName(sleepingOnRe.group(2));
           lock.setClassName(sleepingOnRe.group(3));
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (matches(waitingToLockHeldRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.BLOCKED);
           lock.setAddress(waitingToLockHeldRe.group(1));
           lock.setPackageName(waitingToLockHeldRe.group(2));
           lock.setClassName(waitingToLockHeldRe.group(3));
           lock.setThreadId(getLong(waitingToLockHeldRe, 4, null));
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (matches(waitingToLockRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.BLOCKED);
           lock.setAddress(waitingToLockRe.group(1));
           lock.setPackageName(waitingToLockRe.group(2));
           lock.setClassName(waitingToLockRe.group(3));
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (matches(waitingToLockUnknownRe, text)) {
-        if (isLastFrameJava) {
+        if (lastJavaFrame != null) {
           final SentryLockReason lock = new SentryLockReason();
           lock.setType(SentryLockReason.BLOCKED);
+          lastJavaFrame.setLock(lock);
           combineThreadLocks(thread, lock);
         }
       } else if (text.length() == 0 || matches(blankRe, text)) {

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

@@ -33,6 +33,12 @@ class ThreadDumpParserTest {
         assertEquals("run", lastFrame.function)
         assertEquals(177, lastFrame.lineno)
         assertEquals(true, lastFrame.isInApp)
+        val lock = lastFrame.lock
+        assertEquals("0x0d3a2f0a", lock!!.address)
+        assertEquals(SentryLockReason.BLOCKED, lock.type)
+        assertEquals("java.lang", lock.packageName)
+        assertEquals("Object", lock.className)
+        assertEquals(5, lock.threadId)
 
         val blockingThread = threads.find { it.name == "Thread-9" }
         assertEquals(5, blockingThread!!.id)

sentry/api/sentry.api

@@ -3600,6 +3600,7 @@ public final class io/sentry/protocol/SentryStackFrame : io/sentry/JsonSerializa
 	public fun getImageAddr ()Ljava/lang/String;
 	public fun getInstructionAddr ()Ljava/lang/String;
 	public fun getLineno ()Ljava/lang/Integer;
+	public fun getLock ()Lio/sentry/SentryLockReason;
 	public fun getModule ()Ljava/lang/String;
 	public fun getPackage ()Ljava/lang/String;
 	public fun getPlatform ()Ljava/lang/String;
@@ -3623,6 +3624,7 @@ public final class io/sentry/protocol/SentryStackFrame : io/sentry/JsonSerializa
 	public fun setInApp (Ljava/lang/Boolean;)V
 	public fun setInstructionAddr (Ljava/lang/String;)V
 	public fun setLineno (Ljava/lang/Integer;)V
+	public fun setLock (Lio/sentry/SentryLockReason;)V
 	public fun setModule (Ljava/lang/String;)V
 	public fun setNative (Ljava/lang/Boolean;)V
 	public fun setPackage (Ljava/lang/String;)V
@@ -3652,6 +3654,7 @@ public final class io/sentry/protocol/SentryStackFrame$JsonKeys {
 	public static final field INSTRUCTION_ADDR Ljava/lang/String;
 	public static final field IN_APP Ljava/lang/String;
 	public static final field LINENO Ljava/lang/String;
+	public static final field LOCK Ljava/lang/String;
 	public static final field MODULE Ljava/lang/String;
 	public static final field NATIVE Ljava/lang/String;
 	public static final field PACKAGE Ljava/lang/String;

sentry/src/main/java/io/sentry/protocol/SentryStackFrame.java

@@ -6,6 +6,7 @@
 import io.sentry.JsonObjectWriter;
 import io.sentry.JsonSerializable;
 import io.sentry.JsonUnknown;
+import io.sentry.SentryLockReason;
 import io.sentry.vendor.gson.stream.JsonToken;
 import java.io.IOException;
 import java.util.List;
@@ -123,6 +124,9 @@
    */
   private @Nullable String rawFunction;
 
+  /** Represents a lock (java monitor object) held by this frame. */
+  private @Nullable SentryLockReason lock;
+
   public @Nullable List<String> getPreContext() {
     return preContext;
   }
@@ -284,6 +288,15 @@
     this.symbol = symbol;
   }
 
+  @Nullable
+  public SentryLockReason getLock() {
+    return lock;
+  }
+
+  public void setLock(final @Nullable SentryLockReason lock) {
+    this.lock = lock;
+  }
+
   // region json
 
   @Nullable
@@ -314,6 +327,7 @@
     public static final String INSTRUCTION_ADDR = "instruction_addr";
     public static final String RAW_FUNCTION = "raw_function";
     public static final String SYMBOL = "symbol";
+    public static final String LOCK = "lock";
   }
 
   @Override
@@ -368,6 +382,9 @@
     if (symbol != null) {
       writer.name(JsonKeys.SYMBOL).value(symbol);
     }
+    if (lock != null) {
+      writer.name(JsonKeys.LOCK).value(logger, lock);
+    }
     if (unknown != null) {
       for (String key : unknown.keySet()) {
         Object value = unknown.get(key);
@@ -436,6 +453,9 @@
           case JsonKeys.SYMBOL:
             sentryStackFrame.symbol = reader.nextStringOrNull();
             break;
+          case JsonKeys.LOCK:
+            sentryStackFrame.lock = reader.nextOrNull(logger, new SentryLockReason.Deserializer());
+            break;
           default:
             if (unknown == null) {
               unknown = new ConcurrentHashMap<>();

sentry/src/test/java/io/sentry/protocol/SentryStackFrameSerializationTest.kt

@@ -5,6 +5,7 @@ import io.sentry.ILogger
 import io.sentry.JsonObjectReader
 import io.sentry.JsonObjectWriter
 import io.sentry.JsonSerializable
+import io.sentry.SentryLockReason
 import org.junit.Test
 import org.mockito.kotlin.mock
 import java.io.StringReader
@@ -33,6 +34,13 @@ class SentryStackFrameSerializationTest {
             instructionAddr = "19864a78-2466-461f-9f0b-93a5c9ae7622"
             rawFunction = "f33035a4-0cf0-453d-b6f4-d7c27e9af924"
             symbol = "d9807ffe-d517-11ed-afa1-0242ac120002"
+            lock = SentryLockReason().apply {
+                address = "0x0d3a2f0a"
+                className = "Object"
+                packageName = "java.lang"
+                type = SentryLockReason.BLOCKED
+                threadId = 11
+            }
         }
     }
     private val fixture = Fixture()

sentry/src/test/resources/json/sentry_stack_frame.json

@@ -14,5 +14,12 @@
     "symbol_addr": "180e12cd-1fa8-405d-8dd8-e87b33fa2eb0",
     "instruction_addr": "19864a78-2466-461f-9f0b-93a5c9ae7622",
     "raw_function": "f33035a4-0cf0-453d-b6f4-d7c27e9af924",
-    "symbol": "d9807ffe-d517-11ed-afa1-0242ac120002"
+    "symbol": "d9807ffe-d517-11ed-afa1-0242ac120002",
+    "lock": {
+      "type": 8,
+      "address": "0x0d3a2f0a",
+      "package_name": "java.lang",
+      "class_name": "Object",
+      "thread_id": 11
+    }
 }