jarno
/
element-android
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #8238 from vector-im/feature/bma/postHogOff 

Create Posthog instance only when user consent is given
This commit is contained in:
Benoit Marty 2023-03-17 16:13:30 +01:00 committed by GitHub
parent f76c2f1007 7857339f54
commit f08f3c1b02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
vector/src/main/java/im/vector/app/features/analytics/impl/DefaultVectorAnalytics.kt
View File

@ -41,21 +41,25 @@ private val IGNORED_OPTIONS: Options? = null
@Singleton @Singleton
class DefaultVectorAnalytics @Inject constructor( class DefaultVectorAnalytics @Inject constructor(
postHogFactory: PostHogFactory, private val postHogFactory: PostHogFactory,
private val sentryAnalytics: SentryAnalytics, private val sentryAnalytics: SentryAnalytics,
analyticsConfig: AnalyticsConfig, private val analyticsConfig: AnalyticsConfig,
private val analyticsStore: AnalyticsStore, private val analyticsStore: AnalyticsStore,
private val lateInitUserPropertiesFactory: LateInitUserPropertiesFactory, private val lateInitUserPropertiesFactory: LateInitUserPropertiesFactory,
@NamedGlobalScope private val globalScope: CoroutineScope @NamedGlobalScope private val globalScope: CoroutineScope
) : VectorAnalytics { ) : VectorAnalytics {
private val posthog: PostHog? = when { private var posthog: PostHog? = null
private fun createPosthog(): PostHog? {
return when {
analyticsConfig.isEnabled -> postHogFactory.createPosthog() analyticsConfig.isEnabled -> postHogFactory.createPosthog()
else -> { else -> {
Timber.tag(analyticsTag.value).w("Analytics is disabled") Timber.tag(analyticsTag.value).w("Analytics is disabled")
null null
} }
} }
}
// Cache for the store values // Cache for the store values
private var userConsent: Boolean? = null private var userConsent: Boolean? = null
@ -150,6 +154,7 @@ class DefaultVectorAnalytics @Inject constructor(
userConsent?.let { _userConsent -> userConsent?.let { _userConsent ->
when (_userConsent) { when (_userConsent) {
true -> { true -> {
posthog = createPosthog()
posthog?.optOut(false) posthog?.optOut(false)
identifyPostHog() identifyPostHog()
pendingUserProperties?.let { doUpdateUserProperties(it) } pendingUserProperties?.let { doUpdateUserProperties(it) }
@ -159,6 +164,7 @@ class DefaultVectorAnalytics @Inject constructor(
// When opting out, ensure that the queue is flushed first, or it will be flushed later (after user has revoked consent) // When opting out, ensure that the queue is flushed first, or it will be flushed later (after user has revoked consent)
posthog?.flush() posthog?.flush()
posthog?.optOut(true) posthog?.optOut(true)
posthog = null
} }
} }
} }

6
vector/src/test/java/im/vector/app/features/analytics/impl/DefaultVectorAnalyticsTest.kt
View File

@ -80,6 +80,12 @@ class DefaultVectorAnalyticsTest {
@Test @Test
fun `when revoking consent to analytics then updates posthog opt out to true and closes Sentry`() = runTest { fun `when revoking consent to analytics then updates posthog opt out to true and closes Sentry`() = runTest {
// For opt-out to have effect on Posthog, it has to be used first, so it has to be opt-in first
fakeAnalyticsStore.givenUserContent(consent = true)
fakePostHog.verifyOptOutStatus(optedOut = false)
fakeSentryAnalytics.verifySentryInit()
// Then test opt-out
fakeAnalyticsStore.givenUserContent(consent = false) fakeAnalyticsStore.givenUserContent(consent = false)
fakePostHog.verifyOptOutStatus(optedOut = true) fakePostHog.verifyOptOutStatus(optedOut = true)