Memfault BORT SDK 5.4.2 (Build 3268598)

Author: Memfault Inc.

.gitignore

@@ -1,16 +1,36 @@
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Log/OS Files
+*.log
+
+# Android Studio generated files and folders
+captures/
+.externalNativeBuild/
+.cxx/
+*.aab
+output-metadata.json
+
+# IntelliJ
 *.iml
-.gradle
-/local.properties
-/.idea/caches
-/.idea/libraries
-/.idea/modules.xml
-/.idea/workspace.xml
-/.idea/navEditor.xml
-/.idea/assetWizardSettings.xml
+.idea/
+misc.xml
+deploymentTargetDropDown.xml
+render.experimental.xml
+
+# Google Services (e.g. APIs or Firebase)
+google-services.json
+
+# Android Profiling
+*.hprof
+
+# Mac
 .DS_Store
-/build
-/build-lite
-/captures
-.externalNativeBuild
-.cxx
+
+# Memfault
+build-lite/
 validate-sdk-integration.log*

CHANGELOG.md

@@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 This project currently does not attempt to adhere to Semantic Versioning, but
 breaking changes are avoided unless absolutely necessary.
 
+## v5.4.2 - August 4, 2025
+
+### :construction: Fixes
+
+- Fixed a bug where bugreports would not always be cleaned up due to incorrect
+  file permissions in the Bort app.
+
+### :chart_with_upwards_trend: Improvements
+
+- Refactored the device config handlers into clearer interfaces and
+  implementations.
+- Added several more bugreport reply broadcasts (OK_REQUESTED, OK_GENERATING,
+  OK_GENERATED, ERROR_GENERATED_TIMEOUT).
+- Added optional constraints on bugreport requests through a multibind
+  interface.
+
 ## v5.4.1 - July 22, 2025
 
 ### :rocket: New Features

MemfaultDumpstateRunner/memfault_init.rc

@@ -24,7 +24,8 @@ service memfault_dumpstatez /system/bin/dumpstate -S -d -z -q \
 # the source code of the program itself.
 
 on post-fs-data
-    mkdir /data/misc/MemfaultBugReports/ 0771 system system
+    mkdir /data/misc/MemfaultBugReports/ 0777 system system
+    chmod 0777 /data/misc/MemfaultBugReports/
     wait /data/misc/MemfaultBugReports/
 
 service memfault_dumpstate_runner /system_ext/bin/MemfaultDumpstateRunner

…eport/PendingBugReportRequestReplying.kt …eport/PendingBugReportRequestReplying.ktMemfaultPackages/bort/src/main/java/com/memfault/bort/bugreport/PendingBugReportRequestReplying.kt renamed to MemfaultPackages/bort-shared/src/main/java/com/memfault/bort/bugreport/PendingBugReportRequestReplying.kt MemfaultPackages/bort/src/main/java/com/memfault/bort/bugreport/PendingBugReportRequestReplying.kt renamed to MemfaultPackages/bort-shared/src/main/java/com/memfault/bort/bugreport/PendingBugReportRequestReplying.kt

@@ -9,9 +9,14 @@ private const val INTENT_ACTION_BUG_REPORT_REQUEST_REPLY = "com.memfault.intent.
 private const val INTENT_EXTRA_BUG_REPORT_REQUEST_STATUS = "com.memfault.intent.extra.BUG_REPORT_REQUEST_STATUS"
 
 enum class BugReportRequestStatus(val value: String) {
+    OK_REQUESTED("OK_REQUESTED"),
+    OK_GENERATING("OK_GENERATING"),
+    OK_GENERATED("OK_GENERATED"),
     OK_UPLOAD_QUEUED("OK_UPLOAD_QUEUED"),
     ERROR_ALREADY_PENDING("ERROR_ALREADY_PENDING"),
-    ERROR_TIMEOUT("ERROR_TIMEOUT"),
+    ERROR_CONSTRAINTS_NOT_SATISFIED("ERROR_CONSTRAINTS_NOT_SATISFIED"),
+    ERROR_GENERATING_TIMEOUT("ERROR_TIMEOUT"),
+    ERROR_GENERATED_TIMEOUT("ERROR_GENERATED_TIMEOUT"),
     ERROR_SDK_NOT_ENABLED("ERROR_SDK_NOT_ENABLED"),
     ERROR_RATE_LIMITED("ERROR_RATE_LIMITED"),
 }

MemfaultPackages/bort-shared/src/main/java/com/memfault/bort/shared/BugReportRequest.kt

@@ -24,7 +24,8 @@ data class BugReportOptions(
 data class BugReportRequest(
     val options: BugReportOptions = BugReportOptions(),
 
-    // NOTE: periodic bug report requests have a null requestId
+    // Note that periodic bug reports always have a null requestId, but explicit bug report requests must have a
+    // request_id specified in the request intent.
     @SerialName("request_id")
     val requestId: String? = null,
 

MemfaultPackages/bort/src/main/java/com/memfault/bort/BortAppModule.kt

@@ -5,6 +5,7 @@ import android.content.Context
 import android.content.SharedPreferences
 import android.content.res.Resources
 import androidx.preference.PreferenceManager
+import com.memfault.bort.bugreport.StartBugReportConstraint
 import com.memfault.bort.dagger.InjectSet
 import com.memfault.bort.diagnostics.BortErrorsDb
 import com.memfault.bort.http.RetrofitInterceptor
@@ -46,6 +47,7 @@ import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
 import dagger.multibindings.IntoSet
+import dagger.multibindings.Multibinds
 import okhttp3.HttpUrl.Companion.toHttpUrl
 import okhttp3.OkHttpClient
 import retrofit2.Retrofit
@@ -66,6 +68,10 @@ import kotlin.time.toJavaDuration
 @Module
 @InstallIn(SingletonComponent::class)
 abstract class BortAppModule {
+
+    @Multibinds
+    abstract fun startBugReportConstraints(): InjectSet<StartBugReportConstraint>
+
     companion object {
         @Provides
         @Singleton

MemfaultPackages/bort/src/main/java/com/memfault/bort/BugReportRequestTimeoutTask.kt

@@ -26,7 +26,7 @@ class BugReportRequestTimeoutTask @Inject constructor(
     override fun convertAndValidateInputData(inputData: Data): String? =
         inputData.getString(REQUEST_ID_INPUT_DATA_KEY)
 
-    override suspend fun doWork(input: String?): TaskResult = TaskResult.SUCCESS.also {
+    override suspend fun doWork(input: String?): TaskResult {
         val (_, request) = pendingBugReportRequestAccessor.compareAndSwap(null) { request ->
             if (request == null) {
                 false
@@ -35,10 +35,9 @@ class BugReportRequestTimeoutTask @Inject constructor(
             }
         }
 
-        request?.broadcastReply(
-            application,
-            BugReportRequestStatus.ERROR_TIMEOUT,
-        )
+        request?.broadcastReply(application, BugReportRequestStatus.ERROR_GENERATING_TIMEOUT)
+
+        return TaskResult.SUCCESS
     }
 
     companion object {

MemfaultPackages/bort/src/main/java/com/memfault/bort/bugreport/ReceiveBugReportIntentUseCase.kt

@@ -5,6 +5,8 @@ import android.content.Intent
 import com.memfault.bort.BugReportRequestTimeoutTask
 import com.memfault.bort.INTENT_EXTRA_BUGREPORT_PATH
 import com.memfault.bort.ProcessingOptions
+import com.memfault.bort.bugreport.BugReportRequestStatus.ERROR_GENERATED_TIMEOUT
+import com.memfault.bort.bugreport.BugReportRequestStatus.OK_GENERATED
 import com.memfault.bort.clientserver.MarMetadata.BugReportMarMetadata
 import com.memfault.bort.fileExt.deleteSilently
 import com.memfault.bort.settings.SettingsProvider
@@ -37,11 +39,13 @@ class RealReceiveBugReportIntentUseCase
 
         Logger.v("Got bugreport path: $bugreportPath, request: $request")
         bugreportPath ?: return
+        request?.broadcastReply(application, OK_GENERATED)
 
         val file = File(bugreportPath)
         if (!success) {
             Logger.w("Bug report request timed out, not uploading!")
             file.deleteSilently()
+            request?.broadcastReply(application, ERROR_GENERATED_TIMEOUT)
             return
         }
 

MemfaultPackages/bort/src/main/java/com/memfault/bort/bugreport/RequestBugReportIntentUseCase.kt

@@ -34,6 +34,7 @@ class RealRequestBugReportIntentUseCase
             Logger.e("Invalid bug report request", e)
             return
         }
+        request.broadcastReply(application, BugReportRequestStatus.OK_REQUESTED)
 
         if (!bortEnabledProvider.isEnabled()) {
             Logger.w("Bort not enabled; not sending request")

MemfaultPackages/bort/src/main/java/com/memfault/bort/bugreport/StartBugReportConstraint.kt

@@ -0,0 +1,25 @@
+package com.memfault.bort.bugreport
+
+/**
+ * Plug-in mechanism to control whether a bugreport should run or not. In cases where running a bugreport
+ * during another CPU-heavy operation is not desirable because it would cause the device to stutter or lag, you can
+ * implement a constraint via a Dagger Multibinding that'll be called before a bugreport is started.
+ *
+ * If any constraint is not met, `ERROR_CONSTRAINTS_NOT_SATISFIED` will be returned as the status of the request.
+ *
+ * ex:
+ *
+ * @ContributesMultibinding(SingletonComponent::class)
+ * class DeviceIdleStartBugReportConstraint
+ * @Inject constructor(
+ *   private val deviceStatusApi: DeviceStatusApi,
+ * ): StartBugReportConstraint {
+ *
+ *   override suspend fun ok(): Boolean {
+ *     return deviceStatusApi.status == DeviceStatus.IDLE
+ *   }
+ * }
+ */
+interface StartBugReportConstraint {
+    suspend fun ok(): Boolean
+}