RUM-12923: Attach RUM information on profiling event

ambushwork · ambushwork · commit 01719ec9b4a6 · 2025-11-21T10:54:04.000+01:00
diff --git a/dd-sdk-android-internal/api/apiSurface b/dd-sdk-android-internal/api/apiSurface
@@ -158,6 +158,6 @@ class com.datadog.android.rum.DdRumContentProvider : android.content.ContentProv
     var processImportance: Int
     val createTimeNs: Long
 data class com.datadog.android.rum.TTIDEvent
-  constructor(Long)
+  constructor(Long, String, String, String, String?, String?)
 annotation com.datadog.tools.annotation.NoOpImplementation
   constructor(Boolean = false)
diff --git a/dd-sdk-android-internal/api/dd-sdk-android-internal.api b/dd-sdk-android-internal/api/dd-sdk-android-internal.api
@@ -382,12 +382,22 @@ public final class com/datadog/android/rum/DdRumContentProvider$Companion {
 }
 
 public final class com/datadog/android/rum/TTIDEvent {
-	public fun <init> (J)V
+	public fun <init> (JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 	public final fun component1 ()J
-	public final fun copy (J)Lcom/datadog/android/rum/TTIDEvent;
-	public static synthetic fun copy$default (Lcom/datadog/android/rum/TTIDEvent;JILjava/lang/Object;)Lcom/datadog/android/rum/TTIDEvent;
+	public final fun component2 ()Ljava/lang/String;
+	public final fun component3 ()Ljava/lang/String;
+	public final fun component4 ()Ljava/lang/String;
+	public final fun component5 ()Ljava/lang/String;
+	public final fun component6 ()Ljava/lang/String;
+	public final fun copy (JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lcom/datadog/android/rum/TTIDEvent;
+	public static synthetic fun copy$default (Lcom/datadog/android/rum/TTIDEvent;JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lcom/datadog/android/rum/TTIDEvent;
 	public fun equals (Ljava/lang/Object;)Z
+	public final fun getApplicationId ()Ljava/lang/String;
+	public final fun getSessionId ()Ljava/lang/String;
 	public final fun getValue ()J
+	public final fun getViewId ()Ljava/lang/String;
+	public final fun getViewName ()Ljava/lang/String;
+	public final fun getVitalId ()Ljava/lang/String;
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;
 }
diff --git a/dd-sdk-android-internal/src/main/java/com/datadog/android/rum/TTIDEvent.kt b/dd-sdk-android-internal/src/main/java/com/datadog/android/rum/TTIDEvent.kt
@@ -10,5 +10,17 @@ package com.datadog.android.rum
  * Internal event to pass the Time To Initial Display (TTID) value in nanoseconds.
  *
  * @param value The TTID value in nanoseconds.
+ * @param applicationId The Id of the application of RUM.
+ * @param sessionId The Id of the RUM session where TTID is captured
+ * @param vitalId The Id of the TTID vital event
+ * @param viewId The Id of the view where TTID is captured
+ * @param viewName The name of the view where TTID is captured
  */
-data class TTIDEvent(val value: Long)
+data class TTIDEvent(
+    val value: Long,
+    val applicationId: String,
+    val sessionId: String,
+    val vitalId: String,
+    val viewId: String?,
+    val viewName: String?
+)
diff --git a/dd-sdk-android-internal/src/test/java/com/datadog/android/internal/forge/Configurator.kt b/dd-sdk-android-internal/src/test/java/com/datadog/android/internal/forge/Configurator.kt
@@ -7,6 +7,7 @@
 package com.datadog.android.internal.forge
 
 import com.datadog.android.internal.tests.elmyr.InternalTelemetryErrorLogForgeryFactory
+import com.datadog.android.internal.tests.elmyr.TTIDEventFactory
 import com.datadog.tools.unit.forge.BaseConfigurator
 import fr.xgouchet.elmyr.Forge
 import fr.xgouchet.elmyr.jvm.useJvmFactories
@@ -17,5 +18,6 @@ internal class Configurator :
         super.configure(forge)
         forge.useJvmFactories()
         forge.addFactory(InternalTelemetryErrorLogForgeryFactory())
+        forge.addFactory(TTIDEventFactory())
     }
 }
diff --git a/dd-sdk-android-internal/src/testFixtures/kotlin/com/datadog/android/internal/tests/elmyr/TTIDEventFactory.kt b/dd-sdk-android-internal/src/testFixtures/kotlin/com/datadog/android/internal/tests/elmyr/TTIDEventFactory.kt
@@ -0,0 +1,24 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.internal.tests.elmyr
+
+import com.datadog.android.rum.TTIDEvent
+import fr.xgouchet.elmyr.Forge
+import fr.xgouchet.elmyr.ForgeryFactory
+
+class TTIDEventFactory : ForgeryFactory<TTIDEvent> {
+    override fun getForgery(forge: Forge): TTIDEvent {
+        return TTIDEvent(
+            value = forge.aLong(),
+            applicationId = forge.anAlphabeticalString(),
+            sessionId = forge.anAlphabeticalString(),
+            vitalId = forge.anAlphabeticalString(),
+            viewId = forge.anAlphabeticalString(),
+            viewName = forge.anAlphabeticalString()
+        )
+    }
+}
diff --git a/features/dd-sdk-android-profiling/build.gradle.kts b/features/dd-sdk-android-profiling/build.gradle.kts
@@ -65,6 +65,7 @@ dependencies {
     }
 
     testImplementation(testFixtures(project(":dd-sdk-android-core")))
+    testImplementation(testFixtures(project(":dd-sdk-android-internal")))
     testImplementation(libs.bundles.jUnit5)
     testImplementation(libs.bundles.testTools)
     unmock(libs.robolectric)
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingDataWriter.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingDataWriter.kt
@@ -15,20 +15,23 @@ import com.datadog.android.core.internal.persistence.file.readBytesSafe
 import com.datadog.android.internal.utils.formatIsoUtc
 import com.datadog.android.profiling.internal.perfetto.PerfettoResult
 import com.datadog.android.profiling.model.ProfileEvent
+import com.datadog.android.rum.TTIDEvent
 import java.io.File
 
 internal class ProfilingDataWriter(
     private val sdkCore: FeatureSdkCore
 ) : ProfilingWriter {
     override fun write(
-        profilingResult: PerfettoResult
+        profilingResult: PerfettoResult,
+        ttidEvent: TTIDEvent?
     ) {
         sdkCore.getFeature(Feature.PROFILING_FEATURE_NAME)
             ?.withWriteContext { context, writeScope ->
                 writeScope { writer ->
                     val rawBatchEvent = buildRawBatchEvent(
                         context = context,
-                        profilingResult = profilingResult
+                        profilingResult = profilingResult,
+                        ttidEvent = ttidEvent
                     )
                     if (rawBatchEvent != null) {
                         synchronized(this) {
@@ -45,21 +48,27 @@ internal class ProfilingDataWriter(
 
     private fun buildRawBatchEvent(
         context: DatadogContext,
-        profilingResult: PerfettoResult
+        profilingResult: PerfettoResult,
+        ttidEvent: TTIDEvent?
     ): RawBatchEvent? {
         val byteData = readProfilingData(profilingResult.resultFilePath)
         if (byteData == null || byteData.isEmpty()) {
             return null
         }
-        val profileEvent = createProfileEvent(context, profilingResult)
+        val profileEvent = createProfileEvent(
+            context,
+            profilingResult,
+            ttidEvent
+        )
         val serializedEvent =
             profileEvent.toJson().toString().toByteArray(Charsets.UTF_8)
         return RawBatchEvent(data = serializedEvent, metadata = byteData)
     }
 
     private fun createProfileEvent(
         context: DatadogContext,
-        profilingResult: PerfettoResult
+        profilingResult: PerfettoResult,
+        ttidEvent: TTIDEvent?
     ): ProfileEvent {
         return ProfileEvent(
             start = formatIsoUtc(profilingResult.start),
@@ -68,18 +77,37 @@ internal class ProfilingDataWriter(
             family = ANDROID_FAMILY_NAME,
             runtime = ANDROID_RUNTIME_NAME,
             version = VERSION_NUMBER,
-            tagsProfiler = buildTags(context)
+            tagsProfiler = buildTags(context, ttidEvent)
         )
     }
 
-    private fun buildTags(context: DatadogContext): String = buildString {
+    private fun buildTags(
+        context: DatadogContext,
+        ttidEvent: TTIDEvent?
+    ): String = buildString {
         append("$TAG_KEY_SERVICE:${context.service}")
         append(",")
         append("$TAG_KEY_ENV:${context.env}")
         append(",")
         append("$TAG_KEY_VERSION:${context.version}")
         append(",")
         append("$TAG_KEY_SDK_VERSION:${context.sdkVersion}")
+        ttidEvent?.apply {
+            append(",")
+            append("$TAG_KEY_RUM_APPLICATION_ID:$applicationId")
+            append(",")
+            append("$TAG_KEY_RUM_SESSION_ID:$sessionId")
+            append(",")
+            append("$TAG_KEY_RUM_VITAL_ID:$vitalId")
+            viewId?.let {
+                append(",")
+                append("$TAG_KEY_RUM_VIEW_ID:$it")
+            }
+            viewName?.let {
+                append(",")
+                append("$TAG_KEY_RUM_VIEW_NAME:$it")
+            }
+        }
     }
 
     private fun readProfilingData(profilingPath: String): ByteArray? {
@@ -92,6 +120,11 @@ internal class ProfilingDataWriter(
         private const val TAG_KEY_SERVICE = "service"
         private const val TAG_KEY_VERSION = "version"
         private const val TAG_KEY_SDK_VERSION = "sdk_version"
+        private const val TAG_KEY_RUM_APPLICATION_ID = "session_id"
+        private const val TAG_KEY_RUM_SESSION_ID = "session_id"
+        private const val TAG_KEY_RUM_VITAL_ID = "vital_id"
+        private const val TAG_KEY_RUM_VIEW_ID = "view_id"
+        private const val TAG_KEY_RUM_VIEW_NAME = "view_name"
         private const val TAG_KEY_ENV = "env"
         private const val PERFETTO_ATTACHMENT_NAME = "perfetto.proto"
         private const val ANDROID_FAMILY_NAME = "android"
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingFeature.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingFeature.kt
@@ -29,6 +29,8 @@ internal class ProfilingFeature(
 
     private var dataWriter: ProfilingWriter = NoOpProfilingWriter()
 
+    private var ttidEvent: TTIDEvent? = null
+
     override val requestFactory: RequestFactory = ProfilingRequestFactory(
         configuration.customEndpointUrl,
         sdkCore.internalLogger
@@ -44,7 +46,10 @@ internal class ProfilingFeature(
         profiler.apply {
             this.internalLogger = sdkCore.internalLogger
             this.onProfilingSuccess = { result ->
-                dataWriter.write(profilingResult = result)
+                dataWriter.write(
+                    profilingResult = result,
+                    ttidEvent = ttidEvent
+                )
             }
         }
         // Set the profiling flag in SharedPreferences to profile for the next app launch
@@ -67,6 +72,7 @@ internal class ProfilingFeature(
             )
             return
         }
+        this.ttidEvent = event
         profiler.stop()
         sdkCore.internalLogger.log(
             InternalLogger.Level.INFO,
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingWriter.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingWriter.kt
@@ -7,12 +7,14 @@
 package com.datadog.android.profiling.internal
 
 import com.datadog.android.profiling.internal.perfetto.PerfettoResult
+import com.datadog.android.rum.TTIDEvent
 import com.datadog.tools.annotation.NoOpImplementation
 
 @NoOpImplementation
 internal interface ProfilingWriter {
 
     fun write(
-        profilingResult: PerfettoResult
+        profilingResult: PerfettoResult,
+        ttidEvent: TTIDEvent?
     )
 }
diff --git a/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/ProfilingFeatureTest.kt b/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/ProfilingFeatureTest.kt
@@ -17,7 +17,6 @@ import com.datadog.android.profiling.internal.ProfilingFeature
 import com.datadog.android.profiling.internal.ProfilingRequestFactory
 import com.datadog.android.rum.TTIDEvent
 import fr.xgouchet.elmyr.annotation.Forgery
-import fr.xgouchet.elmyr.annotation.LongForgery
 import fr.xgouchet.elmyr.annotation.StringForgery
 import fr.xgouchet.elmyr.junit5.ForgeConfiguration
 import fr.xgouchet.elmyr.junit5.ForgeExtension
@@ -110,9 +109,11 @@ class ProfilingFeatureTest {
     }
 
     @Test
-    fun `M stop Profiling W receive TTID event`(@LongForgery fakeTtid: Long) {
+    fun `M stop Profiling W receive TTID event`(
+        @Forgery fakeTTIDEvent: TTIDEvent
+    ) {
         // When
-        testedFeature.onReceive(TTIDEvent(fakeTtid))
+        testedFeature.onReceive(fakeTTIDEvent)
 
         // Then
         verify(mockProfiler).stop()
diff --git a/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/forge/Configurator.kt b/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/forge/Configurator.kt
@@ -6,6 +6,7 @@
 
 package com.datadog.android.profiling.forge
 
+import com.datadog.android.internal.tests.elmyr.TTIDEventFactory
 import com.datadog.android.tests.elmyr.useCoreFactories
 import com.datadog.tools.unit.forge.BaseConfigurator
 import fr.xgouchet.elmyr.Forge
@@ -17,5 +18,6 @@ class Configurator : BaseConfigurator() {
         forge.useCoreFactories()
         forge.addFactory(ProfilingConfigurationForgeryFactory())
         forge.addFactory(PerfettoResultFactory())
+        forge.addFactory(TTIDEventFactory())
     }
 }
diff --git a/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/internal/ProfilingDataWriterTest.kt b/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/internal/ProfilingDataWriterTest.kt
@@ -19,6 +19,7 @@ import com.datadog.android.internal.utils.formatIsoUtc
 import com.datadog.android.profiling.forge.Configurator
 import com.datadog.android.profiling.internal.perfetto.PerfettoResult
 import com.datadog.android.profiling.model.ProfileEvent
+import com.datadog.android.rum.TTIDEvent
 import fr.xgouchet.elmyr.Forge
 import fr.xgouchet.elmyr.annotation.Forgery
 import fr.xgouchet.elmyr.junit5.ForgeConfiguration
@@ -97,14 +98,18 @@ internal class ProfilingDataWriterTest {
     }
 
     @Test
-    fun `M write the result in a batch W write`(@Forgery fakeResult: PerfettoResult) {
+    fun `M write the result in a batch W write`(
+        @Forgery fakeResult: PerfettoResult,
+        @Forgery fakeTTIDEvent: TTIDEvent
+    ) {
         // Given
         val file = tmp.resolve(fakeResult.resultFilePath)
         file.writeBytes(fakeByteArray)
 
         // When
         testedDataWriterTest.write(
-            profilingResult = fakeResult.copy(resultFilePath = file.absolutePath)
+            profilingResult = fakeResult.copy(resultFilePath = file.absolutePath),
+            ttidEvent = fakeTTIDEvent
         )
 
         // Then
@@ -115,8 +120,12 @@ internal class ProfilingDataWriterTest {
             family = "android",
             runtime = "android",
             version = "4",
-            tagsProfiler = "service:${fakeDatadogContext.service},env:${fakeDatadogContext.env}," +
-                "version:${fakeDatadogContext.version},sdk_version:${fakeDatadogContext.sdkVersion}"
+            tagsProfiler =
+            "service:${fakeDatadogContext.service},env:${fakeDatadogContext.env}," +
+                "version:${fakeDatadogContext.version},sdk_version:${fakeDatadogContext.sdkVersion}," +
+                "application_id:${fakeTTIDEvent.applicationId}" +
+                "session_id:${fakeTTIDEvent.sessionId},vital_id:${fakeTTIDEvent.vitalId}," +
+                "view_id:${fakeTTIDEvent.viewId},view_name:${fakeTTIDEvent.viewName}"
         )
         val argumentCaptor = argumentCaptor<RawBatchEvent>()
         verify(mockEventBatchWriter).write(
@@ -134,28 +143,36 @@ internal class ProfilingDataWriterTest {
     }
 
     @Test
-    fun `M skip writing W write {can't read perfetto File}`(@Forgery fakeResult: PerfettoResult) {
+    fun `M skip writing W write {can't read perfetto File}`(
+        @Forgery fakeResult: PerfettoResult,
+        @Forgery fakeTTIDEvent: TTIDEvent
+    ) {
         // Given
         // Don't create the tmp file so it can't be found
 
         // When
         testedDataWriterTest.write(
-            profilingResult = fakeResult
+            profilingResult = fakeResult,
+            ttidEvent = fakeTTIDEvent
         )
 
         // Then
         verifyNoMoreInteractions(mockInternalLogger, mockEventBatchWriter)
     }
 
     @Test
-    fun `M skip writing W file is empty`(@Forgery fakeResult: PerfettoResult) {
+    fun `M skip writing W file is empty`(
+        @Forgery fakeResult: PerfettoResult,
+        @Forgery fakeTTIDEvent: TTIDEvent
+    ) {
         // Given
         val file = tmp.resolve(fakeResult.resultFilePath)
         file.writeBytes(ByteArray(0))
 
         // When
         testedDataWriterTest.write(
-            profilingResult = fakeResult.copy(resultFilePath = file.absolutePath)
+            profilingResult = fakeResult.copy(resultFilePath = file.absolutePath),
+            ttidEvent = fakeTTIDEvent
         )
 
         // Then
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/RumFeature.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/RumFeature.kt
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumVitalAppLaunchEventHelper.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumVitalAppLaunchEventHelper.kt
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/startup/RumSessionScopeStartupManager.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/startup/RumSessionScopeStartupManager.kt

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`package com.datadog.android.internal.forge`
`8`	`8`
`9`	`9`	`import com.datadog.android.internal.tests.elmyr.InternalTelemetryErrorLogForgeryFactory`
	`10`	`+import com.datadog.android.internal.tests.elmyr.TTIDEventFactory`
`10`	`11`	`import com.datadog.tools.unit.forge.BaseConfigurator`
`11`	`12`	`import fr.xgouchet.elmyr.Forge`
`12`	`13`	`import fr.xgouchet.elmyr.jvm.useJvmFactories`
`@@ -17,5 +18,6 @@ internal class Configurator :`
`17`	`18`	`super.configure(forge)`
`18`	`19`	`forge.useJvmFactories()`
`19`	`20`	`forge.addFactory(InternalTelemetryErrorLogForgeryFactory())`
	`21`	`+ forge.addFactory(TTIDEventFactory())`
`20`	`22`	`}`
`21`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ dependencies {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`testImplementation(testFixtures(project(":dd-sdk-android-core")))`
	`68`	`+ testImplementation(testFixtures(project(":dd-sdk-android-internal")))`
`68`	`69`	`testImplementation(libs.bundles.jUnit5)`
`69`	`70`	`testImplementation(libs.bundles.testTools)`
`70`	`71`	`unmock(libs.robolectric)`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,14 @@`
`7`	`7`	`package com.datadog.android.profiling.internal`
`8`	`8`
`9`	`9`	`import com.datadog.android.profiling.internal.perfetto.PerfettoResult`
	`10`	`+import com.datadog.android.rum.TTIDEvent`
`10`	`11`	`import com.datadog.tools.annotation.NoOpImplementation`
`11`	`12`
`12`	`13`	`@NoOpImplementation`
`13`	`14`	`internal interface ProfilingWriter {`
`14`	`15`
`15`	`16`	`fun write(`
`16`		`- profilingResult: PerfettoResult`
	`17`	`+ profilingResult: PerfettoResult,`
	`18`	`+ ttidEvent: TTIDEvent?`
`17`	`19`	`)`
`18`	`20`	`}`