Merge pull request #93 from backtrace-labs/release-candidate/3.7.6

Merge 3.7.6 to master

Author: BartoszLitwiniuk

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Backtrace Android Release Notes
 
+## Version 3.7.6
+- Maintenance: Update various components to latest versions
+- Maintenance: Update gradle
+- Bugfix: Fix enabling breadcrumbs when not available
+- Add breadcrumb when ANR is detected
+
 ## Version 3.7.5
 - Maintenance: Update various components to latest versions
 - Bugfix: Managed and native reports generated by the same user now have the same `guid`

backtrace-library/build.gradle

@@ -68,14 +68,14 @@ android {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation 'com.google.code.gson:gson:2.10'
-    implementation 'androidx.appcompat:appcompat:1.5.1'
+    implementation 'androidx.appcompat:appcompat:1.6.1'
     implementation 'com.squareup:tape:1.2.3'
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'net.jodah:concurrentunit:0.4.4'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.4'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
     androidTestImplementation 'androidx.test:rules:1.5.0'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.4'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.0'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 }
 
 apply from: 'publish.gradle'

backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbsTest.java

@@ -7,24 +7,25 @@
 import static junit.framework.TestCase.fail;
 
 import android.content.Context;
-import androidx.test.platform.app.InstrumentationRegistry;
+
 import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.platform.app.InstrumentationRegistry;
 
+import org.json.JSONException;
 import org.json.JSONObject;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
+
 @RunWith(AndroidJUnit4.class)
 public class BacktraceBreadcrumbsTest {
     public Context context;
@@ -37,7 +38,6 @@ public class BacktraceBreadcrumbsTest {
     @Before
     public void setUp() {
         this.context = InstrumentationRegistry.getInstrumentation().getContext();
-
         backtraceBreadcrumbs = new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath());
         backtraceBreadcrumbs.enableBreadcrumbs(context);
     }
@@ -53,7 +53,7 @@ public void testAddBreadcrumb() {
         try {
             assertTrue(backtraceBreadcrumbs.addBreadcrumb("Test"));
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -70,7 +70,7 @@ public void testClearBreadcrumbs() {
         try {
             assertTrue(backtraceBreadcrumbs.addBreadcrumb("Test"));
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
             assertEquals(2, breadcrumbLogFileData.size());
 
             // First breadcrumb is configuration breadcrumb
@@ -83,7 +83,7 @@ public void testClearBreadcrumbs() {
 
             // Should have cleared the breadcrumb we just read but
             // We should still have a configuration breadcrumb
-            breadcrumbLogFileData = readBreadcrumbLogFile();
+            breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
             assertEquals(1, breadcrumbLogFileData.size());
             parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(0));
 
@@ -103,7 +103,7 @@ public void testEnableBreadcrumbs() {
 
             assertTrue(backtraceBreadcrumbs.addBreadcrumb("Test"));
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -126,7 +126,7 @@ public void testAddBreadcrumbWithAttributes() {
 
             backtraceBreadcrumbs.addBreadcrumb("Test", attributes);
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -146,7 +146,7 @@ public void testSpaceInMessage() {
         try {
             backtraceBreadcrumbs.addBreadcrumb("Testing 1 2 3");
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -164,7 +164,7 @@ public void testNewlineInMessage() {
         try {
             backtraceBreadcrumbs.addBreadcrumb("Testing\n 1 2\n 3\n");
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -188,7 +188,7 @@ public void testInvalidCharsInAttribute() {
 
             backtraceBreadcrumbs.addBreadcrumb("Test", attributes);
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -208,7 +208,7 @@ public void testLongMessage() {
         try {
             backtraceBreadcrumbs.addBreadcrumb(longTestMessage);
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -230,7 +230,7 @@ public void testLongAttributesLongFirst() {
 
             backtraceBreadcrumbs.addBreadcrumb("Test", attributes);
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -254,7 +254,7 @@ public void testLongAttributesShortFirst() {
 
             backtraceBreadcrumbs.addBreadcrumb("Test", attributes);
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -283,7 +283,7 @@ public void testQueueFileShouldNotRollover() {
                 backtraceBreadcrumbs.addBreadcrumb("I am a breadcrumb", attributes);
             }
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb, it should be valid
             JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(0));
@@ -327,7 +327,7 @@ public void testQueueFileRollover() {
                     breadcrumbsFileSize > 63 * 1024);
 
             // We should have rolled over the configuration breadcrumb, consider all breadcrumbs here
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
             for (int i = 0; i < breadcrumbLogFileData.size(); i++) {
                 JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(i));
                 assertEquals("I am a breadcrumb", parsedBreadcrumb.get("message"));
@@ -367,7 +367,7 @@ public void testQueueFileShouldNotRolloverCustomMax() {
                 backtraceBreadcrumbs.addBreadcrumb("I am a breadcrumb", attributes);
             }
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb, it should be valid
             JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(0));
@@ -391,42 +391,37 @@ public void testQueueFileShouldNotRolloverCustomMax() {
     }
 
     @Test
-    public void testQueueFileRolloverCustomMax() {
+    public void testQueueFileRolloverCustomMax() throws IOException, JSONException {
         int numIterations = 100;
         // Cleanup after default BacktraceBreadcrumbs constructor
         // Because we want to create our own instance with custom parameters
         cleanUp();
 
-        try {
-            backtraceBreadcrumbs = new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath());
-            backtraceBreadcrumbs.enableBreadcrumbs(context, 6400);
-            // Account for mandatory configuration breadcrumb
-            backtraceBreadcrumbs.setCurrentBreadcrumbId(1);
-
-            for (int i = 0; i < numIterations; i++) {
-                final long threadId = Thread.currentThread().getId();
-                Map<String, Object> attributes = new HashMap<String, Object>() {{
-                    put("From Thread", threadId);
-                }};
-                backtraceBreadcrumbs.addBreadcrumb("I am a breadcrumb", attributes);
-            }
-
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+        backtraceBreadcrumbs = new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath());
+        backtraceBreadcrumbs.enableBreadcrumbs(context, 6400);
+        // Account for mandatory configuration breadcrumb
+        backtraceBreadcrumbs.setCurrentBreadcrumbId(1);
 
-            // We should have rolled over the configuration breadcrumb, consider all breadcrumbs here
-            for (int i = 0; i < breadcrumbLogFileData.size(); i++) {
-                JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(i));
-                assertEquals("I am a breadcrumb", parsedBreadcrumb.get("message"));
-                assertNotNull(parsedBreadcrumb.getJSONObject("attributes").get("From Thread"));
-                assertEquals("manual", parsedBreadcrumb.get("type"));
-                assertEquals("info", parsedBreadcrumb.get("level"));
-                // Timestamp should be convertible to a long
-                assertTrue(parsedBreadcrumb.get("timestamp") instanceof Long);
-                assertTrue(((int) parsedBreadcrumb.get("id")) > 45);
-            }
+        for (int i = 0; i < numIterations; i++) {
+            final long threadId = Thread.currentThread().getId();
+            Map<String, Object> attributes = new HashMap<String, Object>() {{
+                put("From Thread", threadId);
+            }};
+            backtraceBreadcrumbs.addBreadcrumb("I am a breadcrumb", attributes);
+        }
 
-        } catch (Exception ex) {
-            fail(ex.getMessage());
+        List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
+
+        // We should have rolled over the configuration breadcrumb, consider all breadcrumbs here
+        for (int i = 0; i < breadcrumbLogFileData.size(); i++) {
+            JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(i));
+            assertEquals("I am a breadcrumb", parsedBreadcrumb.get("message"));
+            assertNotNull(parsedBreadcrumb.getJSONObject("attributes").get("From Thread"));
+            assertEquals("manual", parsedBreadcrumb.get("type"));
+            assertEquals("info", parsedBreadcrumb.get("level"));
+            // Timestamp should be convertible to a long
+            assertTrue(parsedBreadcrumb.get("timestamp") instanceof Long);
+            assertTrue(((int) parsedBreadcrumb.get("id")) > 45);
         }
     }
 
@@ -445,7 +440,7 @@ public void breadcrumbsEnduranceTest() {
                 threads[i].join();
             }
 
-            List<String> breadcrumbLogFileData = readBreadcrumbLogFile();
+            List<String> breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile(context.getFilesDir().getAbsolutePath());
 
             // First breadcrumb is configuration breadcrumb
             // We start from the second breadcrumb
@@ -497,32 +492,6 @@ public void run() {
         }
     }
 
-    public List<String> readBreadcrumbLogFile() throws IOException {
-        BacktraceBreadcrumbs breadcrumbs = new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath());
-        File breadcrumbLogFile = new File(breadcrumbs.getBreadcrumbLogPath());
-
-        List<String> breadcrumbLogFileData = new ArrayList<String>();
-        FileInputStream inputStream = new FileInputStream(breadcrumbLogFile.getAbsolutePath());
-
-        // The encoding contains headers for the encoded data
-        // We just throw away lines that don't start with "timestamp
-        StringBuilder stringBuilder = new StringBuilder();
-        while (inputStream.available() > 0) {
-            char c = (char) inputStream.read();
-            if (c == '\n') {
-                String line = stringBuilder.toString();
-                if (line.matches(".*timestamp.*")) {
-                    breadcrumbLogFileData.add(line);
-                }
-                stringBuilder = new StringBuilder();
-                continue;
-            }
-            stringBuilder.append(c);
-        }
-
-        return breadcrumbLogFileData;
-    }
-
     private final String longTestMessage = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ipsum consequat nisl vel pretium lectus quam id. Velit dignissim sodales ut eu sem integer vitae justo. Cursus euismod quis viverra nibh cras pulvinar. Pellentesque adipiscing commodo elit at imperdiet. Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. Elementum facilisis leo vel fringilla est ullamcorper eget nulla. Purus sit amet luctus venenatis. Non consectetur a erat nam at. Pellentesque id nibh tortor id aliquet lectus proin. Purus semper eget duis at tellus. Sodales ut etiam sit amet nisl purus. Viverra justo nec ultrices dui sapien eget.\n" +
             "\n" +
             "Et ultrices neque ornare aenean euismod elementum nisi quis eleifend. Ut diam quam nulla porttitor. Vitae elementum curabitur vitae nunc sed. Feugiat sed lectus vestibulum mattis ullamcorper velit sed. A diam sollicitudin tempor id eu nisl nunc. At urna condimentum mattis pellentesque id. Arcu odio ut sem nulla pharetra diam sit amet. Ipsum dolor sit amet consectetur adipiscing elit duis. Adipiscing vitae proin sagittis nisl rhoncus mattis rhoncus. Faucibus interdum posuere lorem ipsum dolor. Aliquet risus feugiat in ante metus dictum at. Pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices. Enim nulla aliquet porttitor lacus luctus accumsan. Diam ut venenatis tellus in metus. Facilisi nullam vehicula ipsum a arcu cursus.\n" +
@@ -542,4 +511,4 @@ public List<String> readBreadcrumbLogFile() throws IOException {
     private final String reasonableLengthAttributeKey = "reasonablySizedKey";
 
     private final String reasonableLengthAttributeValue = "reasonableSizedValue";
-}
+}

backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BreadcrumbsReader.java

@@ -0,0 +1,36 @@
+package backtraceio.library.breadcrumbs;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+public class BreadcrumbsReader {
+
+    public static List<String> readBreadcrumbLogFile(String path) throws IOException {
+        BacktraceBreadcrumbs breadcrumbs = new BacktraceBreadcrumbs(path);
+        File breadcrumbLogFile = new File(breadcrumbs.getBreadcrumbLogPath());
+
+        List<String> breadcrumbLogFileData = new ArrayList<String>();
+        FileInputStream inputStream = new FileInputStream(breadcrumbLogFile.getAbsolutePath());
+
+        // The encoding contains headers for the encoded data
+        // We just throw away lines that don't start with "timestamp
+        StringBuilder stringBuilder = new StringBuilder();
+        while (inputStream.available() > 0) {
+            char c = (char) inputStream.read();
+            if (c == '\n') {
+                String line = stringBuilder.toString();
+                if (line.matches(".*timestamp.*")) {
+                    breadcrumbLogFileData.add(line);
+                }
+                stringBuilder = new StringBuilder();
+                continue;
+            }
+            stringBuilder.append(c);
+        }
+
+        return breadcrumbLogFileData;
+    }
+}

backtrace-library/src/androidTest/java/backtraceio/library/watchdog/BacktraceAnrTest.java

@@ -32,7 +32,6 @@ public void setUp() {
         this.backtraceClient = new BacktraceClient(this.context, credentials);
     }
 
-
     @Test
     @UiThreadTest
     public void checkIfANRIsDetectedCorrectly() {