RUM-11120: Change polling time provider

Author: jonathanmos

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/battery/BatteryInfo.kt

@@ -6,14 +6,16 @@
 
 package com.datadog.android.rum.internal.domain.battery
 
+import androidx.annotation.FloatRange
+
 /**
  * Provides information about the battery state.
  *
  * @property batteryLevel the current battery charge level, expressed as a float from 0.0f (empty) to 1.0f (full).
  * @property lowPowerMode a boolean indicating whether the device is currently in Low Power Mode.
  */
 internal data class BatteryInfo(
-    val batteryLevel: Float? = null,
+    @FloatRange(0.0, 1.0) val batteryLevel: Float? = null,
     val lowPowerMode: Boolean? = null
 ) {
     fun toMap(): Map<String, Any> = buildMap {

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/battery/DefaultBatteryInfoProvider.kt

@@ -28,13 +28,14 @@ internal class DefaultBatteryInfoProvider(
     private val batteryManager: BatteryManager? = applicationContext.getSystemService(
         BATTERY_SERVICE
     ) as? BatteryManager,
-    private val batteryLevelPollInterval: Int = BATTERY_POLL_INTERVAL_MS
+    private val batteryLevelPollInterval: Int = BATTERY_POLL_INTERVAL_MS,
+    private val systemClockWrapper: SystemClockWrapper = SystemClockWrapper() // this wrapper is needed for unit tests
 ) : InfoProvider {
 
     @Volatile
     private var currentState = BatteryInfo()
 
-    private var lastTimeBatteryLevelChecked = AtomicLong(System.currentTimeMillis())
+    private var lastTimeBatteryLevelChecked = AtomicLong(systemClockWrapper.elapsedRealTime())
 
     private val powerSaveModeReceiver = object : BroadcastReceiver() {
         override fun onReceive(context: Context, intent: Intent) {
@@ -57,8 +58,8 @@ internal class DefaultBatteryInfoProvider(
         // while we could register a receiver for battery level,
         // it fires far too often (multiple times per second)
         // so it seems better to only poll battery charge state once in a period of time
-        val now = System.currentTimeMillis()
-        if (now >= lastTimeBatteryLevelChecked.get() + batteryLevelPollInterval) {
+        val now = systemClockWrapper.elapsedRealTime()
+        if (now - batteryLevelPollInterval >= lastTimeBatteryLevelChecked.get()) {
             lastTimeBatteryLevelChecked.set(now)
 
             getBatteryLevel()?.let {

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/battery/SystemClockWrapper.kt

@@ -0,0 +1,15 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.rum.internal.domain.battery
+
+import android.os.SystemClock
+
+internal class SystemClockWrapper {
+    fun elapsedRealTime(): Long {
+        return SystemClock.elapsedRealtime()
+    }
+}

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/display/DefaultDisplayInfoProvider.kt

@@ -50,7 +50,6 @@ internal class DefaultDisplayInfoProvider(
         buildInitialState()
     }
 
-    @Synchronized
     override fun getState(): Map<String, Any> {
         return currentState.toMap()
     }

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/display/DisplayInfo.kt

@@ -6,6 +6,12 @@
 
 package com.datadog.android.rum.internal.domain.display
 
+/**
+ * Provides information about the display state.
+ *
+ * @property screenBrightness The current screen brightness,
+ * normalized as a float between 0.0 (darkest) and 1.0 (brightest).
+ */
 internal data class DisplayInfo(
     val screenBrightness: Number? = null
 ) {

features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/domain/battery/DefaultBatteryInfoProviderTest.kt

@@ -57,12 +57,23 @@ internal class DefaultBatteryInfoProviderTest {
     @Mock
     lateinit var mockPowerManager: PowerManager
 
+    @Mock
+    lateinit var mockSystemClockWrapper: SystemClockWrapper
+
     @Mock
     lateinit var mockBatteryManager: BatteryManager
 
+    private val testSuiteStartTime = System.currentTimeMillis()
+
+    private val shortPollingInterval = 200
+
     @BeforeEach
     fun setup() {
         whenever(mockApplicationContext.contentResolver) doReturn mockContentResolver
+        whenever(mockSystemClockWrapper.elapsedRealTime()) doReturn testSuiteStartTime
+        whenever(mockPowerManager.isPowerSaveMode) doReturn false
+        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
+        initializeBatteryManager()
     }
 
     // region getBatteryState
@@ -75,13 +86,7 @@ internal class DefaultBatteryInfoProviderTest {
         // Given
         whenever(mockPowerManager.isPowerSaveMode) doReturn fakeLowPowerMode
         whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn fakeBatteryLevel
-
-        // Create provider (initialization happens in constructor)
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
+        initializeBatteryManager()
 
         // When
         val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
@@ -96,11 +101,7 @@ internal class DefaultBatteryInfoProviderTest {
     @Test
     fun `M return battery info with nulls W getBatteryState() { services unavailable }`() {
         // Given
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = null,
-            batteryManager = null
-        )
+        initializeBatteryManager(null, null)
 
         // When
         val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
@@ -118,17 +119,6 @@ internal class DefaultBatteryInfoProviderTest {
     @SuppressLint("UnspecifiedRegisterReceiverFlag")
     @Test
     fun `M register broadcast receiver W constructor { initialization }`() {
-        // Given
-        whenever(mockPowerManager.isPowerSaveMode) doReturn false
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
-
-        // When - provider is created (initialization happens in constructor)
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
-
         // Then
         val receiverCaptor = argumentCaptor<BroadcastReceiver>()
         val filterCaptor = argumentCaptor<IntentFilter>()
@@ -142,15 +132,6 @@ internal class DefaultBatteryInfoProviderTest {
     @SuppressLint("UnspecifiedRegisterReceiverFlag")
     @Test
     fun `M unregister receiver W cleanup() { after initialization }`() {
-        // Given - create provider (initialization happens in constructor)
-        whenever(mockPowerManager.isPowerSaveMode) doReturn false
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
-
         // When
         testedProvider.cleanup()
 
@@ -162,15 +143,6 @@ internal class DefaultBatteryInfoProviderTest {
 
     @Test
     fun `M retain initial state W cleanup() then getState() { no re-initialization }`() {
-        // Given - create provider
-        whenever(mockPowerManager.isPowerSaveMode) doReturn false
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
-
         // When - cleanup (no re-initialization happens)
         testedProvider.cleanup()
         val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
@@ -184,48 +156,20 @@ internal class DefaultBatteryInfoProviderTest {
 
     // region Polling Tests
 
-    @Test
-    fun `M respect polling interval W getState() { multiple rapid calls }`() {
-        // Given
-        val shortInterval = 500 // 500ms for testing
-        whenever(mockPowerManager.isPowerSaveMode) doReturn false
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
-
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager,
-            batteryLevelPollInterval = shortInterval
-        )
-
-        // When - rapid calls within polling interval
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 75
-        testedProvider.getState()
-
-        // Then - should still have initial battery level (50) from constructor, not 75
-        val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
-        assertThat(batteryInfo.batteryLevel).isEqualTo(0.5f) // Still 50, not 75
-    }
-
     @Test
     fun `M update battery level W getState() { after polling interval }`() {
-        // Given
-        val shortInterval = 50 // 50ms for testing
-        whenever(mockPowerManager.isPowerSaveMode) doReturn false
-        whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 50
-
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager,
-            batteryLevelPollInterval = shortInterval
-        )
-
         // When
-        Thread.sleep(shortInterval + 10L)
         whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 75
-        val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
 
+        // nothing changes because we are within polling interval
+        assertThat(BatteryInfo.fromMap(testedProvider.getState()).batteryLevel).isEqualTo(0.5f)
+        whenever(mockSystemClockWrapper.elapsedRealTime()) doReturn testSuiteStartTime + shortPollingInterval / 2
+        assertThat(BatteryInfo.fromMap(testedProvider.getState()).batteryLevel).isEqualTo(0.5f)
+
+        // Then
+        // after polling interval level should change
+        whenever(mockSystemClockWrapper.elapsedRealTime()) doReturn testSuiteStartTime + shortPollingInterval
+        val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
         assertThat(batteryInfo.batteryLevel).isEqualTo(0.8f) // Now 75
     }
 
@@ -239,13 +183,7 @@ internal class DefaultBatteryInfoProviderTest {
         // Given
         whenever(mockPowerManager.isPowerSaveMode) doReturn false
         whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn Integer.MIN_VALUE
-
-        // Create provider (initialization happens in constructor)
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
+        initializeBatteryManager()
 
         // When
         val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
@@ -261,13 +199,7 @@ internal class DefaultBatteryInfoProviderTest {
         // Given
         whenever(mockPowerManager.isPowerSaveMode) doReturn false
         whenever(mockBatteryManager.getIntProperty(BATTERY_PROPERTY_CAPACITY)) doReturn 0
-
-        // Create provider (initialization happens in constructor)
-        testedProvider = DefaultBatteryInfoProvider(
-            applicationContext = mockApplicationContext,
-            powerManager = mockPowerManager,
-            batteryManager = mockBatteryManager
-        )
+        initializeBatteryManager()
 
         // When
         val batteryInfo = BatteryInfo.fromMap(testedProvider.getState())
@@ -278,4 +210,17 @@ internal class DefaultBatteryInfoProviderTest {
     }
 
     // endregion
+
+    private fun initializeBatteryManager(
+        powerManager: PowerManager? = mockPowerManager,
+        batteryManager: BatteryManager? = mockBatteryManager
+    ) {
+        testedProvider = DefaultBatteryInfoProvider(
+            applicationContext = mockApplicationContext,
+            batteryLevelPollInterval = shortPollingInterval,
+            powerManager = powerManager,
+            batteryManager = batteryManager,
+            systemClockWrapper = mockSystemClockWrapper
+        )
+    }
 }