[WIP] Use sense of protection experiment to determine whether to show trackers blocked animation

I deleted AppPersonalityFeature which was the local toggle to determine whether to show the animation or not. I did not want to leave it in to cause any confusion with the experiment. It has not been completely removed in this PR which is why it's a WIP.

It would be good to confirm with Ana that the checks to show based on the new variants are correct as things have changed so much but I believe I have the checks correct.

Author: mikescamell

app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt

@@ -150,6 +150,7 @@ import com.duckduckgo.app.browser.omnibar.model.OmnibarPosition.TOP
 import com.duckduckgo.app.browser.print.PrintDocumentAdapterFactory
 import com.duckduckgo.app.browser.print.PrintInjector
 import com.duckduckgo.app.browser.remotemessage.SharePromoLinkRMFBroadCastReceiver
+import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionExperiment
 import com.duckduckgo.app.browser.session.WebViewSessionStorage
 import com.duckduckgo.app.browser.shortcut.ShortcutBuilder
 import com.duckduckgo.app.browser.tabpreview.WebViewPreviewGenerator
@@ -236,7 +237,6 @@ import com.duckduckgo.browser.api.brokensite.BrokenSiteData
 import com.duckduckgo.browser.api.brokensite.BrokenSiteData.ReportFlow.RELOAD_THREE_TIMES_WITHIN_20_SECONDS
 import com.duckduckgo.browser.api.ui.BrowserScreens.WebViewActivityWithParams
 import com.duckduckgo.common.ui.DuckDuckGoFragment
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.experiments.visual.store.VisualDesignExperimentDataStore
 import com.duckduckgo.common.ui.store.BrowserAppTheme
 import com.duckduckgo.common.ui.view.DaxDialog
@@ -544,7 +544,7 @@ class BrowserTabFragment :
     lateinit var experimentTrackersAnimationHelper: ExperimentTrackersAnimationHelper
 
     @Inject
-    lateinit var appPersonalityFeature: AppPersonalityFeature
+    lateinit var senseOfProtectionExperiment: SenseOfProtectionExperiment
 
     /**
      * We use this to monitor whether the user was seeing the in-context Email Protection signup prompt
@@ -678,8 +678,7 @@ class BrowserTabFragment :
         override fun onPopUpHandled(isCosmetic: Boolean) {
             launch {
                 context?.let {
-                    if (appPersonalityFeature.self().isEnabled() &&
-                        !appPersonalityFeature.variant1().isEnabled() &&
+                    if (senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled() &&
                         viewModel.trackersCount().isNotEmpty()
                     ) {
                         if (isCosmetic) {
@@ -1263,9 +1262,7 @@ class BrowserTabFragment :
 
     private fun initPrivacyProtectionsPopup() {
         privacyProtectionsPopup = privacyProtectionsPopupFactory.createPopup(
-            anchor = if (appPersonalityFeature.self().isEnabled() &&
-                !appPersonalityFeature.variant1().isEnabled()
-            ) {
+            anchor = if (senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()) {
                 omnibar.shieldIconExperiment
             } else {
                 omnibar.shieldIcon

app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt

@@ -244,7 +244,6 @@ import com.duckduckgo.app.global.model.SiteFactory
 import com.duckduckgo.app.global.model.domain
 import com.duckduckgo.app.global.model.domainMatchesUrl
 import com.duckduckgo.app.location.data.LocationPermissionType
-import com.duckduckgo.app.onboarding.store.UserStageStore
 import com.duckduckgo.app.pixels.AppPixelName
 import com.duckduckgo.app.pixels.AppPixelName.AUTOCOMPLETE_BANNER_DISMISSED
 import com.duckduckgo.app.pixels.AppPixelName.AUTOCOMPLETE_BANNER_SHOWN
@@ -283,7 +282,6 @@ import com.duckduckgo.browser.api.UserBrowserProperties
 import com.duckduckgo.browser.api.brokensite.BrokenSiteData
 import com.duckduckgo.browser.api.brokensite.BrokenSiteData.ReportFlow.MENU
 import com.duckduckgo.browser.api.brokensite.BrokenSiteData.ReportFlow.RELOAD_THREE_TIMES_WITHIN_20_SECONDS
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.experiments.visual.store.VisualDesignExperimentDataStore
 import com.duckduckgo.common.utils.AppUrl
 import com.duckduckgo.common.utils.AppUrl.ParamKey.QUERY
@@ -478,7 +476,6 @@ class BrowserTabViewModel @Inject constructor(
     private val siteErrorHandlerKillSwitch: SiteErrorHandlerKillSwitch,
     private val siteErrorHandler: StringSiteErrorHandler,
     private val siteHttpErrorHandler: HttpCodeSiteErrorHandler,
-    private val appPersonalityFeature: AppPersonalityFeature,
     private val senseOfProtectionExperiment: SenseOfProtectionExperiment,
 ) : WebViewClientListener,
     EditSavedSiteListener,
@@ -1042,7 +1039,7 @@ class BrowserTabViewModel @Inject constructor(
 
         when (cta) {
             is DaxBubbleCta.DaxIntroSearchOptionsCta,
-            -> {
+                -> {
                 if (!ctaViewModel.isSuggestedSearchOption(query)) {
                     pixel.fire(ONBOARDING_SEARCH_CUSTOM, type = Unique())
                 }
@@ -4081,9 +4078,7 @@ class BrowserTabViewModel @Inject constructor(
 
     fun onAnimationFinished() {
         viewModelScope.launch {
-            if (appPersonalityFeature.self().isEnabled() &&
-                (appPersonalityFeature.variant2().isEnabled() || appPersonalityFeature.variant3().isEnabled())
-            ) {
+            if (senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()) {
                 command.value = StartTrackersExperimentShieldPopAnimation
             }
         }

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayout.kt

@@ -79,6 +79,7 @@ import com.duckduckgo.app.browser.omnibar.animations.PrivacyShieldAnimationHelpe
 import com.duckduckgo.app.browser.omnibar.animations.TrackersAnimatorListener
 import com.duckduckgo.app.browser.omnibar.animations.omnibaranimation.OmnibarAnimationManager
 import com.duckduckgo.app.browser.omnibar.model.OmnibarPosition
+import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionExperiment
 import com.duckduckgo.app.browser.tabswitcher.TabSwitcherButton
 import com.duckduckgo.app.browser.viewstate.LoadingViewState
 import com.duckduckgo.app.browser.viewstate.OmnibarViewState
@@ -87,7 +88,6 @@ import com.duckduckgo.app.global.view.renderIfChanged
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.app.trackerdetection.model.Entity
 import com.duckduckgo.common.ui.DuckDuckGoActivity
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.view.KeyboardAwareEditText
 import com.duckduckgo.common.ui.view.KeyboardAwareEditText.ShowSuggestionsListener
 import com.duckduckgo.common.ui.view.gone
@@ -171,7 +171,7 @@ open class OmnibarLayout @JvmOverloads constructor(
     lateinit var dispatchers: DispatcherProvider
 
     @Inject
-    lateinit var appPersonalityFeature: AppPersonalityFeature
+    lateinit var senseOfProtectionExperiment: SenseOfProtectionExperiment
 
     @Inject
     lateinit var omnibarAnimationManager: OmnibarAnimationManager
@@ -555,7 +555,7 @@ open class OmnibarLayout @JvmOverloads constructor(
             }
 
             OmnibarLayoutViewModel.LeadingIconState.PRIVACY_SHIELD -> {
-                val isExperimentEnabled = appPersonalityFeature.self().isEnabled() && !appPersonalityFeature.variant1().isEnabled()
+                val isExperimentEnabled = !senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()
                 if (isExperimentEnabled) {
                     shieldIcon.gone()
                     shieldIconExperiment.show()
@@ -776,7 +776,7 @@ open class OmnibarLayout @JvmOverloads constructor(
         if (targetView != null) {
             // We need a different asset when the experiment is enabled and the animation is played on the Privacy Shield.
             val isPrivacyShieldAnimation = targetView == placeholder
-            val isExperimentEnabled = appPersonalityFeature.self().isEnabled() && !appPersonalityFeature.variant1().isEnabled()
+            val isExperimentEnabled = senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()
             if (pulseAnimation.isActive) {
                 pulseAnimation.stop()
             }
@@ -855,7 +855,7 @@ open class OmnibarLayout @JvmOverloads constructor(
         renderIfChanged(privacyShield, lastSeenPrivacyShield) {
             lastSeenPrivacyShield = privacyShield
             val shieldIconView = if (viewMode is ViewMode.Browser) {
-                val isExperimentEnabled = appPersonalityFeature.self().isEnabled() && !appPersonalityFeature.variant1().isEnabled()
+                val isExperimentEnabled = senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()
                 if (isExperimentEnabled) shieldIconExperiment else shieldIcon
             } else {
                 customTabToolbarContainer.customTabShieldIcon

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt

@@ -41,6 +41,7 @@ import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconStat
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconState.GLOBE
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconState.PRIVACY_SHIELD
 import com.duckduckgo.app.browser.omnibar.OmnibarLayoutViewModel.LeadingIconState.SEARCH
+import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionExperiment
 import com.duckduckgo.app.browser.viewstate.HighlightableButton
 import com.duckduckgo.app.browser.viewstate.LoadingViewState
 import com.duckduckgo.app.browser.viewstate.OmnibarViewState
@@ -52,7 +53,6 @@ import com.duckduckgo.app.statistics.pixels.Pixel.PixelType.Unique
 import com.duckduckgo.app.tabs.model.TabRepository
 import com.duckduckgo.app.trackerdetection.model.Entity
 import com.duckduckgo.browser.api.UserBrowserProperties
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.experiments.visual.store.VisualDesignExperimentDataStore
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.FragmentScope
@@ -88,7 +88,7 @@ class OmnibarLayoutViewModel @Inject constructor(
     private val dispatcherProvider: DispatcherProvider,
     private val defaultBrowserPromptsExperiment: DefaultBrowserPromptsExperiment,
     visualDesignExperimentDataStore: VisualDesignExperimentDataStore,
-    private val appPersonalityFeature: AppPersonalityFeature,
+    private val senseOfProtectionExperiment: SenseOfProtectionExperiment,
 ) : ViewModel() {
 
     private val _viewState = MutableStateFlow(ViewState())
@@ -607,11 +607,11 @@ class OmnibarLayoutViewModel @Inject constructor(
                         }
                         viewModelScope.launch {
                             when {
-                                appPersonalityFeature.self().isEnabled() && appPersonalityFeature.variant1().isEnabled() -> {
+                                senseOfProtectionExperiment.isUserEnrolledInModifiedControlCohortAndExperimentEnabled() -> {
                                     command.send(Command.StartExperimentVariant1Animation)
                                 }
 
-                                appPersonalityFeature.self().isEnabled() && !appPersonalityFeature.variant1().isEnabled() -> {
+                                senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled() -> {
                                     command.send(
                                         Command.StartExperimentVariant2OrVariant3Animation(decoration.entities),
                                     )

app/src/main/java/com/duckduckgo/app/browser/omnibar/animations/LottiePrivacyShieldAnimationHelper.kt

@@ -18,12 +18,12 @@ package com.duckduckgo.app.browser.omnibar.animations
 
 import com.airbnb.lottie.LottieAnimationView
 import com.duckduckgo.app.browser.R
+import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionExperiment
 import com.duckduckgo.app.global.model.PrivacyShield
 import com.duckduckgo.app.global.model.PrivacyShield.MALICIOUS
 import com.duckduckgo.app.global.model.PrivacyShield.PROTECTED
 import com.duckduckgo.app.global.model.PrivacyShield.UNKNOWN
 import com.duckduckgo.app.global.model.PrivacyShield.UNPROTECTED
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.store.AppTheme
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
@@ -35,7 +35,7 @@ import timber.log.Timber
 @SingleInstanceIn(AppScope::class)
 class LottiePrivacyShieldAnimationHelper @Inject constructor(
     private val appTheme: AppTheme,
-    private val appPersonalityFeature: AppPersonalityFeature,
+    private val senseOfProtectionExperiment: SenseOfProtectionExperiment,
 ) : PrivacyShieldAnimationHelper {
 
     override fun setAnimationView(
@@ -46,7 +46,7 @@ class LottiePrivacyShieldAnimationHelper @Inject constructor(
         val protectedShieldDark: Int
         val unprotectedShield: Int
         val unprotectedShieldDark: Int
-        if (appPersonalityFeature.self().isEnabled() && !appPersonalityFeature.variant1().isEnabled()) {
+        if (!senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled()) {
             protectedShield = R.raw.protected_shield_experiment
             protectedShieldDark = R.raw.protected_shield_experiment
             unprotectedShield = R.raw.unprotected_shield_experiment

app/src/main/java/com/duckduckgo/app/browser/senseofprotection/SenseOfProtectionExperimentImpl.kt

@@ -38,7 +38,9 @@ interface SenseOfProtectionExperiment {
     fun enrolUserInNewExperimentIfEligible(): Boolean
     fun getTabManagerPixelParams(): Map<String, String>
     fun firePrivacyDashboardClickedPixelIfInExperiment()
+    fun isUserEnrolledInAVariantAndExperimentEnabled(): Boolean
     fun isUserEnrolledInVariant2CohortAndExperimentEnabled(): Boolean
+    fun isUserEnrolledInModifiedControlCohortAndExperimentEnabled(): Boolean
 }
 
 @ContributesBinding(
@@ -98,13 +100,18 @@ class SenseOfProtectionExperimentImpl @Inject constructor(
 
     override fun firePrivacyDashboardClickedPixelIfInExperiment() {
         appCoroutineScope.launch(dispatcherProvider.io()) {
-            if (isUserEnrolledInVariantAndExperimentEnabled()) {
+            if (isUserEnrolledInAVariantAndExperimentEnabled()) {
                 senseOfProtectionPixelsPlugin.getPrivacyDashboardClickedMetric()?.fire()
             }
         }
     }
 
-    private fun isUserEnrolledInVariantAndExperimentEnabled(): Boolean {
+    override fun isUserEnrolledInModifiedControlCohortAndExperimentEnabled(): Boolean =
+        getNewUserExperimentCohortName() == MODIFIED_CONTROL.cohortName && isNewUserExperimentEnabled(MODIFIED_CONTROL) ||
+            getExistingUserExperimentCohortName() == MODIFIED_CONTROL.cohortName && isExistingUserExperimentEnabled(MODIFIED_CONTROL)
+
+    // TODO this _might_ be able to be simplified like the isUserEnrolledInModifiedControlCohortAndExperimentEnabled function
+    override fun isUserEnrolledInAVariantAndExperimentEnabled(): Boolean {
         return when {
             isEnrolledInNewUserExperiment() -> {
                 val cohortNameString = senseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25().getCohort()?.name

common/common-ui-internal/src/main/java/com/duckduckgo/common/ui/internal/experiments/trackersblocking/TrackersBlockingExperimentViewModel.kt

@@ -21,11 +21,9 @@ import androidx.lifecycle.DefaultLifecycleObserver
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.duckduckgo.anvil.annotations.ContributesViewModel
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.experiments.visual.store.VisualDesignExperimentDataStore
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.ViewScope
-import com.duckduckgo.feature.toggles.api.Toggle.State
 import javax.inject.Inject
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -37,7 +35,6 @@ import kotlinx.coroutines.launch
 @ContributesViewModel(ViewScope::class)
 class TrackersBlockingExperimentViewModel@Inject constructor(
     private val dispatchers: DispatcherProvider,
-    private val appPersonalityFeature: AppPersonalityFeature,
     private val visualDesignExperimentDataStore: VisualDesignExperimentDataStore,
 ) : ViewModel(), DefaultLifecycleObserver {
 
@@ -57,57 +54,27 @@ class TrackersBlockingExperimentViewModel@Inject constructor(
     @SuppressLint("DenyListedApi")
     fun onTrackersBlockingVariant1ExperimentalUIModeChanged(checked: Boolean) {
         viewModelScope.launch(dispatchers.io()) {
-            appPersonalityFeature.self().setRawStoredState(State(checked))
-            appPersonalityFeature.variant1().setRawStoredState(State(checked))
-
-            if (checked) {
-                visualDesignExperimentDataStore.setExperimentStateUserPreference(false)
-                appPersonalityFeature.variant2().setRawStoredState(State(false))
-                appPersonalityFeature.variant3().setRawStoredState(State(false))
-            }
             updateCurrentState()
         }
     }
 
     @SuppressLint("DenyListedApi")
     fun onTrackersBlockingVariant2ExperimentalUIModeChanged(checked: Boolean) {
         viewModelScope.launch(dispatchers.io()) {
-            appPersonalityFeature.self().setRawStoredState(State(checked))
-            appPersonalityFeature.variant2().setRawStoredState(State(checked))
-
-            if (checked) {
-                visualDesignExperimentDataStore.setExperimentStateUserPreference(false)
-                appPersonalityFeature.variant1().setRawStoredState(State(false))
-                appPersonalityFeature.variant3().setRawStoredState(State(false))
-            }
             updateCurrentState()
         }
     }
 
     @SuppressLint("DenyListedApi")
     fun onTrackersBlockingVariant3ExperimentalUIModeChanged(checked: Boolean) {
         viewModelScope.launch(dispatchers.io()) {
-            appPersonalityFeature.self().setRawStoredState(State(checked))
-            appPersonalityFeature.variant3().setRawStoredState(State(checked))
-
-            if (checked) {
-                visualDesignExperimentDataStore.setExperimentStateUserPreference(false)
-                appPersonalityFeature.variant1().setRawStoredState(State(false))
-                appPersonalityFeature.variant2().setRawStoredState(State(false))
-            }
             updateCurrentState()
         }
     }
 
     private fun updateCurrentState() {
         viewModelScope.launch {
-            viewState.update {
-                currentViewState().copy(
-                    variant1 = appPersonalityFeature.variant1().isEnabled(),
-                    variant2 = appPersonalityFeature.variant2().isEnabled(),
-                    variant3 = appPersonalityFeature.variant3().isEnabled(),
-                )
-            }
+            viewState.update { currentViewState() }
         }
     }
 }

common/common-ui-internal/src/main/java/com/duckduckgo/common/ui/internal/experiments/visual/VisualDesignExperimentViewModel.kt

@@ -21,11 +21,9 @@ import androidx.lifecycle.DefaultLifecycleObserver
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.duckduckgo.anvil.annotations.ContributesViewModel
-import com.duckduckgo.common.ui.experiments.visual.AppPersonalityFeature
 import com.duckduckgo.common.ui.experiments.visual.store.VisualDesignExperimentDataStore
 import com.duckduckgo.common.ui.store.ThemingDataStore
 import com.duckduckgo.di.scopes.ViewScope
-import com.duckduckgo.feature.toggles.api.Toggle.State
 import javax.inject.Inject
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
@@ -39,7 +37,6 @@ import kotlinx.coroutines.launch
 class VisualDesignExperimentViewModel @Inject constructor(
     private val visualDesignExperimentDataStore: VisualDesignExperimentDataStore,
     private val themingDataStore: ThemingDataStore,
-    private val appPersonalityFeature: AppPersonalityFeature,
 ) : ViewModel(), DefaultLifecycleObserver {
 
     data class ViewState(
@@ -84,11 +81,5 @@ class VisualDesignExperimentViewModel @Inject constructor(
     @SuppressLint("DenyListedApi")
     fun onExperimentalUIModeChanged(checked: Boolean) {
         visualDesignExperimentDataStore.setExperimentStateUserPreference(checked)
-        if (checked) {
-            appPersonalityFeature.self().setRawStoredState(State(false))
-            appPersonalityFeature.variant1().setRawStoredState(State(false))
-            appPersonalityFeature.variant2().setRawStoredState(State(false))
-            appPersonalityFeature.variant3().setRawStoredState(State(false))
-        }
     }
 }