Merge pull request #2823 from DataDog/jmoskovich/additional-accessibilty-coverage

Some additional accessibility test coverage

Author: jonathanmos

detekt_custom.yml

@@ -1203,6 +1203,7 @@ datadog:
       - "kotlin.Any.toString()"
       - "kotlin.Boolean.hashCode()"
       - "kotlin.Boolean.not()"
+      - "kotlin.Boolean.takeIf(kotlin.Function1)"
       - "kotlin.Byte.toInt()"
       - "kotlin.ByteArray.constructor(kotlin.Int)"
       - "kotlin.ByteArray.copyTo(kotlin.Int, kotlin.ByteArray, kotlin.Int, kotlin.Int, com.datadog.android.api.InternalLogger)"

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

@@ -60,8 +60,7 @@ data class RumConfiguration internal constructor(
         }
 
         /**
-         * Whether to collect accessibility attributes inside the RUM view update event.
-         * This is disabled by default.
+         * Whether to collect accessibility attributes - this is disabled by default.
          *
          * @param enabled whether collecting accessibility attributes is enabled or not.
          */

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

@@ -33,11 +33,7 @@ internal class RumDataWriter(
         ) ?: return false
 
         val batchEvent = if (element is ViewEvent) {
-            val hasAccessibility = if (element.view.accessibility != null) {
-                isAccessibilityPopulated(element.view.accessibility)
-            } else {
-                false
-            }
+            val hasAccessibility = element.view.accessibility != null
 
             val eventMeta = RumEventMeta.View(
                 viewId = element.view.id,
@@ -75,33 +71,6 @@ internal class RumDataWriter(
         }
     }
 
-    private fun isAccessibilityPopulated(accessibility: ViewEvent.Accessibility): Boolean {
-        return setOf<Any?>(
-            accessibility.textSize,
-            accessibility.assistiveSwitchEnabled,
-            accessibility.assistiveTouchEnabled,
-            accessibility.boldTextEnabled,
-            accessibility.buttonShapesEnabled,
-            accessibility.closedCaptioningEnabled,
-            accessibility.grayscaleEnabled,
-            accessibility.increaseContrastEnabled,
-            accessibility.invertColorsEnabled,
-            accessibility.monoAudioEnabled,
-            accessibility.onOffSwitchLabelsEnabled,
-            accessibility.reduceMotionEnabled,
-            accessibility.reduceTransparencyEnabled,
-            accessibility.reducedAnimationsEnabled,
-            accessibility.rtlEnabled,
-            accessibility.screenReaderEnabled,
-            accessibility.shakeToUndoEnabled,
-            accessibility.shouldDifferentiateWithoutColor,
-            accessibility.singleAppModeEnabled,
-            accessibility.speakScreenEnabled,
-            accessibility.speakSelectionEnabled,
-            accessibility.videoAutoplayEnabled
-        ).any { it != null }
-    }
-
     // endregion
 
     companion object {

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

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

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

@@ -12,65 +12,47 @@ internal class DefaultAccessibilitySnapshotManager(
     private val accessibilityReader: InfoProvider<AccessibilityInfo>
 ) : AccessibilitySnapshotManager {
     @Volatile
-    private var lastSnapshot = AccessibilityInfo()
+    private var lastSnapshot: AccessibilityInfo? = null
 
     @Synchronized
-    override fun latestSnapshot(): AccessibilityInfo {
-        val newAccessibilitySnapshot = accessibilityReader.getState()
+    override fun getIfChanged(): AccessibilityInfo? {
+        val newSnapshot = accessibilityReader.getState()
+        if (newSnapshot == lastSnapshot) return null
 
-        val deltaSnapshot = AccessibilityInfo(
-            textSize =
-            if (newAccessibilitySnapshot.textSize != lastSnapshot.textSize) {
-                newAccessibilitySnapshot.textSize
-            } else {
-                null
-            },
+        val deltaSnapshot = createDelta(newSnapshot, lastSnapshot)
+        lastSnapshot = newSnapshot
 
-            isScreenReaderEnabled =
-            if (newAccessibilitySnapshot.isScreenReaderEnabled != lastSnapshot.isScreenReaderEnabled) {
-                newAccessibilitySnapshot.isScreenReaderEnabled
-            } else {
-                null
-            },
+        return if (deltaSnapshot.hasAnyNonNullValues()) deltaSnapshot else null
+    }
 
+    private fun createDelta(new: AccessibilityInfo, old: AccessibilityInfo?): AccessibilityInfo {
+        return AccessibilityInfo(
+            textSize =
+            new.textSize.takeIf { it != old?.textSize },
+            isScreenReaderEnabled =
+            new.isScreenReaderEnabled.takeIf { it != old?.isScreenReaderEnabled },
             isColorInversionEnabled =
-            if (newAccessibilitySnapshot.isColorInversionEnabled != lastSnapshot.isColorInversionEnabled) {
-                newAccessibilitySnapshot.isColorInversionEnabled
-            } else {
-                null
-            },
-
+            new.isColorInversionEnabled.takeIf { it != old?.isColorInversionEnabled },
             isClosedCaptioningEnabled =
-            if (newAccessibilitySnapshot.isClosedCaptioningEnabled != lastSnapshot.isClosedCaptioningEnabled) {
-                newAccessibilitySnapshot.isClosedCaptioningEnabled
-            } else {
-                null
-            },
-
+            new.isClosedCaptioningEnabled.takeIf { it != old?.isClosedCaptioningEnabled },
             isReducedAnimationsEnabled =
-            if (newAccessibilitySnapshot.isReducedAnimationsEnabled != lastSnapshot.isReducedAnimationsEnabled) {
-                newAccessibilitySnapshot.isReducedAnimationsEnabled
-            } else {
-                null
-            },
-
+            new.isReducedAnimationsEnabled.takeIf { it != old?.isReducedAnimationsEnabled },
             isScreenPinningEnabled =
-            if (newAccessibilitySnapshot.isScreenPinningEnabled != lastSnapshot.isScreenPinningEnabled) {
-                newAccessibilitySnapshot.isScreenPinningEnabled
-            } else {
-                null
-            },
-
+            new.isScreenPinningEnabled.takeIf { it != old?.isScreenPinningEnabled },
             isRtlEnabled =
-            if (newAccessibilitySnapshot.isRtlEnabled != lastSnapshot.isRtlEnabled) {
-                newAccessibilitySnapshot.isRtlEnabled
-            } else {
-                null
-            }
+            new.isRtlEnabled.takeIf { it != old?.isRtlEnabled }
         )
+    }
 
-        lastSnapshot = newAccessibilitySnapshot
-
-        return deltaSnapshot
+    private fun AccessibilityInfo.hasAnyNonNullValues(): Boolean {
+        return setOf<Any?>(
+            this.textSize,
+            this.isScreenReaderEnabled,
+            this.isRtlEnabled,
+            this.isScreenPinningEnabled,
+            this.isColorInversionEnabled,
+            this.isClosedCaptioningEnabled,
+            this.isReducedAnimationsEnabled
+        ).any { it != null }
     }
 }

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

@@ -997,16 +997,17 @@ internal open class RumViewScope(
             )
         }
 
-        val accessibilityState = accessibilitySnapshotManager.latestSnapshot()
-        val accessibility = ViewEvent.Accessibility(
-            textSize = accessibilityState.textSize,
-            invertColorsEnabled = accessibilityState.isColorInversionEnabled,
-            singleAppModeEnabled = accessibilityState.isScreenPinningEnabled,
-            screenReaderEnabled = accessibilityState.isScreenReaderEnabled,
-            closedCaptioningEnabled = accessibilityState.isClosedCaptioningEnabled,
-            reducedAnimationsEnabled = accessibilityState.isReducedAnimationsEnabled,
-            rtlEnabled = accessibilityState.isRtlEnabled
-        )
+        val accessibility = accessibilitySnapshotManager.getIfChanged()?.let {
+            ViewEvent.Accessibility(
+                textSize = it.textSize,
+                invertColorsEnabled = it.isColorInversionEnabled,
+                singleAppModeEnabled = it.isScreenPinningEnabled,
+                screenReaderEnabled = it.isScreenReaderEnabled,
+                closedCaptioningEnabled = it.isClosedCaptioningEnabled,
+                reducedAnimationsEnabled = it.isReducedAnimationsEnabled,
+                rtlEnabled = it.isRtlEnabled
+            )
+        }
 
         val batteryInfo = batteryInfoProvider.getState()
         val displayInfo = displayInfoProvider.getState()

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

@@ -36,6 +36,7 @@ import org.junit.jupiter.api.extension.Extensions
 import org.mockito.Mock
 import org.mockito.junit.jupiter.MockitoExtension
 import org.mockito.junit.jupiter.MockitoSettings
+import org.mockito.kotlin.argumentCaptor
 import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.doThrow
 import org.mockito.kotlin.verify
@@ -129,7 +130,7 @@ internal class RumDataWriterTest {
     ) {
         // Given
         whenever(mockSerializer.serialize(fakeViewEvent)) doReturn fakeSerializedEvent
-        val hasAccessibility = isAccessibilityPopulated(fakeViewEvent.view.accessibility)
+        val hasAccessibility = fakeViewEvent.view.accessibility != null
         val eventMeta = RumEventMeta.View(
             viewId = fakeViewEvent.view.id,
             documentVersion = fakeViewEvent.dd.documentVersion,
@@ -159,7 +160,7 @@ internal class RumDataWriterTest {
     ) {
         // Given
         whenever(mockSerializer.serialize(fakeViewEvent)) doReturn fakeSerializedEvent
-        val hasAccessibility = isAccessibilityPopulated(fakeViewEvent.view.accessibility)
+        val hasAccessibility = fakeViewEvent.view.accessibility != null
         val eventMeta = RumEventMeta.View(
             viewId = fakeViewEvent.view.id,
             documentVersion = fakeViewEvent.dd.documentVersion,
@@ -252,34 +253,60 @@ internal class RumDataWriterTest {
 
     // endregion
 
-    private fun isAccessibilityPopulated(accessibility: ViewEvent.Accessibility?): Boolean {
-        if (accessibility == null) return false
-        return setOf<Any?>(
-            accessibility.textSize,
-            accessibility.assistiveSwitchEnabled,
-            accessibility.assistiveTouchEnabled,
-            accessibility.boldTextEnabled,
-            accessibility.buttonShapesEnabled,
-            accessibility.closedCaptioningEnabled,
-            accessibility.grayscaleEnabled,
-            accessibility.increaseContrastEnabled,
-            accessibility.invertColorsEnabled,
-            accessibility.monoAudioEnabled,
-            accessibility.onOffSwitchLabelsEnabled,
-            accessibility.reduceMotionEnabled,
-            accessibility.reduceTransparencyEnabled,
-            accessibility.reducedAnimationsEnabled,
-            accessibility.rtlEnabled,
-            accessibility.screenReaderEnabled,
-            accessibility.shakeToUndoEnabled,
-            accessibility.shouldDifferentiateWithoutColor,
-            accessibility.singleAppModeEnabled,
-            accessibility.speakScreenEnabled,
-            accessibility.speakSelectionEnabled,
-            accessibility.videoAutoplayEnabled
-        ).any { it != null }
+    // region accessibility
+
+    @Test
+    fun `M hasAccessibility false W write() { null accessibility }`(
+        forge: Forge
+    ) {
+        // Given
+        val viewEvent = forge.getForgery<ViewEvent>()
+        val newView = viewEvent.view.copy(
+            accessibility = null
+        )
+        val newViewEvent = viewEvent.copy(
+            view = newView
+        )
+
+        whenever(mockSerializer.serialize(newViewEvent)) doReturn fakeSerializedEvent
+
+        // When
+        testedWriter.write(mockEventBatchWriter, newViewEvent, fakeEventType)
+
+        // Then
+        val captor = argumentCaptor<RumEventMeta.View>()
+        verify(mockEventMetaSerializer).serialize(captor.capture())
+        val metaData = captor.firstValue
+        assertThat(metaData.hasAccessibility).isFalse
     }
 
+    @Test
+    fun `M hasAccessibility true W write() { non-null accessibility }`(
+        forge: Forge
+    ) {
+        // Given
+        val viewEvent = forge.getForgery<ViewEvent>()
+        val newView = viewEvent.view.copy(
+            accessibility = forge.getForgery()
+        )
+        val newViewEvent = viewEvent.copy(
+            view = newView
+        )
+
+        whenever(mockSerializer.serialize(newViewEvent)) doReturn fakeSerializedEvent
+
+        // When
+        testedWriter.write(mockEventBatchWriter, newViewEvent, fakeEventType)
+
+        // Then
+        val captor = argumentCaptor<RumEventMeta.View>()
+        verify(mockEventMetaSerializer).serialize(captor.capture())
+        val metaData = captor.firstValue
+        assertThat(metaData.hasAccessibility).isTrue
+    }
+
+    // endregion
+
     companion object {
         val rumMonitor = GlobalRumMonitorTestConfiguration()