Skip to content

fix(core): [Session based Traces for Mobile 1] Keep spanless baggage mutable #5384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
adinauer wants to merge 2 commits into
base: feat/session-based-traces-mobile
Choose a base branch
from
Draft

fix(core): [Session based Traces for Mobile 1] Keep spanless baggage mutable #5384

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cce069
fix(core): Keep spanless baggage mutable
adinauer May 7, 2026
1682a44
changelog
adinauer May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sentry/src/main/java/io/sentry/util/TracingUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ public static void setTrace(
@NotNull Baggage baggage = propagationContext.getBaggage();
if (baggage.isMutable()) {
baggage.setValuesFromScope(scope, sentryOptions);
baggage.freeze();
if (baggage.isShouldFreeze()) {
baggage.freeze();
}
}
});
}
Expand Down
43 changes: 36 additions & 7 deletions sentry/src/test/java/io/sentry/util/TracingUtilsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import io.sentry.TracesSamplingDecision
import io.sentry.TransactionContext
import io.sentry.W3CTraceparentHeader
import io.sentry.protocol.SentryId
import io.sentry.protocol.TransactionNameSource
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertNotEquals
Expand Down Expand Up @@ -77,7 +78,7 @@ class TracingUtilsTest {
.value
.contains("sentry-trace_id=${fixture.scope.propagationContext.traceId}")
)
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
Expand All @@ -98,7 +99,7 @@ class TracingUtilsTest {
assertEquals(fixture.scope.propagationContext.traceId, headers.sentryTraceHeader.traceId)
assertEquals(fixture.scope.propagationContext.isSampled, headers.sentryTraceHeader.isSampled)
assertTrue(headers.baggageHeader!!.value.contains("some-baggage-key=some-baggage-value"))
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
Expand All @@ -120,7 +121,7 @@ class TracingUtilsTest {
assertEquals(fixture.scope.propagationContext.traceId, headers.sentryTraceHeader.traceId)
assertEquals(fixture.scope.propagationContext.isSampled, headers.sentryTraceHeader.isSampled)
assertTrue(headers.baggageHeader!!.value.contains("some-baggage-key=some-baggage-value"))
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
Expand All @@ -142,7 +143,7 @@ class TracingUtilsTest {
assertEquals(fixture.scope.propagationContext.traceId, headers.sentryTraceHeader.traceId)
assertEquals(fixture.scope.propagationContext.isSampled, headers.sentryTraceHeader.isSampled)
assertTrue(headers.baggageHeader!!.value.contains("some-baggage-key=some-baggage-value"))
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
Expand All @@ -164,7 +165,7 @@ class TracingUtilsTest {
assertEquals(fixture.scope.propagationContext.traceId, headers.sentryTraceHeader.traceId)
assertEquals(fixture.scope.propagationContext.isSampled, headers.sentryTraceHeader.isSampled)
assertTrue(headers.baggageHeader!!.value.contains("some-baggage-key=some-baggage-value"))
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
Expand Down Expand Up @@ -301,7 +302,7 @@ class TracingUtilsTest {
}

@Test
fun `updates mutable baggage`() {
fun `updates mutable baggage without freezing local baggage`() {
fixture.setup()
// not frozen because it doesn't contain sentry-* keys
fixture.scope.propagationContext =
Expand All @@ -319,7 +320,35 @@ class TracingUtilsTest {
fixture.scope.propagationContext.traceId.toString(),
fixture.scope.propagationContext.baggage!!.traceId,
)
assertFalse(fixture.scope.propagationContext.baggage!!.isMutable)
assertTrue(fixture.scope.propagationContext.baggage!!.isMutable)
}

@Test
fun `spanless propagation leaves baggage mutable for later transaction DSC`() {
fixture.setup()
val propagationContext = fixture.scope.propagationContext

TracingUtils.maybeUpdateBaggage(fixture.scope, fixture.options)

assertTrue(propagationContext.baggage.isMutable)
assertNull(propagationContext.baggage.transaction)
assertNull(propagationContext.baggage.sampleRate)
assertNull(propagationContext.baggage.sampled)

val transactionContext = TransactionContext.fromPropagationContext(propagationContext)
transactionContext.name = "GET /session"
transactionContext.transactionNameSource = TransactionNameSource.CUSTOM
transactionContext.setSamplingDecision(
TracesSamplingDecision(true, 0.5, propagationContext.sampleRand)
)
val tracer = SentryTracer(transactionContext, fixture.scopes)

val baggageHeader = tracer.toBaggageHeader(null)

assertNotNull(baggageHeader)
assertTrue(baggageHeader.value.contains("sentry-transaction=GET%20%2Fsession"))
assertTrue(baggageHeader.value.contains("sentry-sampled=true"))
assertTrue(baggageHeader.value.contains("sentry-sample_rate=0.5"))
}

@Test
Expand Down
Loading