Add address bar trackers animation

app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt

@@ -65,12 +65,14 @@ import com.duckduckgo.app.browser.WebViewErrorResponse.BAD_URL
 import com.duckduckgo.app.browser.WebViewErrorResponse.LOADING
 import com.duckduckgo.app.browser.WebViewErrorResponse.OMITTED
 import com.duckduckgo.app.browser.addtohome.AddToHomeCapabilityDetector
+import com.duckduckgo.app.browser.animations.AddressBarTrackersAnimationFeatureToggle
 import com.duckduckgo.app.browser.applinks.AppLinksHandler
 import com.duckduckgo.app.browser.camera.CameraHardwareChecker
 import com.duckduckgo.app.browser.certificates.BypassedSSLCertificatesRepository
 import com.duckduckgo.app.browser.certificates.remoteconfig.SSLCertificatesFeature
 import com.duckduckgo.app.browser.commands.Command
 import com.duckduckgo.app.browser.commands.Command.CloseCustomTab
+import com.duckduckgo.app.browser.commands.Command.EnqueueCookiesAnimation
 import com.duckduckgo.app.browser.commands.Command.EscapeMaliciousSite
 import com.duckduckgo.app.browser.commands.Command.HideBrokenSitePromptCta
 import com.duckduckgo.app.browser.commands.Command.HideOnboardingDaxBubbleCta
@@ -596,6 +598,7 @@ class BrowserTabViewModelTest {
 
     private val mockOnboardingDesignExperimentManager: OnboardingDesignExperimentManager = mock()
     private val mockSerpEasterEggLogoToggles: SerpEasterEggLogosToggles = mock()
+    private val mockAddressBarTrackersAnimationFeatureToggle: AddressBarTrackersAnimationFeatureToggle = mock()
 
     private val nonHttpAppLinkChecker: NonHttpAppLinkChecker = mock()
 
@@ -689,6 +692,7 @@ class BrowserTabViewModelTest {
             whenever(mockSerpEasterEggLogoToggles.feature()).thenReturn(mockDisabledToggle)
             whenever(nonHttpAppLinkChecker.isPermitted(anyOrNull())).thenReturn(true)
             remoteMessagingModel = givenRemoteMessagingModel(mockRemoteMessagingRepository, mockPixel, coroutineRule.testDispatcherProvider)
+            whenever(mockAddressBarTrackersAnimationFeatureToggle.feature()).thenReturn(mockDisabledToggle)
 
             ctaViewModel =
                 CtaViewModel(
@@ -842,6 +846,7 @@ class BrowserTabViewModelTest {
                     addDocumentStartJavascriptPlugins = fakeAddDocumentStartJavaScriptPlugins,
                     webMessagingPlugins = fakeMessagingPlugins,
                     postMessageWrapperPlugins = fakePostMessageWrapperPlugins,
+                    addressBarTrackersAnimationFeatureToggle = mockAddressBarTrackersAnimationFeatureToggle,
                 )
 
             testee.loadData("abc", null, false, false)
@@ -6435,6 +6440,64 @@ class BrowserTabViewModelTest {
         assertCommandIssued<ShowAutoconsentAnimation>()
     }
 
+    @Test
+    fun whenAutoConsentPopupHandledWithFeatureToggleEnabledAndTrackersBlockedThenEnqueueCookiesAnimation() {
+        whenever(mockAddressBarTrackersAnimationFeatureToggle.feature()).thenReturn(mockEnabledToggle)
+
+        testee.browserViewState.value =
+            testee.browserViewState.value?.copy(
+                browserShowing = true,
+                maliciousSiteBlocked = false,
+                maliciousSiteStatus = null,
+            )
+
+        val site = givenCurrentSite("https://example.com")
+        whenever(site.trackerCount).thenReturn(5)
+        testee.siteLiveData.value = site
+
+        testee.onAutoConsentPopUpHandled(true)
+
+        assertCommandIssued<EnqueueCookiesAnimation> {
+            assertTrue(isCosmetic)
+        }
+    }
+
+    @Test
+    fun whenAutoConsentPopupHandledWithFeatureToggleDisabledThenShowAutoconsentAnimation() {
+        whenever(mockAddressBarTrackersAnimationFeatureToggle.feature()).thenReturn(mockDisabledToggle)
+
+        testee.browserViewState.value =
+            testee.browserViewState.value?.copy(
+                browserShowing = true,
+                maliciousSiteBlocked = false,
+                maliciousSiteStatus = null,
+            )
+
+        testee.onAutoConsentPopUpHandled(true)
+
+        assertCommandIssued<ShowAutoconsentAnimation>()
+    }
+
+    @Test
+    fun whenAutoConsentPopupHandledWithFeatureToggleEnabledButNoTrackersThenShowAutoconsentAnimation() {
+        whenever(mockAddressBarTrackersAnimationFeatureToggle.feature()).thenReturn(mockEnabledToggle)
+
+        testee.browserViewState.value =
+            testee.browserViewState.value?.copy(
+                browserShowing = true,
+                maliciousSiteBlocked = false,
+                maliciousSiteStatus = null,
+            )
+
+        val site = givenCurrentSite("https://example.com")
+        whenever(site.trackerCount).thenReturn(0)
+        testee.siteLiveData.value = site
+
+        testee.onAutoConsentPopUpHandled(true)
+
+        assertCommandIssued<ShowAutoconsentAnimation>()
+    }
+
     @Test
     fun whenVisitSiteThenUpdateLoadingViewStateAndOmnibarViewState() {
         testee.browserViewState.value =

app/src/androidTest/java/com/duckduckgo/app/browser/omnibar/animations/LottiePrivacyShieldAnimationHelperTest.kt

@@ -19,11 +19,15 @@ package com.duckduckgo.app.browser.omnibar.animations
 import android.annotation.SuppressLint
 import com.airbnb.lottie.LottieAnimationView
 import com.duckduckgo.app.browser.R
+import com.duckduckgo.app.browser.animations.AddressBarTrackersAnimationFeatureToggle
 import com.duckduckgo.app.browser.omnibar.Omnibar
+import com.duckduckgo.app.browser.omnibar.animations.addressbar.LottiePrivacyShieldAnimationHelper
 import com.duckduckgo.app.global.model.PrivacyShield.MALICIOUS
 import com.duckduckgo.app.global.model.PrivacyShield.PROTECTED
 import com.duckduckgo.app.global.model.PrivacyShield.UNPROTECTED
 import com.duckduckgo.common.ui.store.AppTheme
+import com.duckduckgo.feature.toggles.api.FakeFeatureToggleFactory
+import com.duckduckgo.feature.toggles.api.Toggle
 import kotlinx.coroutines.test.runTest
 import org.junit.Test
 import org.mockito.kotlin.mock
@@ -34,13 +38,14 @@ class LottiePrivacyShieldAnimationHelperTest {
 
     private val browserViewMode = Omnibar.ViewMode.Browser("cnn.com")
     private val customTabViewMode = Omnibar.ViewMode.CustomTab(0, "cnn.com", "cnn.com")
+    private val fakeAddressBarTrackersAnimationFeatureToggle = FakeFeatureToggleFactory.create(AddressBarTrackersAnimationFeatureToggle::class.java)
 
     @Test
     fun whenLightModeAndPrivacyShieldProtectedThenSetLightShieldAnimation() = runTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, browserViewMode)
 
@@ -52,7 +57,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, browserViewMode)
 
@@ -64,7 +69,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, UNPROTECTED, browserViewMode)
 
@@ -77,7 +82,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, UNPROTECTED, browserViewMode)
 
@@ -90,7 +95,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, MALICIOUS, browserViewMode)
 
@@ -103,7 +108,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val holder: LottieAnimationView = mock()
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, MALICIOUS, browserViewMode)
 
@@ -118,7 +123,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, customTabViewMode)
 
@@ -132,7 +137,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, customTabViewMode)
 
@@ -146,7 +151,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, UNPROTECTED, customTabViewMode)
 
@@ -160,7 +165,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, UNPROTECTED, customTabViewMode)
 
@@ -174,7 +179,7 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(true)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, customTabViewMode)
 
@@ -188,10 +193,40 @@ class LottiePrivacyShieldAnimationHelperTest {
         val appTheme: AppTheme = mock()
         whenever(appTheme.isLightModeEnabled()).thenReturn(false)
 
-        val testee = LottiePrivacyShieldAnimationHelper(appTheme)
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
 
         testee.setAnimationView(holder, PROTECTED, customTabViewMode)
 
         verify(holder).setAnimation(R.raw.dark_protected_shield_custom_tab)
     }
+
+    @SuppressLint("DenyListedApi")
+    @Test
+    fun whenLightModeAndAddressBarTrackersAnimationFeatureToggleIsOnThenUseAddressBarTrackersAnimationShieldVariant() = runTest {
+        val holder: LottieAnimationView = mock()
+        val appTheme: AppTheme = mock()
+        fakeAddressBarTrackersAnimationFeatureToggle.feature().setRawStoredState(Toggle.State(true))
+        whenever(appTheme.isLightModeEnabled()).thenReturn(true)
+
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
+
+        testee.setAnimationView(holder, PROTECTED, browserViewMode)
+
+        verify(holder).setAnimation(R.raw.address_bar_trackers_animation_shield)
+    }
+
+    @SuppressLint("DenyListedApi")
+    @Test
+    fun whenDarkModeAndAddressBarTrackersAnimationFeatureToggleIsOnThenUseAddressBarTrackersAnimationShieldVariant() = runTest {
+        val holder: LottieAnimationView = mock()
+        val appTheme: AppTheme = mock()
+        fakeAddressBarTrackersAnimationFeatureToggle.feature().setRawStoredState(Toggle.State(true))
+        whenever(appTheme.isLightModeEnabled()).thenReturn(false)
+
+        val testee = LottiePrivacyShieldAnimationHelper(appTheme, fakeAddressBarTrackersAnimationFeatureToggle)
+
+        testee.setAnimationView(holder, PROTECTED, browserViewMode)
+
+        verify(holder).setAnimation(R.raw.address_bar_trackers_animation_shield)
+    }
 }

app/src/androidTest/java/com/duckduckgo/app/browser/omnibar/animations/TrackersRendererTest.kt

@@ -18,6 +18,7 @@ package com.duckduckgo.app.browser.omnibar.animations
 
 import androidx.test.platform.app.InstrumentationRegistry
 import com.duckduckgo.app.browser.R
+import com.duckduckgo.app.browser.omnibar.animations.addressbar.TrackersRenderer
 import org.junit.Assert.assertEquals
 import org.junit.Test
 

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

@@ -742,21 +742,7 @@ class BrowserTabFragment :
             override fun onFirstPopUpHandled() {}
 
             override fun onPopUpHandled(isCosmetic: Boolean) {
-                launch {
-                    context?.let {
-                    /* TODO uncomment when sense of protection experiment shield is enabled
-                     if (senseOfProtectionExperiment.isUserEnrolledInAVariantAndExperimentEnabled() &&
-                        viewModel.trackersCount().isNotEmpty()
-                    ) {
-                        if (isCosmetic) {
-                            delay(COOKIES_ANIMATION_DELAY)
-                        }
-                        omnibar.enqueueCookiesAnimation(isCosmetic)
-                    } else {*/
-                        viewModel.onAutoConsentPopUpHandled(isCosmetic)
-                        // }
-                    }
-                }
+                viewModel.onAutoConsentPopUpHandled(isCosmetic)
             }
 
             override fun onResultReceived(
@@ -2296,6 +2282,7 @@ class BrowserTabFragment :
             }
 
             is Command.SubmitChat -> duckChat.openDuckChatWithAutoPrompt(it.query)
+            is Command.EnqueueCookiesAnimation -> enqueueCookiesAnimation(it.isCosmetic)
         }
     }
 
@@ -2323,6 +2310,17 @@ class BrowserTabFragment :
         }
     }
 
+    private fun enqueueCookiesAnimation(isCosmetic: Boolean) {
+        launch {
+            if (isCosmetic) {
+                delay(COOKIES_ANIMATION_DELAY)
+            }
+            context?.let {
+                omnibar.enqueueCookiesAnimation(isCosmetic)
+            }
+        }
+    }
+
     private fun setBrowserBackgroundRes(backgroundRes: Int) {
         newBrowserTab.browserBackground.setImageResource(backgroundRes)
     }

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

@@ -60,6 +60,7 @@ import com.duckduckgo.app.browser.SpecialUrlDetector.UrlType.ShouldLaunchPrivacy
 import com.duckduckgo.app.browser.WebViewErrorResponse.LOADING
 import com.duckduckgo.app.browser.WebViewErrorResponse.OMITTED
 import com.duckduckgo.app.browser.addtohome.AddToHomeCapabilityDetector
+import com.duckduckgo.app.browser.animations.AddressBarTrackersAnimationFeatureToggle
 import com.duckduckgo.app.browser.applinks.AppLinksHandler
 import com.duckduckgo.app.browser.camera.CameraHardwareChecker
 import com.duckduckgo.app.browser.certificates.BypassedSSLCertificatesRepository
@@ -492,6 +493,7 @@ class BrowserTabViewModel @Inject constructor(
     private val addDocumentStartJavascriptPlugins: PluginPoint<AddDocumentStartJavaScriptPlugin>,
     private val webMessagingPlugins: PluginPoint<WebMessagingPlugin>,
     private val postMessageWrapperPlugins: PluginPoint<PostMessageWrapperPlugin>,
+    private val addressBarTrackersAnimationFeatureToggle: AddressBarTrackersAnimationFeatureToggle,
 ) : ViewModel(),
     WebViewClientListener,
     EditSavedSiteListener,
@@ -4479,7 +4481,11 @@ class BrowserTabViewModel @Inject constructor(
 
     fun onAutoConsentPopUpHandled(isCosmetic: Boolean) {
         if (!currentBrowserViewState().maliciousSiteBlocked) {
-            command.postValue(ShowAutoconsentAnimation(isCosmetic))
+            if (addressBarTrackersAnimationFeatureToggle.feature().isEnabled() && trackersCount().isNotEmpty()) {
+                command.postValue(Command.EnqueueCookiesAnimation(isCosmetic))
+            } else {
+                command.postValue(ShowAutoconsentAnimation(isCosmetic))
+            }
         }
     }
 
@@ -4500,8 +4506,6 @@ class BrowserTabViewModel @Inject constructor(
         command.value = LaunchBookmarksActivity
     }
 
-    fun trackersCount(): String = site?.trackerCount?.takeIf { it > 0 }?.toString() ?: ""
-
     fun resetTrackersCount() {
         site?.resetTrackingEvents()
     }
@@ -4538,6 +4542,9 @@ class BrowserTabViewModel @Inject constructor(
         command.value = Command.ShowSerpEasterEggLogo(url)
     }
 
+    private fun trackersCount(): String =
+        siteLiveData.value?.trackerCount?.takeIf { it > 0 }?.toString() ?: ""
+
     companion object {
         private const val FIXED_PROGRESS = 50
 

app/src/main/java/com/duckduckgo/app/browser/animations/AddressBarTrackersAnimationFeatureToggle.kt

@@ -30,6 +30,7 @@ interface AddressBarTrackersAnimationFeatureToggle {
     @Toggle.DefaultValue(DefaultFeatureValue.FALSE)
     fun self(): Toggle
 
+    @Toggle.InternalAlwaysEnabled
     @Toggle.DefaultValue(DefaultFeatureValue.FALSE)
     fun feature(): Toggle
 }

app/src/main/java/com/duckduckgo/app/browser/commands/Command.kt

@@ -498,4 +498,8 @@ sealed class Command {
     data class ShowSerpEasterEggLogo(
         val logoUrl: String,
     ) : Command()
+
+    data class EnqueueCookiesAnimation(
+        val isCosmetic: Boolean,
+    ) : Command()
 }