Skip to content

Rename CrashlyticsOtelContext to PersistenceContext #8641

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
mrober wants to merge 4 commits into
base: firebase-crashlytics-telemetry
Choose a base branch
from
+62 −61
Open

Rename CrashlyticsOtelContext to PersistenceContext #8641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50f86c9
Rename CrashlyticsOtelContext to TelemetryContext
mrober Sep 23, 2026
d2a4ee9
Format
mrober Sep 23, 2026
8b877b0
Rename to PersistenceContext
mrober Sep 24, 2026
84ff3f6
Tag
mrober Sep 24, 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
110 changes: 55 additions & 55 deletions ...s/telemetry/CrashlyticsOtelContextTest.kt → ...ytics/telemetry/PersistenceContextTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
class CrashlyticsOtelContextTest {
class PersistenceContextTest {

@get:Rule val otelRule: OpenTelemetryRule = OpenTelemetryRule.create()
private lateinit var testMmapFile: File
Expand All @@ -49,24 +49,24 @@ class CrashlyticsOtelContextTest {
testMmapFile = File(targetContext.cacheDir, "shared_test_context.mmap")
if (testMmapFile.exists()) testMmapFile.delete()

mutationContext = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
mutationContext = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
Span.getInvalid().makeCurrent()
}

@After
fun tearDown() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()
}

// --- 1. CrashlyticsOtelContext.initialize ---
// --- 1. PersistenceContext.initialize ---

@Test
fun initialize_createsMmapFile() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
assertThat(testMmapFile.exists()).isTrue()
}

Expand All @@ -79,10 +79,10 @@ class CrashlyticsOtelContextTest {
fun initialize_withOnRecovery_returnsRecoveredSpans() {
val originalSpan = createTestSpan("RecoverableSpan")
mutationContext.addSpan(originalSpan)
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recoveredSpans ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recoveredSpans ->
assertThat(recoveredSpans.size).isEqualTo(1)
latch.countDown()
}
Expand All @@ -93,7 +93,7 @@ class CrashlyticsOtelContextTest {
fun initialize_withCorruptedNonTerminatedSpanName_recoversSafelyWithoutCrash() {
val originalSpan = createTestSpan("InitialSpan")
mutationContext.addSpan(originalSpan)
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

// Write 64 non-null bytes into RawSpan.name (offset 88) to test create_bounded_jstring handling
// of non-terminated/oversized buffer
Expand All @@ -104,7 +104,7 @@ class CrashlyticsOtelContextTest {

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -118,16 +118,16 @@ class CrashlyticsOtelContextTest {

@Test
fun initialize_calledTwice_returnsSingleton() {
val secondContext = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
val secondContext = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
assertThat(secondContext).isSameInstanceAs(mutationContext)
}

@Test
fun initialize_afterShutdown_createsNewInstance() {
val firstContext = mutationContext
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val secondContext = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
val secondContext = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL)
assertThat(secondContext).isNotSameInstanceAs(firstContext)
}

Expand All @@ -137,16 +137,16 @@ class CrashlyticsOtelContextTest {
val threadPool = Executors.newFixedThreadPool(threads)
val countDownLatch = CountDownLatch(threads + 1)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val targetContext = InstrumentationRegistry.getInstrumentation().targetContext
val recoveryMmapFile = File(targetContext.cacheDir, "concurrent_recovery.mmap")
if (recoveryMmapFile.exists()) recoveryMmapFile.delete()

val prePopulateContext =
CrashlyticsOtelContext.initialize(recoveryMmapFile.absolutePath, MmapSize.SMALL)
PersistenceContext.initialize(recoveryMmapFile.absolutePath, MmapSize.SMALL)
prePopulateContext.addSpan(createThreadSafeTestSpan(1, 1))
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val recoveryInvocationCount = AtomicInteger(0)
val onRecovery: suspend (List<CrashlyticsSpan>) -> Unit = {
Expand All @@ -163,7 +163,7 @@ class CrashlyticsOtelContextTest {
for (i in 0 until threads) {
threadPool.submit {
try {
CrashlyticsOtelContext.initialize(
PersistenceContext.initialize(
recoveryMmapFile.absolutePath,
MmapSize.SMALL,
onRecovery,
Expand All @@ -178,29 +178,29 @@ class CrashlyticsOtelContextTest {
assertThat(recoveryInvocationCount.get()).isEqualTo(1)
} finally {
threadPool.shutdown()
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (recoveryMmapFile.exists()) recoveryMmapFile.delete()
}
}

// --- 2. CrashlyticsOtelContext.shutdown ---
// --- 2. PersistenceContext.shutdown ---

@Test
fun shutdown_beforeInitialize_doesNotThrow() {
CrashlyticsOtelContext.shutdown() // Tear down default
CrashlyticsOtelContext.shutdown() // Should run safely when already null
PersistenceContext.shutdown() // Tear down default
PersistenceContext.shutdown() // Should run safely when already null
}

@Test
fun shutdown_clearsMutationContext() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
assertThat(mutationContext.countSpans()).isEqualTo(0L)
}

@Test
fun shutdown_calledTwice_doesNotThrow() {
CrashlyticsOtelContext.shutdown()
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
PersistenceContext.shutdown()
}

@Test
Expand All @@ -213,7 +213,7 @@ class CrashlyticsOtelContextTest {
for (i in 0 until threads) {
threadPool.submit {
try {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
} finally {
countDownLatch.countDown()
}
Expand All @@ -227,10 +227,10 @@ class CrashlyticsOtelContextTest {

@Test
fun shutdown_calledConcurrentlyWithMutations_doesNotCrashOrThrow() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

val context = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)
val context = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)

val threads = 10
val iterations = 50
Expand Down Expand Up @@ -259,7 +259,7 @@ class CrashlyticsOtelContextTest {

startLatch.countDown()
Thread.sleep(5)
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

assertThat(countDownLatch.await(5, TimeUnit.SECONDS)).isTrue()
} finally {
Expand All @@ -283,7 +283,7 @@ class CrashlyticsOtelContextTest {

@Test
fun countSpans_afterShutdown_returnsZero() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
assertThat(mutationContext.countSpans()).isEqualTo(0L)
}

Expand All @@ -300,9 +300,9 @@ class CrashlyticsOtelContextTest {
val originalSpan = createTestSpan("PersistedSpan", mapOf("k" to "v"))
mutationContext.addSpan(originalSpan)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
assertThat(recovered).isNotEmpty()
}
}
Expand All @@ -313,11 +313,11 @@ class CrashlyticsOtelContextTest {
val span = createTestSpan(oversizedName)
mutationContext.addSpan(span)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -336,11 +336,11 @@ class CrashlyticsOtelContextTest {
val span = createTestSpan("OversizedAttrSpan", mapOf(oversizedKey to oversizedValue))
mutationContext.addSpan(span)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -364,11 +364,11 @@ class CrashlyticsOtelContextTest {
val span = createTestSpan(utf8Name, mapOf(utf8Key to utf8Value))
mutationContext.addSpan(span)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -385,11 +385,11 @@ class CrashlyticsOtelContextTest {
val span = createTestSpan("", emptyMap())
mutationContext.addSpan(span)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -403,16 +403,16 @@ class CrashlyticsOtelContextTest {

@Test
fun addSpan_afterShutdown_isNoOp() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
mutationContext.addSpan(createTestSpan("AfterShutdown"))
}

@Test
fun addSpan_calledConcurrently_maintainsAccurateCount() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

val context = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)
val context = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)

val threads = 10
val iterations = 20
Expand Down Expand Up @@ -458,16 +458,16 @@ class CrashlyticsOtelContextTest {

@Test
fun endSpan_afterShutdown_isNoOp() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
mutationContext.endSpan("0000000000000000")
}

@Test
fun endSpan_calledConcurrently_maintainsConsistentState() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

val context = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)
val context = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)

val threads = 10
val iterations = 20
Expand Down Expand Up @@ -553,11 +553,11 @@ class CrashlyticsOtelContextTest {
val oversizedValue = "v".repeat(300)
mutationContext.setAttributeOnSpan(span.spanId, oversizedKey, oversizedValue)

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val latch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.SMALL) { recovered ->
recoveredSpans = recovered
latch.countDown()
}
Expand All @@ -579,16 +579,16 @@ class CrashlyticsOtelContextTest {

@Test
fun setAttributeOnSpan_afterShutdown_isNoOp() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
mutationContext.setAttributeOnSpan("0000000000000000", "key", "value")
}

@Test
fun setAttributeOnSpan_calledConcurrently_doesNotCrashOrCorrupt() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

val context = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)
val context = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)

val threads = 10
val iterations = 20
Expand Down Expand Up @@ -632,10 +632,10 @@ class CrashlyticsOtelContextTest {

@Test
fun mixedOperations_calledConcurrently_maintainsDataIntegrityAndRecoversCleanly() {
CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()
if (testMmapFile.exists()) testMmapFile.delete()

val context = CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)
val context = PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE)

val threads = 10
val iterations = 20
Expand All @@ -661,11 +661,11 @@ class CrashlyticsOtelContextTest {
assertThat(countDownLatch.await(10, TimeUnit.SECONDS)).isTrue()
assertThat(context.countSpans()).isEqualTo((threads * iterations).toLong())

CrashlyticsOtelContext.shutdown()
PersistenceContext.shutdown()

val recoveryLatch = CountDownLatch(1)
var recoveredSpans: List<CrashlyticsSpan>? = null
CrashlyticsOtelContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE) { recovered ->
PersistenceContext.initialize(testMmapFile.absolutePath, MmapSize.LARGE) { recovered ->
recoveredSpans = recovered
recoveryLatch.countDown()
}
Expand All @@ -684,7 +684,7 @@ class CrashlyticsOtelContextTest {
name: String,
attributes: Map<String, String> = emptyMap(),
): CrashlyticsSpan {
val tracer = otelRule.openTelemetry.getTracer("CrashlyticsOtelContextTest")
val tracer = otelRule.openTelemetry.getTracer("PersistenceContextTest")
val span = tracer.spanBuilder(name)

for ((key, value) in attributes) {
Expand Down
4 changes: 2 additions & 2 deletions ...telemetry/src/main/java/com/google/firebase/crashlytics/telemetry/OpenTelemetryManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ internal object OpenTelemetryManager {
Log.d("OpenTelemetryManager", "mmap file: $mmapFileCurrent")

val mutationContext =
CrashlyticsOtelContext.initialize(mmapFileCurrent.absolutePath, MmapSize.SMALL) {
recoveredSpans ->
PersistenceContext.initialize(mmapFileCurrent.absolutePath, MmapSize.SMALL) { recoveredSpans
->
val recoverPreviousSpans = Firebase.crashlytics.didCrashOnPreviousExecution()
if (recoverPreviousSpans) {
Log.d("OpenTelemetryManager", "Found ${recoveredSpans.size} recovered spans to export.")
Expand Down
Loading
Loading