Merge pull request #2655 from DataDog/xgouchet/RUM-9908/add_view_attributes_update_methods

xgouchet · web-flow · commit 2fe6c41982b4 · 2025-05-23T11:14:14.000+02:00
RUM-9908 Create view attributes update methods
diff --git a/features/dd-sdk-android-rum/api/apiSurface b/features/dd-sdk-android-rum/api/apiSurface
@@ -120,6 +120,8 @@ interface com.datadog.android.rum.RumMonitor
   fun clearAttributes()
   fun stopSession()
   fun addViewLoadingTime(Boolean)
+  fun addViewAttributes(Map<String, Any?>)
+  fun removeViewAttributes(Collection<String>)
   var debug: Boolean
   fun _getInternal(): _RumInternalProxy?
 enum com.datadog.android.rum.RumPerformanceMetric
diff --git a/features/dd-sdk-android-rum/api/dd-sdk-android-rum.api b/features/dd-sdk-android-rum/api/dd-sdk-android-rum.api
@@ -152,12 +152,14 @@ public abstract interface class com/datadog/android/rum/RumMonitor {
 	public abstract fun addFeatureFlagEvaluation (Ljava/lang/String;Ljava/lang/Object;)V
 	public abstract fun addFeatureFlagEvaluations (Ljava/util/Map;)V
 	public abstract fun addTiming (Ljava/lang/String;)V
+	public abstract fun addViewAttributes (Ljava/util/Map;)V
 	public abstract fun addViewLoadingTime (Z)V
 	public abstract fun clearAttributes ()V
 	public abstract fun getAttributes ()Ljava/util/Map;
 	public abstract fun getCurrentSessionId (Lkotlin/jvm/functions/Function1;)V
 	public abstract fun getDebug ()Z
 	public abstract fun removeAttribute (Ljava/lang/String;)V
+	public abstract fun removeViewAttributes (Ljava/util/Collection;)V
 	public abstract fun setDebug (Z)V
 	public abstract fun startAction (Lcom/datadog/android/rum/RumActionType;Ljava/lang/String;Ljava/util/Map;)V
 	public abstract fun startResource (Ljava/lang/String;Lcom/datadog/android/rum/RumResourceMethod;Ljava/lang/String;Ljava/util/Map;)V
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/RumMonitor.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/RumMonitor.kt
@@ -334,6 +334,20 @@ interface RumMonitor {
     @ExperimentalRumApi
     fun addViewLoadingTime(overwrite: Boolean)
 
+    /**
+     * Adds attributes to the current active View. They will be propagated to all future RUM events within this View
+     * until it stops being active.
+     * @param attributes the attributes to add to the view
+     */
+    fun addViewAttributes(attributes: Map<String, Any?>)
+
+    /**
+     * Removes attributes from the current active View. Future RUM events within this view won't be having these
+     * attributes anymore.
+     * @param attributes the attribute keys to remove from the view
+     */
+    fun removeViewAttributes(attributes: Collection<String>)
+
     /**
      * Utility setting to inspect the active RUM View.
      * If set, a debugging outline will be displayed on top of the application, describing the name
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumApplicationScope.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumApplicationScope.kt
@@ -122,12 +122,16 @@ internal class RumApplicationScope(
 
     // endregion
 
+    // region RumViewChangedListener
+
     override fun onViewChanged(viewInfo: RumViewInfo) {
         if (viewInfo.isActive) {
             lastActiveViewInfo = viewInfo
         }
     }
 
+    // endregion
+
     // region Internal
 
     @WorkerThread
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumRawEvent.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumRawEvent.kt
@@ -186,6 +186,16 @@ internal sealed class RumRawEvent {
         override val eventTime: Time = Time()
     ) : RumRawEvent()
 
+    internal data class AddViewAttributes(
+        val attributes: Map<String, Any?>,
+        override val eventTime: Time = Time()
+    ) : RumRawEvent()
+
+    internal data class RemoveViewAttributes(
+        val attributes: Collection<String>,
+        override val eventTime: Time = Time()
+    ) : RumRawEvent()
+
     internal data class AddLongTask(
         val durationNs: Long,
         val target: String,
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScope.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScope.kt
@@ -216,6 +216,8 @@ internal open class RumViewScope(
 
             is RumRawEvent.UpdatePerformanceMetric -> onUpdatePerformanceMetric(event)
             is RumRawEvent.AddViewLoadingTime -> onAddViewLoadingTime(event, writer)
+            is RumRawEvent.AddViewAttributes -> onAddViewAttributes(event)
+            is RumRawEvent.RemoveViewAttributes -> onRemoveViewAttributes(event)
 
             else -> delegateEventToChildren(event, writer)
         }
@@ -322,6 +324,18 @@ internal open class RumViewScope(
         sendViewUpdate(event, writer)
     }
 
+    @WorkerThread
+    private fun onAddViewAttributes(event: RumRawEvent.AddViewAttributes) {
+        viewAttributes.putAll(event.attributes)
+    }
+
+    @WorkerThread
+    private fun onRemoveViewAttributes(event: RumRawEvent.RemoveViewAttributes) {
+        event.attributes.forEach {
+            viewAttributes.remove(it)
+        }
+    }
+
     @WorkerThread
     private fun onStartView(
         event: RumRawEvent.StartView,
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitor.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitor.kt
@@ -553,6 +553,18 @@ internal class DatadogRumMonitor(
         handleEvent(RumRawEvent.AddViewLoadingTime(overwrite = overwrite))
     }
 
+    override fun addViewAttributes(attributes: Map<String, Any?>) {
+        handleEvent(
+            RumRawEvent.AddViewAttributes(attributes)
+        )
+    }
+
+    override fun removeViewAttributes(attributes: Collection<String>) {
+        handleEvent(
+            RumRawEvent.RemoveViewAttributes(attributes)
+        )
+    }
+
     override fun addLongTask(durationNs: Long, target: String) {
         handleEvent(
             RumRawEvent.AddLongTask(durationNs, target)
diff --git a/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScopeAttributePropagationTest.kt b/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScopeAttributePropagationTest.kt
@@ -45,10 +45,13 @@ import com.datadog.tools.unit.extensions.TestConfigurationExtension
 import com.datadog.tools.unit.extensions.config.TestConfiguration
 import com.datadog.tools.unit.forge.exhaustiveAttributes
 import fr.xgouchet.elmyr.Forge
+import fr.xgouchet.elmyr.annotation.AdvancedForgery
 import fr.xgouchet.elmyr.annotation.BoolForgery
 import fr.xgouchet.elmyr.annotation.Forgery
 import fr.xgouchet.elmyr.annotation.LongForgery
+import fr.xgouchet.elmyr.annotation.MapForgery
 import fr.xgouchet.elmyr.annotation.StringForgery
+import fr.xgouchet.elmyr.annotation.StringForgeryType
 import fr.xgouchet.elmyr.junit5.ForgeConfiguration
 import fr.xgouchet.elmyr.junit5.ForgeExtension
 import org.assertj.core.api.Assertions.assertThat
@@ -314,6 +317,52 @@ internal class RumViewScopeAttributePropagationTest {
         }
     }
 
+    @Test
+    fun `M send event with added view attributes W handleEvent(AddViewAttributes+KeepAlive) on active view`() {
+        // Given
+        val expectedAttributes = mutableMapOf<String, Any?>()
+        expectedAttributes.putAll(fakeParentAttributes)
+        expectedAttributes.putAll(fakeViewAttributes)
+        testedScope = newRumViewScope(initialAttributes = emptyMap())
+
+        // When
+        testedScope.handleEvent(RumRawEvent.AddViewAttributes(fakeViewAttributes), mockWriter)
+        val result = testedScope.handleEvent(RumRawEvent.KeepAlive(), mockWriter)
+
+        // Then
+        argumentCaptor<ViewEvent> {
+            verify(mockWriter).write(eq(mockEventBatchWriter), capture(), eq(EventType.DEFAULT))
+            assertThat(lastValue)
+                .containsExactlyContextAttributes(expectedAttributes)
+        }
+        assertThat(result).isNotNull()
+    }
+
+    @Test
+    fun `M send event without removed view attributes W handleEvent(AddViewAttributes+KeepAlive) on active view`(
+        @MapForgery(
+            key = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHABETICAL)]),
+            value = AdvancedForgery(string = [StringForgery()])
+        ) fakeViewAttributes: Map<String, String>
+    ) {
+        // Given
+        val expectedAttributes = mutableMapOf<String, Any?>()
+        expectedAttributes.putAll(fakeParentAttributes)
+        testedScope = newRumViewScope(initialAttributes = fakeViewAttributes)
+
+        // When
+        testedScope.handleEvent(RumRawEvent.RemoveViewAttributes(fakeViewAttributes.keys), mockWriter)
+        val result = testedScope.handleEvent(RumRawEvent.KeepAlive(), mockWriter)
+
+        // Then
+        argumentCaptor<ViewEvent> {
+            verify(mockWriter).write(eq(mockEventBatchWriter), capture(), eq(EventType.DEFAULT))
+            assertThat(lastValue)
+                .containsExactlyContextAttributes(expectedAttributes)
+        }
+        assertThat(result).isNotNull()
+    }
+
     // endregion
 
     // region Propagate parent attributes in Error Event
diff --git a/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitorTest.kt b/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitorTest.kt
@@ -55,12 +55,14 @@ import com.datadog.android.telemetry.internal.TelemetryEventHandler
 import com.datadog.tools.unit.forge.aThrowable
 import com.datadog.tools.unit.forge.exhaustiveAttributes
 import fr.xgouchet.elmyr.Forge
+import fr.xgouchet.elmyr.annotation.AdvancedForgery
 import fr.xgouchet.elmyr.annotation.BoolForgery
 import fr.xgouchet.elmyr.annotation.DoubleForgery
 import fr.xgouchet.elmyr.annotation.FloatForgery
 import fr.xgouchet.elmyr.annotation.Forgery
 import fr.xgouchet.elmyr.annotation.IntForgery
 import fr.xgouchet.elmyr.annotation.LongForgery
+import fr.xgouchet.elmyr.annotation.MapForgery
 import fr.xgouchet.elmyr.annotation.StringForgery
 import fr.xgouchet.elmyr.annotation.StringForgeryType
 import fr.xgouchet.elmyr.junit5.ForgeConfiguration
@@ -919,6 +921,41 @@ internal class DatadogRumMonitorTest {
         verifyNoMoreInteractions(mockScope, mockWriter)
     }
 
+    @Test
+    fun `M delegate event to rootScope W addViewAttributes()`(
+        @MapForgery(
+            key = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHABETICAL)]),
+            value = AdvancedForgery(string = [StringForgery()])
+        ) fakeAttributes: Map<String, String>
+    ) {
+        testedMonitor.addViewAttributes(fakeAttributes)
+        Thread.sleep(PROCESSING_DELAY)
+
+        argumentCaptor<RumRawEvent> {
+            verify(mockScope).handleEvent(capture(), same(mockWriter))
+            val event = firstValue
+            check(event is RumRawEvent.AddViewAttributes)
+            assertThat(event.attributes).isSameAs(fakeAttributes)
+        }
+        verifyNoMoreInteractions(mockScope, mockWriter)
+    }
+
+    @Test
+    fun `M delegate event to rootScope W removeViewAttributes()`(
+        @StringForgery fakeAttributes: List<String>
+    ) {
+        testedMonitor.removeViewAttributes(fakeAttributes)
+        Thread.sleep(PROCESSING_DELAY)
+
+        argumentCaptor<RumRawEvent> {
+            verify(mockScope).handleEvent(capture(), same(mockWriter))
+            val event = firstValue
+            check(event is RumRawEvent.RemoveViewAttributes)
+            assertThat(event.attributes).isSameAs(fakeAttributes)
+        }
+        verifyNoMoreInteractions(mockScope, mockWriter)
+    }
+
     @Test
     fun `M delegate event to rootScope on current thread W addCrash()`(
         @StringForgery message: String,

Original file line number	Diff line number	Diff line change
`@@ -122,12 +122,16 @@ internal class RumApplicationScope(`
`122`	`122`
`123`	`123`	`// endregion`
`124`	`124`
	`125`	`+ // region RumViewChangedListener`
	`126`	`+`
`125`	`127`	`override fun onViewChanged(viewInfo: RumViewInfo) {`
`126`	`128`	`if (viewInfo.isActive) {`
`127`	`129`	`lastActiveViewInfo = viewInfo`
`128`	`130`	`}`
`129`	`131`	`}`
`130`	`132`
	`133`	`+ // endregion`
	`134`	`+`
`131`	`135`	`// region Internal`
`132`	`136`
`133`	`137`	`@WorkerThread`