Merge pull request #3060 from DataDog/aleksandr-gringauz/feature/app-launch-vitals

Merge App launch vitals feature branch into develop

Author: ambushwork

detekt_custom_safe_calls.yml

@@ -930,6 +930,7 @@ datadog:
       - "kotlin.collections.listOf(com.datadog.android.rum.model.ErrorEvent.Interface)"
       - "kotlin.collections.listOf(com.datadog.android.rum.model.LongTaskEvent.Interface)"
       - "kotlin.collections.listOf(com.datadog.android.rum.model.ResourceEvent.Interface)"
+      - "kotlin.collections.listOf(com.datadog.android.rum.model.RumVitalAppLaunchEvent.Interface)"
       - "kotlin.collections.listOf(com.datadog.android.rum.model.RumVitalOperationStepEvent.Interface)"
       - "kotlin.collections.listOf(com.datadog.android.rum.model.ViewEvent.Interface)"
       - "kotlin.collections.listOf(com.datadog.android.sessionreplay.MapperTypeWrapper)"

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

@@ -122,6 +122,7 @@ interface com.datadog.android.rum.RumMonitor
   fun startFeatureOperation(String, String? = null, Map<String, Any?> = emptyMap())
   fun succeedFeatureOperation(String, String? = null, Map<String, Any?> = emptyMap())
   fun failFeatureOperation(String, String? = null, com.datadog.android.rum.featureoperations.FailureReason, Map<String, Any?> = emptyMap())
+  fun reportAppFullyDisplayed()
   var debug: Boolean
   fun _getInternal(): _RumInternalProxy?
 enum com.datadog.android.rum.RumPerformanceMetric

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

@@ -162,6 +162,7 @@ public abstract interface class com/datadog/android/rum/RumMonitor {
 	public abstract fun getDebug ()Z
 	public abstract fun removeAttribute (Ljava/lang/String;)V
 	public abstract fun removeViewAttributes (Ljava/util/Collection;)V
+	public abstract fun reportAppFullyDisplayed ()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 startFeatureOperation (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V

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

@@ -18,9 +18,11 @@ import com.datadog.android.core.InternalSdkCore
 import com.datadog.android.core.sampling.RateBasedSampler
 import com.datadog.android.rum.internal.RumAnonymousIdentifierManager
 import com.datadog.android.rum.internal.RumFeature
+import com.datadog.android.rum.internal.domain.scope.RumVitalAppLaunchEventHelper
 import com.datadog.android.rum.internal.metric.SessionEndedMetricDispatcher
 import com.datadog.android.rum.internal.monitor.DatadogRumMonitor
 import com.datadog.android.rum.internal.startup.RumAppStartupTelemetryReporter
+import com.datadog.android.rum.internal.startup.RumSessionScopeStartupManager
 import com.datadog.android.telemetry.internal.TelemetryEventHandler
 
 /**
@@ -115,6 +117,16 @@ object Rum {
             sessionSamplingRate = rumFeature.configuration.sampleRate
         )
 
+        val rumVitalAppLaunchEventHelper = RumVitalAppLaunchEventHelper(
+            rumSessionTypeOverride = rumFeature.configuration.rumSessionTypeOverride,
+            batteryInfoProvider = rumFeature.batteryInfoProvider,
+            displayInfoProvider = rumFeature.displayInfoProvider,
+            sampleRate = rumFeature.sampleRate,
+            internalLogger = sdkCore.internalLogger
+        )
+
+        val rumAppStartupTelemetryReporter = RumAppStartupTelemetryReporter.create(sdkCore = sdkCore)
+
         return DatadogRumMonitor(
             applicationId = rumFeature.applicationId,
             sdkCore = sdkCore,
@@ -145,7 +157,13 @@ object Rum {
             accessibilitySnapshotManager = rumFeature.accessibilitySnapshotManager,
             batteryInfoProvider = rumFeature.batteryInfoProvider,
             displayInfoProvider = rumFeature.displayInfoProvider,
-            rumAppStartupTelemetryReporter = RumAppStartupTelemetryReporter.create(sdkCore)
+            rumSessionScopeStartupManagerFactory = {
+                RumSessionScopeStartupManager.create(
+                    rumVitalAppLaunchEventHelper = rumVitalAppLaunchEventHelper,
+                    sdkCore = sdkCore,
+                    rumAppStartupTelemetryReporter = rumAppStartupTelemetryReporter
+                )
+            }
         )
     }
 

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

@@ -370,6 +370,14 @@ interface RumMonitor {
         attributes: Map<String, Any?> = emptyMap()
     )
 
+    /**
+     * This method can be used to mark the moment in time when the UI of the app is considered fully displayed.
+     * The duration between the application launch and this moment of time will be shown as TTFD (time to full display)
+     * in the RUM session explorer. Only the first call to this method will have any effect for a given RUM session.
+     */
+    @ExperimentalRumApi
+    fun reportAppFullyDisplayed()
+
     /**
      * Utility setting to inspect the active RUM View.
      * If set, a debugging outline will be displayed on top of the application, describing the name

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

@@ -692,15 +692,17 @@ internal class RumFeature(
 
                 override fun onAppStartupDetected(scenario: RumStartupScenario) {
                     val activity = scenario.activity.get() ?: return
+                    val rumMonitor = (GlobalRumMonitor.get(sdkCore) as? AdvancedRumMonitor) ?: return
+
+                    rumMonitor.sendAppStartEvent(scenario)
 
                     val callback = object : RumFirstDrawTimeReporter.Callback {
                         override fun onFirstFrameDrawn(timestampNs: Long) {
                             val info = RumTTIDInfo(
                                 scenario = scenario,
-                                durationNs = timestampNs - scenario.initialTimeNs
+                                durationNs = timestampNs - scenario.initialTime.nanoTime
                             )
-                            (GlobalRumMonitor.get(sdkCore) as? AdvancedRumMonitor)
-                                ?.sendTTIDEvent(info)
+                            rumMonitor.sendTTIDEvent(info)
                         }
                     }
 

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

@@ -11,6 +11,7 @@ import com.datadog.android.rum.model.ActionEvent
 import com.datadog.android.rum.model.ErrorEvent
 import com.datadog.android.rum.model.LongTaskEvent
 import com.datadog.android.rum.model.ResourceEvent
+import com.datadog.android.rum.model.RumVitalAppLaunchEvent
 import com.datadog.android.rum.model.RumVitalOperationStepEvent
 import com.datadog.android.rum.model.ViewEvent
 
@@ -54,3 +55,10 @@ internal fun RumSessionType.toVital(): RumVitalOperationStepEvent.RumVitalOperat
         RumSessionType.USER -> RumVitalOperationStepEvent.RumVitalOperationStepEventSessionType.USER
     }
 }
+
+internal fun RumSessionType.toVitalAppLaunch(): RumVitalAppLaunchEvent.RumVitalAppLaunchEventSessionType {
+    return when (this) {
+        RumSessionType.SYNTHETICS -> RumVitalAppLaunchEvent.RumVitalAppLaunchEventSessionType.SYNTHETICS
+        RumSessionType.USER -> RumVitalAppLaunchEvent.RumVitalAppLaunchEventSessionType.USER
+    }
+}

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

@@ -13,6 +13,9 @@ internal data class Time(
     val nanoTime: Long = System.nanoTime()
 )
 
+/**
+ * Convert a value obtained from [System.currentTimeMillis] to [Time].
+ */
 internal fun Long.asTime(): Time {
     // Because nanoTime only measures the nanoseconds since the beginning
     // of the current JVM lifetime, we need to approximate the nanotime we want.
@@ -22,3 +25,12 @@ internal fun Long.asTime(): Time {
     val offset = this - now.timestamp
     return Time(this, TimeUnit.MILLISECONDS.toNanos(offset) + now.nanoTime)
 }
+
+/**
+ * Convert a value obtained from [System.nanoTime] to [Time].
+ */
+internal fun Long.asTimeNs(): Time {
+    val now = Time()
+    val offset = this - now.nanoTime
+    return Time(TimeUnit.NANOSECONDS.toMillis(offset) + now.timestamp, this)
+}

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

@@ -13,6 +13,7 @@ import com.datadog.android.rum.model.ActionEvent
 import com.datadog.android.rum.model.ErrorEvent
 import com.datadog.android.rum.model.LongTaskEvent
 import com.datadog.android.rum.model.ResourceEvent
+import com.datadog.android.rum.model.RumVitalAppLaunchEvent
 import com.datadog.android.rum.model.RumVitalOperationStepEvent
 import com.datadog.android.rum.model.ViewEvent
 import com.datadog.android.telemetry.model.TelemetryConfigurationEvent
@@ -64,6 +65,8 @@ internal data class RumEventMapper(
             is LongTaskEvent -> longTaskEventMapper.map(event)
             is RumVitalOperationStepEvent -> vitalOperationStepEventMapper.map(event)
             is TelemetryConfigurationEvent -> telemetryConfigurationMapper.map(event)
+            // TODO RUM-13103: add vitalAppLaunchEventMapper.
+            is RumVitalAppLaunchEvent,
             is TelemetryDebugEvent,
             is TelemetryUsageEvent,
             is TelemetryErrorEvent -> event

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

@@ -16,6 +16,7 @@ import com.datadog.android.rum.model.ActionEvent
 import com.datadog.android.rum.model.ErrorEvent
 import com.datadog.android.rum.model.LongTaskEvent
 import com.datadog.android.rum.model.ResourceEvent
+import com.datadog.android.rum.model.RumVitalAppLaunchEvent
 import com.datadog.android.rum.model.RumVitalOperationStepEvent
 import com.datadog.android.rum.model.ViewEvent
 import com.datadog.android.telemetry.model.TelemetryConfigurationEvent
@@ -24,6 +25,7 @@ import com.datadog.android.telemetry.model.TelemetryErrorEvent
 import com.datadog.android.telemetry.model.TelemetryUsageEvent
 import com.google.gson.JsonObject
 
+@Suppress("TooManyFunctions")
 internal class RumEventSerializer(
     private val internalLogger: InternalLogger,
     private val dataConstraints: DataConstraints = DatadogDataConstraints(internalLogger)
@@ -49,7 +51,10 @@ internal class RumEventSerializer(
                 serializeLongTaskEvent(model)
             }
             is RumVitalOperationStepEvent -> {
-                serializeVitalEvent(model)
+                serializeVitalOperationStepEvent(model)
+            }
+            is RumVitalAppLaunchEvent -> {
+                serializeVitalAppLaunchEvent(model)
             }
             is TelemetryDebugEvent -> {
                 model.toJson().toString()
@@ -205,7 +210,31 @@ internal class RumEventSerializer(
         return extractKnownAttributes(sanitizedModel.toJson().asJsonObject).toString()
     }
 
-    private fun serializeVitalEvent(model: RumVitalOperationStepEvent): String {
+    private fun serializeVitalOperationStepEvent(model: RumVitalOperationStepEvent): String {
+        val sanitizedUser = model.usr?.copy(
+            additionalProperties = validateUserAttributes(model.usr.additionalProperties)
+                .safeMapValuesToJson(internalLogger)
+                .toMutableMap()
+        )
+        val sanitizedAccount = model.account?.copy(
+            additionalProperties = validateAccountAttributes(model.account.additionalProperties)
+                .safeMapValuesToJson(internalLogger)
+                .toMutableMap()
+        )
+        val sanitizedContext = model.context?.copy(
+            additionalProperties = validateContextAttributes(model.context.additionalProperties)
+                .safeMapValuesToJson(internalLogger)
+                .toMutableMap()
+        )
+        val sanitizedModel = model.copy(
+            usr = sanitizedUser,
+            account = sanitizedAccount,
+            context = sanitizedContext
+        )
+        return extractKnownAttributes(sanitizedModel.toJson().asJsonObject).toString()
+    }
+
+    private fun serializeVitalAppLaunchEvent(model: RumVitalAppLaunchEvent): String {
         val sanitizedUser = model.usr?.copy(
             additionalProperties = validateUserAttributes(model.usr.additionalProperties)
                 .safeMapValuesToJson(internalLogger)