Skip to content

fix(android): Prevent duplicated breadcrumbs on tombstone-merged events #5888

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

Open
lucas-zimerman wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −5
Open

fix(android): Prevent duplicated breadcrumbs on tombstone-merged events #5888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 2 deletions ...-android-core/src/main/java/io/sentry/android/core/ApplicationExitInfoEventProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,9 +356,9 @@ private void setBreadcrumbs(final @NotNull SentryBaseEvent event) {
}
if (event.getBreadcrumbs() == null) {
event.setBreadcrumbs(breadcrumbs);
} else {
event.getBreadcrumbs().addAll(breadcrumbs);
}
// else: the event already carries its own breadcrumbs (e.g. a tombstone-merged native
// crash event), so appending the persisted ones here would duplicate entries.
}

@SuppressWarnings("unchecked")
Expand Down
22 changes: 19 additions & 3 deletions ...ndroid-core/src/test/java/io/sentry/android/core/ApplicationExitInfoEventProcessorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,21 @@ class ApplicationExitInfoEventProcessorTest {
assertEquals("Google Chrome", processed.contexts.browser!!.name)
}

@Test
fun `when backfillable event already has breadcrumbs, does not duplicate them with persisted ones`() {
// simulates a tombstone-merged native crash event, which already carries its own
// breadcrumb history captured at crash time, overlapping with what was persisted to disk
val hint = HintUtils.createWithTypeCheckHint(BackfillableHint())

val processed =
processEvent(hint, populateScopeCache = true) {
breadcrumbs = listOf(Breadcrumb.debug("own-crash-time-breadcrumb"))
}

assertEquals(1, processed.breadcrumbs!!.size)
assertEquals("own-crash-time-breadcrumb", processed.breadcrumbs!![0].message)
}

@Test
fun `when backfillable event is enrichable, does not backfill user ip`() {
val hint = HintUtils.createWithTypeCheckHint(BackfillableHint())
Expand Down Expand Up @@ -670,10 +685,11 @@ class ApplicationExitInfoEventProcessorTest {

assertEquals("MainActivity", processed.transaction)
assertEquals(DEBUG, processed.level)
assertEquals(3, processed.breadcrumbs!!.size)
// breadcrumbs already set on the event are preserved as-is, not merged with the persisted
// ones, since the event already carries its own authoritative breadcrumb history
assertEquals(1, processed.breadcrumbs!!.size)
assertEquals("debug", processed.breadcrumbs!![0].type)
assertEquals("debug", processed.breadcrumbs!![1].type)
assertEquals("navigation", processed.breadcrumbs!![2].type)
assertEquals("test", processed.breadcrumbs!![0].message)

assertEquals("debug", processed.environment)
assertEquals("io.sentry.samples@1.1.0+220", processed.release)
Expand Down
Loading