Add user toggle to control tracker animation

Author: aibrahim-

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

@@ -4256,6 +4256,45 @@ class BrowserTabViewModelTest {
         assertFalse(loadingViewState().trackersAnimationEnabled)
     }
 
+    @Test
+    fun whenUserPreferenceDisabledThenTrackersAnimationDisabled() {
+        whenever(mockSettingsDataStore.showTrackersCountInAddressBar).thenReturn(false)
+        loadUrl("https://example.com")
+        assertFalse(loadingViewState().trackersAnimationEnabled)
+    }
+
+    @Test
+    fun whenUserPreferenceEnabledAndPrivacyProtectionActiveThenTrackersAnimationEnabled() {
+        whenever(mockSettingsDataStore.showTrackersCountInAddressBar).thenReturn(true)
+        whenever(mockContentBlocking.isAnException("example.com")).thenReturn(false)
+        loadUrl("https://example.com")
+        assertTrue(loadingViewState().trackersAnimationEnabled)
+    }
+
+    @Test
+    fun whenUserPreferenceDisabledEvenWithPrivacyProtectionActiveThenTrackersAnimationDisabled() {
+        whenever(mockSettingsDataStore.showTrackersCountInAddressBar).thenReturn(false)
+        whenever(mockContentBlocking.isAnException("example.com")).thenReturn(false)
+        loadUrl("https://example.com")
+        assertFalse(loadingViewState().trackersAnimationEnabled)
+    }
+
+    @Test
+    fun whenUserPreferenceEnabledButPrivacyProtectionDisabledThenTrackersAnimationDisabled() {
+        whenever(mockSettingsDataStore.showTrackersCountInAddressBar).thenReturn(true)
+        whenever(mockContentBlocking.isAnException("example.com")).thenReturn(true)
+        loadUrl("https://example.com")
+        assertFalse(loadingViewState().trackersAnimationEnabled)
+    }
+
+    @Test
+    fun whenUserPreferenceDisabledAndPrivacyProtectionDisabledThenTrackersAnimationDisabled() {
+        whenever(mockSettingsDataStore.showTrackersCountInAddressBar).thenReturn(false)
+        whenever(mockContentBlocking.isAnException("example.com")).thenReturn(true)
+        loadUrl("https://example.com")
+        assertFalse(loadingViewState().trackersAnimationEnabled)
+    }
+
     @Test
     fun whenEditBookmarkRequestedThenRepositoryIsNotUpdated() =
         runTest {

app/src/main/java/com/duckduckgo/app/appearance/AppearanceActivity.kt

@@ -100,6 +100,11 @@ class AppearanceActivity : DuckDuckGoActivity() {
             viewModel.onShowTrackersCountInTabSwitcherChanged(isChecked)
         }
 
+    private val showTrackersCountInAddressBar =
+        CompoundButton.OnCheckedChangeListener { _, isChecked ->
+            viewModel.onShowTrackersCountInAddressBarChanged(isChecked)
+        }
+
     private val changeIconFlow =
         registerForActivityResult(ChangeIconContract()) { resultOk ->
             if (resultOk) {
@@ -173,6 +178,12 @@ class AppearanceActivity : DuckDuckGoActivity() {
                         viewState.isTrackersCountInTabSwitcherEnabled,
                         showTrackersCountInTabSwitcher,
                     )
+                    binding.showTrackersCountInAddressBar.isVisible = viewState.shouldShowTrackersCountInAddressBar
+                    binding.trackersCountInAddressBarDivider.isVisible = viewState.shouldShowTrackersCountInAddressBar
+                    binding.showTrackersCountInAddressBar.quietlySetIsChecked(
+                        viewState.isTrackersCountInAddressBarEnabled,
+                        showTrackersCountInAddressBar,
+                    )
                     configureOmnibarSettings(it)
                 }
             }.launchIn(lifecycleScope)

app/src/main/java/com/duckduckgo/app/appearance/AppearanceViewModel.kt

@@ -20,6 +20,7 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import androidx.webkit.WebViewFeature
 import com.duckduckgo.anvil.annotations.ContributesViewModel
+import com.duckduckgo.app.browser.animations.AddressBarTrackersAnimationManager
 import com.duckduckgo.app.browser.api.OmnibarRepository
 import com.duckduckgo.app.browser.omnibar.OmnibarType
 import com.duckduckgo.app.browser.urldisplay.UrlDisplayRepository
@@ -58,6 +59,7 @@ class AppearanceViewModel @Inject constructor(
     private val pixel: Pixel,
     private val dispatcherProvider: DispatcherProvider,
     private val tabSwitcherDataStore: TabSwitcherDataStore,
+    private val addressBarTrackersAnimationManager: AddressBarTrackersAnimationManager,
     omnibarRepository: OmnibarRepository,
 ) : ViewModel() {
     data class ViewState(
@@ -69,6 +71,8 @@ class AppearanceViewModel @Inject constructor(
         val omnibarType: OmnibarType = OmnibarType.SINGLE_TOP,
         val isFullUrlEnabled: Boolean = true,
         val isTrackersCountInTabSwitcherEnabled: Boolean = true,
+        val isTrackersCountInAddressBarEnabled: Boolean = true,
+        val shouldShowTrackersCountInAddressBar: Boolean = false,
         val shouldShowSplitOmnibarSettings: Boolean = false,
     )
 
@@ -95,6 +99,7 @@ class AppearanceViewModel @Inject constructor(
             supportsForceDarkMode = WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING),
             omnibarType = settingsDataStore.omnibarType,
             shouldShowSplitOmnibarSettings = omnibarRepository.isSplitOmnibarAvailable,
+            isTrackersCountInAddressBarEnabled = settingsDataStore.showTrackersCountInAddressBar,
         ),
     )
 
@@ -103,9 +108,11 @@ class AppearanceViewModel @Inject constructor(
         urlDisplayRepository.isFullUrlEnabled,
         tabSwitcherDataStore.isTrackersAnimationInfoTileHidden(),
     ) { currentViewState, isFullUrlEnabled, isTrackersAnimationTileHidden ->
+        val isFeatureEnabled = addressBarTrackersAnimationManager.isFeatureEnabled()
         currentViewState.copy(
             isTrackersCountInTabSwitcherEnabled = !isTrackersAnimationTileHidden,
             isFullUrlEnabled = isFullUrlEnabled,
+            shouldShowTrackersCountInAddressBar = isFeatureEnabled,
         )
     }.stateIn(viewModelScope, SharingStarted.Lazily, viewState.value)
 
@@ -194,4 +201,14 @@ class AppearanceViewModel @Inject constructor(
             pixel.fire(AppPixelName.SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_TAB_SWITCHER_TOGGLED, params)
         }
     }
+
+    fun onShowTrackersCountInAddressBarChanged(checked: Boolean) {
+        viewModelScope.launch(dispatcherProvider.io()) {
+            settingsDataStore.showTrackersCountInAddressBar = checked
+            viewState.update { it.copy(isTrackersCountInAddressBarEnabled = checked) }
+
+            val params = mapOf(Pixel.PixelParameter.IS_ENABLED to checked.toString())
+            pixel.fire(AppPixelName.SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_ADDRESS_BAR_TOGGLED, params)
+        }
+    }
 }

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

@@ -1753,7 +1753,8 @@ class BrowserTabViewModel @Inject constructor(
         withContext(dispatchers.main()) {
             loadingViewState.value =
                 currentLoadingViewState().copy(
-                    trackersAnimationEnabled = !(privacyProtectionDisabled || currentBrowserViewState().maliciousSiteBlocked),
+                    trackersAnimationEnabled = !(privacyProtectionDisabled || currentBrowserViewState().maliciousSiteBlocked)
+                        && settingsDataStore.showTrackersCountInAddressBar,
                     url = site?.url ?: "",
                 )
         }
@@ -2151,7 +2152,7 @@ class BrowserTabViewModel @Inject constructor(
                 loadingViewState.value =
                     currentLoadingViewState().copy(
                         isLoading = true,
-                        trackersAnimationEnabled = true,
+                        trackersAnimationEnabled = settingsDataStore.showTrackersCountInAddressBar,
                         /*We set the progress to 20 so the omnibar starts animating and the user knows we are loading the page.
                          * We don't show the browser until the page actually starts loading, to prevent previous sites from briefly
                          * showing in case the URL was blocked locally and therefore never started to show*/

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

@@ -903,7 +903,7 @@ class OmnibarLayoutViewModel @Inject constructor(
                                 Command.StartTrackersAnimation(
                                     entities = decoration.entities,
                                     isCustomTab = viewState.value.viewMode is CustomTab,
-                                    isAddressBarTrackersAnimationEnabled = addressBarTrackersAnimationManager.isFeatureEnabled(),
+                                    isAddressBarTrackersAnimationEnabled = viewState.value.isAddressBarTrackersAnimationEnabled,
                                 ),
                             )
                         }

app/src/main/java/com/duckduckgo/app/global/api/PixelParamRemovalInterceptor.kt

@@ -127,6 +127,7 @@ object PixelInterceptorPixelsRequiringDataCleaning : PixelParamRemovalPlugin {
             AppPixelName.SEARCH_WIDGET_ADDED.pixelName to PixelParameter.removeAtb(),
             AppPixelName.SEARCH_WIDGET_DELETED.pixelName to PixelParameter.removeAtb(),
             AppPixelName.SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_TAB_SWITCHER_TOGGLED.pixelName to PixelParameter.removeAll(),
+            AppPixelName.SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_ADDRESS_BAR_TOGGLED.pixelName to PixelParameter.removeAll(),
             AppPixelName.TIMEOUT_WAITING_FOR_APP_REFERRER.pixelName to PixelParameter.removeAtb(),
             AppPixelName.PRODUCT_TELEMETRY_SURFACE_LANDSCAPE_ORIENTATION_USED.pixelName to PixelParameter.removeAtb(),
             AppPixelName.PRODUCT_TELEMETRY_SURFACE_LANDSCAPE_ORIENTATION_USED_DAILY.pixelName to PixelParameter.removeAtb(),

app/src/main/java/com/duckduckgo/app/pixels/AppPixelName.kt

@@ -143,6 +143,7 @@ enum class AppPixelName(override val pixelName: String) : Pixel.PixelName {
     SETTINGS_APPEARANCE_IS_FULL_URL_OPTION_TOGGLED("m_appearance_settings_is_full_url_option_toggled"),
     APPEARANCE_SETTINGS_IS_FULL_URL_ENABLED_DAILY("m_appearance_settings_is_full_url_enabled_daily"),
     SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_TAB_SWITCHER_TOGGLED("m_appearance_settings_is_tracker_count_in_tab_switcher_toggled"),
+    SETTINGS_APPEARANCE_IS_TRACKER_COUNT_IN_ADDRESS_BAR_TOGGLED("m_appearance_settings_is_tracker_count_in_address_bar_toggled"),
     SETTINGS_APP_ICON_PRESSED("ms_app_icon_setting_pressed"),
     SETTINGS_ADDRESS_BAR_POSITION_PRESSED("ms_address_bar_position_setting_pressed"),
     SETTINGS_ADDRESS_BAR_POSITION_SELECTED_TOP("ms_address_bar_position_setting_selected_top"),

app/src/main/java/com/duckduckgo/app/settings/db/SettingsDataStore.kt

@@ -105,6 +105,7 @@ interface SettingsDataStore {
      */
     var urlPreferenceSetByUser: Boolean
     var clearDuckAiData: Boolean
+    var showTrackersCountInAddressBar: Boolean
 
     /**
      * Check if a value has been set to the URL display preference.
@@ -267,6 +268,10 @@ class SettingsSharedPreferences @Inject constructor(
         get() = preferences.getBoolean(KEY_CLEAR_DUCK_AI_DATA, false)
         set(enabled) = preferences.edit { putBoolean(KEY_CLEAR_DUCK_AI_DATA, enabled) }
 
+    override var showTrackersCountInAddressBar: Boolean
+        get() = preferences.getBoolean(KEY_SHOW_TRACKERS_COUNT_IN_ADDRESS_BAR, true)
+        set(enabled) = preferences.edit { putBoolean(KEY_SHOW_TRACKERS_COUNT_IN_ADDRESS_BAR, enabled) }
+
     override fun hasBackgroundTimestampRecorded(): Boolean = preferences.contains(KEY_APP_BACKGROUNDED_TIMESTAMP)
 
     override fun clearAppBackgroundTimestamp() = preferences.edit { remove(KEY_APP_BACKGROUNDED_TIMESTAMP) }
@@ -345,6 +350,7 @@ class SettingsSharedPreferences @Inject constructor(
         const val URL_PREFERENCE_MIGRATED = "URL_PREFERENCE_MIGRATED"
         const val URL_PREFERENCE_SET_BY_USER = "URL_PREFERENCE_SET_BY_USER"
         const val KEY_CLEAR_DUCK_AI_DATA = "KEY_CLEAR_DUCK_AI_DATA"
+        const val KEY_SHOW_TRACKERS_COUNT_IN_ADDRESS_BAR = "KEY_SHOW_TRACKERS_COUNT_IN_ADDRESS_BAR"
     }
 
     private class FireAnimationPrefsMapper {

app/src/main/res/layout/activity_appearance.xml

@@ -274,6 +274,20 @@
                 app:primaryTextTruncated="false"
                 app:showSwitch="true" />
 
+            <com.duckduckgo.common.ui.view.divider.HorizontalDivider
+                android:id="@+id/trackersCountInAddressBarDivider"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                android:paddingBottom="0dp" />
+
+            <com.duckduckgo.common.ui.view.listitem.OneLineListItem
+                android:id="@+id/showTrackersCountInAddressBar"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                app:primaryText="@string/showTrackerCountInAddressBar"
+                app:primaryTextTruncated="false"
+                app:showSwitch="true" />
+
             <com.duckduckgo.common.ui.view.divider.HorizontalDivider
                 android:id="@+id/trackersAnimationSettingDivider"
                 android:layout_width="match_parent"

app/src/main/res/values/strings.xml

@@ -893,6 +893,7 @@
 
     <!--TabSwitcher Trackers Animation-->
     <string name="showTrackerCountInTabSwitcher">Show Tracker Count in Tab Switcher</string>
+    <string name="showTrackerCountInAddressBar">Show Trackers Blocked Animation </string>
     <string name="tabSwitcherAnimationTileRemovalDialogTitle" instruction="A title for a dialog that shows when a user clicks a tile that shows them their current blocked tracker count">Hide tracker count?</string>
     <string name="tabSwitcherAnimationTileRemovalDialogBody" instruction="A message for a dialog that shows when a user clicks a tile that shows them their current blocked tracker count">You can turn this back on in Settings > Appearance.</string>
     <string name="tabSwitcherAnimationTileRemovalDialogPositiveButton">Hide</string>