Tab Switcher Animation: Add pixels (#5802)

Task/Issue URL:
https://app.asana.com/0/1207908166761516/1209726015931612/f

### Description
Added tracking for the tab manager info panel with three new pixels:
- `m_tab_manager_info_panel_impressions` - Fired when the panel becomes
visible
- `m_tab_manager_info_panel_dismissed` - Fired when the panel is
dismissed, includes tracker count
- `m_tab_manager_info_panel_tapped` - Fired when the panel is tapped

Implemented visibility detection for the tracker animation info panel in
the tab switcher to accurately track impressions.

### Steps to test this PR

Pre-requisite: Enable `tabSwitcherAnimation` feature flag

_m_tab_manager_info_panel_impressions_
- [x] Start with no tabs
- [x] Open the TabSwitcher
- [x] Verify `m_tab_manager_info_panel_impressions` fires
- [x] Add many tabs (use developer settings to easily add 100)
- [x] Ensure that the active tab is one where you cannot see the
animated info panel
- [x] Close the TabSwitcher
- [x] Open the TabSwitcher
- [x] Ensure that `m_tab_manager_info_panel_impressions` is **not**
fired
- [x] Scroll up slowly to the animated tile until the bottom of the info
panel is barely visible
- [x] Ensure that `m_tab_manager_info_panel_impressions` is **not**
fired
- [x] Scroll up until ~75% of the tile is visible
- [x] Ensure that `m_tab_manager_info_panel_impressions` **is** fired
- [x] Scroll away from the InfoPanel until it is not visible
- [x] Scroll back to the InfoPanel 
- [x] Ensure that `m_tab_manager_info_panel_impressions` **is** fired
- [x] Scroll away from the InfoPanel until it is not visible
- [x] Switch layouts
- [x] Ensure that `m_tab_manager_info_panel_impressions` is **not**
fired

_m_tab_manager_info_panel_tapped_
- [x] Open the TabSwitcher
- [x] Tap on the panel and verify the tapped pixel is fired

_m_tab_manager_info_panel_dismissed_
- [x] Dismiss the panel and verify the dismissed pixel is fired with
tracker count

### UI changes
N/A

Author: mikescamell

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

@@ -407,4 +407,8 @@ enum class AppPixelName(override val pixelName: String) : Pixel.PixelName {
     SET_AS_DEFAULT_IN_MENU_CLICK("m_set-as-default_in-menu_click"),
 
     MALICIOUS_SITE_DETECTED_IN_IFRAME("m_malicious-site-protection_iframe-loaded"),
+
+    TAB_MANAGER_INFO_PANEL_IMPRESSIONS("m_tab_manager_info_panel_impressions"),
+    TAB_MANAGER_INFO_PANEL_DISMISSED("m_tab_manager_info_panel_dismissed"),
+    TAB_MANAGER_INFO_PANEL_TAPPED("m_tab_manager_info_panel_tapped"),
 }

app/src/main/java/com/duckduckgo/app/tabs/ui/TabSwitcherActivity.kt

@@ -33,6 +33,7 @@ import androidx.recyclerview.widget.GridLayoutManager.SpanSizeLookup
 import androidx.recyclerview.widget.ItemTouchHelper
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
+import androidx.recyclerview.widget.RecyclerView.OnScrollListener
 import com.duckduckgo.anvil.annotations.InjectWith
 import com.duckduckgo.app.browser.R
 import com.duckduckgo.app.browser.favicon.FaviconManager
@@ -73,6 +74,7 @@ import com.google.android.material.snackbar.BaseTransientBottomBar
 import com.google.android.material.snackbar.Snackbar
 import javax.inject.Inject
 import kotlin.coroutines.CoroutineContext
+import kotlin.math.max
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.flow.filterNotNull
@@ -143,6 +145,17 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
         )
     }
 
+    private val onScrolledListener = object : OnScrollListener() {
+        override fun onScrolled(
+            recyclerView: RecyclerView,
+            dx: Int,
+            dy: Int,
+        ) {
+            super.onScrolled(recyclerView, dx, dy)
+            checkTrackerAnimationPanelVisibility()
+        }
+    }
+
     // we need to scroll to show selected tab, but only if it is the first time loading the tabs.
     private var firstTimeLoadingTabsList = true
 
@@ -158,6 +171,8 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
 
     private var tabSwitcherAnimationTileRemovalDialog: DaxAlertDialog? = null
 
+    private var isTrackerAnimationPanelVisible = false
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_tab_switcher)
@@ -216,6 +231,37 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
         tabsRecycler.setHasFixedSize(true)
     }
 
+    private fun checkTrackerAnimationPanelVisibility() {
+        if (!tabSwitcherAnimationFeature.self().isEnabled()) {
+            return
+        }
+
+        val layoutManager = tabsRecycler.layoutManager as? LinearLayoutManager ?: return
+        val firstVisible = layoutManager.findFirstVisibleItemPosition()
+        val isPanelCurrentlyVisible = firstVisible == 0 && tabsAdapter.getTabSwitcherItem(0) is TrackerAnimationInfoPanel
+
+        if (!isPanelCurrentlyVisible) {
+            isTrackerAnimationPanelVisible = false
+            return
+        }
+
+        val viewHolder = tabsRecycler.findViewHolderForAdapterPosition(0) ?: return
+        val itemView = viewHolder.itemView
+
+        val itemHeight = itemView.height
+        val visibleHeight = itemHeight - max(0, -itemView.top) -
+            max(0, itemView.bottom - tabsRecycler.height)
+
+        val isEnoughVisible = visibleHeight > itemHeight * 0.75
+
+        if (isEnoughVisible && !isTrackerAnimationPanelVisible) {
+            viewModel.onTrackerAnimationInfoPanelVisible()
+            isTrackerAnimationPanelVisible = true
+        } else if (!isEnoughVisible) {
+            isTrackerAnimationPanelVisible = false
+        }
+    }
+
     private fun configureObservers() {
         viewModel.tabSwitcherItems.observe(this) { tabSwitcherItems ->
 
@@ -255,6 +301,7 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
 
     private fun updateLayoutType(layoutType: LayoutType) {
         tabsRecycler.hide()
+        tabsRecycler.removeOnScrollListener(onScrolledListener)
 
         val centerOffsetPercent = getCurrentCenterOffset()
 
@@ -276,7 +323,12 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
         tabsAdapter.onLayoutTypeChanged(layoutType)
         tabTouchHelper.onLayoutTypeChanged(layoutType)
 
-        scrollToPreviousCenterOffset(centerOffsetPercent)
+        scrollToPreviousCenterOffset(
+            centerOffsetPercent = centerOffsetPercent,
+            onScrollCompleted = {
+                tabsRecycler.addOnScrollListener(onScrolledListener)
+            },
+        )
 
         tabsRecycler.show()
     }
@@ -298,12 +350,18 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
         }
     }
 
-    private fun scrollToPreviousCenterOffset(centerOffsetPercent: Float) {
+    private fun scrollToPreviousCenterOffset(
+        centerOffsetPercent: Float,
+        onScrollCompleted: () -> Unit = {},
+    ) {
         tabsRecycler.post {
             val newRange = tabsRecycler.computeVerticalScrollRange()
             val newExtent = tabsRecycler.computeVerticalScrollExtent()
             val newOffset = (centerOffsetPercent * newRange - newExtent / 2).toInt()
             (tabsRecycler.layoutManager as? LinearLayoutManager)?.scrollToPositionWithOffset(0, -newOffset)
+            tabsRecycler.post {
+                onScrollCompleted()
+            }
         }
     }
 
@@ -456,14 +514,14 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
                         )
                     }
                 }
-                is TabSwitcherItem.TrackerAnimationInfoPanel -> Unit // TODO delete from list
+                is TrackerAnimationInfoPanel -> Unit
             }
         }
     }
 
     override fun onTabMoved(from: Int, to: Int) {
         if (tabSwitcherAnimationFeature.self().isEnabled()) {
-            val isTrackerAnimationInfoPanelVisible = viewModel.tabSwitcherItems.value?.get(0) is TabSwitcherItem.TrackerAnimationInfoPanel
+            val isTrackerAnimationInfoPanelVisible = viewModel.tabSwitcherItems.value?.get(0) is TrackerAnimationInfoPanel
             val canSwapFromIndex = if (isTrackerAnimationInfoPanelVisible) 1 else 0
             val tabSwitcherItemCount = viewModel.tabSwitcherItems.value?.count() ?: 0
 

app/src/main/java/com/duckduckgo/app/tabs/ui/TabSwitcherViewModel.kt

@@ -28,6 +28,8 @@ import com.duckduckgo.anvil.annotations.ContributesViewModel
 import com.duckduckgo.app.browser.SwipingTabsFeatureProvider
 import com.duckduckgo.app.browser.session.WebViewSessionStorage
 import com.duckduckgo.app.pixels.AppPixelName
+import com.duckduckgo.app.pixels.AppPixelName.TAB_MANAGER_INFO_PANEL_DISMISSED
+import com.duckduckgo.app.pixels.AppPixelName.TAB_MANAGER_INFO_PANEL_TAPPED
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.app.statistics.pixels.Pixel.PixelType.Daily
 import com.duckduckgo.app.tabs.TabSwitcherAnimationFeature
@@ -240,6 +242,7 @@ class TabSwitcherViewModel @Inject constructor(
     }
 
     fun onTrackerAnimationInfoPanelClicked() {
+        pixel.fire(TAB_MANAGER_INFO_PANEL_TAPPED)
         command.value = ShowAnimatedTileDismissalDialog
     }
 
@@ -252,9 +255,15 @@ class TabSwitcherViewModel @Inject constructor(
     fun onTrackerAnimationTileNegativeButtonClicked() {
         viewModelScope.launch {
             tabSwitcherDataStore.setIsAnimationTileDismissed(isDismissed = true)
+            val trackerCount = webTrackersBlockedAppRepository.getTrackerCountForLast7Days()
+            pixel.fire(pixel = TAB_MANAGER_INFO_PANEL_DISMISSED, parameters = mapOf("trackerCount" to trackerCount.toString()))
         }
     }
 
+    fun onTrackerAnimationInfoPanelVisible() {
+        pixel.fire(pixel = AppPixelName.TAB_MANAGER_INFO_PANEL_IMPRESSIONS)
+    }
+
     private suspend fun LiveDataScope<List<TabSwitcherItem>>.collectTabItemsWithOptionalAnimationTile(
         tabEntities: List<TabEntity>,
     ) {

app/src/test/java/com/duckduckgo/app/tabs/ui/TabSwitcherViewModelTest.kt

@@ -490,7 +490,7 @@ class TabSwitcherViewModelTest {
     }
 
     @Test
-    fun `when Animation Tile Visible then Tab Switcher Items Include Animation Tile And Tabs`() = runTest {
+    fun `when animated info panel then tab switcher items include animation tile and tabs`() = runTest {
         tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
 
         val tab1 = TabEntity("1", position = 1)
@@ -511,7 +511,7 @@ class TabSwitcherViewModelTest {
     }
 
     @Test
-    fun `when Animation Tile Not Visible then Tab Switcher Items Contain Only Tabs`() = runTest {
+    fun `when animated info panel not visible then tab switcher items contain only tabs`() = runTest {
         tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
 
         val tab1 = TabEntity("1", position = 1)
@@ -531,7 +531,7 @@ class TabSwitcherViewModelTest {
     }
 
     @Test
-    fun `when Tab Switcher Animation Feature disabled then Tab Switcher Items Contain Only Tabs`() = runTest {
+    fun `when tab switcher animation feature disabled then tab switcher items contain only tabs`() = runTest {
         initializeViewModel(FakeTabSwitcherDataStore())
         tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = false))
         whenever(mockTabSwitcherPrefsDataStore.isAnimationTileDismissed()).thenReturn(flowOf(true))
@@ -549,7 +549,7 @@ class TabSwitcherViewModelTest {
     }
 
     @Test
-    fun `when Animation Tile positive button clicked then Animation Tile is still visible`() = runTest {
+    fun `when animated info panel positive button clicked then animated info panel is still visible`() = runTest {
         initializeViewModel(FakeTabSwitcherDataStore())
         whenever(mockWebTrackersBlockedAppRepository.getTrackerCountForLast7Days()).thenReturn(15)
 
@@ -567,7 +567,7 @@ class TabSwitcherViewModelTest {
     }
 
     @Test
-    fun `when Animation Tile positive button clicked then Animation Tile is removed`() = runTest {
+    fun `when animated info panel negative button clicked then animated info panel is removed`() = runTest {
         initializeViewModel(FakeTabSwitcherDataStore())
 
         tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
@@ -585,6 +585,39 @@ class TabSwitcherViewModelTest {
         assertFalse(items.first() is TabSwitcherItem.TrackerAnimationInfoPanel)
     }
 
+    @Test
+    fun `when animated info panel visible then impressions pixel fired`() = runTest {
+        initializeViewModel(FakeTabSwitcherDataStore())
+        tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
+        whenever(mockWebTrackersBlockedAppRepository.getTrackerCountForLast7Days()).thenReturn(15)
+
+        testee.onTrackerAnimationInfoPanelVisible()
+
+        verify(mockPixel).fire(AppPixelName.TAB_MANAGER_INFO_PANEL_IMPRESSIONS)
+    }
+
+    @Test
+    fun `when animated info panel clicked then tapped pixel fired`() = runTest {
+        initializeViewModel(FakeTabSwitcherDataStore())
+        tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
+        whenever(mockWebTrackersBlockedAppRepository.getTrackerCountForLast7Days()).thenReturn(15)
+
+        testee.onTrackerAnimationInfoPanelClicked()
+
+        verify(mockPixel).fire(AppPixelName.TAB_MANAGER_INFO_PANEL_TAPPED)
+    }
+
+    @Test
+    fun `when animated info panel negative button clicked then dismiss pixel fired`() = runTest {
+        initializeViewModel(FakeTabSwitcherDataStore())
+        tabSwitcherAnimationFeature.self().setRawStoredState(State(enable = true))
+        whenever(mockWebTrackersBlockedAppRepository.getTrackerCountForLast7Days()).thenReturn(15)
+
+        testee.onTrackerAnimationTileNegativeButtonClicked()
+
+        verify(mockPixel).fire(pixel = AppPixelName.TAB_MANAGER_INFO_PANEL_DISMISSED, parameters = mapOf("trackerCount" to "15"))
+    }
+
     private class FakeTabSwitcherDataStore : TabSwitcherDataStore {
 
         private val animationTileDismissedFlow = MutableStateFlow(false)