Memfault BORT SDK 4.18.0 (Build 2216845)

Author: Memfault Inc.

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Memfault Bort Changelog
 
+## v4.18.0 - July 1, 2024
+
+### :rocket: New Features
+
+- Battery device vitals are automatically added to
+  [Sessions](https://mflt.io/android-sessions), to enable seeing how the Session
+  affected battery life: `battery_discharge_duration_ms`,
+  `battery_soc_pct_drop`.
+- Added battery charge cycle count metric: `battery.charge_cycle_count` - this
+  tracks the total number of charge cycles the battery has been through (if the
+  device supports this and writes it to
+  `/sys/class/power_supply/battery/cycle_count`).
+- Added `startSession`/`finishSession` native APIs for Sessions
+
+### :chart_with_upwards_trend: Improvements
+
+- Removed legacy settings endpoint support (this had not been used for ~2
+  years - replaced by `device-config`).
+- Added rate-limiter for Sessions.
+- Catch a `SocketTimeoutException` during settings update, so that it doesn't
+  fail the job.
+- Changed the jitter for settings update, so that it evenly distributes requests
+  throughout the fleet. Also removed any jitter from the very first settings
+  update on a fresh device.
+- Updated gradle to version 8.8 (fixed a build failure we saw internally).
+
+### :house: Internal
+
+- Changed network security config in the debug variant of the Bort app, for our
+  internal CI configuration.
+- Added internal metrics to track the size of Bort's databases.
+
 ## v4.17.0 - June 24, 2024
 
 ### :rocket: New Features

MemfaultDumpster/MemfaultDumpster.cpp

@@ -86,6 +86,9 @@ namespace {
                 case IDumpster::CMD_ID_SET_STRUCTURED_ENABLED_PROPERTY_DISABLED: return {
                         "/system/bin/setprop", STRUCTURED_ENABLED_PROPERTY, "0"
                 };
+                case IDumpster::CMD_ID_CYCLE_COUNT: return {
+                        "cat", "/sys/class/power_supply/battery/cycle_count"
+                };
 
 
                 default: return {};

MemfaultDumpster/com/memfault/dumpster/IDumpster.aidl

@@ -9,11 +9,12 @@ interface IDumpster {
     const int VERSION_GETPROP_TYPES = 3;
     const int VERSION_BORT_CONTINUOUS_LOGGING = 4;
     const int VERSION_BORT_CONTINUOUS_FIXES = 5;
+    const int VERSION_CYCLE_COUNT = 6;
 
     /**
      * Current version of the service.
      */
-    const int VERSION = 5;
+    const int VERSION = 6;
 
     /**
     * Gets the version of the MemfaultDumpster service.
@@ -26,6 +27,7 @@ interface IDumpster {
     const int CMD_ID_SET_STRUCTURED_ENABLED_PROPERTY_ENABLED = 4;
     const int CMD_ID_SET_STRUCTURED_ENABLED_PROPERTY_DISABLED = 5;
     const int CMD_ID_GETPROP_TYPES = 6;
+    const int CMD_ID_CYCLE_COUNT = 7;
 
     /**
      * Runs a basic command and calls the listener with the string output.

MemfaultPackages/bort-ota/src/debug/res/xml/network_security_config.xml

@@ -3,6 +3,5 @@
     <domain-config cleartextTrafficPermitted="true">
         <domain includeSubdomains="true">127.0.0.1</domain>
         <domain includeSubdomains="true">localhost</domain>
-        <domain includeSubdomains="true">minio</domain>
     </domain-config>
 </network-security-config>

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

@@ -1,25 +1,14 @@
 package com.memfault.bort
 
 import javax.inject.Qualifier
-import kotlin.annotation.AnnotationTarget.FIELD
-import kotlin.annotation.AnnotationTarget.FUNCTION
-import kotlin.annotation.AnnotationTarget.PROPERTY_GETTER
-import kotlin.annotation.AnnotationTarget.PROPERTY_SETTER
-import kotlin.annotation.AnnotationTarget.VALUE_PARAMETER
 
 @Qualifier
-@Retention(AnnotationRetention.RUNTIME)
-@Target(FIELD, VALUE_PARAMETER, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
 annotation class Main
 
 @Qualifier
-@Retention(AnnotationRetention.RUNTIME)
-@Target(FIELD, VALUE_PARAMETER, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
 annotation class IO
 
 @Qualifier
-@Retention(AnnotationRetention.RUNTIME)
-@Target(FIELD, VALUE_PARAMETER, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
 /*
  * You probably want the IO or Main dispatcher instead of the Default dispatcher. For one-off longer computation
  * tasks, we should use the IO dispatcher, which will run the task on a large pool of threads. For short tasks that

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

@@ -20,12 +20,6 @@ import kotlinx.coroutines.withTimeoutOrNull
 import javax.inject.Inject
 import javax.inject.Qualifier
 import javax.inject.Singleton
-import kotlin.annotation.AnnotationRetention.RUNTIME
-import kotlin.annotation.AnnotationTarget.FIELD
-import kotlin.annotation.AnnotationTarget.FUNCTION
-import kotlin.annotation.AnnotationTarget.PROPERTY_GETTER
-import kotlin.annotation.AnnotationTarget.PROPERTY_SETTER
-import kotlin.annotation.AnnotationTarget.VALUE_PARAMETER
 import kotlin.coroutines.resume
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.seconds
@@ -107,8 +101,6 @@ private class WrappedService(val service: IDumpster, val basicCommandTimeout: Lo
 }
 
 @Qualifier
-@Retention(RUNTIME)
-@Target(FIELD, VALUE_PARAMETER, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
 annotation class BasicCommandTimeout
 
 class DumpsterClient @Inject constructor(
@@ -230,6 +222,11 @@ class DumpsterClient @Inject constructor(
         }
     }
 
+    suspend fun getChargeCycleCount(): Int? =
+        withService<Int?>(minimumVersion = IDumpster.VERSION_CYCLE_COUNT) {
+            return runBasicCommand(IDumpster.CMD_ID_CYCLE_COUNT)?.toIntOrNull()
+        }
+
     /**
      * Gets the available version of the MemfaultDumpster service, or null if the service is not available.
      */

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

@@ -10,6 +10,7 @@ import kotlinx.coroutines.flow.callbackFlow
 
 suspend fun Context.registerForIntents(
     vararg actions: String,
+    sticky: Boolean = false,
 ): Flow<Intent> {
     check(actions.isNotEmpty()) { "Must provide a non-empty list of actions to listen to." }
 
@@ -24,7 +25,11 @@ suspend fun Context.registerForIntents(
         val filter = IntentFilter()
         actions.forEach { filter.addAction(it) }
 
-        registerReceiver(receiver, filter)
+        val stickyIntentOrNull = registerReceiver(receiver, filter)
+
+        if (sticky && stickyIntentOrNull != null) {
+            trySend(stickyIntentOrNull)
+        }
 
         awaitClose { unregisterReceiver(receiver) }
     }

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

@@ -7,6 +7,7 @@ import android.content.ContentResolver
 import android.content.pm.PackageManager
 import android.content.res.Resources
 import android.net.ConnectivityManager
+import android.os.BatteryManager
 import android.os.DropBoxManager
 import android.os.Looper
 import com.memfault.bort.Default
@@ -65,4 +66,8 @@ class SharedAndroidModule {
     @Provides
     fun storageStatsManager(application: Application): StorageStatsManager =
         application.getSystemService(StorageStatsManager::class.java)
+
+    @Provides
+    fun batteryManager(application: Application): BatteryManager =
+        application.getSystemService(BatteryManager::class.java)
 }

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

@@ -387,6 +387,13 @@ data class FetchedSettings(
     @SerialName("metric_report.daily_heartbeat")
     val dailyHeartbeatEnabled: Boolean = false,
 
+    @SerialName("metric_report.sessions_rate_limiting_settings")
+    val metricReportSessionsRateLimitingSettings: RateLimitingSettings = RateLimitingSettings(
+        defaultCapacity = 125,
+        defaultPeriod = 24.hours.boxed(),
+        maxBuckets = 1,
+    ),
+
     @SerialName("storage.apps_size_data_source_enabled")
     val storageAppsSizeDataSourceEnabled: Boolean = true,
 

MemfaultPackages/bort/src/debug/java/com/memfault/bort/receivers/BortTestReceiver.kt

@@ -25,9 +25,9 @@ import com.memfault.bort.requester.restartPeriodicMetricsCollection
 import com.memfault.bort.selftest.SelfTestWorker
 import com.memfault.bort.settings.LogcatCollectionMode
 import com.memfault.bort.settings.SettingsProvider
+import com.memfault.bort.settings.SettingsUpdateRequester
 import com.memfault.bort.settings.StoredSettingsPreferenceProvider
 import com.memfault.bort.settings.asLoggerSettings
-import com.memfault.bort.settings.restartPeriodicSettingsUpdate
 import com.memfault.bort.shared.JitterDelayProvider
 import com.memfault.bort.shared.Logger
 import com.memfault.bort.shared.goAsync
@@ -111,6 +111,8 @@ class BortTestReceiver : FilteringReceiver(
 
     @Inject lateinit var devMode: RealDevMode
 
+    @Inject lateinit var settingsUpdateRequester: SettingsUpdateRequester
+
     override fun onIntentReceived(
         context: Context,
         intent: Intent,
@@ -193,15 +195,12 @@ class BortTestReceiver : FilteringReceiver(
             }
 
             "com.memfault.intent.action.TEST_REQUEST_SETTINGS_UPDATE" -> {
-                restartPeriodicSettingsUpdate(
-                    context = context,
+                settingsUpdateRequester.restartPeriodicSettingsUpdate(
                     // Something long to ensure it does not re-run & interfere with tests:
                     updateInterval = 4.days,
-                    httpApiSettings = settingsProvider.httpApiSettings,
                     delayAfterSettingsUpdate = false,
                     testRequest = true,
                     cancel = true,
-                    jitterDelayProvider = jitterDelayProvider,
                 )
             }