Capture trace of error reporting thread and identify with boolean flag

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 4.X.X (TBD)
+
+* Capture trace of error reporting thread and identify with boolean flag [#355](https://github.com/bugsnag/bugsnag-android/pull/355)
+
 ## 4.6.0 (2018-08-02)
 
 * Android P compatibility fixes - ensure available information on StrictMode violations is collected [#350](https://github.com/bugsnag/bugsnag-android/pull/350)

mazerunner/src/main/java/com/bugsnag/android/TestHarnessHooks.kt

@@ -66,6 +66,7 @@ internal fun createCustomHeaderDelivery(context: Context): Delivery {
 
 
 internal fun writeErrorToStore(client: Client) {
-    val error = Error.Builder(Configuration("api-key"), RuntimeException(), null).build()
+    val error = Error.Builder(Configuration("api-key"), RuntimeException(), null,
+        Thread.currentThread()).build()
     client.errorStore.write(error)
 }

sdk/src/androidTest/java/com/bugsnag/android/BeforeNotifyTest.kt

@@ -23,7 +23,8 @@ class BeforeNotifyTest {
             false
         }
 
-        val error = Error.Builder(config, RuntimeException("Test"), null).build()
+        val error = Error.Builder(config, RuntimeException("Test"), null,
+            Thread.currentThread()).build()
         beforeNotify.run(error)
         assertEquals(context, error.context)
     }

sdk/src/androidTest/java/com/bugsnag/android/ErrorStoreTest.java

@@ -71,7 +71,8 @@ public void testWrite() throws Exception {
 
     @NonNull
     private Error writeErrorToStore() {
-        Error error = new Error.Builder(config, new RuntimeException(), null).build();
+        Error error = new Error.Builder(config, new RuntimeException(),
+            null, Thread.currentThread()).build();
         errorStore.write(error);
         return error;
     }

sdk/src/androidTest/java/com/bugsnag/android/ErrorTest.java

@@ -41,7 +41,7 @@ public class ErrorTest {
     public void setUp() throws Exception {
         config = new Configuration("api-key");
         RuntimeException exception = new RuntimeException("Example message");
-        error = new Error.Builder(config, exception, null).build();
+        error = new Error.Builder(config, exception, null, Thread.currentThread()).build();
     }
 
     @After
@@ -55,12 +55,14 @@ public void testShouldIgnoreClass() {
 
         // Shouldn't ignore classes not in ignoreClasses
         RuntimeException runtimeException = new RuntimeException("Test");
-        Error error = new Error.Builder(config, runtimeException, null).build();
+        Error error = new Error.Builder(config,
+            runtimeException, null, Thread.currentThread()).build();
         assertFalse(error.shouldIgnoreClass());
 
         // Should ignore errors in ignoreClasses
         IOException ioException = new IOException("Test");
-        error = new Error.Builder(config, ioException, null).build();
+        error = new Error.Builder(config,
+            ioException, null, Thread.currentThread()).build();
         assertTrue(error.shouldIgnoreClass());
     }
 
@@ -91,7 +93,8 @@ public void testBasicSerialization() throws JSONException, IOException {
 
     @Test
     public void testHandledSerialisation() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null)
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread())
             .severityReasonType(HandledState.REASON_HANDLED_EXCEPTION)
             .build();
 
@@ -108,7 +111,8 @@ public void testHandledSerialisation() throws Exception {
 
     @Test
     public void testUnhandledSerialisation() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null)
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread())
             .severityReasonType(HandledState.REASON_UNHANDLED_EXCEPTION)
             .severity(Severity.ERROR)
             .build();
@@ -126,7 +130,8 @@ public void testUnhandledSerialisation() throws Exception {
 
     @Test
     public void testPromiseRejectionSerialisation() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null)
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread())
             .severityReasonType(HandledState.REASON_PROMISE_REJECTION)
             .severity(Severity.ERROR)
             .build();
@@ -144,7 +149,8 @@ public void testPromiseRejectionSerialisation() throws Exception {
 
     @Test
     public void testLogSerialisation() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null)
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread())
             .severityReasonType(HandledState.REASON_LOG)
             .severity(Severity.WARNING)
             .attributeValue("warning")
@@ -179,7 +185,8 @@ public void testUserSpecifiedSerialisation() throws Exception {
 
     @Test
     public void testStrictModeSerialisation() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null)
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread())
             .severityReasonType(HandledState.REASON_STRICT_MODE)
             .attributeValue("Test")
             .build();
@@ -244,7 +251,8 @@ public void testSetSeverity() throws JSONException, IOException {
     @Test
     public void testSessionIncluded() throws Exception {
         Session session = generateSession();
-        Error err = new Error.Builder(config, new RuntimeException(), session).build();
+        Error err = new Error.Builder(config,
+            new RuntimeException(), session, Thread.currentThread()).build();
 
         JSONObject errorJson = streamableToJson(err);
         assertNotNull(errorJson);
@@ -264,7 +272,8 @@ public void testSessionIncluded() throws Exception {
 
     @Test(expected = JSONException.class)
     public void testSessionExcluded() throws Exception {
-        Error err = new Error.Builder(config, new RuntimeException(), null).build();
+        Error err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread()).build();
 
         JSONObject errorJson = streamableToJson(err);
         assertNotNull(errorJson);
@@ -274,10 +283,12 @@ public void testSessionExcluded() throws Exception {
     @Test
     public void checkExceptionMessageNullity() throws Exception {
         String msg = "Foo";
-        Error err = new Error.Builder(config, new RuntimeException(msg), null).build();
+        Error err = new Error.Builder(config,
+            new RuntimeException(msg), null, Thread.currentThread()).build();
         assertEquals(msg, err.getExceptionMessage());
 
-        err = new Error.Builder(config, new RuntimeException(), null).build();
+        err = new Error.Builder(config,
+            new RuntimeException(), null, Thread.currentThread()).build();
         assertEquals("", err.getExceptionMessage());
     }
 
@@ -298,7 +309,8 @@ public void testSendThreadsDisabled() throws Exception {
     public void testBugsnagExceptionName() throws Exception {
         BugsnagException exception = new BugsnagException("Busgang", "exceptional",
             new StackTraceElement[]{});
-        Error err = new Error.Builder(config, exception, null).build();
+        Error err = new Error.Builder(config,
+            exception, null, Thread.currentThread()).build();
         assertEquals("Busgang", err.getExceptionName());
     }
 
@@ -357,7 +369,8 @@ public void testSetUser() throws Exception {
     @Test
     public void testBuilderMetaData() {
         Configuration config = new Configuration("api-key");
-        Error.Builder builder = new Error.Builder(config, new RuntimeException("foo"), null);
+        Error.Builder builder = new Error.Builder(config,
+            new RuntimeException("foo"), null, Thread.currentThread());
 
         assertNotNull(builder.metaData(new MetaData()).build());
 
@@ -401,7 +414,7 @@ public void testBuilderNullSession() throws Throwable {
 
         Session session = generateSession();
         session.setAutoCaptured(true);
-        error = new Error.Builder(config, exception, session).build();
+        error = new Error.Builder(config, exception, session, Thread.currentThread()).build();
 
         JSONObject errorJson = streamableToJson(error);
         assertFalse(errorJson.has("session"));

sdk/src/androidTest/java/com/bugsnag/android/ExceptionsTest.java

@@ -71,7 +71,7 @@ public void testNamedException() throws JSONException, IOException {
         StackTraceElement element = new StackTraceElement("Class", "method", "Class.java", 123);
         StackTraceElement[] frames = new StackTraceElement[]{element};
         Error error = new Error.Builder(config, "RuntimeException",
-            "Example message", frames, null).build();
+            "Example message", frames, null, Thread.currentThread()).build();
         Exceptions exceptions = new Exceptions(config, error.getException());
 
         JSONObject exceptionJson = streamableToJsonArray(exceptions).getJSONObject(0);

sdk/src/androidTest/java/com/bugsnag/android/NullMetadataTest.java

@@ -42,20 +42,21 @@ public void tearDown() throws Exception {
 
     @Test
     public void testErrorDefaultMetaData() throws Exception {
-        Error error = new Error.Builder(config, throwable, null).build();
+        Error error = new Error.Builder(config, throwable, null, Thread.currentThread()).build();
         validateDefaultMetadata(error.getMetaData());
     }
 
     @Test
     public void testSecondErrorDefaultMetaData() throws Exception {
         Error error = new Error.Builder(config, "RuntimeException",
-            "Something broke", new StackTraceElement[]{}, null).build();
+            "Something broke", new StackTraceElement[]{},
+            null, Thread.currentThread()).build();
         validateDefaultMetadata(error.getMetaData());
     }
 
     @Test
     public void testErrorSetMetadataRef() throws Exception {
-        Error error = new Error.Builder(config, throwable, null).build();
+        Error error = new Error.Builder(config, throwable, null, Thread.currentThread()).build();
         MetaData metaData = new MetaData();
         metaData.addToTab(TAB_KEY, "test", "data");
         error.setMetaData(metaData);
@@ -64,7 +65,7 @@ public void testErrorSetMetadataRef() throws Exception {
 
     @Test
     public void testErrorSetNullMetadata() throws Exception {
-        Error error = new Error.Builder(config, throwable, null).build();
+        Error error = new Error.Builder(config, throwable, null, Thread.currentThread()).build();
         error.setMetaData(null);
         validateDefaultMetadata(error.getMetaData());
     }
@@ -97,7 +98,8 @@ public boolean run(Error error) {
                 return false;
             }
         });
-        Error error = new Error.Builder(config, new Throwable(), null).build();
+        Error error = new Error.Builder(config, new Throwable(),
+            null, Thread.currentThread()).build();
         Client client = Bugsnag.getClient();
         client.notify(error, DeliveryStyle.SAME_THREAD, null);
     }

sdk/src/androidTest/java/com/bugsnag/android/ReportTest.java

@@ -31,7 +31,7 @@ public class ReportTest {
     public void setUp() throws Exception {
         Configuration config = new Configuration("example-api-key");
         RuntimeException exception = new RuntimeException("Something broke");
-        Error error = new Error.Builder(config, exception, null).build();
+        Error error = new Error.Builder(config, exception, null, Thread.currentThread()).build();
         report = new Report("api-key", error);
     }
 

sdk/src/androidTest/java/com/bugsnag/android/ThreadStateTest.kt

@@ -0,0 +1,82 @@
+package com.bugsnag.android
+
+import android.support.test.filters.SmallTest
+import android.support.test.runner.AndroidJUnit4
+import com.bugsnag.android.BugsnagTestUtils.streamableToJsonArray
+import org.json.JSONObject
+import org.junit.Assert.*
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+@SmallTest
+class ThreadStateTest {
+
+    private val threadState = ThreadState(Configuration("api-key"), Thread.currentThread())
+    private val json = streamableToJsonArray(threadState)
+
+    /**
+     * Verifies that the required values for 'thread' are serialised as an array
+     */
+    @Test
+    fun testSerialisation() {
+        for (k in 0 until json.length()) {
+            val thread = json[k] as JSONObject
+            assertNotNull(thread.getString("id"))
+            assertNotNull(thread.getString("name"))
+            assertNotNull(thread.getString("stacktrace"))
+            assertEquals("android", thread.getString("type"))
+        }
+    }
+
+    /**
+     * Verifies that the current thread is serialised as an object, and that only this value
+     * contains the errorReportingThread boolean flag
+     */
+    @Test
+    fun testCurrentThread() {
+        val currentThreadId = Thread.currentThread().id
+        var currentThreadCount = 0
+
+        for (k in 0 until json.length()) {
+            val thread = json[k] as JSONObject
+            val threadId = thread.getLong("id")
+
+            if (threadId == currentThreadId) {
+                assertTrue(thread.getBoolean("errorReportingThread"))
+                currentThreadCount++
+            } else {
+                assertFalse(thread.has("errorReportingThread"))
+            }
+        }
+        assertEquals(1, currentThreadCount)
+    }
+
+    /**
+     * Verifies that a thread different from the current thread is serialised as an object,
+     * and that only this value contains the errorReportingThread boolean flag
+     */
+    @Test
+    fun testDifferentThread() {
+        val otherThread = Thread.getAllStackTraces()
+            .filter { it.key != Thread.currentThread() }
+            .map { it.key }
+            .first()
+
+        val json = streamableToJsonArray(ThreadState(Configuration("api-key"), otherThread))
+        var currentThreadCount = 0
+
+        for (k in 0 until json.length()) {
+            val thread = json[k] as JSONObject
+            val threadId = thread.getLong("id")
+
+            if (threadId == otherThread.id) {
+                assertTrue(thread.getBoolean("errorReportingThread"))
+                currentThreadCount++
+            } else {
+                assertFalse(thread.has("errorReportingThread"))
+            }
+        }
+        assertEquals(1, currentThreadCount)
+    }
+}