Skip to content

Commit aa79b82

Browse files
jonathanmosjonathanmos
committed
Refactor accessibilitysnapshotmanager to return nullable
1 parent 16acef9 commit aa79b82

File tree

14 files changed

+140
-164
lines changed

14 files changed

+140
-164
lines changed

‎detekt_custom.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,6 +1203,7 @@ datadog:
12031203
- "kotlin.Any.toString()"
12041204
- "kotlin.Boolean.hashCode()"
12051205
- "kotlin.Boolean.not()"
1206+
- "kotlin.Boolean.takeIf(kotlin.Function1)"
12061207
- "kotlin.Byte.toInt()"
12071208
- "kotlin.ByteArray.constructor(kotlin.Int)"
12081209
- "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/internal/domain/RumDataWriter.kt‎

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,7 @@ internal class RumDataWriter(
3333
) ?: return false
3434

3535
val batchEvent = if (element is ViewEvent) {
36-
val hasAccessibility = if (element.view.accessibility != null) {
37-
isAccessibilityPopulated(element.view.accessibility)
38-
} else {
39-
false
40-
}
36+
val hasAccessibility = element.view.accessibility != null
4137

4238
val eventMeta = RumEventMeta.View(
4339
viewId = element.view.id,
@@ -75,33 +71,6 @@ internal class RumDataWriter(
7571
}
7672
}
7773

78-
private fun isAccessibilityPopulated(accessibility: ViewEvent.Accessibility): Boolean {
79-
return setOf<Any?>(
80-
accessibility.textSize,
81-
accessibility.assistiveSwitchEnabled,
82-
accessibility.assistiveTouchEnabled,
83-
accessibility.boldTextEnabled,
84-
accessibility.buttonShapesEnabled,
85-
accessibility.closedCaptioningEnabled,
86-
accessibility.grayscaleEnabled,
87-
accessibility.increaseContrastEnabled,
88-
accessibility.invertColorsEnabled,
89-
accessibility.monoAudioEnabled,
90-
accessibility.onOffSwitchLabelsEnabled,
91-
accessibility.reduceMotionEnabled,
92-
accessibility.reduceTransparencyEnabled,
93-
accessibility.reducedAnimationsEnabled,
94-
accessibility.rtlEnabled,
95-
accessibility.screenReaderEnabled,
96-
accessibility.shakeToUndoEnabled,
97-
accessibility.shouldDifferentiateWithoutColor,
98-
accessibility.singleAppModeEnabled,
99-
accessibility.speakScreenEnabled,
100-
accessibility.speakSelectionEnabled,
101-
accessibility.videoAutoplayEnabled
102-
).any { it != null }
103-
}
104-
10574
// endregion
10675

10776
companion object {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ import com.datadog.tools.annotation.NoOpImplementation
1010

1111
@NoOpImplementation
1212
internal interface AccessibilitySnapshotManager {
13-
fun latestSnapshot(): AccessibilityInfo
13+
fun getIfChanged(): AccessibilityInfo?
1414
}

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

Lines changed: 30 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -12,65 +12,47 @@ internal class DefaultAccessibilitySnapshotManager(
1212
private val accessibilityReader: InfoProvider<AccessibilityInfo>
1313
) : AccessibilitySnapshotManager {
1414
@Volatile
15-
private var lastSnapshot = AccessibilityInfo()
15+
private var lastSnapshot: AccessibilityInfo? = null
1616

1717
@Synchronized
18-
override fun latestSnapshot(): AccessibilityInfo {
19-
val newAccessibilitySnapshot = accessibilityReader.getState()
18+
override fun getIfChanged(): AccessibilityInfo? {
19+
val newSnapshot = accessibilityReader.getState()
20+
if (newSnapshot == lastSnapshot) return null
2021

21-
val deltaSnapshot = AccessibilityInfo(
22-
textSize =
23-
if (newAccessibilitySnapshot.textSize != lastSnapshot.textSize) {
24-
newAccessibilitySnapshot.textSize
25-
} else {
26-
null
27-
},
22+
val deltaSnapshot = createDelta(newSnapshot, lastSnapshot)
23+
lastSnapshot = newSnapshot
2824

29-
isScreenReaderEnabled =
30-
if (newAccessibilitySnapshot.isScreenReaderEnabled != lastSnapshot.isScreenReaderEnabled) {
31-
newAccessibilitySnapshot.isScreenReaderEnabled
32-
} else {
33-
null
34-
},
25+
return if (deltaSnapshot.hasAnyNonNullValues()) deltaSnapshot else null
26+
}
3527

28+
private fun createDelta(new: AccessibilityInfo, old: AccessibilityInfo?): AccessibilityInfo {
29+
return AccessibilityInfo(
30+
textSize =
31+
new.textSize.takeIf { it != old?.textSize },
32+
isScreenReaderEnabled =
33+
new.isScreenReaderEnabled.takeIf { it != old?.isScreenReaderEnabled },
3634
isColorInversionEnabled =
37-
if (newAccessibilitySnapshot.isColorInversionEnabled != lastSnapshot.isColorInversionEnabled) {
38-
newAccessibilitySnapshot.isColorInversionEnabled
39-
} else {
40-
null
41-
},
42-
35+
new.isColorInversionEnabled.takeIf { it != old?.isColorInversionEnabled },
4336
isClosedCaptioningEnabled =
44-
if (newAccessibilitySnapshot.isClosedCaptioningEnabled != lastSnapshot.isClosedCaptioningEnabled) {
45-
newAccessibilitySnapshot.isClosedCaptioningEnabled
46-
} else {
47-
null
48-
},
49-
37+
new.isClosedCaptioningEnabled.takeIf { it != old?.isClosedCaptioningEnabled },
5038
isReducedAnimationsEnabled =
51-
if (newAccessibilitySnapshot.isReducedAnimationsEnabled != lastSnapshot.isReducedAnimationsEnabled) {
52-
newAccessibilitySnapshot.isReducedAnimationsEnabled
53-
} else {
54-
null
55-
},
56-
39+
new.isReducedAnimationsEnabled.takeIf { it != old?.isReducedAnimationsEnabled },
5740
isScreenPinningEnabled =
58-
if (newAccessibilitySnapshot.isScreenPinningEnabled != lastSnapshot.isScreenPinningEnabled) {
59-
newAccessibilitySnapshot.isScreenPinningEnabled
60-
} else {
61-
null
62-
},
63-
41+
new.isScreenPinningEnabled.takeIf { it != old?.isScreenPinningEnabled },
6442
isRtlEnabled =
65-
if (newAccessibilitySnapshot.isRtlEnabled != lastSnapshot.isRtlEnabled) {
66-
newAccessibilitySnapshot.isRtlEnabled
67-
} else {
68-
null
69-
}
43+
new.isRtlEnabled.takeIf { it != old?.isRtlEnabled }
7044
)
45+
}
7146

72-
lastSnapshot = newAccessibilitySnapshot
73-
74-
return deltaSnapshot
47+
private fun AccessibilityInfo.hasAnyNonNullValues(): Boolean {
48+
return setOf<Any?>(
49+
this.textSize,
50+
this.isScreenReaderEnabled,
51+
this.isRtlEnabled,
52+
this.isScreenPinningEnabled,
53+
this.isColorInversionEnabled,
54+
this.isClosedCaptioningEnabled,
55+
this.isReducedAnimationsEnabled
56+
).any { it != null }
7557
}
7658
}

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -997,16 +997,17 @@ internal open class RumViewScope(
997997
)
998998
}
999999

1000-
val accessibilityState = accessibilitySnapshotManager.latestSnapshot()
1001-
val accessibility = ViewEvent.Accessibility(
1002-
textSize = accessibilityState.textSize,
1003-
invertColorsEnabled = accessibilityState.isColorInversionEnabled,
1004-
singleAppModeEnabled = accessibilityState.isScreenPinningEnabled,
1005-
screenReaderEnabled = accessibilityState.isScreenReaderEnabled,
1006-
closedCaptioningEnabled = accessibilityState.isClosedCaptioningEnabled,
1007-
reducedAnimationsEnabled = accessibilityState.isReducedAnimationsEnabled,
1008-
rtlEnabled = accessibilityState.isRtlEnabled
1009-
)
1000+
val accessibility = accessibilitySnapshotManager.getIfChanged()?.let {
1001+
ViewEvent.Accessibility(
1002+
textSize = it.textSize,
1003+
invertColorsEnabled = it.isColorInversionEnabled,
1004+
singleAppModeEnabled = it.isScreenPinningEnabled,
1005+
screenReaderEnabled = it.isScreenReaderEnabled,
1006+
closedCaptioningEnabled = it.isClosedCaptioningEnabled,
1007+
reducedAnimationsEnabled = it.isReducedAnimationsEnabled,
1008+
rtlEnabled = it.isRtlEnabled
1009+
)
1010+
}
10101011

10111012
val batteryInfo = batteryInfoProvider.getState()
10121013
val displayInfo = displayInfoProvider.getState()

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

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import com.datadog.android.rum.model.ErrorEvent
1717
import com.datadog.android.rum.model.LongTaskEvent
1818
import com.datadog.android.rum.model.ResourceEvent
1919
import com.datadog.android.rum.model.ViewEvent
20-
import com.datadog.android.rum.model.ViewEvent.Accessibility
2120
import com.datadog.android.rum.utils.config.GlobalRumMonitorTestConfiguration
2221
import com.datadog.android.rum.utils.forge.Configurator
2322
import com.datadog.tools.unit.annotations.TestConfigurationsProvider
@@ -131,7 +130,7 @@ internal class RumDataWriterTest {
131130
) {
132131
// Given
133132
whenever(mockSerializer.serialize(fakeViewEvent)) doReturn fakeSerializedEvent
134-
val hasAccessibility = isAccessibilityPopulated(fakeViewEvent.view.accessibility)
133+
val hasAccessibility = fakeViewEvent.view.accessibility != null
135134
val eventMeta = RumEventMeta.View(
136135
viewId = fakeViewEvent.view.id,
137136
documentVersion = fakeViewEvent.dd.documentVersion,
@@ -161,7 +160,7 @@ internal class RumDataWriterTest {
161160
) {
162161
// Given
163162
whenever(mockSerializer.serialize(fakeViewEvent)) doReturn fakeSerializedEvent
164-
val hasAccessibility = isAccessibilityPopulated(fakeViewEvent.view.accessibility)
163+
val hasAccessibility = fakeViewEvent.view.accessibility != null
165164
val eventMeta = RumEventMeta.View(
166165
viewId = fakeViewEvent.view.id,
167166
documentVersion = fakeViewEvent.dd.documentVersion,
@@ -257,13 +256,13 @@ internal class RumDataWriterTest {
257256
// region accessibility
258257

259258
@Test
260-
fun `M hasAccessibility false W write() { empty accessibility object }`(
259+
fun `M hasAccessibility false W write() { null accessibility }`(
261260
forge: Forge
262261
) {
263262
// Given
264263
val viewEvent = forge.getForgery<ViewEvent>()
265264
val newView = viewEvent.view.copy(
266-
accessibility = Accessibility()
265+
accessibility = null
267266
)
268267
val newViewEvent = viewEvent.copy(
269268
view = newView
@@ -282,15 +281,13 @@ internal class RumDataWriterTest {
282281
}
283282

284283
@Test
285-
fun `M hasAccessibility true W write() { populated accessibility object }`(
284+
fun `M hasAccessibility true W write() { non-null accessibility }`(
286285
forge: Forge
287286
) {
288287
// Given
289288
val viewEvent = forge.getForgery<ViewEvent>()
290289
val newView = viewEvent.view.copy(
291-
accessibility = Accessibility(
292-
textSize = "1.3"
293-
)
290+
accessibility = forge.getForgery()
294291
)
295292
val newViewEvent = viewEvent.copy(
296293
view = newView
@@ -310,34 +307,6 @@ internal class RumDataWriterTest {
310307

311308
// endregion
312309

313-
private fun isAccessibilityPopulated(accessibility: Accessibility?): Boolean {
314-
if (accessibility == null) return false
315-
return setOf<Any?>(
316-
accessibility.textSize,
317-
accessibility.assistiveSwitchEnabled,
318-
accessibility.assistiveTouchEnabled,
319-
accessibility.boldTextEnabled,
320-
accessibility.buttonShapesEnabled,
321-
accessibility.closedCaptioningEnabled,
322-
accessibility.grayscaleEnabled,
323-
accessibility.increaseContrastEnabled,
324-
accessibility.invertColorsEnabled,
325-
accessibility.monoAudioEnabled,
326-
accessibility.onOffSwitchLabelsEnabled,
327-
accessibility.reduceMotionEnabled,
328-
accessibility.reduceTransparencyEnabled,
329-
accessibility.reducedAnimationsEnabled,
330-
accessibility.rtlEnabled,
331-
accessibility.screenReaderEnabled,
332-
accessibility.shakeToUndoEnabled,
333-
accessibility.shouldDifferentiateWithoutColor,
334-
accessibility.singleAppModeEnabled,
335-
accessibility.speakScreenEnabled,
336-
accessibility.speakSelectionEnabled,
337-
accessibility.videoAutoplayEnabled
338-
).any { it != null }
339-
}
340-
341310
companion object {
342311
val rumMonitor = GlobalRumMonitorTestConfiguration()
343312

0 commit comments

Comments
 (0)