Sulkta-OSS/element-x-ada
3
0
Fork 0
Code Issues 1 Pull requests 4 Projects Releases Packages Wiki Activity Actions 8

Replace AnalyticsSdkSpanFactory with AnalyticsSdkManager.

Browse source 
`AnalyticsSdkManager` also enables and disables Sentry logging in the SDK based on analytics user content.
This commit is contained in:
Jorge Martín 2025-12-04 10:27:04 +01:00 • committed by Jorge Martin Espinosa
parent 942eae94ad
commit 342ee0c10b
7 changed files with 88 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

14
services/analytics/impl/src/main/kotlin/io/element/android/services/analytics/impl/DefaultAnalyticsService.kt
View file

@ -20,8 +20,8 @@ import io.element.android.libraries.di.annotations.AppCoroutineScope
import io.element.android.libraries.sessionstorage.api.observer.SessionListener
import io.element.android.libraries.sessionstorage.api.observer.SessionObserver
import io.element.android.services.analytics.api.AnalyticsLongRunningTransaction
import io.element.android.services.analytics.api.AnalyticsSdkManager
import io.element.android.services.analytics.api.AnalyticsSdkSpan
import io.element.android.services.analytics.api.AnalyticsSdkSpanFactory
import io.element.android.services.analytics.api.AnalyticsService
import io.element.android.services.analytics.api.NoopAnalyticsSdkSpan
import io.element.android.services.analytics.api.NoopAnalyticsTransaction
@ -42,11 +42,9 @@ import java.util.concurrent.atomic.AtomicBoolean
class DefaultAnalyticsService(
private val analyticsProviders: Set<@JvmSuppressWildcards AnalyticsProvider>,
private val analyticsStore: AnalyticsStore,
// private val lateInitUserPropertiesFactory: LateInitUserPropertiesFactory,
@AppCoroutineScope
private val coroutineScope: CoroutineScope,
@AppCoroutineScope private val coroutineScope: CoroutineScope,
private val sessionObserver: SessionObserver,
private val analyticsSdkSpanFactory: AnalyticsSdkSpanFactory,
private val analyticsSdkManager: AnalyticsSdkManager,
) : AnalyticsService, SessionListener {
private val pendingLongRunningTransactions = ConcurrentHashMap<AnalyticsLongRunningTransaction, AnalyticsTransaction>()
@ -72,6 +70,7 @@ class DefaultAnalyticsService(
override suspend fun setUserConsent(userConsent: Boolean) {
Timber.tag(analyticsTag.value).d("setUserConsent($userConsent)")
analyticsStore.setUserConsent(userConsent)
analyticsSdkManager.enableSdkAnalytics(enabled = userConsent)
}
override suspend fun setDidAskUserConsent() {
@ -88,6 +87,7 @@ class DefaultAnalyticsService(
// Delete the store when the last session is deleted
if (wasLastSession) {
analyticsStore.reset()
analyticsSdkManager.enableSdkAnalytics(false)
}
}
@ -179,9 +179,9 @@ class DefaultAnalyticsService(
override fun enterSdkSpan(name: String?, parentTraceId: String?): AnalyticsSdkSpan {
return if (userConsent.get()) {
if (name != null) {
analyticsSdkSpanFactory.create(name, parentTraceId)
analyticsSdkManager.startSpan(name, parentTraceId)
} else {
analyticsSdkSpanFactory.bridge(parentTraceId)
analyticsSdkManager.bridge(parentTraceId)
}.apply { enter() }
} else {
NoopAnalyticsSdkSpan

29
services/analytics/impl/src/test/kotlin/io/element/android/services/analytics/impl/DefaultAnalyticsServiceTest.kt
View file

@ -17,11 +17,11 @@ import im.vector.app.features.analytics.plan.MobileScreen
import im.vector.app.features.analytics.plan.PollEnd
import im.vector.app.features.analytics.plan.SuperProperties
import im.vector.app.features.analytics.plan.UserProperties
import io.element.android.libraries.matrix.test.analytics.FakeAnalyticsSdkManager
import io.element.android.libraries.sessionstorage.api.observer.SessionObserver
import io.element.android.libraries.sessionstorage.test.observer.NoOpSessionObserver
import io.element.android.services.analytics.impl.store.AnalyticsStore
import io.element.android.services.analytics.impl.store.FakeAnalyticsStore
import io.element.android.services.analytics.test.FakeAnalyticsSdkSpanFactory
import io.element.android.services.analyticsproviders.api.AnalyticsProvider
import io.element.android.services.analyticsproviders.test.FakeAnalyticsProvider
import io.element.android.tests.testutils.lambda.lambdaRecorder
@ -33,6 +33,7 @@ import kotlinx.coroutines.cancel
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.launch
import kotlinx.coroutines.test.TestScope
import kotlinx.coroutines.test.runTest
import org.junit.Test
@ -127,17 +128,20 @@ class DefaultAnalyticsServiceTest {
}
@Test
fun `setUserConsent is sent to the store`() = runTest {
fun `setUserConsent is sent to the store and the SDK`() = runTest {
val sdkAnalyticsEnabledLambda = lambdaRecorder<Boolean, Unit> {}
val store = FakeAnalyticsStore()
val sut = createDefaultAnalyticsService(
coroutineScope = backgroundScope,
analyticsStore = store,
sdkAnalyticsManager = FakeAnalyticsSdkManager(sdkAnalyticsEnabledLambda),
)
assertThat(store.userConsentFlow.first()).isFalse()
assertThat(sut.userConsentFlow.first()).isFalse()
sut.setUserConsent(true)
assertThat(store.userConsentFlow.first()).isTrue()
assertThat(sut.userConsentFlow.first()).isTrue()
sdkAnalyticsEnabledLambda.assertions().isCalledOnce().with(value(true))
}
@Test
@ -170,16 +174,19 @@ class DefaultAnalyticsServiceTest {
@Test
fun `when the last session is deleted, the store is reset`() = runTest {
val resetLambda = lambdaRecorder<Unit> { }
val resetLambda = lambdaRecorder<Unit> {}
val sdkAnalyticsEnabledLambda = lambdaRecorder<Boolean, Unit> {}
val store = FakeAnalyticsStore(
resetLambda = resetLambda,
)
val sut = createDefaultAnalyticsService(
coroutineScope = backgroundScope,
analyticsStore = store,
sdkAnalyticsManager = FakeAnalyticsSdkManager(sdkAnalyticsEnabledLambda),
)
sut.onSessionDeleted("userId", true)
resetLambda.assertions().isCalledOnce()
sdkAnalyticsEnabledLambda.assertions().isCalledOnce().with(value(false))
}
@Test
@ -235,7 +242,6 @@ class DefaultAnalyticsServiceTest {
fun `when consent is provided, updateUserProperties is sent to the provider`() = runTest {
val updateUserPropertiesLambda = lambdaRecorder<UserProperties, Unit> { _ -> }
val sut = createDefaultAnalyticsService(
coroutineScope = backgroundScope,
analyticsProviders = setOf(
FakeAnalyticsProvider(
initLambda = { },
@ -252,7 +258,6 @@ class DefaultAnalyticsServiceTest {
fun `when super properties are updated, updateSuperProperties is sent to the provider`() = runTest {
val updateSuperPropertiesLambda = lambdaRecorder<SuperProperties, Unit> { _ -> }
val sut = createDefaultAnalyticsService(
coroutineScope = backgroundScope,
analyticsProviders = setOf(
FakeAnalyticsProvider(
initLambda = { },
@ -265,8 +270,15 @@ class DefaultAnalyticsServiceTest {
updateSuperPropertiesLambda.assertions().isCalledOnce().with(value(aSuperProperty))
}
private suspend fun createDefaultAnalyticsService(
coroutineScope: CoroutineScope,
@Test
fun `startSdkSpan returns a span from the AnalyticsSdkManager`() = runTest {
val sut = createDefaultAnalyticsService()
val span = sut.enterSdkSpan("spanName", "parentTraceId")
assertThat(span).isNotNull()
}
private suspend fun TestScope.createDefaultAnalyticsService(
coroutineScope: CoroutineScope = backgroundScope,
analyticsProviders: Set<@JvmSuppressWildcards AnalyticsProvider> = setOf(
FakeAnalyticsProvider(
stopLambda = { },
@ -274,12 +286,13 @@ class DefaultAnalyticsServiceTest {
),
analyticsStore: AnalyticsStore = FakeAnalyticsStore(),
sessionObserver: SessionObserver = NoOpSessionObserver(),
sdkAnalyticsManager: FakeAnalyticsSdkManager = FakeAnalyticsSdkManager(enableSdkAnalyticsLambda = {}),
) = DefaultAnalyticsService(
analyticsProviders = analyticsProviders,
analyticsStore = analyticsStore,
coroutineScope = coroutineScope,
sessionObserver = sessionObserver,
analyticsSdkSpanFactory = FakeAnalyticsSdkSpanFactory(),
analyticsSdkManager = sdkAnalyticsManager,
).also {
// Wait for the service to be ready
delay(1)