[FatalIssueReporter] Preparing for BuiltIn Release

format check

Bump latest shared core

Author: FranAguilera

Cargo.Bazel.lock

@@ -18,29 +18,29 @@ android_logger = { version = "0.15.0", default-features = false }
 anyhow = "1.0.98"
 assert_matches = "1.5.0"
 async-trait = "0.1.88"
-bd-api = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-buffer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-client-common = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-client-stats-store = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-crash-handler = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-device = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-grpc = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-hyper-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-key-value = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-log = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-log-metadata = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-log-primitives = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-logger = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-noop-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-proto = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-report-writer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-runtime = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-session = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-shutdown = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
-bd-test-helpers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09", default-features = false }
-bd-time = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "87e485ecc69bada556139b9c6ffd3d8585920f09" }
+bd-api = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-buffer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-client-common = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-client-stats-store = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-crash-handler = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-device = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-grpc = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-hyper-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-key-value = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-log = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-log-metadata = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-log-primitives = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-logger = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-noop-network = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-proto = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-report-writer = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-runtime = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-session = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-shutdown = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
+bd-test-helpers = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286", default-features = false }
+bd-time = { git = "https://github.com/bitdriftlabs/shared-core.git", rev = "7317b2475b46c3635f83717c709cab7e045a3286" }
 chrono = "0.4.41"
-clap = { version = "4.5.38", features = ["derive", "env"] }
+clap = { version = "4.5.37", features = ["derive", "env"] }
 ctor = "0.4.2"
 env_logger = { version = "0.11.8", default-features = false }
 jni = "0.21.1"

Cargo.lock

@@ -30,7 +30,7 @@ class HelloWorldApp : Application() {
         super.onCreate()
 
         @OptIn(ExperimentalBitdriftApi::class)
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(fatalIssueMechanism = FatalIssueMechanism.BuiltIn)
 
         setupExampleCrashHandler()
 

Cargo.toml

@@ -55,6 +55,7 @@ bitdrift_kt_android_local_test(
     ],
     data = [
         "//test/platform/jvm:capture",
+        "//platform/jvm/capture/src/test/resources:test_resources",
     ],
     jvm_flags = [
         "-Djava.library.path=test/platform/jvm",

examples/android/HelloWorldApp.kt

@@ -110,11 +110,10 @@ object Capture {
         @ExperimentalBitdriftApi
         @JvmStatic
         @JvmOverloads
-        fun initFatalIssueReporting(context: Context? = null) {
-            // TODO:(FranAguilera) BIT-5401: To allow passing fatalIssueMechanism config once
-            // we are ready to ship [io.bitdrift.capture.reports.FatalIssueMechanism.BuiltIn]
-            val fatalIssueMechanism = FatalIssueMechanism.Integration
-
+        fun initFatalIssueReporting(
+            context: Context? = null,
+            fatalIssueMechanism: FatalIssueMechanism,
+        ) {
             if (context == null && !ContextHolder.isInitialized) {
                 Log.w(LOG_TAG, "Attempted to initialize Fatal Issue Reporting with a null context. Skipping enabling crash tracking.")
                 return

platform/jvm/capture/BUILD.bazel

@@ -26,9 +26,9 @@ internal class FatalIssueReporterStorage(
 
     private fun mapToReadableType(reportType: Byte): String =
         when (reportType) {
-            ReportType.AppNotResponding -> "ANR"
-            ReportType.JVMCrash -> "JVM_CRASH"
-            ReportType.NativeCrash -> "NATIVE_CRASH"
-            else -> "UNKNOWN"
+            ReportType.AppNotResponding -> "anr"
+            ReportType.JVMCrash -> "crash"
+            ReportType.NativeCrash -> "native_crash"
+            else -> "Unknown"
         }
 }

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

@@ -51,10 +51,10 @@ internal object AppExitAnrTraceProcessor {
                 }
             }
 
-        val name = description?.let { builder.createString(it) } ?: 0
         val trace = Error.createStackTraceVector(builder, mainStackTraceFrames.toIntArray())
         val reason = builder.createString(AnrReason.extractFrom(description).readableType)
-        val error = Error.createError(builder, name, reason, trace, ErrorRelation.CausedBy)
+        val name = description?.let { builder.createString(it) } ?: 0
+        val error = Error.createError(builder, reason, name, trace, ErrorRelation.CausedBy)
 
         return Report.createReport(
             builder,

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/reports/persistence/FatalIssueReporterStorage.kt

@@ -26,8 +26,14 @@ import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.annotation.Config
+import java.io.InputStream
 import java.nio.ByteBuffer
+import java.nio.file.Paths
 
+/**
+ * WARNING: For now these test only run on bazel given the difference between accessing
+ * test resources on gradle vs Bazel
+ */
 @RunWith(RobolectricTestRunner::class)
 @Config(sdk = [31])
 class FatalIssueReporterProcessorTest {
@@ -77,14 +83,14 @@ class FatalIssueReporterProcessorTest {
             "persistJvmCrash_withFakeException_shouldCreateNonEmptyErrorModel",
         )
         assertThat(error.stackTrace(0)!!.sourceFile!!.path).isEqualTo("FatalIssueReporterProcessorTest.kt")
-        assertThat(error.stackTrace(0)!!.sourceFile!!.line).isEqualTo(50)
+        assertThat(error.stackTrace(0)!!.sourceFile!!.line).isEqualTo(56)
         assertThat(error.stackTrace(0)!!.sourceFile!!.column).isEqualTo(0)
     }
 
     @Test
     fun persistAppExitReport_whenAnr_shouldCreateNonEmptyErrorModel() {
         val description = APP_EXIT_DESCRIPTION_ANR
-        val traceInputStream = createTraceInputStream(APP_EXIT_VALID_ANR_TRACE)
+        val traceInputStream = buildTraceInputStringFromFile("app_exit_anr_deadlock_anr.txt")
 
         fatalIssueReporterProcessor.persistAppExitReport(
             fatalIssueType = ReportType.AppNotResponding,
@@ -101,8 +107,8 @@ class FatalIssueReporterProcessorTest {
         val buffer = ByteBuffer.wrap(fatalIssueReportCaptor.firstValue)
         val report = Report.getRootAsReport(buffer)
         val error = report.errors(0)!!
-        assertThat(error.name).isEqualTo(APP_EXIT_DESCRIPTION_ANR)
-        assertThat(error.reason).isEqualTo("User Perceived ANR")
+        assertThat(error.name).isEqualTo("User Perceived ANR")
+        assertThat(error.reason).isEqualTo(APP_EXIT_DESCRIPTION_ANR)
         assertThat(error.stackTrace(0)!!.type).isEqualTo(1)
         assertThat(error.stackTrace(0)!!.stateLength).isEqualTo(0)
         assertThat(error.stackTrace(0)!!.className).isEqualTo("io.bitdrift.capture.FatalIssueGenerator")
@@ -116,7 +122,7 @@ class FatalIssueReporterProcessorTest {
     fun persistAppExitReport_whenUserPerceivedAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "Input Dispatching Timed Out",
-            expectedReasonMessage = "User Perceived ANR",
+            expectedMessage = "User Perceived ANR",
         )
     }
 
@@ -126,7 +132,7 @@ class FatalIssueReporterProcessorTest {
             descriptionFromAppExit =
                 "Broadcast of Intent { act=android.intent.action.MAIN " +
                     "cmp=com.example.app/.MainActivity}",
-            expectedReasonMessage = "Broadcast Receiver ANR",
+            expectedMessage = "Broadcast Receiver ANR",
         )
     }
 
@@ -136,71 +142,71 @@ class FatalIssueReporterProcessorTest {
             descriptionFromAppExit =
                 "Executing service. { act=android.intent.action.MAIN \" +\n" +
                     "                    \"cmp=com.example.app/.MainActivity}",
-            expectedReasonMessage = "Executing Service ANR",
+            expectedMessage = "Executing Service ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenStartServiceForegroundAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "Service.StartForeground() not called.{ act=android.intent.action.MAIN}",
-            expectedReasonMessage = "Service.startForeground() Not Called ANR",
+            expectedMessage = "Service.startForeground() Not Called ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenContentProviderTimeoutAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "My Application. Content Provider Timeout",
-            expectedReasonMessage = "Content Provider ANR",
+            expectedMessage = "Content Provider ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenAppRegisteredTimeoutAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "My Application. App Registered Timeout",
-            expectedReasonMessage = "App Registered ANR",
+            expectedMessage = "App Registered ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenShortFgsTimeoutAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "Foreground service ANR. Short FGS Timeout. Duration=5000ms",
-            expectedReasonMessage = "Short Foreground Service Timeout ANR",
+            expectedMessage = "Short Foreground Service Timeout ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenSystemJobServiceTimeoutAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "SystemJobService. Job Service Timeout",
-            expectedReasonMessage = "Job Service ANR",
+            expectedMessage = "Job Service ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenAppStartupTimeOut_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "App start timeout. Timeout=5000ms",
-            expectedReasonMessage = "App Start ANR",
+            expectedMessage = "App Start ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenServiceStartTimeout_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "Service start timeout. Timeout=5000ms",
-            expectedReasonMessage = "Service Start ANR",
+            expectedMessage = "Service Start ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenBackgroundAnr_shouldMatchAnrReason() {
         assertAnrReason(
             descriptionFromAppExit = "It's full moon ANR",
-            expectedReasonMessage = "Undetermined ANR",
+            expectedMessage = "Undetermined ANR",
         )
     }
 
@@ -211,14 +217,14 @@ class FatalIssueReporterProcessorTest {
                 "bg anr: Process " +
                     "ProcessRecord{9707291 4609:io.bitdrift.gradletestapp/u0a207} " +
                     "failed to complete startup\n",
-            expectedReasonMessage = "Background ANR",
+            expectedMessage = "Background ANR",
         )
     }
 
     @Test
     fun persistAppExitReport_whenNativeCrash_shouldCreateEmptyErrorModel() {
         val description = "Native crash"
-        val traceInputStream = createTraceInputStream("sample native crash trace")
+        val traceInputStream = buildTraceInputStringFromFile("app_exit_native_crash.txt")
 
         fatalIssueReporterProcessor.persistAppExitReport(
             ReportType.NativeCrash,
@@ -255,15 +261,13 @@ class FatalIssueReporterProcessorTest {
 
     private fun assertAnrReason(
         descriptionFromAppExit: String,
-        expectedReasonMessage: String,
+        expectedMessage: String,
     ) {
-        val traceInputStream = createTraceInputStream(APP_EXIT_VALID_ANR_TRACE)
-
         fatalIssueReporterProcessor.persistAppExitReport(
             fatalIssueType = ReportType.AppNotResponding,
             FAKE_TIME_STAMP,
             descriptionFromAppExit,
-            traceInputStream,
+            buildTraceInputStringFromFile("app_exit_anr_deadlock_anr.txt"),
         )
 
         verify(fatalIssueReporterStorage).persistFatalIssue(
@@ -274,41 +278,29 @@ class FatalIssueReporterProcessorTest {
         val report = Report.getRootAsReport(ByteBuffer.wrap(fatalIssueReportCaptor.firstValue))
         assertThat(report.errors(0)).isNotNull
         report.errors(0)?.let { error ->
-            assertThat(error.reason).isEqualTo(expectedReasonMessage)
+            assertThat(error.name).isEqualTo(expectedMessage)
         }
     }
 
+    private fun buildTraceInputStringFromFile(rawFilePath: String): InputStream {
+        val file =
+            Paths
+                .get(
+                    System.getenv("TEST_SRCDIR"),
+                    "_main",
+                    "platform/jvm/capture/src/test/resources",
+                    rawFilePath,
+                ).toFile()
+        val resourceStream = file.inputStream()
+        val anrRawTrace = resourceStream.bufferedReader().use { it.readText() }
+        return createTraceInputStream(anrRawTrace)
+    }
+
     private companion object {
         const val FAKE_TIME_STAMP = 1241515210914L
         const val APP_EXIT_DESCRIPTION_ANR =
             "Input dispatching timed out (219180 " +
                 "io.bitdrift.capture/io.bitdrift.capture.MainActivity (server) " +
                 "is not responding. Waited 5004ms for MotionEvent"
-
-        // TODO(FranAguilera): BIT-5142 use raw files
-        const val APP_EXIT_VALID_ANR_TRACE =
-            "\"main\" prio=5 tid=1 Blocked\n" +
-                "  | group=\"main\" sCount=1 ucsCount=0 flags=1 obj=0x721b0f98 self=0xb400007d136a27b0\n" +
-                "  | sysTid=3994 nice=-10 cgrp=top-app sched=0/0 handle=0x7f053014f8\n" +
-                "  | state=S schedstat=( 979645230 62026944 1016 ) utm=91 stm=6 core=0 HZ=100\n" +
-                "  | stack=0x7ffccb0000-0x7ffccb2000 stackSize=8188KB\n" +
-                "  | held mutexes=\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator.startProcessing(FatalIssueGenerator.kt:106)\n" +
-                "  - waiting to lock <0x0481d03d> (a java.lang.String) held by thread 4\n" +
-                "  - locked <0x04e67032> (a java.lang.String)\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator.forceDeadlockAnr$(FatalIssueGenerator.kt:35)\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator(unavailable:0)\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator.callOnMainThread\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator\n" +
-                "  at io.bitdrift.capture.FatalIssueGenerator\n" +
-                "  at android.os.Handler.handleCallback(Handler.java:958)\n" +
-                "  at android.os.Handler.dispatchMessage(Handler.java:99)\n" +
-                "  at android.os.Looper.loopOnce(Looper.java:205)\n" +
-                "  at android.os.Looper.loop(Looper.java:294)\n" +
-                "  at android.app.ActivityThread.main(ActivityThread.java:8177)\n" +
-                "  at java.lang.reflect.Method.invoke(Native method)\n" +
-                "  at com.android.internal.os.RuntimeInit.run(RuntimeInit.java:552)\n" +
-                "  at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:971)\n"
     }
 }

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/reports/processor/AppExitAnrTraceProcessor.kt

@@ -45,31 +45,31 @@ class FatalIssueReporterStorageTest {
     fun persistFatalIssue_whenAnr_shouldAddTypeToFileName() {
         assertFileWithExpectedType(
             reportType = ReportType.AppNotResponding,
-            "ANR",
+            "anr",
         )
     }
 
     @Test
     fun persistFatalIssue_whenJvmCrash_shouldAddTypeToFileName() {
         assertFileWithExpectedType(
             reportType = ReportType.JVMCrash,
-            "JVM_CRASH",
+            "crash",
         )
     }
 
     @Test
     fun persistFatalIssue_whenNativeCrash_shouldAddTypeToFileName() {
         assertFileWithExpectedType(
             reportType = ReportType.NativeCrash,
-            "NATIVE_CRASH",
+            "native_crash",
         )
     }
 
     @Test
     fun persistFatalIssue_whenStrictMode_shouldAddUnknownType() {
         assertFileWithExpectedType(
             reportType = ReportType.StrictModeViolation,
-            "UNKNOWN",
+            "Unknown",
         )
     }
 

platform/jvm/capture/src/test/kotlin/io/bitdrift/capture/FatalIssueReporterProcessorTest.kt

@@ -0,0 +1,9 @@
+exports_files([
+    "app_exit_anr_deadlock_anr.txt",
+    "app_exit_native_crash.txt",
+])
+filegroup(
+    name = "test_resources",
+    srcs = glob(["*.txt"]),
+    visibility = ["//visibility:public"]
+)