Fix unlikely SpanTracker leak #205
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ens have been garbage collected
…eaks on `Build.VERSION`
lemnik
requested review from
kstenerud,
tomlongridge,
yousif-bugsnag and
a user
lemnik
force-pushed
the
PLAT-10282/fix-unlikely-spantracker-leak
branch
from
1e8b71f
to
3f3b02c
Compare
Android notifier sizes
Generated by 🚫 Danger |
kstenerud
approved these changes
Jan 26, 2024
...-android-performance/src/main/kotlin/com/bugsnag/android/performance/internal/SpanTracker.kt
Outdated
Show resolved
Hide resolved
...-android-performance/src/main/kotlin/com/bugsnag/android/performance/internal/SpanTracker.kt
Outdated
Show resolved
Hide resolved
…w Array<SpanBinding?>.unlinkBindingWhere function to simplify unlinking and make it more robust.
yousif-bugsnag
approved these changes
Jan 26, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
Avoid possibly leaking tracked spans due to garbage-collection of their tokens. When a tracked span is on the
SpanContextstack, and its "token" object (Activity,Fragment, etc.) is garbage-collected without the span being ended, it will remain on the stack permanently (because theSpanTrackerdoes not know to end it).Design
The
SpanTrackeris now implemented as a special-purposeWeakHashMapimplementation. When spans are "lost" due to their tokens being garbage collected, the spans are correctlyended and removed from the table. This implementation also avoids the "map in map" design of the previousSpanTrackerby instead implementing a composite-key structure.WeakHashMapitself is unfortunately unsuitable as we have no way to determine when entries are removed due to garbage collection.Testing
Additional unit tests