fix(ndk): moved the NDK JSON payloads back to their own directory so …

…that enabledReleaseStage & discardClasses can be checked before delivery

bugsnag-android-core/api/bugsnag-android-core.api

@@ -476,6 +476,7 @@ public class com/bugsnag/android/NativeInterface {
 	public static fun addMetadata (Ljava/lang/String;Ljava/util/Map;)V
 	public static fun clearMetadata (Ljava/lang/String;Ljava/lang/String;)V
 	public static fun createEvent (Ljava/lang/Throwable;Lcom/bugsnag/android/Client;Lcom/bugsnag/android/SeverityReason;)Lcom/bugsnag/android/Event;
+	public static fun deliverReport (Ljava/io/File;)V
 	public static fun deliverReport ([B[B[BLjava/lang/String;Z)V
 	public static fun getApp ()Ljava/util/Map;
 	public static fun getAppVersion ()Ljava/lang/String;

bugsnag-android-core/src/main/java/com/bugsnag/android/NativeInterface.java

@@ -21,6 +21,7 @@
 import java.util.Map;
 import java.util.regex.Pattern;
 
+
 /**
  * Used as the entry point for native code to allow proguard to obfuscate other areas if needed
  */
@@ -81,7 +82,15 @@ public static String getContext() {
      */
     @NonNull
     public static File getNativeReportPath() {
-        return getClient().getEventStore().getStorageDir();
+        return getNativeReportPath(getPersistenceDirectory());
+    }
+
+    private static @NonNull File getNativeReportPath(@NonNull File persistenceDirectory) {
+        return new File(persistenceDirectory, "bugsnag/native");
+    }
+
+    private static @NonNull File getPersistenceDirectory() {
+        return getClient().getConfig().getPersistenceDirectory().getValue();
     }
 
     /**
@@ -422,6 +431,25 @@ public static void deliverReport(@Nullable byte[] releaseStageBytes,
         }
     }
 
+    /**
+     * Attempt to deliver an existing event file that is not current enqueued for delivery. The
+     * filename is expected to be in the standard {@link EventFilenameInfo} format, and the file
+     * should contain a correctly formatted {@link Event} object. This method will attempt to
+     * move the file into place, and flush the queue asynchronously. If the file cannot be moved
+     * into the queue directory, the file is deleted before returning.
+     *
+     * @param reportFile the file to enqueue for delivery
+     */
+    public static void deliverReport(@NonNull File reportFile) {
+        EventStore eventStore = getClient().eventStore;
+        File eventFile = new File(eventStore.getStorageDir(), reportFile.getName());
+        if (reportFile.renameTo(eventFile)) {
+            eventStore.flushAsync();
+        } else {
+            reportFile.delete();
+        }
+    }
+
     /**
      * Notifies using the Android SDK
      *

bugsnag-android-core/src/test/java/com/bugsnag/android/NativeInterfaceApiTest.kt

@@ -7,7 +7,6 @@ import com.bugsnag.android.internal.ImmutableConfig
 import org.junit.Assert.assertArrayEquals
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNotNull
-import org.junit.Assert.assertSame
 import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
@@ -22,6 +21,7 @@ import org.mockito.Mockito.times
 import org.mockito.Mockito.verify
 import org.mockito.Mockito.`when`
 import org.mockito.junit.MockitoJUnitRunner
+import java.io.File
 import java.nio.file.Files
 
 /**
@@ -87,9 +87,10 @@ internal class NativeInterfaceApiTest {
     @Test
     fun getNativeReportPathPersistenceDirectory() {
         val customDir = Files.createTempDirectory("custom").toFile()
-        `when`(eventStore.storageDir).thenReturn(customDir)
+        `when`(immutableConfig.persistenceDirectory).thenReturn(lazy { customDir })
         val observed = NativeInterface.getNativeReportPath()
-        assertSame(customDir, observed)
+        val expected = File(customDir, "bugsnag/native")
+        assertEquals(expected, observed)
     }
 
     @Test

bugsnag-plugin-android-ndk/detekt-baseline.xml

@@ -3,9 +3,8 @@
   <ManuallySuppressedIssues/>
   <CurrentIssues>
     <ID>CyclomaticComplexMethod:NativeBridge.kt$NativeBridge$override fun onStateChange(event: StateEvent)</ID>
-    <ID>LongMethod:EventOnDiskTests.kt$EventOnDiskTests$@Test fun testEvent()</ID>
     <ID>LongParameterList:NativeBridge.kt$NativeBridge$( apiKey: String, reportingDirectory: String, lastRunInfoPath: String, eventUUID: String, consecutiveLaunchCrashes: Int, autoDetectNdkCrashes: Boolean, apiLevel: Int, is32bit: Boolean, threadSendPolicy: Int, maxBreadcrumbs: Int, )</ID>
-    <ID>NestedBlockDepth:NativeBridge.kt$NativeBridge$private fun deliverPendingReports()</ID>
+    <ID>SwallowedException:ReportDiscardScanner.kt$ReportDiscardScanner$ex: Exception</ID>
     <ID>TooManyFunctions:NativeBridge.kt$NativeBridge : StateObserver</ID>
     <ID>UseCheckOrError:ResourceUtils.kt$throw IllegalStateException("Failed to read JSON from $resourceName")</ID>
   </CurrentIssues>

bugsnag-plugin-android-ndk/src/androidTest/resources/event_serialization.json

@@ -1 +1,79 @@
-{"context":"Foo","metaData":{},"severity":"info","unhandled":true,"severityReason":{"unhandledOverridden":false,"type":"signal","attributes":{"signalType":"SIGSEGV"}},"exceptions":[{"errorClass":"SIGSEGV","message":"Whoops!","type":"c","stacktrace":[{"frameAddress":"0x0","symbolAddress":"0x0","loadAddress":"0x0","lineNumber":58,"isPC":true,"file":"Something.c","method":"foo()"}]}],"user":{"id":"123","name":"Bob Bobbiton","email":"bob@example.com"},"app":{"version":"1.0","id":"fa02","type":"C","releaseStage":"dev","versionCode":55,"buildUUID":"123","binaryArch":"x86","duration":9019,"durationInForeground":7017,"inForeground":true,"isLaunching":true},"device":{"osName":"android","id":"my-id-123","locale":"en","osVersion":"9.1","manufacturer":"Google","model":"Nexus","orientation":"portrait","runtimeVersions":{"androidApiLevel":0,"osBuild":""},"cpuAbi":[],"totalMemory":1095092340,"jailbroken":true,"time":"1970-01-01T02:06:49Z"},"breadcrumbs":[],"groupingHash":"Bar","usage":{"callbacks":{}},"session":{"id":"","startedAt":"","events":{"handled":0,"unhandled":0}}}
+{
+  "context": "Foo",
+  "metaData": {},
+  "severity": "info",
+  "unhandled": true,
+  "severityReason": {
+    "unhandledOverridden": false,
+    "type": "signal",
+    "attributes": {
+      "signalType": "SIGSEGV"
+    }
+  },
+  "exceptions": [
+    {
+      "errorClass": "SIGSEGV",
+      "message": "Whoops!",
+      "type": "c",
+      "stacktrace": [
+        {
+          "frameAddress": "0x0",
+          "symbolAddress": "0x0",
+          "loadAddress": "0x0",
+          "lineNumber": 58,
+          "isPC": true,
+          "file": "Something.c",
+          "method": "foo()"
+        }
+      ]
+    }
+  ],
+  "user": {
+    "id": "123",
+    "name": "Bob Bobbiton",
+    "email": "bob@example.com"
+  },
+  "app": {
+    "version": "1.0",
+    "id": "fa02",
+    "type": "C",
+    "releaseStage": "dev",
+    "versionCode": 55,
+    "buildUUID": "123",
+    "binaryArch": "x86",
+    "duration": 9019,
+    "durationInForeground": 7017,
+    "inForeground": true,
+    "isLaunching": true
+  },
+  "device": {
+    "osName": "android",
+    "id": "my-id-123",
+    "locale": "en",
+    "osVersion": "9.1",
+    "manufacturer": "Google",
+    "model": "Nexus",
+    "orientation": "portrait",
+    "runtimeVersions": {
+      "androidApiLevel": 0,
+      "osBuild": ""
+    },
+    "cpuAbi": [],
+    "totalMemory": 1095092340,
+    "jailbroken": true,
+    "time": "1970-01-01T02:06:49Z"
+  },
+  "breadcrumbs": [],
+  "groupingHash": "Bar",
+  "usage": {
+    "callbacks": {}
+  },
+  "session": {
+    "id": "",
+    "startedAt": "",
+    "events": {
+      "handled": 0,
+      "unhandled": 0
+    }
+  }
+}

bugsnag-plugin-android-ndk/src/main/java/com/bugsnag/android/ndk/NativeBridge.kt

@@ -8,6 +8,7 @@ import com.bugsnag.android.StateEvent.AddBreadcrumb
 import com.bugsnag.android.StateEvent.AddMetadata
 import com.bugsnag.android.StateEvent.ClearMetadataSection
 import com.bugsnag.android.StateEvent.ClearMetadataValue
+import com.bugsnag.android.StateEvent.DeliverPending
 import com.bugsnag.android.StateEvent.Install
 import com.bugsnag.android.StateEvent.NotifyHandled
 import com.bugsnag.android.StateEvent.NotifyUnhandled
@@ -107,6 +108,7 @@ class NativeBridge(private val bgTaskService: BackgroundTaskService) : StateObse
 
         when (event) {
             is Install -> handleInstallMessage(event)
+            is DeliverPending -> deliverPendingReports()
             is AddMetadata -> handleAddMetadata(event)
             is ClearMetadataSection -> clearMetadataTab(event.section)
             is ClearMetadataValue -> removeMetadata(
@@ -169,6 +171,17 @@ class NativeBridge(private val bgTaskService: BackgroundTaskService) : StateObse
         }
     }
 
+    private fun deliverPendingReports() {
+        val discardScanner = ReportDiscardScanner(logger)
+        reportDirectory.listFiles()?.forEach { reportFile ->
+            if (discardScanner.shouldDiscard(reportFile)) {
+                reportFile.delete()
+            } else {
+                NativeInterface.deliverReport(reportFile)
+            }
+        }
+    }
+
     private fun isInvalidMessage(msg: Any?): Boolean {
         if (msg == null || msg !is StateEvent) {
             return true

bugsnag-plugin-android-ndk/src/main/java/com/bugsnag/android/ndk/ReportDiscardScanner.kt

@@ -0,0 +1,125 @@
+package com.bugsnag.android.ndk
+
+import android.util.JsonReader
+import android.util.JsonToken
+import com.bugsnag.android.Logger
+import com.bugsnag.android.NativeInterface
+import java.io.File
+
+internal class ReportDiscardScanner(private val logger: Logger) {
+    /**
+     * Checks whether a given report file should be discarded due to its `releaseStage` or any of
+     * the configured `discardClasses`.
+     *
+     * @return true if the report should be discarded instead of being sent
+     */
+    fun shouldDiscard(report: File): Boolean {
+        return try {
+            report.bufferedReader().use { reader ->
+                JsonReader(reader).use { json -> shouldDiscard(json) }
+            }
+        } catch (ex: Exception) {
+            false
+        }
+    }
+
+    private fun shouldDiscard(json: JsonReader): Boolean {
+        json.beginObject()
+        var pendingAppCheck = true
+        var pendingExceptionsCheck = true
+
+        while (json.hasNext() && (pendingAppCheck || pendingExceptionsCheck)) {
+            val nextName = json.nextName()
+            val discard: Boolean = when (nextName) {
+                "app" -> {
+                    pendingAppCheck = false
+                    shouldDiscardForApp(json)
+                }
+
+                "exceptions" -> {
+                    pendingExceptionsCheck = false
+                    shouldDiscardForExceptions(json)
+                }
+
+                else -> {
+                    json.skipValue()
+                    false
+                }
+            }
+
+            if (discard) {
+                return true
+            }
+        }
+
+        return false
+    }
+
+    private fun shouldDiscardForApp(json: JsonReader): Boolean {
+        val enabledReleaseStages = NativeInterface.getEnabledReleaseStages()
+        if (enabledReleaseStages.isNullOrEmpty()) {
+            json.skipValue()
+            return false
+        }
+
+        json.beginObject()
+        while (json.peek() != JsonToken.END_OBJECT) {
+            val nextName = json.nextName()
+            when (nextName) {
+                "releaseStage" -> {
+                    val releaseStage = json.nextString()
+                    if (releaseStage !in enabledReleaseStages) {
+                        logger.d("Discarding native report due to releaseStage")
+                        return true
+                    }
+                    // do not early exit, make sure the entire "app" object is consumed
+                    // before returning
+                }
+
+                else -> json.skipValue()
+            }
+        }
+        json.endObject()
+
+        return false
+    }
+
+    private fun shouldDiscardForExceptions(json: JsonReader): Boolean {
+        json.beginArray()
+
+        while (json.peek() != JsonToken.END_ARRAY) {
+            if (shouldDiscardException(json)) {
+                logger.d("Discarding native report due to errorClass")
+                return true
+            }
+        }
+
+        json.endArray()
+
+        return false
+    }
+
+    private fun shouldDiscardException(json: JsonReader): Boolean {
+        json.beginObject()
+
+        while (json.peek() != JsonToken.END_OBJECT) {
+            val name = json.nextName()
+            when (name) {
+                "errorClass" -> {
+                    val errorClass = json.nextString()
+                    if (NativeInterface.isDiscardErrorClass(errorClass)) {
+                        return true
+                    }
+                    // do not early exit, make sure the entire "exception" object is consumed
+                    // before returning
+                }
+
+                else -> json.skipValue()
+            }
+        }
+
+        json.endObject()
+
+        return false
+    }
+}

bugsnag-plugin-android-ndk/src/main/jni/utils/serializer/event_writer.c

@@ -193,8 +193,13 @@ static bool bsg_write_metadata_value(BSG_KSJSONEncodeContext *json,
     CHECKED(JSON_LIMITED_STRING_ELEMENT(value->name, value->char_value));
     break;
   case BSG_METADATA_NUMBER_VALUE:
-    CHECKED(bsg_ksjsonaddFloatingPointElement(json, value->name,
-                                              value->double_value));
+    if (value->double_value == (double)((long long)value->double_value)) {
+      CHECKED(bsg_ksjsonaddIntegerElement(json, value->name,
+                                          (long long)value->double_value));
+    } else {
+      CHECKED(bsg_ksjsonaddFloatingPointElement(json, value->name,
+                                                value->double_value));
+    }
     break;
   case BSG_METADATA_OPAQUE_VALUE:
     CHECKED(bsg_ksjsonbeginElement(json, value->name));