Add getPreviousRunInfo (#922)

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

* Updating android tests

* Update docs

* Test name

* Fix edge case for OS 10 and initial app installation

* Update case for OS 10 and initial start call

* Prevent a null Capture.logger instance inside onBeforeReportSend callback

* Allow to compare bugsnag duration

* Update Capture.kt

* Cache AppExitReason result to prevent unnecessary IPC binder calls

* Remove noisy benchmark tests on emulator

* copilot review

* Copilot feedback part 2

* Rename previousRunInfo.reason to previousRunInfo.terminationReason

* Remove file sentinel logic for below OS 11

* Test fixes

Author: FranAguilera

CHANGELOG.md

@@ -7,7 +7,7 @@
 
 **Added**
 
-- Nothing yet!
+- Added experimental API to get detailed previous run information (`Capture.Logger.getPreviousRunInfo()` on Android, `Capture.Logger.previousRunInfo` on iOS/Swift, `previousRunInfo()` in Objective-C).
 
 **Changed**
 

Cargo.Bazel.lock

@@ -11,8 +11,10 @@ import android.app.Application
 import android.os.Handler
 import android.os.Looper
 import android.util.Log
+import io.bitdrift.capture.Capture
 import io.bitdrift.capture.Capture.Logger
 import io.bitdrift.capture.Configuration
+import io.bitdrift.capture.experimental.ExperimentalBitdriftApi
 import io.bitdrift.capture.providers.FieldProvider
 import io.bitdrift.capture.providers.session.SessionStrategy
 import io.bitdrift.capture.reports.IssueCallbackConfiguration
@@ -69,6 +71,20 @@ class HelloWorldApp : Application() {
 
         Log.v("HelloWorldApp", "Android Bitdrift app launched with session url=${Logger.sessionUrl}")
 
+        @OptIn(ExperimentalBitdriftApi::class)
+        Capture.Logger.getPreviousRunInfo()?.let { previousRunInfo ->
+            val hasFatallyTerminated = previousRunInfo.hasFatallyTerminated.toString()
+            val reason = previousRunInfo.terminationReason?.toString() ?: ""
+            Capture.Logger.logInfo(
+                mapOf(
+                    "hasFatallyTerminated" to hasFatallyTerminated,
+                    "reason" to reason,
+                ),
+            ) {
+                "Bitdrift PreviousRunInfo"
+            }
+        }
+
         Handler(Looper.getMainLooper()).postDelayed(
             {
                 Log.i("HelloWorldApp", getCaptureSdkInitializedMessage())

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/android/HelloWorldApp.kt

@@ -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,21 @@ object Capture {
             }
         }
 
+        /**
+         * Returns a snapshot of the previous app run status, or `null` if not available.
+         *
+         * Must be called after [start]. Returns `null` if the logger is not initialized.
+         *
+         * Available on Android API 30+ (OS 11+). On API < 30, this returns `null` at the moment.
+         *
+         * Note: on API 30, native crashes are reported as a fatal termination reason but do not
+         * trigger an `onBeforeSend` callback with the crash report. The `onBeforeSend` callback
+         * for native crashes is only available on API >= 31.
+         */
+        @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
@@ -675,6 +691,10 @@ object Capture {
 
             default.set(LoggerState.Started(loggerImpl))
 
+            // Must be initialized right after the logger state is set to avoid a null
+            // Capture.logger() reference when onBeforeSend callbacks are triggered.
+            loggerImpl.initIssueReporter()
+
             val sdkConfiguredDuration =
                 SdkConfiguredDuration(
                     wholeStartDuration = startSdkTimer.elapsedNow(),

examples/swift/hello_world/LoggerCustomer.swift

@@ -50,6 +50,8 @@ 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.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 +87,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),
@@ -95,6 +97,7 @@ internal class LoggerImpl(
     internal val webViewConfiguration: WebViewConfiguration? = configuration.webViewConfiguration
 
     private val metadataProvider: MetadataProvider
+    private val sdkDirectory: String
     private val batteryMonitor = BatteryMonitor(context)
     private val powerMonitor = PowerMonitor(context)
     private val diskUsageMonitor: DiskUsageMonitor
@@ -112,9 +115,14 @@ internal class LoggerImpl(
 
     private val sessionReplayTarget: ISessionReplayTarget
 
+    private val previousRunInfoResolver = PreviousRunInfoResolver(activityManager)
+
     private val issueReporter: IssueReporter? =
         if (configuration.enableFatalIssueReporting) {
-            IssueReporter(internalLogger = this, dateProvider = dateProvider)
+            IssueReporter(
+                internalLogger = this,
+                dateProvider = dateProvider,
+            )
         } else {
             null
         }
@@ -153,7 +161,7 @@ internal class LoggerImpl(
                 okHttpClient = sharedOkHttpClient,
             )
 
-        val sdkDirectory = SdkDirectory.getPath(context)
+        sdkDirectory = SdkDirectory.getPath(context)
 
         val localErrorReporter =
             errorReporter ?: ErrorReporterService(
@@ -274,14 +282,6 @@ internal class LoggerImpl(
 
         CaptureJniLibrary.startLogger(this.loggerId)
 
-        // issue reporter needs to be initialized after appExitLogger and the jniLogger
-        issueReporter?.init(
-            activityManager = activityManager,
-            sdkDirectory = sdkDirectory,
-            clientAttributes = clientAttributes,
-            completedReportsProcessor = this,
-        )
-
         startDebugOperationsAsNeeded(context)
     }
 
@@ -670,6 +670,21 @@ internal class LoggerImpl(
 
     internal fun getIssueProcessor(): IIssueReporterProcessor? = issueReporter?.getIssueReporterProcessor()
 
+    internal fun getPreviousRunInfo(): PreviousRunInfo? = previousRunInfoResolver.get()
+
+    /**
+     * Initializes the issue reporter. Must be called immediately right after the LoggerImpl is created
+     * so we can guarantee that any calls to Capture.Logger.* are valid within `onBeforeReportSend`
+     */
+    internal fun initIssueReporter() {
+        issueReporter?.init(
+            activityManager = activityManager,
+            sdkDirectory = sdkDirectory,
+            clientAttributes = clientAttributes,
+            completedReportsProcessor = this,
+        )
+    }
+
     private fun startDebugOperationsAsNeeded(context: Context) {
         if (!BuildTypeChecker.isDebuggable(context)) {
             return

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/Capture.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("JVM_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
+    }