error.type attribute support (#44)

konraddysput · web-flow · commit 2f57da44a071 · 2022-03-24T15:01:36.000+01:00
* Prevent ANR duplicates * typo * Format change * Add error type attribute * rollback main activity * Formatting rules * Set different attribute size * Use variables * Remove unsupported test case * backtrace.version attribute (#45) * Add build version * Ignore dynamic attributes - attributes that changes over the time * Bring back native library initialization * Include backtrace.version attribute * Formatting changes * styles
diff --git a/backtrace-library/build.gradle b/backtrace-library/build.gradle
@@ -9,6 +9,7 @@ android {
         targetSdkVersion 30
         versionCode 360
         versionName "3.6.0"
+        buildConfigField("String", "VERSION_NAME", "\"${versionName}\"")
 
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
 
diff --git a/backtrace-library/src/androidTest/java/backtraceio/library/BacktraceErrorTypeAttributeTest.java b/backtrace-library/src/androidTest/java/backtraceio/library/BacktraceErrorTypeAttributeTest.java
@@ -0,0 +1,92 @@
+package backtraceio.library;
+
+import static junit.framework.TestCase.assertTrue;
+import static junit.framework.TestCase.fail;
+import static org.junit.Assert.assertEquals;
+
+import android.content.Context;
+import android.support.test.InstrumentationRegistry;
+import android.support.test.runner.AndroidJUnit4;
+
+import net.jodah.concurrentunit.Waiter;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.concurrent.TimeUnit;
+
+import backtraceio.library.events.OnServerResponseEventListener;
+import backtraceio.library.events.RequestHandler;
+import backtraceio.library.models.BacktraceAttributeConsts;
+import backtraceio.library.models.BacktraceData;
+import backtraceio.library.models.BacktraceResult;
+import backtraceio.library.models.json.BacktraceReport;
+import backtraceio.library.models.types.BacktraceResultStatus;
+
+@RunWith(AndroidJUnit4.class)
+public class BacktraceErrorTypeAttributeTest {
+
+    private Context context;
+    private BacktraceCredentials credentials;
+
+    @Before
+    public void setUp() {
+        context = InstrumentationRegistry.getContext();
+        credentials = new BacktraceCredentials("https://example-endpoint.com/", "");
+    }
+
+    @Test
+    public void setDefaultErrorTypeForExceptionTypeOfError() {
+        BacktraceReport report = new BacktraceReport(new Exception("test exception"));
+
+        assertTrue(report.attributes.containsKey(BacktraceAttributeConsts.ErrorType));
+        assertEquals(report.attributes.get(BacktraceAttributeConsts.ErrorType), BacktraceAttributeConsts.HandledExceptionAttributeType);
+    }
+
+    @Test
+    public void setDefaultErrorTypeForMessageType() {
+        BacktraceReport report = new BacktraceReport("test message");
+
+        assertTrue(report.attributes.containsKey(BacktraceAttributeConsts.ErrorType));
+        assertEquals(report.attributes.get(BacktraceAttributeConsts.ErrorType), BacktraceAttributeConsts.MessageAttributeType);
+    }
+
+    @Test
+    public void sendBacktraceExceptionWithErrorType() {
+
+        BacktraceClient backtraceClient = new BacktraceClient(context, credentials);
+
+        final Waiter waiter = new Waiter();
+        RequestHandler rh = new RequestHandler() {
+            @Override
+            public BacktraceResult onRequest(BacktraceData data) {
+                return new BacktraceResult(data.report, data.report.exception.getMessage(),
+                        BacktraceResultStatus.Ok);
+            }
+        };
+        backtraceClient.setOnRequestHandler(rh);
+
+        // WHEN
+        backtraceClient.send(new Exception("test exception"), new
+                OnServerResponseEventListener() {
+                    @Override
+                    public void onEvent(BacktraceResult backtraceResult) {
+                        // THEN
+                        String errorType = backtraceResult.getBacktraceReport().attributes.get(BacktraceAttributeConsts.ErrorType).toString();
+                        assertEquals(
+                                errorType,
+                                BacktraceAttributeConsts.HandledExceptionAttributeType);
+
+                        waiter.resume();
+                    }
+                }
+        );
+        // WAIT FOR THE RESULT FROM ANOTHER THREAD
+        try {
+            waiter.await(5, TimeUnit.SECONDS);
+        } catch (Exception ex) {
+            fail(ex.getMessage());
+        }
+    }
+}
diff --git a/backtrace-library/src/main/cpp/crashpad-builds b/backtrace-library/src/main/cpp/crashpad-builds
@@ -1 +1 @@
-Subproject commit 4e6e4ed3fd4bf974fe68a8a2341d789a0ad7ab28
+Subproject commit 9be6ee78f5e785cd693569186e263a7c0d3a4c54
diff --git a/backtrace-library/src/main/java/backtraceio/library/BacktraceDatabase.java b/backtrace-library/src/main/java/backtraceio/library/BacktraceDatabase.java
@@ -21,6 +21,7 @@
 import backtraceio.library.interfaces.DatabaseContext;
 import backtraceio.library.interfaces.DatabaseFileContext;
 import backtraceio.library.logger.BacktraceLogger;
+import backtraceio.library.models.BacktraceAttributeConsts;
 import backtraceio.library.models.BacktraceData;
 import backtraceio.library.models.BacktraceResult;
 import backtraceio.library.models.database.BacktraceDatabaseRecord;
@@ -177,7 +178,9 @@ public Boolean setupNativeIntegration(BacktraceBase client, BacktraceCredentials
         // Path to Crashpad native handler
         String handlerPath = _applicationContext.getApplicationInfo().nativeLibraryDir + _crashpadHandlerName;
 
-        BacktraceAttributes crashpadAttributes = new BacktraceAttributes(_applicationContext, null, client.attributes);
+        // setup default native attribtues
+        BacktraceAttributes crashpadAttributes = new BacktraceAttributes(_applicationContext, client.attributes);
+        crashpadAttributes.attributes.put(BacktraceAttributeConsts.ErrorType, BacktraceAttributeConsts.CrashAttributeType);
         String[] keys = crashpadAttributes.attributes.keySet().toArray(new String[0]);
         String[] values = crashpadAttributes.attributes.values().toArray(new String[0]);
 
diff --git a/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java b/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java
@@ -10,6 +10,7 @@
 
 import backtraceio.library.BacktraceCredentials;
 import backtraceio.library.BacktraceDatabase;
+import backtraceio.library.BuildConfig;
 import backtraceio.library.enums.BacktraceBreadcrumbLevel;
 import backtraceio.library.enums.BacktraceBreadcrumbType;
 import backtraceio.library.enums.UnwindingMode;
@@ -47,6 +48,11 @@ public class BacktraceBase implements Client {
      */
     public final Database database;
 
+    /**
+     * Backtrace client version
+     */
+    public static String version = BuildConfig.VERSION_NAME;
+
     /**
      * Get custom client attributes. Every argument stored in dictionary will be send to Backtrace API
      */
diff --git a/backtrace-library/src/main/java/backtraceio/library/common/DeviceAttributesHelper.java b/backtrace-library/src/main/java/backtraceio/library/common/DeviceAttributesHelper.java
@@ -44,13 +44,14 @@ public DeviceAttributesHelper(Context context) {
      *
      * @return device attributes
      */
-    public HashMap<String, String> getDeviceAttributes() {
+    public HashMap<String, String> getDeviceAttributes(Boolean includeDynamicAttributes) {
         HashMap<String, String> result = new HashMap<>();
         result.put("guid", this.generateDeviceId());
         result.put("uname.sysname", "Android");
         result.put("uname.machine", System.getProperty("os.arch"));
-        result.put("cpu.boottime", String.valueOf(java.lang.System.currentTimeMillis() - android.os.SystemClock
-                .elapsedRealtime()));
+        if (includeDynamicAttributes == false) {
+            return result;
+        }
         result.put("device.airplane_mode", String.valueOf(isAirplaneModeOn()));
         result.put("device.location", getLocationServiceStatus().toString());
         result.put("device.nfc.status", getNfcStatus().toString());
@@ -65,6 +66,9 @@ public HashMap<String, String> getDeviceAttributes() {
         result.put("app.storage_used", getAppUsedStorageSize());
         result.put("battery.level", String.valueOf(getBatteryLevel()));
         result.put("battery.state", getBatteryState().toString());
+        result.put("cpu.boottime", String.valueOf(java.lang.System.currentTimeMillis() - android.os.SystemClock
+                .elapsedRealtime()));
+
         return result;
     }
 
diff --git a/backtrace-library/src/main/java/backtraceio/library/models/BacktraceAttributeConsts.java b/backtrace-library/src/main/java/backtraceio/library/models/BacktraceAttributeConsts.java
@@ -0,0 +1,10 @@
+package backtraceio.library.models;
+
+public class BacktraceAttributeConsts {
+    public static final String ErrorType = "error.type";
+    public static final String CrashAttributeType = "Crash";
+    public static final String UnhandledExceptionAttributeType = "Unhandled Exception";
+    public static final String HandledExceptionAttributeType = "Exception";
+    public static final String MessageAttributeType = "Message";
+    public static final String AnrAttributeType = "Hang";
+}
diff --git a/backtrace-library/src/main/java/backtraceio/library/models/BacktraceData.java b/backtrace-library/src/main/java/backtraceio/library/models/BacktraceData.java
@@ -7,7 +7,7 @@
 import java.util.List;
 import java.util.Map;
 
-import backtraceio.library.common.DeviceAttributesHelper;
+import backtraceio.library.BacktraceClient;
 import backtraceio.library.common.FileHelper;
 import backtraceio.library.logger.BacktraceLogger;
 import backtraceio.library.models.json.Annotations;
@@ -178,12 +178,7 @@ private void setReportInformation() {
         timestamp = report.timestamp;
         classifiers = report.exceptionTypeReport ? new String[]{report.classifier} : null;
         langVersion = System.getProperty("java.version"); //TODO: Fix problem with read Java version
-        try {
-            agentVersion = context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionName;
-        } catch (Exception e) {
-            BacktraceLogger.e(LOG_TAG, "Could not resolve package version name");
-            agentVersion = "";
-        }
+        agentVersion = BacktraceClient.version;
     }
 
     /**
diff --git a/backtrace-library/src/main/java/backtraceio/library/models/BacktraceExceptionHandler.java b/backtrace-library/src/main/java/backtraceio/library/models/BacktraceExceptionHandler.java
@@ -53,7 +53,9 @@ public void uncaughtException(final Thread thread, final Throwable throwable) {
 
         if (throwable instanceof Exception) {
             BacktraceLogger.e(LOG_TAG, "Sending uncaught exception to Backtrace API", throwable);
-            this.client.send(new BacktraceReport((Exception) throwable, BacktraceExceptionHandler.customAttributes), callback);
+            BacktraceReport report = new BacktraceReport((Exception) throwable, BacktraceExceptionHandler.customAttributes);
+            report.attributes.put(BacktraceAttributeConsts.ErrorType, BacktraceAttributeConsts.UnhandledExceptionAttributeType);
+            this.client.send(report, callback);
             BacktraceLogger.d(LOG_TAG, "Uncaught exception sent to Backtrace API");
         }
         BacktraceLogger.d(LOG_TAG, "Default uncaught exception handler");
diff --git a/backtrace-library/src/main/java/backtraceio/library/models/json/BacktraceAttributes.java b/backtrace-library/src/main/java/backtraceio/library/models/json/BacktraceAttributes.java
@@ -14,6 +14,7 @@
 import java.util.Map;
 import java.util.UUID;
 
+import backtraceio.library.BacktraceClient;
 import backtraceio.library.BuildConfig;
 import backtraceio.library.common.BacktraceStringHelper;
 import backtraceio.library.common.DeviceAttributesHelper;
@@ -61,6 +62,15 @@ public class BacktraceAttributes {
      */
     public BacktraceAttributes(Context context, BacktraceReport report, Map<String, Object>
             clientAttributes) {
+        this(context, report, clientAttributes, true);
+    }
+
+    public BacktraceAttributes(Context context, Map<String, Object> clientAttributes) {
+        this(context, null, clientAttributes, false);
+    }
+
+    public BacktraceAttributes(Context context, BacktraceReport report, Map<String, Object>
+            clientAttributes, Boolean includeDynamicAttributes) {
         this.context = context;
         if (report != null) {
             this.convertReportAttributes(report);
@@ -73,8 +83,8 @@ public BacktraceAttributes(Context context, BacktraceReport report, Map<String,
             BacktraceReport.concatAttributes(report, clientAttributes);
         }
         setAppInformation();
-        setDeviceInformation();
-        setScreenInformation();
+        setDeviceInformation(includeDynamicAttributes);
+        setScreenInformation(includeDynamicAttributes);
 
         // For tracking crash-free sessions we need to add
         // application.session and application.version to Backtrace attributes
@@ -90,7 +100,7 @@ public Map<String, Object> getComplexAttributes() {
     /**
      * Set information about device eg. lang, model, brand, sdk, manufacturer, os version
      */
-    private void setDeviceInformation() {
+    private void setDeviceInformation(Boolean includeDynamicAttributes) {
         this.attributes.put("uname.version", Build.VERSION.RELEASE);
         this.attributes.put("culture", Locale.getDefault().getDisplayLanguage());
         this.attributes.put("build.type", BuildConfig.DEBUG ? "Debug" : "Release");
@@ -103,7 +113,7 @@ private void setDeviceInformation() {
         this.attributes.put("device.os_version", System.getProperty("os.version"));
 
         DeviceAttributesHelper deviceAttributesHelper = new DeviceAttributesHelper(this.context);
-        this.attributes.putAll(deviceAttributesHelper.getDeviceAttributes());
+        this.attributes.putAll(deviceAttributesHelper.getDeviceAttributes(includeDynamicAttributes));
     }
 
     private void setAppInformation() {
@@ -117,19 +127,23 @@ private void setAppInformation() {
             // But we keep version attribute name as to not break any customer workflows
             this.attributes.put("version", version);
         }
+        this.attributes.put("backtrace.version", BacktraceClient.version);
     }
 
     /**
      * Set information about screen such as screen width, height, dpi, orientation
      */
-    private void setScreenInformation() {
+    private void setScreenInformation(Boolean includeDynamicAttributes) {
         WindowManager wm = (WindowManager) context.getSystemService(Context.WINDOW_SERVICE);
         Display display = wm.getDefaultDisplay();
         DisplayMetrics metrics = new DisplayMetrics();
         display.getMetrics(metrics);
         this.attributes.put("screen.width", String.valueOf(metrics.widthPixels));
         this.attributes.put("screen.height", String.valueOf(metrics.heightPixels));
         this.attributes.put("screen.dpi", String.valueOf(metrics.densityDpi));
+        if (includeDynamicAttributes == false) {
+            return;
+        }
         this.attributes.put("screen.orientation", getScreenOrientation().toString());
         this.attributes.put("screen.brightness", String.valueOf(getScreenBrightness()));
     }
diff --git a/backtrace-library/src/main/java/backtraceio/library/models/json/BacktraceReport.java b/backtrace-library/src/main/java/backtraceio/library/models/json/BacktraceReport.java
@@ -9,6 +9,7 @@
 import java.util.UUID;
 
 import backtraceio.library.common.BacktraceTimeHelper;
+import backtraceio.library.models.BacktraceAttributeConsts;
 import backtraceio.library.models.BacktraceData;
 import backtraceio.library.models.BacktraceStackFrame;
 import backtraceio.library.models.BacktraceStackTrace;
@@ -183,6 +184,23 @@ public BacktraceReport(
         if (this.exceptionTypeReport && exception != null) {
             this.classifier = exception.getClass().getCanonicalName();
         }
+        this.setDefaultErrorTypeAttribute();
+    }
+
+    /**
+     * Sets error.type attribute depends on the type of the report
+     */
+    private void setDefaultErrorTypeAttribute() {
+        if (attributes.containsKey(BacktraceAttributeConsts.ErrorType)) {
+            // error type already set
+            return;
+        }
+
+        attributes.put(
+                BacktraceAttributeConsts.ErrorType,
+                this.exceptionTypeReport
+                        ? BacktraceAttributeConsts.HandledExceptionAttributeType
+                        : BacktraceAttributeConsts.MessageAttributeType);
     }
 
     /**
diff --git a/backtrace-library/src/main/java/backtraceio/library/watchdog/BacktraceANRWatchdog.java b/backtrace-library/src/main/java/backtraceio/library/watchdog/BacktraceANRWatchdog.java
@@ -97,6 +97,11 @@ public void setOnApplicationNotRespondingEvent(OnApplicationNotRespondingEvent
      */
     @Override
     public void run() {
+        if (debug && (Debug.isDebuggerConnected() || Debug.waitingForDebugger())) {
+            BacktraceLogger.w(LOG_TAG, "Detected a debugger connection. ANR Watchdog is disabled");
+            return;
+        }
+
         Boolean reported = false;
         while (!shouldStop && !isInterrupted()) {
             String dateTimeNow = Calendar.getInstance().getTime().toString();
@@ -122,11 +127,6 @@ public void run() {
                 continue;
             }
 
-            if (debug && (Debug.isDebuggerConnected() || Debug.waitingForDebugger())) {
-                BacktraceLogger.w(LOG_TAG, "ANR detected but will be ignored because debug mode " +
-                        "is on and connected debugger");
-                continue;
-            }
             if (reported) {
                 // skipping, because we already reported an ANR report for current ANR
                 continue;
diff --git a/backtrace-library/src/main/java/backtraceio/library/watchdog/BacktraceWatchdogShared.java b/backtrace-library/src/main/java/backtraceio/library/watchdog/BacktraceWatchdogShared.java
@@ -1,7 +1,12 @@
 package backtraceio.library.watchdog;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import backtraceio.library.BacktraceClient;
 import backtraceio.library.logger.BacktraceLogger;
+import backtraceio.library.models.BacktraceAttributeConsts;
+import backtraceio.library.models.json.BacktraceReport;
 
 /**
  * Used to share code used by objects that detect different types of blocked threads
@@ -23,7 +28,10 @@ static void sendReportCauseBlockedThread(BacktraceClient backtraceClient, Thread
         if (onApplicationNotRespondingEvent != null) {
             onApplicationNotRespondingEvent.onEvent(exception);
         } else if (backtraceClient != null) {
-            backtraceClient.send(exception);
+            BacktraceReport report = new BacktraceReport(exception, new HashMap<String, Object>() {{
+                put(BacktraceAttributeConsts.ErrorType, BacktraceAttributeConsts.AnrAttributeType);
+            }});
+            backtraceClient.send(report);
         }
     }
 }
diff --git a/backtrace-library/src/test/java/backtraceio/library/ConcatAttributesUnitTest.java b/backtrace-library/src/test/java/backtraceio/library/ConcatAttributesUnitTest.java
diff --git a/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java b/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java
