feat: Create unified Delivery interface (#299)

Gemfile.lock

@@ -1,17 +1,18 @@
 GIT
   remote: git@github.com:bugsnag/maze-runner
-  revision: 65bdcb7a135ef0a5864d03c454f7a1654f850237
+  revision: f7123450d5a75b719911c6dd3baa0507e6062c2d
   specs:
     bugsnag-maze-runner (1.0.0)
       cucumber (~> 3.1.0)
+      cucumber-expressions (= 5.0.15)
       minitest (~> 5.0)
       rack (~> 2.0.0)
       test-unit (~> 3.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    backports (3.11.1)
+    backports (3.11.3)
     builder (3.2.3)
     coderay (1.1.2)
     cucumber (3.1.0)
@@ -27,7 +28,7 @@ GEM
       backports (>= 3.8.0)
       cucumber-tag_expressions (~> 1.1.0)
       gherkin (>= 5.0.0)
-    cucumber-expressions (5.0.13)
+    cucumber-expressions (5.0.15)
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
@@ -40,7 +41,7 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.4)
+    rack (2.0.5)
     test-unit (3.2.7)
       power_assert
 

features/custom_client.feature

@@ -0,0 +1,32 @@
+Feature: Using custom API clients for reporting errors
+
+Scenario: Set a custom session client and flush a stored session
+    When I run "CustomClientSessionFlushScenario" with the defaults
+    When I force stop the "com.bugsnag.android.mazerunner" Android app
+    And I set environment variable "EVENT_TYPE" to "CustomClientSessionFlushScenario"
+    And I set environment variable "EVENT_METADATA" to "DeliverSessions"
+    And I start the "com.bugsnag.android.mazerunner" Android app using the "com.bugsnag.android.mazerunner.MainActivity" activity
+    Then I should receive 2 requests
+    And the "Custom-Client" header equals "Hello World" for request 0
+    And the "Custom-Client" header equals "Hello World" for request 1
+
+Scenario: Set a custom error API client and notify an error
+    When I run "CustomClientErrorScenario" with the defaults
+    Then I should receive 1 request
+    And the "Custom-Client" header equals "Hello World"
+    And the request is a valid for the error reporting API
+
+Scenario: Set a custom session API client and start a session
+    When I run "CustomClientSessionScenario" with the defaults
+    Then I should receive 1 request
+    And the "Custom-Client" header equals "Hello World"
+    And the request is a valid for the session tracking API
+
+Scenario: Set a custom error client and flush a stored error
+    When I run "CustomClientErrorFlushScenario" with the defaults
+    When I force stop the "com.bugsnag.android.mazerunner" Android app
+    And I set environment variable "EVENT_TYPE" to "CustomClientErrorFlushScenario"
+    And I set environment variable "EVENT_METADATA" to "DeliverReports"
+    And I start the "com.bugsnag.android.mazerunner" Android app using the "com.bugsnag.android.mazerunner.MainActivity" activity
+    Then I should receive 1 request
+    And the "Custom-Client" header equals "Hello World"

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

@@ -2,7 +2,6 @@ package com.bugsnag.android
 
 import android.content.Context
 import android.net.ConnectivityManager
-import com.bugsnag.android.Bugsnag.client
 
 /**
  * Accesses the session tracker and flushes all stored sessions
@@ -11,31 +10,62 @@ internal fun flushAllSessions() {
     Bugsnag.getClient().sessionTracker.flushStoredSessions()
 }
 
-internal fun flushErrorStoreAsync(client: Client, apiClient: ErrorReportApiClient) {
-    client.errorStore.flushAsync(apiClient)
+internal fun flushErrorStoreAsync(client: Client) {
+    client.errorStore.flushAsync()
 }
 
-internal fun flushErrorStoreOnLaunch(client: Client, apiClient: ErrorReportApiClient) {
-    client.errorStore.flushOnLaunch(apiClient)
+internal fun flushErrorStoreOnLaunch(client: Client) {
+    client.errorStore.flushOnLaunch()
 }
 
 /**
- * Creates an error API client with a 500ms delay, emulating poor network connectivity
+ * Creates a delivery API client with a 500ms delay, emulating poor network connectivity
  */
-internal fun createSlowErrorApiClient(context: Context): ErrorReportApiClient {
+internal fun createSlowDelivery(context: Context): Delivery {
     val cm = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager?
-    val defaultHttpClient = DefaultHttpClient(cm)
-
-    return ErrorReportApiClient({ url: String?,
-                                  report: Report?,
-                                  headers: MutableMap<String, String>? ->
-        Thread.sleep(500)
-        defaultHttpClient.postReport(url, report, headers)
-    })
+    val delivery = DefaultDelivery(cm)
+
+    return object : Delivery {
+        override fun deliver(payload: SessionTrackingPayload?, config: Configuration?) {
+            Thread.sleep(500)
+            delivery.deliver(payload, config)
+        }
+
+        override fun deliver(report: Report?, config: Configuration?) {
+            Thread.sleep(500)
+            delivery.deliver(report, config)
+        }
+    }
+}
+
+internal fun createDefaultDelivery(context: Context): DefaultDelivery {
+    val cm = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager?
+    return DefaultDelivery(cm)
+}
+
+internal fun createCustomHeaderDelivery(context: Context): Delivery {
+    return object : Delivery {
+        val delivery: DefaultDelivery = createDefaultDelivery(context)
+
+        override fun deliver(payload: SessionTrackingPayload?, config: Configuration?) {
+            deliver(config?.sessionEndpoint, payload, config?.sessionApiHeaders)
+        }
+
+        override fun deliver(report: Report?, config: Configuration?) {
+            deliver(config?.endpoint, report, config?.errorApiHeaders)
+        }
+
+        fun deliver(endpoint: String?,
+                    streamable: JsonStream.Streamable?,
+                    headers: MutableMap<String, String>?) {
+            headers!!["Custom-Client"] = "Hello World"
+            delivery.deliver(endpoint, streamable, headers)
+        }
+    }
 }
 
+
 internal fun writeErrorToStore(client: Client) {
     val error = Error.Builder(Configuration("api-key"), RuntimeException(), null).build()
     client.errorStore.write(error)
 }
-

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/AsyncErrorConnectivityScenario.kt

@@ -11,13 +11,13 @@ internal class AsyncErrorConnectivityScenario(config: Configuration,
                                               context: Context) : Scenario(config, context) {
 
     override fun run() {
+        val delivery = createSlowDelivery(context)
+        config.delivery = delivery
         super.run()
-        val apiClient = createSlowErrorApiClient(context)
-        Bugsnag.setErrorReportApiClient(apiClient)
 
         writeErrorToStore(Bugsnag.getClient())
-        flushErrorStoreAsync(Bugsnag.getClient(), apiClient)
-        flushErrorStoreOnLaunch(Bugsnag.getClient(), apiClient)
+        flushErrorStoreAsync(Bugsnag.getClient())
+        flushErrorStoreOnLaunch(Bugsnag.getClient())
         Thread.sleep(50)
     }
 

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/AsyncErrorDoubleFlushScenario.kt

@@ -11,13 +11,12 @@ internal class AsyncErrorDoubleFlushScenario(config: Configuration,
                                              context: Context) : Scenario(config, context) {
 
     override fun run() {
+        config.delivery = createSlowDelivery(context)
         super.run()
-        val apiClient = createSlowErrorApiClient(context)
-        Bugsnag.setErrorReportApiClient(apiClient)
 
         writeErrorToStore(Bugsnag.getClient())
-        flushErrorStoreAsync(Bugsnag.getClient(), apiClient)
-        flushErrorStoreAsync(Bugsnag.getClient(), apiClient)
+        flushErrorStoreAsync(Bugsnag.getClient())
+        flushErrorStoreAsync(Bugsnag.getClient())
         Thread.sleep(50)
     }
 

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/AsyncErrorLaunchScenario.kt

@@ -11,13 +11,12 @@ internal class AsyncErrorLaunchScenario(config: Configuration,
                                         context: Context) : Scenario(config, context) {
 
     override fun run() {
+        config.delivery = createSlowDelivery(context)
         super.run()
-        val apiClient = createSlowErrorApiClient(context)
-        Bugsnag.setErrorReportApiClient(apiClient)
 
         writeErrorToStore(Bugsnag.getClient())
-        flushErrorStoreOnLaunch(Bugsnag.getClient(), apiClient)
-        flushErrorStoreAsync(Bugsnag.getClient(), apiClient)
+        flushErrorStoreOnLaunch(Bugsnag.getClient())
+        flushErrorStoreAsync(Bugsnag.getClient())
         Thread.sleep(50)
     }
 

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/CustomClientErrorFlushScenario.kt

@@ -0,0 +1,28 @@
+package com.bugsnag.android.mazerunner.scenarios
+
+import android.content.Context
+import com.bugsnag.android.Bugsnag
+import com.bugsnag.android.Configuration
+import com.bugsnag.android.createCustomHeaderDelivery
+
+/**
+ * Sends an unhandled exception which is cached on disk to Bugsnag, then sent on a separate launch,
+ * using a custom API client which modifies the request.
+ */
+internal class CustomClientErrorFlushScenario(config: Configuration,
+                                              context: Context) : Scenario(config, context) {
+
+    override fun run() {
+        if ("DeliverReports" == eventMetaData) {
+            config.delivery = createCustomHeaderDelivery(context)
+        }
+        super.run()
+
+        if ("DeliverReports" != eventMetaData) {
+            disableAllDelivery()
+            throw RuntimeException("ReportCacheScenario")
+        }
+
+    }
+
+}

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/CustomClientErrorScenario.kt

@@ -0,0 +1,20 @@
+package com.bugsnag.android.mazerunner.scenarios
+
+import android.content.Context
+import com.bugsnag.android.Bugsnag
+import com.bugsnag.android.Configuration
+import com.bugsnag.android.createCustomHeaderDelivery
+
+/**
+ * Sends a handled exception to Bugsnag using a custom API client which modifies the request.
+ */
+internal class CustomClientErrorScenario(config: Configuration,
+                                         context: Context) : Scenario(config, context) {
+
+    override fun run() {
+        config.delivery = createCustomHeaderDelivery(context)
+        super.run()
+        Bugsnag.notify(RuntimeException("Hello"))
+    }
+
+}

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/CustomClientSessionFlushScenario.kt

@@ -0,0 +1,29 @@
+package com.bugsnag.android.mazerunner.scenarios
+
+import android.content.Context
+import com.bugsnag.android.Bugsnag
+import com.bugsnag.android.Configuration
+import com.bugsnag.android.createCustomHeaderDelivery
+import com.bugsnag.android.createDefaultDelivery
+
+/**
+ * Sends a session which is cached on disk to Bugsnag, then sent on a separate launch,
+ * using a custom API client which modifies the request.
+ */
+internal class CustomClientSessionFlushScenario(config: Configuration,
+                                                context: Context) : Scenario(config, context) {
+
+    override fun run() {
+        super.run()
+
+        if ("DeliverSessions" == eventMetaData) {
+            // simulate activity lifecycle callback occurring before api client can be set
+            Bugsnag.startSession()
+            config.delivery = createCustomHeaderDelivery(context)
+        } else {
+            disableAllDelivery()
+            Bugsnag.startSession()
+        }
+    }
+
+}

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/CustomClientSessionScenario.kt

@@ -0,0 +1,21 @@
+package com.bugsnag.android.mazerunner.scenarios
+
+import android.content.Context
+import com.bugsnag.android.Bugsnag
+import com.bugsnag.android.Configuration
+import com.bugsnag.android.createCustomHeaderDelivery
+import com.bugsnag.android.createDefaultDelivery
+
+/**
+ * Sends a session using a custom API client which modifies the request.
+ */
+internal class CustomClientSessionScenario(config: Configuration,
+                                           context: Context) : Scenario(config, context) {
+
+    override fun run() {
+        config.delivery = createCustomHeaderDelivery(context)
+        super.run()
+        Bugsnag.startSession()
+    }
+
+}

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/Scenario.kt

@@ -1,9 +1,7 @@
 package com.bugsnag.android.mazerunner.scenarios
 
 import android.content.Context
-import com.bugsnag.android.Bugsnag
-import com.bugsnag.android.Configuration
-import com.bugsnag.android.NetworkException
+import com.bugsnag.android.*
 
 abstract internal class Scenario(protected val config: Configuration,
                                  protected val context: Context) {
@@ -19,18 +17,33 @@ abstract internal class Scenario(protected val config: Configuration,
      * Sets a NOP implementation for the Session Tracking API, preventing delivery
      */
     protected fun disableSessionDelivery() {
-        Bugsnag.setSessionTrackingApiClient({ _, _, _ ->
-            throw NetworkException("Session Delivery NOP", RuntimeException("NOP"))
-        })
+        val baseDelivery = Bugsnag.getClient().config.delivery
+        Bugsnag.getClient().config.delivery = object: Delivery {
+            override fun deliver(payload: SessionTrackingPayload?, config: Configuration?) {
+                throw DeliveryFailureException("Session Delivery NOP", RuntimeException("NOP"))
+            }
+
+            override fun deliver(report: Report?, config: Configuration?) {
+                baseDelivery.deliver(report, config)
+            }
+        }
     }
 
     /**
      * Sets a NOP implementation for the Error Tracking API, preventing delivery
      */
     protected fun disableReportDelivery() {
-        Bugsnag.setErrorReportApiClient({ _, _, _ ->
-            throw NetworkException("Error Delivery NOP", RuntimeException("NOP"))
-        })
+        val baseDelivery = Bugsnag.getClient().config.delivery
+        Bugsnag.getClient().config.delivery = object: Delivery {
+            override fun deliver(payload: SessionTrackingPayload?, config: Configuration?) {
+                baseDelivery.deliver(payload, config)
+            }
+
+            override fun deliver(report: Report?, config: Configuration?) {
+                throw DeliveryFailureException("Session Delivery NOP", RuntimeException("NOP"))
+            }
+        }
+
     }
 
     /**

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

@@ -22,11 +22,10 @@ public class BreadcrumbLifecycleCrashTest {
      */
     @Before
     public void setUp() throws Exception {
-        Configuration configuration = new Configuration("api-key");
+        Configuration configuration = BugsnagTestUtils.generateConfiguration();
         Context context = InstrumentationRegistry.getContext();
         SessionStore sessionStore = new SessionStore(configuration, context);
-        SessionTrackingApiClient apiClient = BugsnagTestUtils.generateSessionTrackingApiClient();
-        sessionTracker = new SessionTracker(configuration, null, sessionStore, apiClient);
+        sessionTracker = new SessionTracker(configuration, null, sessionStore);
     }
 
     @Test