Create child span for time waiting for manual UI load ending

Author: bidetofevil

embrace-android-features/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/LifecycleStage.kt

@@ -7,7 +7,8 @@ enum class LifecycleStage(private val typeName: String) {
     CREATE("create"),
     START("start"),
     RESUME("resume"),
-    RENDER("render");
+    RENDER("render"),
+    READY("ready");
 
     fun spanName(componentName: String): String = "$componentName-$typeName"
 }

embrace-android-features/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadTraceEmitter.kt

@@ -107,11 +107,19 @@ class UiLoadTraceEmitter(
                 timestampMs = timestampMs,
                 lifecycleStage = LifecycleStage.RESUME
             )
-        } else if (traceCompleteTrigger(instanceId) == TraceCompleteTrigger.RESUME) {
-            endTrace(
-                instanceId = instanceId,
-                timestampMs = timestampMs,
-            )
+        } else {
+            if (traceCompleteTrigger(instanceId) == TraceCompleteTrigger.RESUME) {
+                endTrace(
+                    instanceId = instanceId,
+                    timestampMs = timestampMs,
+                )
+            } else if (!hasRenderEvent && traceCompleteTrigger(instanceId) == TraceCompleteTrigger.MANUAL) {
+                startChildSpan(
+                    instanceId = instanceId,
+                    timestampMs = timestampMs,
+                    lifecycleStage = LifecycleStage.READY
+                )
+            }
         }
     }
 
@@ -122,11 +130,18 @@ class UiLoadTraceEmitter(
             lifecycleStage = LifecycleStage.RESUME
         )
 
-        if (traceCompleteTrigger(instanceId) == TraceCompleteTrigger.RESUME) {
+        val endType = traceCompleteTrigger(instanceId)
+        if (endType == TraceCompleteTrigger.RESUME) {
             endTrace(
                 instanceId = instanceId,
                 timestampMs = timestampMs,
             )
+        } else if (!hasRenderEvent && endType == TraceCompleteTrigger.MANUAL) {
+            startChildSpan(
+                instanceId = instanceId,
+                timestampMs = timestampMs,
+                lifecycleStage = LifecycleStage.READY
+            )
         }
     }
 
@@ -148,17 +163,35 @@ class UiLoadTraceEmitter(
                 lifecycleStage = LifecycleStage.RENDER
             )
 
-            if (traceCompleteTrigger(instanceId) == TraceCompleteTrigger.RENDER) {
-                endTrace(
-                    instanceId = instanceId,
-                    timestampMs = timestampMs,
-                )
+            val endType = traceCompleteTrigger(instanceId)
+            when (endType) {
+                TraceCompleteTrigger.RENDER -> {
+                    endTrace(
+                        instanceId = instanceId,
+                        timestampMs = timestampMs,
+                    )
+                }
+
+                TraceCompleteTrigger.MANUAL -> {
+                    startChildSpan(
+                        instanceId = instanceId,
+                        timestampMs = timestampMs,
+                        lifecycleStage = LifecycleStage.READY
+                    )
+                }
+
+                else -> {}
             }
         }
     }
 
     override fun complete(instanceId: Int, timestampMs: Long) {
         if (traceCompleteTrigger(instanceId) == TraceCompleteTrigger.MANUAL) {
+            endChildSpan(
+                instanceId = instanceId,
+                timestampMs = timestampMs,
+                lifecycleStage = LifecycleStage.READY
+            )
             endTrace(
                 instanceId = instanceId,
                 timestampMs = timestampMs,

embrace-android-features/src/test/java/io/embrace/android/embracesdk/internal/capture/activity/UiLoadTraceEmitterTest.kt

@@ -298,10 +298,17 @@ internal class UiLoadTraceEmitterTest {
                 }
             }
 
+            val traceEndTime = trace.endTimeNanos.nanosToMillis()
             if (manualEnd) {
-                assertNotEquals(trace.endTimeNanos.nanosToMillis(), lastEventEndTimeMs)
+                assertEmbraceSpanData(
+                    span = checkNotNull(spanMap["emb-$activityName-ready"]).toNewPayload(),
+                    expectedStartTimeMs = lastEventEndTimeMs,
+                    expectedEndTimeMs = traceEndTime,
+                    expectedParentId = trace.spanId
+                )
+                assertNotEquals(traceEndTime, lastEventEndTimeMs)
             } else {
-                assertEquals(trace.endTimeNanos.nanosToMillis(), lastEventEndTimeMs)
+                assertEquals(traceEndTime, lastEventEndTimeMs)
             }
         }
     }

embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/features/UiLoadTest.kt

@@ -24,6 +24,7 @@ import io.embrace.android.embracesdk.testframework.actions.EmbraceActionInterfac
 import io.embrace.android.embracesdk.testframework.actions.EmbraceActionInterface.Companion.STARTUP_BACKGROUND_TIME
 import io.opentelemetry.api.trace.SpanId
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertTrue
 import org.junit.Rule
 import org.junit.Test
@@ -149,6 +150,10 @@ internal class UiLoadTest {
                         expectedCustomAttributes = mapOf("manual-end" to "true")
                     )
 
+                    assertNotNull(findSpansByName("emb-$MANUAL_STOP_ACTIVITY_NAME-create").single())
+                    assertNotNull(findSpansByName("emb-$MANUAL_STOP_ACTIVITY_NAME-start").single())
+                    assertNotNull(findSpansByName("emb-$MANUAL_STOP_ACTIVITY_NAME-ready").single())
+
                     assertEmbraceSpanData(
                         span = findSpansByName("loading-time").single(),
                         expectedStartTimeMs = expectedTraceStartTime + calculateTotalTime(lifecycleStages = 3),