Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sentry-android-core/api/sentry-android-core.api
Original file line number Diff line number Diff line change
Expand Up @@ -759,8 +759,10 @@ public final class io/sentry/android/core/anr/AnrProfilingIntegration : io/sentr

public final class io/sentry/android/core/anr/AnrStackTrace : java/lang/Comparable {
public final field stack [Ljava/lang/StackTraceElement;
public final field state Ljava/lang/Thread$State;
public final field timestampMs J
public fun <init> (J[Ljava/lang/StackTraceElement;)V
public fun <init> (J[Ljava/lang/StackTraceElement;Ljava/lang/Thread$State;)V
public fun compareTo (Lio/sentry/android/core/anr/AnrStackTrace;)I
public synthetic fun compareTo (Ljava/lang/Object;)I
public static fun deserialize (Ljava/io/DataInputStream;)Lio/sentry/android/core/anr/AnrStackTrace;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,50 @@ public final class AnrStackTrace implements Comparable<AnrStackTrace> {

public final StackTraceElement[] stack;
public final long timestampMs;
public final @Nullable Thread.State state;

public AnrStackTrace(final long timestampMs, final StackTraceElement[] stack) {
this(timestampMs, stack, null);
}

public AnrStackTrace(
final long timestampMs, final StackTraceElement[] stack, final @Nullable Thread.State state) {
this.timestampMs = timestampMs;
this.stack = stack;
this.state = state;
}

@Override
public int compareTo(final @NotNull AnrStackTrace o) {
return Long.compare(timestampMs, o.timestampMs);
}

/**
* Writes this sample in format version 2. All numbers are big-endian, and strings use the
* modified UTF-8 of {@link DataOutputStream#writeUTF(String)}.
*
* <pre>
* short version (2)
* long timestampMs
* boolean isStateNull
* UTF state name, or "" if isStateNull
* int number of frames
* for each frame:
* UTF className
* UTF methodName
* boolean isFileNameNull
* UTF fileName, or "" if isFileNameNull
* int lineNumber
* </pre>
*
* <p>Version 1 is the same without the two state fields. {@link #deserialize(DataInputStream)}
* reads both versions.
*/
public void serialize(final @NotNull DataOutputStream dos) throws IOException {
dos.writeShort(1); // version
dos.writeShort(2); // version
dos.writeLong(timestampMs);
dos.writeBoolean(state == null);
dos.writeUTF(state == null ? "" : state.name());
dos.writeInt(stack.length);
for (final @NotNull StackTraceElement element : stack) {
dos.writeUTF(StringUtils.getOrEmpty(element.getClassName()));
Expand All @@ -46,8 +76,20 @@ public void serialize(final @NotNull DataOutputStream dos) throws IOException {
public static AnrStackTrace deserialize(final @NotNull DataInputStream dis) throws IOException {
try {
final short version = dis.readShort();
if (version == 1) {
if (version == 1 || version == 2) {
final long timestampMs = dis.readLong();
@Nullable Thread.State state = null;
if (version == 2) {
final boolean isStateNull = dis.readBoolean();
final @NotNull String stateName = dis.readUTF();
if (!isStateNull) {
try {
state = Thread.State.valueOf(stateName);
} catch (IllegalArgumentException e) {
// written by a runtime with a state this one does not know
}
}
}
final int stackLength = dis.readInt();
if (stackLength < 0 || stackLength > MAX_STACK_LENGTH) {
return null;
Expand All @@ -67,7 +109,7 @@ public static AnrStackTrace deserialize(final @NotNull DataInputStream dis) thro
stack[i] = element;
}

return new AnrStackTrace(timestampMs, stack);
return new AnrStackTrace(timestampMs, stack, state);
} else {
// unsupported future version
return null;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.sentry.android.core.anr

import com.google.common.truth.Truth.assertThat
import java.io.ByteArrayInputStream
import java.io.ByteArrayOutputStream
import java.io.DataInputStream
Expand Down Expand Up @@ -124,4 +125,91 @@ class AnrStackTraceTest {

assertNull(deserialized)
}

@Test
fun `v2 round trip keeps the thread state`() {
val stack = arrayOf(StackTraceElement("com.example.MyClass", "method1", "MyClass.java", 42))
val original = AnrStackTrace(1234567890L, stack, Thread.State.BLOCKED)

val deserialized = roundTrip(original)

assertThat(deserialized).isNotNull()
assertThat(deserialized!!.state).isEqualTo(Thread.State.BLOCKED)
assertThat(deserialized.timestampMs).isEqualTo(1234567890L)
assertThat(deserialized.stack).isEqualTo(stack)
}

@Test
fun `v2 round trip keeps a null thread state`() {
val original = AnrStackTrace(1234567890L, emptyArray(), null)

val deserialized = roundTrip(original)

assertThat(deserialized).isNotNull()
assertThat(deserialized!!.state).isNull()
}

@Test
fun `v1 bytes are still read with a null state`() {
val bytes = ByteArrayOutputStream()
val dos = DataOutputStream(bytes)
dos.writeShort(1)
dos.writeLong(1234567890L)
dos.writeInt(1)
dos.writeUTF("com.example.MyClass")
dos.writeUTF("method1")
dos.writeBoolean(false)
dos.writeUTF("MyClass.java")
dos.writeInt(42)
dos.flush()

val deserialized =
AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray())))

assertThat(deserialized).isNotNull()
assertThat(deserialized!!.state).isNull()
assertThat(deserialized.timestampMs).isEqualTo(1234567890L)
assertThat(deserialized.stack)
.isEqualTo(arrayOf(StackTraceElement("com.example.MyClass", "method1", "MyClass.java", 42)))
}

@Test
fun `unknown thread state name reads as null`() {
val bytes = ByteArrayOutputStream()
val dos = DataOutputStream(bytes)
dos.writeShort(2)
dos.writeLong(1234567890L)
dos.writeBoolean(false)
dos.writeUTF("NOT_A_STATE")
dos.writeInt(0)
dos.flush()

val deserialized =
AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray())))

assertThat(deserialized).isNotNull()
assertThat(deserialized!!.state).isNull()
}

@Test
fun `version 3 returns null`() {
val bytes = ByteArrayOutputStream()
val dos = DataOutputStream(bytes)
dos.writeShort(3)
dos.writeLong(1234567890L)
dos.flush()

val deserialized =
AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray())))

assertThat(deserialized).isNull()
}

private fun roundTrip(original: AnrStackTrace): AnrStackTrace? {
val bytes = ByteArrayOutputStream()
val dos = DataOutputStream(bytes)
original.serialize(dos)
dos.flush()
return AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray())))
}
}
Loading