Merge pull request #2787 from DataDog/jmoskovich/rum-9631/accessibility-attributes

RUM-9631: Add accessibility attributes

Author: jonathanmos

detekt_custom.yml

@@ -369,6 +369,7 @@ datadog:
       - "android.content.Context.registerReceiver(android.content.BroadcastReceiver?, android.content.IntentFilter?)"
       - "android.content.Context.registerReceiver(android.content.BroadcastReceiver?, android.content.IntentFilter?, kotlin.Int)"
       - "android.content.Context.resourceIdName(kotlin.Int)"
+      - "android.content.Context.unregisterComponentCallbacks(android.content.ComponentCallbacks?)"
       - "android.content.Context.unregisterReceiver(android.content.BroadcastReceiver?)"
       - "android.content.Intent.getBooleanExtra(kotlin.String?, kotlin.Boolean)"
       - "android.content.Intent.getIntExtra(kotlin.String?, kotlin.Int)"
@@ -406,12 +407,17 @@ datadog:
       - "android.os.StrictMode.allowThreadDiskWrites()"
       - "android.os.StrictMode.setThreadPolicy(android.os.StrictMode.ThreadPolicy?)"
       - "android.os.SystemClock.elapsedRealtime()"
+      - "android.provider.Settings.Global.getUriFor(kotlin.String?)"
+      - "android.provider.Settings.Secure.getUriFor(kotlin.String?)"
       - "android.util.Log.e(kotlin.String?, kotlin.String)"
       - "android.util.Log.e(kotlin.String?, kotlin.String?, kotlin.Throwable?)"
       - "android.util.Log.getStackTraceString(kotlin.Throwable?)"
       - "android.util.Log.i(kotlin.String?, kotlin.String)"
       - "android.util.Log.w(kotlin.String?, kotlin.String)"
       - "android.util.TypedValue.constructor()"
+      - "android.view.accessibility.AccessibilityManager.addTouchExplorationStateChangeListener(android.view.accessibility.AccessibilityManager.TouchExplorationStateChangeListener)"
+      - "android.view.accessibility.AccessibilityManager.removeTouchExplorationStateChangeListener(android.view.accessibility.AccessibilityManager.TouchExplorationStateChangeListener)"
+      - "android.view.accessibility.TouchExplorationStateChangeListener(kotlin.Function1)"
       - "android.view.Choreographer.postFrameCallback(android.view.Choreographer.FrameCallback)"
       - "android.view.Display.getSize(android.graphics.Point?)"
       - "android.view.FrameMetrics.getMetric(kotlin.Int)"
@@ -554,6 +560,8 @@ datadog:
       - "androidx.compose.ui.semantics.SemanticsConfiguration.getOrNull(androidx.compose.ui.semantics.SemanticsPropertyKey)"
       - "androidx.compose.ui.semantics.SemanticsPropertyKey.constructor(kotlin.String, kotlin.Function2)"
       - "androidx.compose.ui.text.AnnotatedString.getStringAnnotations(kotlin.Int, kotlin.Int)"
+      - "android.content.ContentResolver.registerContentObserver(android.net.Uri, kotlin.Boolean, android.database.ContentObserver)"
+      - "android.content.ContentResolver.unregisterContentObserver(android.database.ContentObserver)"
       - "androidx.core.view.GestureDetectorCompat.constructor(android.content.Context, android.view.GestureDetector.OnGestureListener)"
       - "androidx.core.view.GestureDetectorCompat.onTouchEvent(android.view.MotionEvent)"
       - "androidx.fragment.app.FragmentManager.FragmentLifecycleCallbacks.onFragmentActivityCreated(androidx.fragment.app.FragmentManager, androidx.fragment.app.Fragment, android.os.Bundle?)"

features/dd-sdk-android-rum/api/apiSurface

@@ -174,6 +174,7 @@ class com.datadog.android.rum._RumInternalProxy
     fun setAdditionalConfiguration(com.datadog.android.rum.RumConfiguration.Builder, Map<String, Any>): com.datadog.android.rum.RumConfiguration.Builder
     fun setComposeActionTrackingStrategy(com.datadog.android.rum.RumConfiguration.Builder, com.datadog.android.rum.tracking.ActionTrackingStrategy): com.datadog.android.rum.RumConfiguration.Builder
     fun setRumSessionTypeOverride(com.datadog.android.rum.RumConfiguration.Builder, RumSessionType): com.datadog.android.rum.RumConfiguration.Builder
+    fun collectAccessibilitySettings(com.datadog.android.rum.RumConfiguration.Builder): com.datadog.android.rum.RumConfiguration.Builder
 data class com.datadog.android.rum.configuration.SlowFramesConfiguration
   constructor(Int = DEFAULT_SLOW_FRAME_RECORDS_MAX_AMOUNT, Long = DEFAULT_FROZEN_FRAME_THRESHOLD_NS, Long = DEFAULT_CONTINUOUS_SLOW_FRAME_THRESHOLD_NS, Long = DEFAULT_FREEZE_DURATION_NS, Long = DEFAULT_VIEW_LIFETIME_THRESHOLD_NS)
   companion object 

features/dd-sdk-android-rum/api/dd-sdk-android-rum.api

@@ -253,6 +253,7 @@ public final class com/datadog/android/rum/_RumInternalProxy {
 }
 
 public final class com/datadog/android/rum/_RumInternalProxy$Companion {
+	public final fun collectAccessibilitySettings (Lcom/datadog/android/rum/RumConfiguration$Builder;)Lcom/datadog/android/rum/RumConfiguration$Builder;
 	public final fun setAdditionalConfiguration (Lcom/datadog/android/rum/RumConfiguration$Builder;Ljava/util/Map;)Lcom/datadog/android/rum/RumConfiguration$Builder;
 	public final fun setComposeActionTrackingStrategy (Lcom/datadog/android/rum/RumConfiguration$Builder;Lcom/datadog/android/rum/tracking/ActionTrackingStrategy;)Lcom/datadog/android/rum/RumConfiguration$Builder;
 	public final fun setRumSessionTypeOverride (Lcom/datadog/android/rum/RumConfiguration$Builder;Lcom/datadog/android/rum/RumSessionType;)Lcom/datadog/android/rum/RumConfiguration$Builder;

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

@@ -140,7 +140,8 @@ object Rum {
             initialResourceIdentifier = rumFeature.initialResourceIdentifier,
             lastInteractionIdentifier = rumFeature.lastInteractionIdentifier,
             slowFramesListener = rumFeature.slowFramesListener,
-            rumSessionTypeOverride = rumFeature.configuration.rumSessionTypeOverride
+            rumSessionTypeOverride = rumFeature.configuration.rumSessionTypeOverride,
+            accessibilityReader = rumFeature.accessibilityReader
         )
     }
 

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

@@ -387,6 +387,15 @@ data class RumConfiguration internal constructor(
             rumConfig = rumConfig.copy(rumSessionTypeOverride = rumSessionTypeOverride)
             return this
         }
+
+        /**
+         * Sets a flag to collect accessibility settings inside the RUM view end event.
+         * By default these settings are not collected.
+         */
+        internal fun collectAccessibilitySettings(): Builder {
+            rumConfig = rumConfig.copy(collectAccessibilitySettings = true)
+            return this
+        }
         // endregion
     }
 }

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

@@ -115,5 +115,11 @@ class _RumInternalProxy internal constructor(private val rumMonitor: AdvancedRum
         ): Builder {
             return builder.setRumSessionTypeOverride(rumSessionTypeOverride)
         }
+
+        fun collectAccessibilitySettings(
+            builder: Builder
+        ): Builder {
+            return builder.collectAccessibilitySettings()
+        }
     }
 }

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

@@ -43,6 +43,9 @@ 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.RumDataWriter
+import com.datadog.android.rum.internal.domain.accessibility.AccessibilityReader
+import com.datadog.android.rum.internal.domain.accessibility.DatadogAccessibilityReader
+import com.datadog.android.rum.internal.domain.accessibility.NoOpAccessibilityReader
 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
@@ -145,15 +148,23 @@ internal class RumFeature(
     internal var initialResourceIdentifier: InitialResourceIdentifier = NoOpInitialResourceIdentifier()
     internal var lastInteractionIdentifier: LastInteractionIdentifier? = NoOpLastInteractionIdentifier()
     internal var slowFramesListener: SlowFramesListener? = null
+    internal var accessibilityReader: AccessibilityReader = NoOpAccessibilityReader()
 
     private val lateCrashEventHandler by lazy { lateCrashReporterFactory(sdkCore as InternalSdkCore) }
 
     // region Feature
 
     override val name: String = Feature.RUM_FEATURE_NAME
 
+    @Suppress("LongMethod")
     override fun onInitialize(appContext: Context) {
         this.appContext = appContext
+
+        if (configuration.collectAccessibilitySettings) {
+            accessibilityReader =
+                DatadogAccessibilityReader(applicationContext = appContext, internalLogger = sdkCore.internalLogger)
+        }
+
         initialResourceIdentifier = configuration.initialResourceIdentifier
         lastInteractionIdentifier = configuration.lastInteractionIdentifier
 
@@ -288,6 +299,7 @@ internal class RumFeature(
         anrDetectorRunnable?.stop()
         vitalExecutorService = NoOpScheduledExecutorService()
         sessionListener = NoOpRumSessionListener()
+        accessibilityReader.cleanup()
 
         GlobalRumMonitor.unregister(sdkCore)
     }
@@ -630,7 +642,8 @@ internal class RumFeature(
         val composeActionTrackingStrategy: ActionTrackingStrategy,
         val additionalConfig: Map<String, Any>,
         val trackAnonymousUser: Boolean,
-        val rumSessionTypeOverride: RumSessionType?
+        val rumSessionTypeOverride: RumSessionType?,
+        val collectAccessibilitySettings: Boolean
     )
 
     internal companion object {
@@ -680,7 +693,8 @@ internal class RumFeature(
             additionalConfig = emptyMap(),
             trackAnonymousUser = true,
             slowFramesConfiguration = null,
-            rumSessionTypeOverride = null
+            rumSessionTypeOverride = null,
+            collectAccessibilitySettings = false
         )
 
         internal const val EVENT_MESSAGE_PROPERTY = "message"

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

@@ -0,0 +1,44 @@
+/*
+ * 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
+
+/**
+ * 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
+ */
+internal data class Accessibility(
+    val textSize: Float? = null,
+    val isScreenReaderEnabled: Boolean? = null,
+    val isColorInversionEnabled: Boolean? = null,
+    val isClosedCaptioningEnabled: Boolean? = null,
+    val isReducedAnimationsEnabled: Boolean? = null,
+    val isScreenPinningEnabled: Boolean? = null
+) {
+    fun toMap(): Map<String, Any> = buildMap {
+        textSize?.let { put(TEXT_SIZE_KEY, it) }
+        isScreenReaderEnabled?.let { put(SCREEN_READER_ENABLED_KEY, it) }
+        isColorInversionEnabled?.let { put(COLOR_INVERSION_ENABLED_KEY, it) }
+        isClosedCaptioningEnabled?.let { put(CLOSED_CAPTIONING_ENABLED_KEY, it) }
+        isReducedAnimationsEnabled?.let { put(REDUCED_ANIMATIONS_ENABLED_KEY, it) }
+        isScreenPinningEnabled?.let { put(SCREEN_PINNING_ENABLED_KEY, it) }
+    }
+
+    companion object {
+        internal const val TEXT_SIZE_KEY = "text_size"
+        internal const val SCREEN_READER_ENABLED_KEY = "screen_reader_enabled"
+        internal const val COLOR_INVERSION_ENABLED_KEY = "invert_colors_enabled"
+        internal const val CLOSED_CAPTIONING_ENABLED_KEY = "closed_captioning_enabled"
+        internal const val REDUCED_ANIMATIONS_ENABLED_KEY = "reduced_animations_enabled"
+        internal const val SCREEN_PINNING_ENABLED_KEY = "single_app_mode_enabled"
+    }
+}

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

@@ -0,0 +1,20 @@
+/*
+ * 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.tools.annotation.NoOpImplementation
+
+@NoOpImplementation
+internal interface AccessibilityReader {
+    fun getState(): Map<String, Any>
+
+    fun cleanup()
+
+    companion object {
+        internal const val ACCESSIBILITY_KEY = "accessibility"
+    }
+}