RUM-6035 Add the integration tests related with RumMonitor#addViewLoadingTime API

dd-sdk-android-core/api/apiSurface

@@ -44,7 +44,7 @@ interface com.datadog.android.api.InternalLogger
   fun log(Level, List<Target>, () -> String, Throwable? = null, Boolean = false, Map<String, Any?>? = null)
   fun logMetric(() -> String, Map<String, Any?>, Float)
   fun startPerformanceMeasure(String, com.datadog.android.core.metrics.TelemetryMetricType, Float, String): com.datadog.android.core.metrics.PerformanceMetric?
-  fun logApiUsage(com.datadog.android.internal.telemetry.InternalTelemetryEvent.ApiUsage, Float)
+  fun logApiUsage(com.datadog.android.internal.telemetry.InternalTelemetryEvent.ApiUsage, Float = 15f)
   companion object 
     val UNBOUND: InternalLogger
 interface com.datadog.android.api.SdkCore

dd-sdk-android-core/api/dd-sdk-android-core.api

@@ -89,6 +89,7 @@ public final class com/datadog/android/api/InternalLogger$Companion {
 public final class com/datadog/android/api/InternalLogger$DefaultImpls {
 	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Lcom/datadog/android/api/InternalLogger$Target;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;ILjava/lang/Object;)V
 	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Ljava/util/List;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;ILjava/lang/Object;)V
+	public static synthetic fun logApiUsage$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/internal/telemetry/InternalTelemetryEvent$ApiUsage;FILjava/lang/Object;)V
 }
 
 public final class com/datadog/android/api/InternalLogger$Level : java/lang/Enum {

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/InternalLogger.kt

@@ -137,12 +137,12 @@ interface InternalLogger {
      * Logs an API usage from the internal implementation.
      * @param apiUsageEvent the API event being tracked
      * @param samplingRate value between 0-100 for sampling the event. Note that the sampling rate applied to this
-     * event will be applied in addition to the global telemetry sampling rate.
+     * event will be applied in addition to the global telemetry sampling rate. By default, the sampling rate is 15%.
      */
     @InternalApi
     fun logApiUsage(
         apiUsageEvent: InternalTelemetryEvent.ApiUsage,
-        samplingRate: Float
+        samplingRate: Float = 15f
     )
 
     companion object {

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

@@ -540,7 +540,7 @@ internal class RumFeature(
         internal const val ALL_IN_SAMPLE_RATE: Float = 100f
         internal const val DEFAULT_SAMPLE_RATE: Float = 100f
         internal const val DEFAULT_TELEMETRY_SAMPLE_RATE: Float = 20f
-        internal const val DEFAULT_TELEMETRY_CONFIGURATION_SAMPLE_RATE: Float = 100f
+        internal const val DEFAULT_TELEMETRY_CONFIGURATION_SAMPLE_RATE: Float = 20f
         internal const val DEFAULT_LONG_TASK_THRESHOLD_MS = 100L
         internal const val DD_TELEMETRY_CONFIG_SAMPLE_RATE_TAG =
             "_dd.telemetry.configuration_sample_rate"

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

@@ -20,6 +20,7 @@ import com.datadog.android.rum.model.ViewEvent
 import com.datadog.android.telemetry.model.TelemetryConfigurationEvent
 import com.datadog.android.telemetry.model.TelemetryDebugEvent
 import com.datadog.android.telemetry.model.TelemetryErrorEvent
+import com.datadog.android.telemetry.model.TelemetryUsageEvent
 import com.google.gson.JsonObject
 
 internal class RumEventSerializer(
@@ -55,6 +56,9 @@ internal class RumEventSerializer(
             is TelemetryConfigurationEvent -> {
                 model.toJson().toString()
             }
+            is TelemetryUsageEvent -> {
+                model.toJson().toString()
+            }
             is JsonObject -> {
                 model.toString()
             }

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

@@ -13,6 +13,7 @@ import com.datadog.android.api.storage.DataWriter
 import com.datadog.android.core.InternalSdkCore
 import com.datadog.android.core.internal.net.FirstPartyHostHeaderTypeResolver
 import com.datadog.android.core.metrics.MethodCallSamplingRate
+import com.datadog.android.internal.telemetry.InternalTelemetryEvent
 import com.datadog.android.rum.DdRumContentProvider
 import com.datadog.android.rum.internal.anr.ANRException
 import com.datadog.android.rum.internal.domain.RumContext
@@ -144,7 +145,24 @@ internal class RumViewManagerScope(
         val importanceForeground = ActivityManager.RunningAppProcessInfo.IMPORTANCE_FOREGROUND
         val isForegroundProcess = processFlag == importanceForeground
 
-        if (applicationDisplayed || !isForegroundProcess) {
+        if (event is RumRawEvent.AddViewLoadingTime) {
+            val internalLogger = sdkCore.internalLogger
+            internalLogger.log(
+                InternalLogger.Level.WARN,
+                InternalLogger.Target.USER,
+                { MESSAGE_MISSING_VIEW }
+            )
+            internalLogger.logApiUsage(
+                InternalTelemetryEvent.ApiUsage.AddViewLoadingTime(
+                    overwrite = event.overwrite,
+                    noView = true,
+                    noActiveView = false
+                )
+            )
+            // we should return here and not add the event to the session ended metric missed events as we already
+            // send the API usage telemetry
+            return
+        } else if (applicationDisplayed || !isForegroundProcess) {
             handleBackgroundEvent(event, writer)
         } else {
             val isSilentOrphanEvent = event.javaClass in silentOrphanEventTypes

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

@@ -241,24 +241,74 @@ internal open class RumViewScope(
 
     @WorkerThread
     private fun onAddViewLoadingTime(event: RumRawEvent.AddViewLoadingTime, writer: DataWriter<Any>) {
-        if (stopped) return
-        val canAddViewLoadingTime = event.overwrite || viewLoadingTime == null
-        sdkCore.internalLogger.logApiUsage(
-            InternalTelemetryEvent.ApiUsage.AddViewLoadingTime(
-                overwrite = event.overwrite,
-                noView = viewId.isEmpty(),
-                noActiveView = !isActive()
-            ),
-            100.0f
-        )
-        if (canAddViewLoadingTime) {
-            viewLoadingTime = event.eventTime.nanoTime - startedNanos
-            sendViewUpdate(event, writer)
-        } else {
-            // TODO RUM-6031 Add logs and telemetry here
+        val internalLogger = sdkCore.internalLogger
+        val canUpdateViewLoadingTime = !stopped && (viewLoadingTime == null || event.overwrite)
+        if (stopped) {
+            internalLogger.log(
+                InternalLogger.Level.WARN,
+                InternalLogger.Target.USER,
+                { NO_ACTIVE_VIEW_FOR_LOADING_TIME_WARNING_MESSAGE }
+            )
+            internalLogger.logApiUsage(
+                InternalTelemetryEvent.ApiUsage.AddViewLoadingTime(
+                    overwrite = event.overwrite,
+                    noView = false,
+                    noActiveView = true
+                )
+            )
+        }
+
+        if (canUpdateViewLoadingTime) {
+            updateViewLoadingTime(event, internalLogger, writer)
         }
     }
 
+    private fun updateViewLoadingTime(
+        event: RumRawEvent.AddViewLoadingTime,
+        internalLogger: InternalLogger,
+        writer: DataWriter<Any>
+    ) {
+        val viewName = key.name
+        val previousViewLoadingTime = viewLoadingTime
+        val newLoadingTime = event.eventTime.nanoTime - startedNanos
+        if (previousViewLoadingTime == null) {
+            internalLogger.log(
+                InternalLogger.Level.DEBUG,
+                InternalLogger.Target.USER,
+                { ADDING_VIEW_LOADING_TIME_DEBUG_MESSAGE_FORMAT.format(Locale.US, viewLoadingTime, viewName) }
+            )
+            internalLogger.logApiUsage(
+                InternalTelemetryEvent.ApiUsage.AddViewLoadingTime(
+                    overwrite = false,
+                    noView = false,
+                    noActiveView = false
+                )
+            )
+        } else if (event.overwrite) {
+            internalLogger.log(
+                InternalLogger.Level.WARN,
+                InternalLogger.Target.USER,
+                {
+                    OVERWRITING_VIEW_LOADING_TIME_WARNING_MESSAGE_FORMAT.format(
+                        Locale.US,
+                        viewName,
+                        previousViewLoadingTime,
+                        newLoadingTime
+                    )
+                }
+            )
+            internalLogger.logApiUsage(
+                InternalTelemetryEvent.ApiUsage.AddViewLoadingTime(
+                    overwrite = true,
+                    noView = false,
+                    noActiveView = false
+                )
+            )
+        }
+        viewLoadingTime = newLoadingTime
+        sendViewUpdate(event, writer)
+    }
+
     @WorkerThread
     private fun onStartView(
         event: RumRawEvent.StartView,
@@ -1258,6 +1308,13 @@ internal open class RumViewScope(
         internal const val SLOW_RENDERED_THRESHOLD_FPS = 55
         internal const val NEGATIVE_DURATION_WARNING_MESSAGE = "The computed duration for the " +
             "view: %s was 0 or negative. In order to keep the view we forced it to 1ns."
+        internal const val NO_ACTIVE_VIEW_FOR_LOADING_TIME_WARNING_MESSAGE =
+            "No active view found to add the loading time."
+        internal const val ADDING_VIEW_LOADING_TIME_DEBUG_MESSAGE_FORMAT =
+            "View loading time %dns added to the view %s"
+        internal const val OVERWRITING_VIEW_LOADING_TIME_WARNING_MESSAGE_FORMAT =
+            "View loading time already exists for the view %s. Replacing the existing %d ns " +
+                "view loading time with the new %d ns loading time."
 
         internal fun fromEvent(
             parentScope: RumScope,

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

@@ -446,7 +446,7 @@ internal class TelemetryEventHandler(
 
     companion object {
         const val MAX_EVENTS_PER_SESSION = 100
-        const val DEFAULT_CONFIGURATION_SAMPLE_RATE = 100f
+        const val DEFAULT_CONFIGURATION_SAMPLE_RATE = 20f
         const val ALREADY_SEEN_EVENT_MESSAGE =
             "Already seen telemetry event with identity=%s, rejecting."
         const val MAX_EVENT_NUMBER_REACHED_MESSAGE =

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

@@ -19,6 +19,7 @@ import com.datadog.android.rum.utils.forge.Configurator
 import com.datadog.android.telemetry.model.TelemetryConfigurationEvent
 import com.datadog.android.telemetry.model.TelemetryDebugEvent
 import com.datadog.android.telemetry.model.TelemetryErrorEvent
+import com.datadog.android.telemetry.model.TelemetryUsageEvent
 import com.datadog.tools.unit.assertj.JsonObjectAssert.Companion.assertThat
 import com.datadog.tools.unit.forge.anException
 import com.google.gson.JsonObject
@@ -33,6 +34,7 @@ import org.junit.jupiter.api.RepeatedTest
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.api.extension.Extensions
+import org.junit.jupiter.api.fail
 import org.mockito.Mock
 import org.mockito.junit.jupiter.MockitoExtension
 import org.mockito.junit.jupiter.MockitoSettings
@@ -748,6 +750,110 @@ internal class RumEventSerializerTest {
         }
     }
 
+    @RepeatedTest(8)
+    fun `M serialize RUM event W serialize() with TelemetryUsageEvent`(
+        @Forgery event: TelemetryUsageEvent
+    ) {
+        val serialized = testedSerializer.serialize(event)
+        val jsonObject = JsonParser.parseString(serialized).asJsonObject
+        assertThat(jsonObject)
+            .hasField("type", "telemetry")
+            .hasField("_dd") {
+                hasField("format_version", 2L)
+            }
+            .hasField("date", event.date)
+            .hasField("source", event.source.name.lowercase(Locale.US).replace('_', '-'))
+            .hasField("service", event.service)
+            .hasField("version", event.version)
+            .hasField("telemetry") {
+                hasField("usage") {
+                    when (event.telemetry.usage) {
+                        is TelemetryUsageEvent.Usage.AddViewLoadingTime -> {
+                            val usage = event.telemetry.usage as TelemetryUsageEvent.Usage.AddViewLoadingTime
+                            hasField("no_view", usage.noView)
+                            hasField("no_active_view", usage.noActiveView)
+                            hasField("overwritten", usage.overwritten)
+                        }
+
+                        else -> {
+                            fail("Usage type not covered in assertions")
+                        }
+                    }
+                }
+                if (event.telemetry.device != null) {
+                    hasField("device") {
+                        val device = event.telemetry.device
+                        checkNotNull(device)
+                        if (device.architecture != null) {
+                            hasField("architecture", device.architecture!!)
+                        }
+                        if (device.brand != null) {
+                            hasField("brand", device.brand!!)
+                        }
+                        if (device.model != null) {
+                            hasField("model", device.model!!)
+                        }
+                    }
+                }
+                if (event.telemetry.os != null) {
+                    hasField("os") {
+                        val os = event.telemetry.os
+                        checkNotNull(os)
+                        if (os.build != null) {
+                            hasField("build", os.build!!)
+                        }
+                        if (os.name != null) {
+                            hasField("name", os.name!!)
+                        }
+                        if (os.version != null) {
+                            hasField("version", os.version!!)
+                        }
+                    }
+                }
+                containsAttributes(event.telemetry.additionalProperties)
+            }
+
+        val application = event.application
+        if (application != null) {
+            assertThat(jsonObject)
+                .hasField("application") {
+                    hasField("id", application.id)
+                }
+        } else {
+            assertThat(jsonObject).doesNotHaveField("application")
+        }
+
+        val session = event.session
+        if (session != null) {
+            assertThat(jsonObject)
+                .hasField("session") {
+                    hasField("id", session.id)
+                }
+        } else {
+            assertThat(jsonObject).doesNotHaveField("session")
+        }
+
+        val view = event.view
+        if (view != null) {
+            assertThat(jsonObject)
+                .hasField("view") {
+                    hasField("id", view.id)
+                }
+        } else {
+            assertThat(jsonObject).doesNotHaveField("view")
+        }
+
+        val action = event.action
+        if (action != null) {
+            assertThat(jsonObject)
+                .hasField("action") {
+                    hasField("id", action.id)
+                }
+        } else {
+            assertThat(jsonObject).doesNotHaveField("action")
+        }
+    }
+
     @Test
     fun `M serialize RUM event W serialize() with unknown event`(
         @Forgery unknownEvent: UserInfo
@@ -1451,25 +1557,29 @@ internal class RumEventSerializerTest {
                     usr = (it.usr ?: ViewEvent.Usr()).copy(additionalProperties = userAttributes)
                 )
             }
+
             2 -> this.getForgery(ActionEvent::class.java).let {
                 it.copy(
                     context = ActionEvent.Context(additionalProperties = attributes),
                     usr = (it.usr ?: ActionEvent.Usr()).copy(additionalProperties = userAttributes)
                 )
             }
+
             3 -> this.getForgery(ErrorEvent::class.java).let {
                 it.copy(
                     context = ErrorEvent.Context(additionalProperties = attributes),
                     usr = (it.usr ?: ErrorEvent.Usr()).copy(additionalProperties = userAttributes)
                 )
             }
+
             4 -> this.getForgery(ResourceEvent::class.java).let {
                 it.copy(
                     context = ResourceEvent.Context(additionalProperties = attributes),
                     usr = (it.usr ?: ResourceEvent.Usr())
                         .copy(additionalProperties = userAttributes)
                 )
             }
+
             else -> this.getForgery(LongTaskEvent::class.java).let {
                 it.copy(
                     context = LongTaskEvent.Context(additionalProperties = attributes),

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

@@ -112,6 +112,10 @@ internal fun Forge.addErrorEvent(): RumRawEvent.AddError {
     )
 }
 
+internal fun Forge.addViewLoadingTimeEvent(): RumRawEvent.AddViewLoadingTime {
+    return RumRawEvent.AddViewLoadingTime(overwrite = aBool())
+}
+
 internal fun Forge.addLongTaskEvent(): RumRawEvent.AddLongTask {
     return RumRawEvent.AddLongTask(
         durationNs = aLong(min = 1),
@@ -178,7 +182,8 @@ internal fun Forge.invalidBackgroundEvent(): RumRawEvent {
             stopActionEvent(),
             stopResourceEvent(),
             stopResourceWithErrorEvent(),
-            stopResourceWithStacktraceEvent()
+            stopResourceWithStacktraceEvent(),
+            addViewLoadingTimeEvent()
         )
     )
 }
@@ -197,7 +202,8 @@ internal fun Forge.anyRumEvent(excluding: List<Type> = listOf()): RumRawEvent {
         addLongTaskEvent(),
         addFeatureFlagEvaluationEvent(),
         addCustomTimingEvent(),
-        updatePerformanceMetricEvent()
+        updatePerformanceMetricEvent(),
+        addViewLoadingTimeEvent()
     )
     return this.anElementFrom(
         allEvents.filter {