Expose crash hook callback

Author: FranAguilera

Cargo.Bazel.lock

@@ -19,35 +19,35 @@ android_logger = { version = "0.15.1", default-features = false }
 anyhow = "1.0.102"
 assert_matches = "1.5.0"
 async-trait = "0.1.89"
-bd-api = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-bonjson = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-bonjson-ffi = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-buffer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-client-common = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-client-stats-store = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-crash-handler = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-device = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-error-reporter = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-grpc = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-hyper-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67", default-features = false, features = [
+bd-api = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-bonjson = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-bonjson-ffi = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-buffer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-client-common = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-client-stats-store = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-crash-handler = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-device = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-error-reporter = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-grpc = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-hyper-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6", default-features = false, features = [
   "ring",
 ] }
-bd-key-value = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-log = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-log-metadata = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-log-primitives = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-logger = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-noop-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-proto = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-report-parsers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-report-writer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-runtime = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-session = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-shutdown = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
-bd-test-helpers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67", default-features = false, features = [
+bd-key-value = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-log = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-log-metadata = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-log-primitives = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-logger = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-noop-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-proto = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-report-parsers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-report-writer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-runtime = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-session = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-shutdown = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
+bd-test-helpers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6", default-features = false, features = [
   "ring",
 ] }
-bd-time = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "eb85d1790ff9374dbe7ea778f70337ef5ab15f67" }
+bd-time = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "5f38dc4d9e3c993ee5315209c2519a9a8030a0e6" }
 clap = { version = "4.5.60", features = ["derive", "env"] }
 ctor = "0.6.3"
 env_logger = { version = "0.11.9", default-features = false }

Cargo.lock

@@ -64,6 +64,15 @@
    public <methods>;
 }
 
+# Accessed reflectively from Rust/JNI (class/method names must remain stable).
+-keep class io.bitdrift.capture.reports.IssueCallbackConfiguration {
+   public void dispatch(io.bitdrift.capture.reports.Report);
+}
+
+-keep class io.bitdrift.capture.reports.Report {
+   public <init>(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map);
+}
+
 -keep, includedescriptorclasses class io.bitdrift.capture.IEventsListenerTarget {
    public <methods>;
 }
@@ -126,4 +135,4 @@
 -keep class io.bitdrift.capture.webview.WebViewCapture {
     public static void instrument(android.webkit.WebView);
     public static void instrument(android.webkit.WebView, io.bitdrift.capture.ILogger);
-}
+}

Cargo.toml

@@ -12,6 +12,7 @@ import io.bitdrift.capture.error.IErrorReporter
 import io.bitdrift.capture.network.ICaptureNetwork
 import io.bitdrift.capture.providers.Field
 import io.bitdrift.capture.providers.session.SessionStrategyConfiguration
+import io.bitdrift.capture.reports.IssueCallbackConfiguration
 import io.bitdrift.capture.reports.processor.IStreamingReportProcessor
 import io.bitdrift.capture.reports.processor.ReportProcessingSession
 import okio.IOException
@@ -71,6 +72,7 @@ internal object CaptureJniLibrary : IBridge, IStreamingReportProcessor {
         preferences: IPreferences,
         errorReporter: IErrorReporter,
         startInSleepMode: Boolean,
+        issueCallbackConfiguration: IssueCallbackConfiguration?,
     ): Long
 
     /**

platform/jvm/capture/consumer-rules.pro

@@ -9,18 +9,21 @@ package io.bitdrift.capture
 
 import io.bitdrift.capture.experimental.ExperimentalBitdriftApi
 import io.bitdrift.capture.replay.SessionReplayConfiguration
+import io.bitdrift.capture.reports.IssueCallbackConfiguration
 import io.bitdrift.capture.webview.WebViewConfiguration
 
 /**
  * A configuration object representing the feature set enabled for Capture.
  * @param sessionReplayConfiguration The resource reporting configuration to use. Passing `null` disables the feature.
- * @param enableFatalIssueReporting When set to true wil capture Fatal Issues automatically [JVM crash, ANR, etc] and without requiring
- * any external 3rd party library integration
+ * @param enableFatalIssueReporting When set to true captures fatal issues automatically (JVM crash, ANR, etc.)
+ *                                  without requiring third-party integrations.
  * @param sleepMode SleepMode.ENABLED if Capture should initialize in minimal activity mode
  * @param webViewConfiguration The WebView instrumentation configuration. Requires the `io.bitdrift.capture-plugin`
  *                             Gradle plugin with `automaticWebViewInstrumentation = true` enabled.
  *                             Passing `null` disables WebView monitoring.
-*/
+ * @param issueCallbackConfiguration Optional callback configuration used for issue report callbacks.
+ *                                   This is only effective when [enableFatalIssueReporting] is true.
+ */
 data class Configuration
     @JvmOverloads
     constructor(
@@ -29,4 +32,5 @@ data class Configuration
         val sleepMode: SleepMode = SleepMode.DISABLED,
         @property:ExperimentalBitdriftApi
         val webViewConfiguration: WebViewConfiguration? = null,
+        val issueCallbackConfiguration: IssueCallbackConfiguration? = null,
     )

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/CaptureJniLibrary.kt

@@ -10,6 +10,7 @@ package io.bitdrift.capture
 import io.bitdrift.capture.error.IErrorReporter
 import io.bitdrift.capture.network.ICaptureNetwork
 import io.bitdrift.capture.providers.session.SessionStrategyConfiguration
+import io.bitdrift.capture.reports.IssueCallbackConfiguration
 
 internal interface IBridge {
     fun createLogger(
@@ -27,5 +28,6 @@ internal interface IBridge {
         preferences: IPreferences,
         errorReporter: IErrorReporter,
         startInSleepMode: Boolean,
+        issueCallbackConfiguration: IssueCallbackConfiguration?,
     ): Long
 }

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/Configuration.kt

@@ -210,6 +210,7 @@ internal class LoggerImpl(
                 preferences,
                 localErrorReporter,
                 configuration.sleepMode == SleepMode.ENABLED,
+                if (configuration.enableFatalIssueReporting) configuration.issueCallbackConfiguration else null,
             )
 
         check(loggerId != -1L) { "initialization of the rust logger failed" }

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/IBridge.kt

@@ -0,0 +1,91 @@
+// capture-sdk - bitdrift's client SDK
+// Copyright Bitdrift, Inc. All rights reserved.
+//
+// Use of this source code is governed by a source available license that can be found in the
+// LICENSE file or at:
+// https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt
+
+package io.bitdrift.capture.reports
+
+import android.util.Log
+import io.bitdrift.capture.Capture
+import io.bitdrift.capture.Capture.LOG_TAG
+import io.bitdrift.capture.IInternalLogger
+import java.util.concurrent.Executor
+import kotlin.jvm.JvmName
+
+/**
+ * Configuration for issue report callbacks.
+ *
+ * Use this to provide:
+ * - the executor where callbacks run
+ * - the callback that receives issue report metadata before send
+ *
+ * @param executor Executor used to run callback invocations.
+ * @param issueReportCallback Callback invoked before an issue report is sent.
+ */
+class IssueCallbackConfiguration(
+    private val executor: Executor,
+    private val issueReportCallback: IssueReportCallback,
+) {
+    /**
+     * Dispatches the callback on the configured executor from the JNI layer
+     */
+    @Suppress("unused")
+    @JvmName("dispatch")
+    internal fun dispatch(report: Report) {
+        runSafely("Issue report callback dispatch failed") {
+            executor.execute { invokeCallback(report) }
+        }
+    }
+
+    private fun invokeCallback(report: Report) {
+        runSafely("Issue report callback failed") {
+            issueReportCallback.onBeforeReportSend(report)
+        }
+    }
+
+    private inline fun runSafely(
+        message: String,
+        action: () -> Unit,
+    ) {
+        runCatching(action).onFailure { handleFailure(message, it) }
+    }
+
+    private fun handleFailure(
+        message: String,
+        throwable: Throwable,
+    ) {
+        Log.e(LOG_TAG, message, throwable)
+        getInternalLogger()?.logInternalError(throwable) { message }
+    }
+
+    private fun getInternalLogger(): IInternalLogger? = Capture.logger() as? IInternalLogger
+}
+
+/**
+ * Issue report metadata delivered to [IssueReportCallback] before send.
+ *
+ * @param reportType High-level issue type (for example "ANR", "Native Crash", "Crash").
+ * @param reason Primary issue identifier (for example exception class or signal name).
+ * @param details Additional issue details (for example exception message).
+ * @param sessionId bitdrift session ID associated with the report.
+ * @param fields Additional report fields available at callback time.
+ */
+data class Report(
+    val reportType: String,
+    val reason: String,
+    val details: String,
+    val sessionId: String,
+    val fields: Map<String, String>,
+)
+
+/**
+ * Callback invoked before an issue report (crash, ANR, etc.) is sent.
+ */
+fun interface IssueReportCallback {
+    /**
+     * Called before an issue report is sent.
+     */
+    fun onBeforeReportSend(report: Report)
+}

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/LoggerImpl.kt

@@ -92,6 +92,7 @@ class CaptureLoggerNetworkTest {
                 mock(),
                 mock(),
                 false,
+                null,
             )
         CaptureJniLibrary.startLogger(logger)
         return logger
@@ -175,6 +176,7 @@ class CaptureLoggerNetworkTest {
                 mock(),
                 mock(),
                 false,
+                null,
             )
         CaptureJniLibrary.startLogger(loggerId)
         logger = loggerId
@@ -211,6 +213,7 @@ class CaptureLoggerNetworkTest {
                 MockPreferences(),
                 mock(),
                 false,
+                null,
             )
         CaptureJniLibrary.startLogger(logger)