Read projectPackages array when serialising error reports

CHANGELOG.md

@@ -7,6 +7,9 @@
 * Prevent NPE occurring when calling resumeSession()
 [#444](https://github.com/bugsnag/bugsnag-android/pull/444)
 
+* Read projectPackages array when serialising error reports
+[#451](https://github.com/bugsnag/bugsnag-android/pull/451)
+
 ## 4.12.0 (2019-02-27)
 
 ### Enhancements

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

@@ -126,6 +126,7 @@ public void testShouldIgnore() {
         assertTrue(config.shouldIgnoreClass(className));
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void testInProject() {
         // Shouldn't be inProject if projectPackages hasn't been set

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

@@ -27,16 +27,21 @@ public class StacktraceTest {
 
     private Configuration config;
     private Throwable exception;
+    private String[] projectPackages;
 
+    /**
+     * Creates an initial exception
+     */
     @Before
     public void setUp() throws Exception {
         config = new Configuration("api-key");
         exception = new RuntimeException("oops");
+        projectPackages = config.getProjectPackages();
     }
 
     @Test
     public void testBasicException() throws JSONException, IOException {
-        Stacktrace stacktrace = new Stacktrace(config, exception.getStackTrace());
+        Stacktrace stacktrace = new Stacktrace(exception.getStackTrace(), projectPackages);
         JSONArray stacktraceJson = streamableToJsonArray(stacktrace);
 
         JSONObject firstFrame = (JSONObject) stacktraceJson.get(0);
@@ -50,7 +55,7 @@ public void testBasicException() throws JSONException, IOException {
     public void testInProject() throws JSONException, IOException {
         config.setProjectPackages(new String[]{"com.bugsnag.android"});
 
-        Stacktrace stacktrace = new Stacktrace(config, exception.getStackTrace());
+        Stacktrace stacktrace = new Stacktrace(exception.getStackTrace(), projectPackages);
         JSONArray stacktraceJson = streamableToJsonArray(stacktrace);
 
         JSONObject firstFrame = (JSONObject) stacktraceJson.get(0);
@@ -62,27 +67,31 @@ public void testStacktraceTrimming() throws Throwable {
         List<StackTraceElement> elements = new ArrayList<>();
 
         for (int k = 0; k < 1000; k++) {
-            elements.add(new StackTraceElement("SomeClass", "someMethod", "someFile", k));
+            elements.add(new StackTraceElement("SomeClass",
+                "someMethod", "someFile", k));
         }
 
         StackTraceElement[] ary = new StackTraceElement[elements.size()];
-        Stacktrace stacktrace = new Stacktrace(config, elements.toArray(ary));
+        Stacktrace stacktrace = new Stacktrace(elements.toArray(ary), projectPackages);
         JSONArray jsonArray = streamableToJsonArray(stacktrace);
         assertEquals(200, jsonArray.length());
     }
 
     @Test
     public void testClassNameResolution() throws JSONException, IOException {
-        JSONArray stacktraceJson = streamableToJsonArray(
-            new Stacktrace(config, new StackTraceElement[] {
-                new StackTraceElement("SomeClass", "someMethod", "someFile", 12)}));
+        StackTraceElement[] stackTraceElements = {
+            new StackTraceElement("SomeClass", "someMethod", "someFile", 12)};
+        Stacktrace stacktrace = new Stacktrace(stackTraceElements, projectPackages);
+        JSONArray stacktraceJson = streamableToJsonArray(stacktrace);
 
         JSONObject frame = (JSONObject) stacktraceJson.get(0);
         assertEquals("SomeClass.someMethod", frame.get("method"));
 
-        stacktraceJson = streamableToJsonArray(
-            new Stacktrace(config, new StackTraceElement[] {
-                new StackTraceElement("", "someMethod", "someFile", 12)}));
+        StackTraceElement stackTraceElement = new StackTraceElement("",
+            "someMethod", "someFile", 12);
+        Stacktrace stacktrace1 = new Stacktrace(
+            new StackTraceElement[]{stackTraceElement}, projectPackages);
+        stacktraceJson = streamableToJsonArray(stacktrace1);
 
         frame = (JSONObject) stacktraceJson.get(0);
         assertEquals("someMethod", frame.get("method"));

sdk/src/main/java/com/bugsnag/android/Bugsnag.java

@@ -203,7 +203,9 @@ public static void setNotifyReleaseStages(@Nullable final String... notifyReleas
      * By default, we'll mark the current package name as part of you app.
      *
      * @param projectPackages a list of package names
+     * @deprecated use {{@link Configuration#setProjectPackages(String[])}} instead
      */
+    @Deprecated
     public static void setProjectPackages(@Nullable final String... projectPackages) {
         getClient().setProjectPackages(projectPackages);
     }

sdk/src/main/java/com/bugsnag/android/CachedThread.java

@@ -31,7 +31,7 @@ public void toStream(@NonNull JsonStream writer) throws IOException {
         writer.name("id").value(id);
         writer.name("name").value(name);
         writer.name("type").value(type);
-        writer.name("stacktrace").value(new Stacktrace(config, frames));
+        writer.name("stacktrace").value(new Stacktrace(frames, config.getProjectPackages()));
         if (isErrorReportingThread) {
             writer.name("errorReportingThread").value(true);
         }

sdk/src/main/java/com/bugsnag/android/Client.java

@@ -473,7 +473,9 @@ public void setNotifyReleaseStages(@Nullable String... notifyReleaseStages) {
      * By default, we'll mark the current package name as part of you app.
      *
      * @param projectPackages a list of package names
+     * @deprecated use {{@link Configuration#setProjectPackages(String[])}} instead
      */
+    @Deprecated
     public void setProjectPackages(@Nullable String... projectPackages) {
         config.setProjectPackages(projectPackages);
     }

sdk/src/main/java/com/bugsnag/android/Configuration.java

@@ -754,16 +754,10 @@ protected void beforeRecordBreadcrumb(@NonNull BeforeRecordBreadcrumb beforeReco
      * @param className the class to check
      * @return true if the class should be considered in the project else false
      */
+    @Deprecated
     protected boolean inProject(@NonNull String className) {
-        if (projectPackages != null) {
-            for (String packageName : projectPackages) {
-                if (packageName != null && className.startsWith(packageName)) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
+        Stacktrace stacktrace = new Stacktrace(new StackTraceElement[]{}, projectPackages);
+        return stacktrace.inProject(className);
     }
 
     /**

sdk/src/main/java/com/bugsnag/android/Error.java

@@ -41,7 +41,7 @@ public class Error implements JsonStream.Streamable {
 
     @NonNull
     final Configuration config;
-    private final String[] projectPackages;
+    private String[] projectPackages;
     private final Exceptions exceptions;
     private Breadcrumbs breadcrumbs;
     private final Throwable exception;
@@ -382,6 +382,17 @@ Session getSession() {
         return session;
     }
 
+    String[] getProjectPackages() {
+        return projectPackages;
+    }
+
+    void setProjectPackages(String[] projectPackages) {
+        this.projectPackages = projectPackages;
+        if (exceptions != null) {
+            exceptions.setProjectPackages(projectPackages);
+        }
+    }
+
     static class Builder {
         private final Configuration config;
         private final Throwable exception;

sdk/src/main/java/com/bugsnag/android/ErrorReader.java

@@ -7,6 +7,7 @@
 import java.io.FileReader;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
@@ -39,6 +40,7 @@ static Error readError(@NonNull Configuration config, @NonNull File errorFile)
             ThreadState threadState = null;
             Breadcrumbs crumbs = null;
             ArrayList<String> severityReasonValues = null;
+            List<String> projectPackages = Collections.emptyList();
             boolean unhandled = false;
 
             reader = new JsonReader(new FileReader(errorFile));
@@ -57,6 +59,9 @@ static Error readError(@NonNull Configuration config, @NonNull File errorFile)
                     case "device":
                         deviceData = jsonObjectToMap(reader);
                         break;
+                    case "projectPackages":
+                        projectPackages = jsonArrayToList(reader);
+                        break;
                     case "exceptions":
                         exceptions = readExceptions(config, reader);
                         break;
@@ -97,9 +102,11 @@ static Error readError(@NonNull Configuration config, @NonNull File errorFile)
                 : null;
             HandledState handledState = new HandledState(severityReasonValues.get(0), severity,
                                                          unhandled, severityReasonAttribute);
+
             Error error = new Error(config, exceptions.getException(), handledState, severity,
                                     session, threadState);
             error.getExceptions().setExceptionType(exceptions.getExceptionType());
+            error.setProjectPackages(projectPackages.toArray(new String[]{}));
             error.setUser(user);
             error.setContext(context);
             error.setGroupingHash(groupingHash);
@@ -445,11 +452,11 @@ private static Map<String, Object> jsonObjectToMap(JsonReader reader) throws IOE
         return data;
     }
 
-    private static List<Object> jsonArrayToList(JsonReader reader) throws IOException {
-        List<Object> objects = new ArrayList<>();
+    private static <T> List<T> jsonArrayToList(JsonReader reader) throws IOException {
+        List<T> objects = new ArrayList<>();
         reader.beginArray();
         while (reader.hasNext()) {
-            Object value = coerceSerializableFromJSON(reader);
+            T value = coerceSerializableFromJSON(reader);
             if (value != null) {
                 objects.add(value);
             }
@@ -458,26 +465,27 @@ private static List<Object> jsonArrayToList(JsonReader reader) throws IOExceptio
         return objects;
     }
 
-    private static Object coerceSerializableFromJSON(JsonReader reader) throws IOException {
+    @SuppressWarnings("unchecked")
+    private static <T> T coerceSerializableFromJSON(JsonReader reader) throws IOException {
         switch (reader.peek()) {
             case BEGIN_OBJECT:
-                return jsonObjectToMap(reader);
+                return (T) jsonObjectToMap(reader);
             case STRING:
-                return reader.nextString();
+                return (T) reader.nextString();
             case BOOLEAN:
-                return reader.nextBoolean();
+                return (T)(Boolean) reader.nextBoolean();
             case NUMBER:
                 try {
-                    return reader.nextInt();
+                    return (T)(Integer) reader.nextInt();
                 } catch (NumberFormatException ex) {
                     try {
-                        return reader.nextLong();
+                        return (T)(Long) reader.nextLong();
                     } catch (NumberFormatException ex2) {
-                        return reader.nextDouble();
+                        return (T)(Double) reader.nextDouble();
                     }
                 }
             case BEGIN_ARRAY:
-                return jsonArrayToList(reader);
+                return (T) jsonArrayToList(reader);
             default:
                 return null;
         }

sdk/src/main/java/com/bugsnag/android/Exceptions.java

@@ -3,6 +3,8 @@
 import android.support.annotation.NonNull;
 
 import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
 
 /**
  * Unwrap and serialize exception information and any "cause" exceptions.
@@ -11,11 +13,13 @@ class Exceptions implements JsonStream.Streamable {
     private final Configuration config;
     private final Throwable exception;
     private String exceptionType;
+    private String[] projectPackages;
 
     Exceptions(Configuration config, Throwable exception) {
         this.config = config;
         this.exception = exception;
         exceptionType = Configuration.DEFAULT_EXCEPTION_TYPE;
+        projectPackages = config.getProjectPackages();
     }
 
     @Override
@@ -51,6 +55,14 @@ void setExceptionType(@NonNull String type) {
         exceptionType = type;
     }
 
+    String[] getProjectPackages() {
+        return projectPackages;
+    }
+
+    void setProjectPackages(String[] projectPackages) {
+        this.projectPackages = projectPackages;
+    }
+
     /**
      * Get the class name from the exception contained in this Error report.
      */
@@ -71,7 +83,7 @@ private void exceptionToStream(@NonNull JsonStream writer,
         writer.name("message").value(message);
         writer.name("type").value(exceptionType);
 
-        Stacktrace stacktrace = new Stacktrace(config, frames);
+        Stacktrace stacktrace = new Stacktrace(frames, projectPackages);
         writer.name("stacktrace").value(stacktrace);
         writer.endObject();
     }

sdk/src/main/java/com/bugsnag/android/Stacktrace.java

@@ -3,6 +3,9 @@
 import android.support.annotation.NonNull;
 
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 
 /**
  * Serialize an exception stacktrace and mark frames as "in-project"
@@ -12,12 +15,14 @@ class Stacktrace implements JsonStream.Streamable {
 
     private static final int STACKTRACE_TRIM_LENGTH = 200;
 
-    final Configuration config;
+    private final List<String> projectPackages = new ArrayList<>();
     final StackTraceElement[] stacktrace;
 
-    Stacktrace(Configuration config, StackTraceElement[] stacktrace) {
-        this.config = config;
+    Stacktrace(StackTraceElement[] stacktrace, String[] projectPackages) {
         this.stacktrace = stacktrace;
+        if (projectPackages != null) {
+            this.projectPackages.addAll(Arrays.asList(projectPackages));
+        }
     }
 
     @Override
@@ -36,7 +41,7 @@ public void toStream(@NonNull JsonStream writer) throws IOException {
                 writer.name("file").value(el.getFileName() == null ? "Unknown" : el.getFileName());
                 writer.name("lineNumber").value(el.getLineNumber());
 
-                if (config.inProject(el.getClassName())) {
+                if (inProject(el.getClassName())) {
                     writer.name("inProject").value(true);
                 }
 
@@ -48,4 +53,13 @@ public void toStream(@NonNull JsonStream writer) throws IOException {
 
         writer.endArray();
     }
+
+    boolean inProject(String className) {
+        for (String packageName : projectPackages) {
+            if (packageName != null && className.startsWith(packageName)) {
+                return true;
+            }
+        }
+        return false;
+    }
 }