RUM-11120: Use generics in InfoProvider

Author: jonathanmos

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/RumFeature.kt

@@ -43,14 +43,19 @@ import com.datadog.android.rum.configuration.VitalsUpdateFrequency
 import com.datadog.android.rum.internal.anr.ANRDetectorRunnable
 import com.datadog.android.rum.internal.debug.UiRumDebugListener
 import com.datadog.android.rum.internal.domain.InfoProvider
-import com.datadog.android.rum.internal.domain.NoOpInfoProvider
 import com.datadog.android.rum.internal.domain.RumDataWriter
+import com.datadog.android.rum.internal.domain.accessibility.AccessibilityInfo
 import com.datadog.android.rum.internal.domain.accessibility.AccessibilitySnapshotManager
-import com.datadog.android.rum.internal.domain.accessibility.DatadogAccessibilityReader
+import com.datadog.android.rum.internal.domain.accessibility.DefaultAccessibilityReader
 import com.datadog.android.rum.internal.domain.accessibility.DefaultAccessibilitySnapshotManager
+import com.datadog.android.rum.internal.domain.accessibility.NoOpAccessibilityReader
 import com.datadog.android.rum.internal.domain.accessibility.NoOpAccessibilitySnapshotManager
+import com.datadog.android.rum.internal.domain.battery.BatteryInfo
 import com.datadog.android.rum.internal.domain.battery.DefaultBatteryInfoProvider
+import com.datadog.android.rum.internal.domain.battery.NoOpBatteryInfoProvider
 import com.datadog.android.rum.internal.domain.display.DefaultDisplayInfoProvider
+import com.datadog.android.rum.internal.domain.display.DisplayInfo
+import com.datadog.android.rum.internal.domain.display.NoOpDisplayInfoProvider
 import com.datadog.android.rum.internal.domain.event.RumEventMapper
 import com.datadog.android.rum.internal.domain.event.RumEventMetaDeserializer
 import com.datadog.android.rum.internal.domain.event.RumEventMetaSerializer
@@ -153,11 +158,11 @@ internal class RumFeature(
     internal var initialResourceIdentifier: InitialResourceIdentifier = NoOpInitialResourceIdentifier()
     internal var lastInteractionIdentifier: LastInteractionIdentifier? = NoOpLastInteractionIdentifier()
     internal var slowFramesListener: SlowFramesListener? = null
-    internal var accessibilityReader: InfoProvider = NoOpInfoProvider()
+    internal var accessibilityReader: InfoProvider<AccessibilityInfo> = NoOpAccessibilityReader()
     internal var accessibilitySnapshotManager: AccessibilitySnapshotManager =
         NoOpAccessibilitySnapshotManager()
-    internal var batteryInfoProvider: InfoProvider = NoOpInfoProvider()
-    internal var displayInfoProvider: InfoProvider = NoOpInfoProvider()
+    internal var batteryInfoProvider: InfoProvider<BatteryInfo> = NoOpBatteryInfoProvider()
+    internal var displayInfoProvider: InfoProvider<DisplayInfo> = NoOpDisplayInfoProvider()
 
     private val lateCrashEventHandler by lazy { lateCrashReporterFactory(sdkCore as InternalSdkCore) }
 
@@ -170,7 +175,7 @@ internal class RumFeature(
         this.appContext = appContext
 
         if (configuration.collectAccessibility) {
-            accessibilityReader = DatadogAccessibilityReader(
+            accessibilityReader = DefaultAccessibilityReader(
                 internalLogger = sdkCore.internalLogger,
                 applicationContext = appContext
             )
@@ -329,14 +334,14 @@ internal class RumFeature(
     private fun cleanupInfoProviders() {
         if (configuration.collectAccessibility) {
             accessibilityReader.cleanup()
-            accessibilityReader = NoOpInfoProvider()
+            accessibilityReader = NoOpAccessibilityReader()
             accessibilitySnapshotManager = NoOpAccessibilitySnapshotManager()
         }
 
         batteryInfoProvider.cleanup()
-        batteryInfoProvider = NoOpInfoProvider()
+        batteryInfoProvider = NoOpBatteryInfoProvider()
         displayInfoProvider.cleanup()
-        displayInfoProvider = NoOpInfoProvider()
+        displayInfoProvider = NoOpDisplayInfoProvider()
     }
 
     private fun createDataWriter(

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

@@ -6,10 +6,9 @@
 
 package com.datadog.android.rum.internal.domain
 
-import com.datadog.tools.annotation.NoOpImplementation
+internal interface InfoData
 
-@NoOpImplementation
-internal interface InfoProvider {
-    fun getState(): Map<String, Any>
+internal interface InfoProvider<T : InfoData> {
+    fun getState(): T
     fun cleanup()
 }

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

@@ -0,0 +1,30 @@
+/*
+ * 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.accessibility
+
+import com.datadog.android.rum.internal.domain.InfoData
+
+/**
+ * Represents the accessibility settings state of the device.
+ *
+ * @property textSize The font scale factor (1.0 = normal, >1.0 = larger, <1.0 = smaller)
+ * @property isScreenReaderEnabled Whether touch exploration is enabled (TalkBack, etc.)
+ * @property isColorInversionEnabled Whether color inversion is enabled
+ * @property isClosedCaptioningEnabled Whether closed captions are enabled
+ * @property isReducedAnimationsEnabled Whether animations are disabled/reduced
+ * @property isScreenPinningEnabled Whether the device is in single-app mode
+ * @property isRtlEnabled Whether right to left layout is enabled
+ */
+internal data class AccessibilityInfo(
+    val textSize: String? = null,
+    val isScreenReaderEnabled: Boolean? = null,
+    val isColorInversionEnabled: Boolean? = null,
+    val isClosedCaptioningEnabled: Boolean? = null,
+    val isReducedAnimationsEnabled: Boolean? = null,
+    val isScreenPinningEnabled: Boolean? = null,
+    val isRtlEnabled: Boolean? = null
+) : InfoData

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

@@ -10,5 +10,5 @@ import com.datadog.tools.annotation.NoOpImplementation
 
 @NoOpImplementation
 internal interface AccessibilitySnapshotManager {
-    fun latestSnapshot(): Accessibility
+    fun latestSnapshot(): AccessibilityInfo
 }

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

@@ -26,7 +26,7 @@ import com.datadog.android.rum.internal.domain.InfoProvider
 import java.util.concurrent.atomic.AtomicLong
 
 @Suppress("TooManyFunctions")
-internal class DatadogAccessibilityReader(
+internal class DefaultAccessibilityReader(
     private val internalLogger: InternalLogger,
     private val applicationContext: Context,
     private val resources: Resources = applicationContext.resources,
@@ -37,7 +37,7 @@ internal class DatadogAccessibilityReader(
     private val secureWrapper: SecureWrapper = SecureWrapper(),
     private val globalWrapper: GlobalWrapper = GlobalWrapper(),
     private val handler: Handler = Handler(Looper.getMainLooper())
-) : InfoProvider, ComponentCallbacks {
+) : InfoProvider<AccessibilityInfo>, ComponentCallbacks {
 
     private val displayInversionListener = object : ContentObserver(handler) {
         override fun onChange(selfChange: Boolean, uri: Uri?) {
@@ -66,7 +66,7 @@ internal class DatadogAccessibilityReader(
     }
 
     @Volatile
-    private var currentState = Accessibility()
+    private var currentState = AccessibilityInfo()
 
     private var lastPollTime: AtomicLong = AtomicLong(0)
 
@@ -96,24 +96,24 @@ internal class DatadogAccessibilityReader(
     }
 
     @Synchronized
-    override fun getState(): Map<String, Any> {
+    override fun getState(): AccessibilityInfo {
         val currentTime = System.currentTimeMillis()
         val shouldPoll = currentTime - lastPollTime.get() >= POLL_THRESHOLD
         if (shouldPoll) {
             lastPollTime.set(currentTime)
             pollForAttributesWithoutListeners()
         }
 
-        return currentState.toMap()
+        return currentState
     }
 
     @Synchronized
-    private fun updateState(updater: (Accessibility) -> Accessibility) {
+    private fun updateState(updater: (AccessibilityInfo) -> AccessibilityInfo) {
         currentState = updater(currentState)
     }
 
     private fun buildInitialState() {
-        currentState = Accessibility(
+        currentState = AccessibilityInfo(
             textSize = getTextSize(),
             isScreenReaderEnabled = isScreenReaderEnabled(accessibilityManager),
             isColorInversionEnabled = isDisplayInversionEnabled(),

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/accessibility/DatadogAccessibilityReader.kt renamed to features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/accessibility/DefaultAccessibilityReader.kt

@@ -9,28 +9,71 @@ package com.datadog.android.rum.internal.domain.accessibility
 import com.datadog.android.rum.internal.domain.InfoProvider
 
 internal class DefaultAccessibilitySnapshotManager(
-    private val accessibilityReader: InfoProvider
+    private val accessibilityReader: InfoProvider<AccessibilityInfo>
 ) : AccessibilitySnapshotManager {
-    private val lastSnapshot = mutableMapOf<String, Any>()
+    @Volatile
+    private var lastSnapshot = AccessibilityInfo()
 
     @Synchronized
-    override fun latestSnapshot(): Accessibility {
-        val newAccessibilityState = accessibilityReader.getState()
-        val newSnapshot = mutableMapOf<String, Any>()
+    override fun latestSnapshot(): AccessibilityInfo {
+        val newAccessibilitySnapshot = accessibilityReader.getState()
 
-        // remove the ones we saw already
-        for (key in newAccessibilityState.keys) {
-            val newValue = newAccessibilityState[key]
-                ?: continue
+        // Create delta by comparing new snapshot to last snapshot
+        // Only include properties that have changed (null for unchanged properties)
+        val deltaSnapshot = AccessibilityInfo(
+            textSize =
+            if (newAccessibilitySnapshot.textSize != lastSnapshot.textSize) {
+                newAccessibilitySnapshot.textSize
+            } else {
+                null
+            },
 
-            val oldValue = lastSnapshot[key]
+            isScreenReaderEnabled =
+            if (newAccessibilitySnapshot.isScreenReaderEnabled != lastSnapshot.isScreenReaderEnabled) {
+                newAccessibilitySnapshot.isScreenReaderEnabled
+            } else {
+                null
+            },
 
-            if (newValue != oldValue) {
-                newSnapshot[key] = newValue
-                lastSnapshot[key] = newValue
+            isColorInversionEnabled =
+            if (newAccessibilitySnapshot.isColorInversionEnabled != lastSnapshot.isColorInversionEnabled) {
+                newAccessibilitySnapshot.isColorInversionEnabled
+            } else {
+                null
+            },
+
+            isClosedCaptioningEnabled =
+            if (newAccessibilitySnapshot.isClosedCaptioningEnabled != lastSnapshot.isClosedCaptioningEnabled) {
+                newAccessibilitySnapshot.isClosedCaptioningEnabled
+            } else {
+                null
+            },
+
+            isReducedAnimationsEnabled =
+            if (newAccessibilitySnapshot.isReducedAnimationsEnabled != lastSnapshot.isReducedAnimationsEnabled) {
+                newAccessibilitySnapshot.isReducedAnimationsEnabled
+            } else {
+                null
+            },
+
+            isScreenPinningEnabled =
+            if (newAccessibilitySnapshot.isScreenPinningEnabled != lastSnapshot.isScreenPinningEnabled) {
+                newAccessibilitySnapshot.isScreenPinningEnabled
+            } else {
+                null
+            },
+
+            isRtlEnabled =
+            if (newAccessibilitySnapshot.isRtlEnabled != lastSnapshot.isRtlEnabled) {
+                newAccessibilitySnapshot.isRtlEnabled
+            } else {
+                null
             }
-        }
+        )
+
+        // Update last snapshot for future comparisons
+        lastSnapshot = newAccessibilitySnapshot
 
-        return Accessibility.fromMap(newSnapshot)
+        return deltaSnapshot
     }
 }

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

@@ -0,0 +1,17 @@
+/*
+ * 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.accessibility
+
+import com.datadog.android.rum.internal.domain.InfoProvider
+
+internal class NoOpAccessibilityReader : InfoProvider<AccessibilityInfo> {
+    override fun getState(): AccessibilityInfo {
+        return AccessibilityInfo()
+    }
+
+    override fun cleanup() {}
+}

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

@@ -7,31 +7,16 @@
 package com.datadog.android.rum.internal.domain.battery
 
 import androidx.annotation.FloatRange
+import com.datadog.android.rum.internal.domain.InfoData
 
 /**
  * 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 batteryLevel the current battery charge level, expressed as a float from 0.0f (empty) to 1.0f (full)
+ * to two decimal places.
  * @property lowPowerMode a boolean indicating whether the device is currently in Low Power Mode.
  */
 internal data class BatteryInfo(
     @FloatRange(0.0, 1.0) val batteryLevel: Float? = null,
     val lowPowerMode: Boolean? = null
-) {
-    fun toMap(): Map<String, Any> = buildMap {
-        batteryLevel?.let { put(BATTERY_LEVEL_KEY, it) }
-        lowPowerMode?.let { put(LOW_POWER_MODE_KEY, it) }
-    }
-
-    internal companion object {
-        const val BATTERY_LEVEL_KEY = "battery_level"
-        const val LOW_POWER_MODE_KEY = "low_power_mode"
-
-        fun fromMap(map: Map<String, Any>): BatteryInfo {
-            return BatteryInfo(
-                batteryLevel = map[BATTERY_LEVEL_KEY] as? Float,
-                lowPowerMode = map[LOW_POWER_MODE_KEY] as? Boolean
-            )
-        }
-    }
-}
+) : InfoData