chore(compose): Update SentryTraced to emit a span only for initial composition

Commit updates SentryTraced to:

- emit a span only for initial composition,
- add the origin on ui.render spans, as we already do for composition spans.

It also cleans up use of ImmutableHolder and renames it to MutableRef.

Author: 0xadam-brown

CHANGELOG.md

@@ -9,6 +9,7 @@
 
 ### Improvements
 
+- Emit a single `ui.compose` span per `SentryTraced` on initial composition instead of one on every recomposition, and set the `auto.ui.jetpack_compose` origin on `ui.render` spans ([#XXXX](https://github.com/getsentry/sentry-java/pull/XXXX))
 - Move ANR profiling out of experimental ([#6042](https://github.com/getsentry/sentry-java/pull/6042))
 
 ### Fixes

sentry-compose/src/androidMain/kotlin/io/sentry/compose/SentryComposeTracing.kt

@@ -3,7 +3,6 @@ package io.sentry.compose
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.BoxScope
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.Immutable
 import androidx.compose.runtime.SideEffect
 import androidx.compose.runtime.compositionLocalOf
 import androidx.compose.runtime.remember
@@ -25,45 +24,68 @@ private const val OP_RENDER = "ui.render"
 private const val OP_TRACE_ORIGIN = "auto.ui.jetpack_compose"
 
 private val localSentryCompositionParentSpan = compositionLocalOf {
-  ImmutableHolder(
-    getRootSpan()
-      ?.startChild(
-        OP_PARENT_COMPOSITION,
-        "Jetpack Compose Initial Composition",
-        SpanOptions().apply {
-          isTrimStart = true
-          isTrimEnd = true
-          isIdle = true
-        },
-      )
-      ?.apply { spanContext.origin = OP_TRACE_ORIGIN }
-  )
+  getRootSpan()
+    // We create a single parent span to be shared among *all* composition spans emitted by all
+    // SentryTraced composables.
+    ?.startChild(
+      OP_PARENT_COMPOSITION,
+      "Jetpack Compose Initial Composition",
+      SpanOptions().apply {
+        isTrimStart = true
+        isTrimEnd = true
+        isIdle = true
+      },
+    )
+    ?.apply { spanContext.origin = OP_TRACE_ORIGIN }
 }
 
 private val localSentryRenderingParentSpan = compositionLocalOf {
-  ImmutableHolder(
-    getRootSpan()
-      ?.startChild(
-        OP_PARENT_RENDER,
-        "Jetpack Compose Initial Render",
-        SpanOptions().apply {
-          isTrimStart = true
-          isTrimEnd = true
-          isIdle = true
-        },
-      )
-      ?.apply { spanContext.origin = OP_TRACE_ORIGIN }
-  )
+  getRootSpan()
+    // We create a single parent span to be shared among *all* render spans emitted by all
+    // SentryTraced composables.
+    ?.startChild(
+      OP_PARENT_RENDER,
+      "Jetpack Compose Initial Render",
+      SpanOptions().apply {
+        isTrimStart = true
+        isTrimEnd = true
+        isIdle = true
+      },
+    )
+    ?.apply { spanContext.origin = OP_TRACE_ORIGIN }
 }
 
-@Immutable internal class ImmutableHolder<T>(var item: T)
+/**
+ * A substitute for Compose's `MutableState` that doesn't register itself with the snapshot system,
+ * so mutating [value] never triggers recomposition.
+ */
+private class MutableRef<T>(var value: T)
 
 /**
- * Creates spans for tracking the time required to compose the wrapped [content], and a span for its
- * initial draw.
+ * Creates a span for tracking the time required to compose the wrapped [content], and a span for
+ * its initial draw.
  *
  * Spans are approximate and include work performed by any composables [content] invokes. Abandoned
  * recompositions are ignored.
+ *
+ * Generated spans live under a set of parents shared by all `SentryTraced` composables. Every
+ * `SentryTraced` contributes one `ui.compose` child and one `ui.render` child:
+ * ```
+ * Root span
+ * │
+ * ├─ ui.compose.composition  "Jetpack Compose Initial Composition"
+ * │   ├─ ui.compose   "product_info"
+ * │   └─ ui.compose   "add_to_cart_button"
+ * │
+ * └─ ui.compose.rendering    "Jetpack Compose Initial Render"
+ *     ├─ ui.render    "product_info"
+ *     └─ ui.render    "add_to_cart_button"
+ * ```
+ *
+ * Here `ui.compose.composition` and `ui.compose.rendering` are the shared parents. The
+ * "product_info" spans are generated by a `SentryTraced` that wraps a product info composable, and
+ * the "add_to_cart_button" spans are generated by a separate `SentryTraced` that wraps an
+ * add-to-cart button.
  */
 @ExperimentalComposeUiApi
 @Composable
@@ -73,11 +95,12 @@ public fun SentryTraced(
   enableUserInteractionTracing: Boolean = true,
   content: @Composable BoxScope.() -> Unit,
 ) {
-  val alreadyRendered = remember { ImmutableHolder(false) }
+  val alreadyComposed = remember { MutableRef(false) }
+  val alreadyRendered = remember { MutableRef(false) }
   val baseModifier = if (enableUserInteractionTracing) modifier.sentryTag(tag) else modifier
 
-  val parentCompositionSpan = localSentryCompositionParentSpan.current.item
-  val parentRenderingSpan = localSentryRenderingParentSpan.current.item
+  val parentCompositionSpan = localSentryCompositionParentSpan.current
+  val parentRenderingSpan = localSentryRenderingParentSpan.current
   val dateProvider = Sentry.getCurrentScopes().options.dateProvider
 
   // Only record spans if we have a parent for them.
@@ -86,14 +109,14 @@ public fun SentryTraced(
   Box(
     modifier =
       baseModifier.drawWithContent {
-        if (alreadyRendered.item || parentRenderingSpan == null) {
+        if (alreadyRendered.value || parentRenderingSpan == null) {
           drawContent()
         } else {
           val renderStart = dateProvider.now()
           drawContent()
           val renderEnd = dateProvider.now()
 
-          alreadyRendered.item = true
+          alreadyRendered.value = true
           recordRenderSpan(parentRenderingSpan, tag, renderStart, renderEnd)
         }
       },
@@ -102,7 +125,7 @@ public fun SentryTraced(
     content()
   }
 
-  if (compositionStart != null) {
+  if (!alreadyComposed.value && compositionStart != null) {
     val compositionEnd = dateProvider.now()
 
     SideEffect {
@@ -112,6 +135,8 @@ public fun SentryTraced(
         startTimestamp = compositionStart,
         endTimestamp = compositionEnd,
       )
+
+      alreadyComposed.value = true
     }
   }
 }
@@ -141,6 +166,7 @@ private fun recordRenderSpan(
   endTimestamp: SentryDate,
 ) {
   parentSpan?.startChild(OP_RENDER, tag, startTimestamp)?.apply {
+    spanContext.origin = OP_TRACE_ORIGIN
     finish(null, endTimestamp)
   }
 }