[Android] Add manufacturer as OOTB field (#920)

Author: FranAguilera

CHANGELOG.md

@@ -7,7 +7,7 @@
 
 **Added**
 
-- Nothing yet!
+- Added experimental `Capture.Logger.getPreviousRunInfo()` API to get detailed previous run information.
 
 **Changed**
 

Cargo.lock

@@ -115,6 +115,15 @@ final class LoggerCustomer: NSObject, URLSessionDelegate {
         Logger.registerOpaqueUserID(kOpaqueUserID)
         Logger.logInfo("App launched. Logger configured.")
 
+        if let previousRunInfo = Capture.Logger.previousRunInfo {
+            Capture.Logger.logInfo(
+                "Bitdrift PreviousRunInfo",
+                fields: [
+                    "hasFatallyTerminated": String(previousRunInfo.hasFatallyTerminated),
+                ]
+            )
+        }
+
         MXMetricManager.shared.add(self)
     }
 

examples/swift/hello_world/LoggerCustomer.swift

@@ -26,6 +26,7 @@ import io.bitdrift.capture.providers.DateProvider
 import io.bitdrift.capture.providers.FieldProvider
 import io.bitdrift.capture.providers.SystemDateProvider
 import io.bitdrift.capture.providers.session.SessionStrategy
+import io.bitdrift.capture.reports.exitinfo.PreviousRunInfo
 import io.bitdrift.capture.utils.BuildTypeChecker
 import okhttp3.HttpUrl
 import java.util.UUID
@@ -253,6 +254,14 @@ object Capture {
             }
         }
 
+        /**
+         * Returns a snapshot of the previous app run status.
+         *
+         */
+        @JvmStatic
+        @ExperimentalBitdriftApi
+        fun getPreviousRunInfo(): PreviousRunInfo? = (logger() as? LoggerImpl)?.getPreviousRunInfo()
+
         /**
          * Adds a field that should be attached to all logs emitted by the logger going forward.
          * If a field with a given key has already been registered with the logger, its value is

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

@@ -50,6 +50,9 @@ import io.bitdrift.capture.providers.toFields
 import io.bitdrift.capture.providers.toLegacyJniFields
 import io.bitdrift.capture.reports.IssueCallbackConfiguration
 import io.bitdrift.capture.reports.IssueReporter
+import io.bitdrift.capture.reports.exitinfo.LatestAppExitInfoProvider
+import io.bitdrift.capture.reports.exitinfo.PreviousRunInfo
+import io.bitdrift.capture.reports.exitinfo.PreviousRunInfoResolver
 import io.bitdrift.capture.reports.processor.ICompletedReportsProcessor
 import io.bitdrift.capture.reports.processor.IIssueReporterProcessor
 import io.bitdrift.capture.reports.processor.ReportProcessingSession
@@ -85,7 +88,7 @@ internal class LoggerImpl(
     sharedOkHttpClient: OkHttpClient = OkHttpClient(),
     private val apiClient: OkHttpApiClient = OkHttpApiClient(apiUrl, apiKey, client = sharedOkHttpClient),
     private var deviceCodeService: DeviceCodeService = DeviceCodeService(apiClient),
-    activityManager: ActivityManager = context.getSystemService(Context.ACTIVITY_SERVICE) as ActivityManager,
+    private val activityManager: ActivityManager = context.getSystemService(Context.ACTIVITY_SERVICE) as ActivityManager,
     bridge: IBridge = CaptureJniLibrary,
     private val eventListenerDispatcher: CaptureDispatchers.CommonBackground = CaptureDispatchers.CommonBackground,
     windowManager: IWindowManager = WindowManager(errorHandler),
@@ -112,9 +115,15 @@ internal class LoggerImpl(
 
     private val sessionReplayTarget: ISessionReplayTarget
 
+    private val previousRunInfoResolver = PreviousRunInfoResolver(this, LatestAppExitInfoProvider)
+
     private val issueReporter: IssueReporter? =
         if (configuration.enableFatalIssueReporting) {
-            IssueReporter(internalLogger = this, dateProvider = dateProvider)
+            IssueReporter(
+                internalLogger = this,
+                dateProvider = dateProvider,
+                previousRunInfoResolver = previousRunInfoResolver,
+            )
         } else {
             null
         }
@@ -265,6 +274,7 @@ internal class LoggerImpl(
                 runtime,
                 memoryMetricsProvider = memoryMetricsProvider,
                 issueReporter = issueReporter,
+                previousRunInfoResolver = previousRunInfoResolver,
             )
 
         // Install the app exit logger before the Capture logger is started to ensure
@@ -274,6 +284,8 @@ internal class LoggerImpl(
 
         CaptureJniLibrary.startLogger(this.loggerId)
 
+        previousRunInfoResolver.initLegacyWatcher(sdkDirectory)
+
         // issue reporter needs to be initialized after appExitLogger and the jniLogger
         issueReporter?.init(
             activityManager = activityManager,
@@ -670,6 +682,8 @@ internal class LoggerImpl(
 
     internal fun getIssueProcessor(): IIssueReporterProcessor? = issueReporter?.getIssueReporterProcessor()
 
+    internal fun getPreviousRunInfo(): PreviousRunInfo? = previousRunInfoResolver.get(activityManager)
+
     private fun startDebugOperationsAsNeeded(context: Context) {
         if (!BuildTypeChecker.isDebuggable(context)) {
             return

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

@@ -27,8 +27,10 @@ import io.bitdrift.capture.providers.fieldsOf
 import io.bitdrift.capture.reports.IIssueReporter
 import io.bitdrift.capture.reports.IssueReporterState
 import io.bitdrift.capture.reports.exitinfo.ILatestAppExitInfoProvider
+import io.bitdrift.capture.reports.exitinfo.IPreviousRunInfoResolver
 import io.bitdrift.capture.reports.exitinfo.LatestAppExitInfoProvider
 import io.bitdrift.capture.reports.exitinfo.LatestAppExitReasonResult
+import io.bitdrift.capture.reports.exitinfo.toExitReason
 import io.bitdrift.capture.reports.jvmcrash.CaptureUncaughtExceptionHandler
 import io.bitdrift.capture.reports.jvmcrash.ICaptureUncaughtExceptionHandler
 import io.bitdrift.capture.reports.jvmcrash.IJvmCrashListener
@@ -43,6 +45,7 @@ internal class AppExitLogger(
     private val latestAppExitInfoProvider: ILatestAppExitInfoProvider = LatestAppExitInfoProvider,
     private val captureUncaughtExceptionHandler: ICaptureUncaughtExceptionHandler = CaptureUncaughtExceptionHandler,
     private val issueReporter: IIssueReporter?,
+    private val previousRunInfoResolver: IPreviousRunInfoResolver,
 ) : IJvmCrashListener {
     companion object {
         private const val APP_EXIT_EVENT_NAME = "AppExit"
@@ -110,6 +113,8 @@ internal class AppExitLogger(
             return
         }
 
+        previousRunInfoResolver.persistJvmCrashState()
+
         // explicitly letting it run in the caller thread
         logger.logInternal(
             LogType.LIFECYCLE,
@@ -170,7 +175,7 @@ internal class AppExitLogger(
         return fieldsOf(
             APP_EXIT_SOURCE_KEY to "ApplicationExitInfo",
             APP_EXIT_PROCESS_NAME_KEY to this.processName,
-            APP_EXIT_REASON_KEY to this.reason.toReasonText(),
+            APP_EXIT_REASON_KEY to this.reason.toExitReason().value,
             APP_EXIT_IMPORTANCE_KEY to this.importance.toImportanceText(),
             APP_EXIT_STATUS_KEY to this.status.toString(),
             APP_EXIT_PSS_KEY to this.pss.toString(),
@@ -179,25 +184,6 @@ internal class AppExitLogger(
         )
     }
 
-    private fun Int.toReasonText(): String =
-        when (this) {
-            ApplicationExitInfo.REASON_EXIT_SELF -> "EXIT_SELF"
-            ApplicationExitInfo.REASON_SIGNALED -> "SIGNALED"
-            ApplicationExitInfo.REASON_LOW_MEMORY -> "LOW_MEMORY"
-            ApplicationExitInfo.REASON_CRASH -> "CRASH"
-            ApplicationExitInfo.REASON_CRASH_NATIVE -> "CRASH_NATIVE"
-            ApplicationExitInfo.REASON_ANR -> "ANR"
-            ApplicationExitInfo.REASON_INITIALIZATION_FAILURE -> "INITIALIZATION_FAILURE"
-            ApplicationExitInfo.REASON_PERMISSION_CHANGE -> "PERMISSION_CHANGE"
-            ApplicationExitInfo.REASON_EXCESSIVE_RESOURCE_USAGE -> "EXCESSIVE_RESOURCE_USAGE"
-            ApplicationExitInfo.REASON_USER_REQUESTED -> "USER_REQUESTED"
-            ApplicationExitInfo.REASON_USER_STOPPED -> "USER_STOPPED"
-            ApplicationExitInfo.REASON_DEPENDENCY_DIED -> "DEPENDENCY_DIED"
-            ApplicationExitInfo.REASON_OTHER -> "OTHER"
-            ApplicationExitInfo.REASON_FREEZER -> "FREEZER"
-            else -> "UNKNOWN"
-        }
-
     private fun Int.toImportanceText(): String =
         when (this) {
             RunningAppProcessInfo.IMPORTANCE_CACHED -> "CACHED"

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/events/lifecycle/AppExitLogger.kt

@@ -20,6 +20,7 @@ import io.bitdrift.capture.providers.DateProvider
 import io.bitdrift.capture.reports.IssueReporterState.NotInitialized
 import io.bitdrift.capture.reports.IssueReporterState.RuntimeState
 import io.bitdrift.capture.reports.exitinfo.ILatestAppExitInfoProvider
+import io.bitdrift.capture.reports.exitinfo.IPreviousRunInfoResolver
 import io.bitdrift.capture.reports.exitinfo.LatestAppExitInfoProvider
 import io.bitdrift.capture.reports.exitinfo.LatestAppExitInfoProvider.mapToFatalIssueType
 import io.bitdrift.capture.reports.exitinfo.LatestAppExitReasonResult
@@ -50,6 +51,7 @@ internal class IssueReporter(
     private val internalLogger: IInternalLogger,
     private val backgroundThreadHandler: IBackgroundThreadHandler = CaptureDispatchers.CommonBackground,
     private val latestAppExitInfoProvider: ILatestAppExitInfoProvider = LatestAppExitInfoProvider,
+    private val previousRunInfoResolver: IPreviousRunInfoResolver,
     private val captureUncaughtExceptionHandler: ICaptureUncaughtExceptionHandler = CaptureUncaughtExceptionHandler,
     private val dateProvider: DateProvider,
 ) : IIssueReporter,
@@ -120,6 +122,7 @@ internal class IssueReporter(
             throwable = throwable,
             allThreads = Thread.getAllStackTraces(),
         )
+        previousRunInfoResolver.persistJvmCrashState()
     }
 
     override fun getLogStatusFieldsMap(): Map<String, String> =

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

@@ -0,0 +1,94 @@
+// 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.exitinfo
+
+import android.app.ApplicationExitInfo
+
+/**
+ * Application termination reason values.
+ */
+enum class ExitReason(
+    /** Stable text representation safe for serialization/logging. */
+    val value: String,
+) {
+    /** App exited itself. */
+    ExitSelf("EXIT_SELF"),
+
+    /** App was terminated by a signal. */
+    Signaled("SIGNALED"),
+
+    /** App exited due to low memory. */
+    LowMemory("LOW_MEMORY"),
+
+    /** App exited due to a JVM crash. */
+    JvmCrash("CRASH"),
+
+    /** App exited due to a native crash. */
+    NativeCrash("CRASH_NATIVE"),
+
+    /** App exited due to ANR. */
+    AppNotResponding("ANR"),
+
+    /** App exited due to initialization failure. */
+    InitializationFailure("INITIALIZATION_FAILURE"),
+
+    /** App exited due to permission changes. */
+    PermissionChange("PERMISSION_CHANGE"),
+
+    /** App exited due to excessive resource usage. */
+    ExcessiveResourceUsage("EXCESSIVE_RESOURCE_USAGE"),
+
+    /** App exited due to a user request. */
+    UserRequested("USER_REQUESTED"),
+
+    /** App was stopped by the user. */
+    UserStopped("USER_STOPPED"),
+
+    /** App exited because a dependency died. */
+    DependencyDied("DEPENDENCY_DIED"),
+
+    /** Other OS exit reason. */
+    Other("OTHER"),
+
+    /** App was frozen by the OS. */
+    Freezer("FREEZER"),
+
+    /** Unknown or unsupported reason. */
+    Unknown("UNKNOWN"),
+
+    ;
+
+    /**
+     * Lookup helpers for [ExitReason].
+     */
+    companion object {
+        /**
+         * Returns the enum value matching a stable string representation.
+         */
+        fun fromValue(value: String): ExitReason? = entries.firstOrNull { it.value == value }
+    }
+}
+
+internal fun Int.toExitReason(): ExitReason =
+    when (this) {
+        ApplicationExitInfo.REASON_EXIT_SELF -> ExitReason.ExitSelf
+        ApplicationExitInfo.REASON_SIGNALED -> ExitReason.Signaled
+        ApplicationExitInfo.REASON_LOW_MEMORY -> ExitReason.LowMemory
+        ApplicationExitInfo.REASON_CRASH -> ExitReason.JvmCrash
+        ApplicationExitInfo.REASON_CRASH_NATIVE -> ExitReason.NativeCrash
+        ApplicationExitInfo.REASON_ANR -> ExitReason.AppNotResponding
+        ApplicationExitInfo.REASON_INITIALIZATION_FAILURE -> ExitReason.InitializationFailure
+        ApplicationExitInfo.REASON_PERMISSION_CHANGE -> ExitReason.PermissionChange
+        ApplicationExitInfo.REASON_EXCESSIVE_RESOURCE_USAGE -> ExitReason.ExcessiveResourceUsage
+        ApplicationExitInfo.REASON_USER_REQUESTED -> ExitReason.UserRequested
+        ApplicationExitInfo.REASON_USER_STOPPED -> ExitReason.UserStopped
+        ApplicationExitInfo.REASON_DEPENDENCY_DIED -> ExitReason.DependencyDied
+        ApplicationExitInfo.REASON_OTHER -> ExitReason.Other
+        ApplicationExitInfo.REASON_FREEZER -> ExitReason.Freezer
+        else -> ExitReason.Unknown
+    }