Closes #18948: Update tabstray telemetry

mozilla-mobile · Apr 14, 2021 · 2bf13a0 · 2bf13a0
1 parent 1128f92
commit 2bf13a0
Show file tree

Hide file tree

Showing 15 changed files with 182 additions and 32 deletions.
diff --git a/app/metrics.yaml b/app/metrics.yaml
@@ -2473,6 +2473,19 @@ tabs_tray:
     notification_emails:
       - fenix-core@mozilla.com
     expires: "2021-08-01"
+  synced_mode_tapped:
+    type: event
+    description: |
+      A user switched to synced mode
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/18948
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/19004
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2022-08-01"
   new_tab_tapped:
     type: event
     description: |

diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/Event.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/Event.kt
@@ -182,6 +182,7 @@ sealed class Event {
     object ClosedExistingTab : Event()
     object TabsTrayPrivateModeTapped : Event()
     object TabsTrayNormalModeTapped : Event()
+    object TabsTraySyncedModeTapped : Event()
     object NewTabTapped : Event()
     object NewPrivateTabTapped : Event()
     object TabsTrayMenuOpened : Event()

diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/GleanMetricsService.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/GleanMetricsService.kt
@@ -671,6 +671,9 @@ private val Event.wrapper: EventWrapper<*>?
         is Event.TabsTrayNormalModeTapped -> EventWrapper<NoExtraKeys>(
             { TabsTray.normalModeTapped.record(it) }
         )
+        is Event.TabsTraySyncedModeTapped -> EventWrapper<NoExtraKeys>(
+            { TabsTray.syncedModeTapped.record(it) }
+        )
         is Event.NewTabTapped -> EventWrapper<NoExtraKeys>(
             { TabsTray.newTabTapped.record(it) }
         )

diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabLayoutMediator.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabLayoutMediator.kt
@@ -9,8 +9,11 @@ import com.google.android.material.tabs.TabLayout
 import mozilla.components.browser.state.selector.selectedTab
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.support.base.feature.LifecycleAwareFeature
+import org.mozilla.fenix.components.metrics.Event
+import org.mozilla.fenix.components.metrics.MetricController
 import org.mozilla.fenix.tabstray.TrayPagerAdapter.Companion.POSITION_NORMAL_TABS
 import org.mozilla.fenix.tabstray.TrayPagerAdapter.Companion.POSITION_PRIVATE_TABS
+import org.mozilla.fenix.utils.Do
 
 /**
  * Selected the selected pager depending on the [BrowserStore] state and synchronizes user actions
@@ -20,10 +23,11 @@ class TabLayoutMediator(
     private val tabLayout: TabLayout,
     interactor: TabsTrayInteractor,
     private val browserStore: BrowserStore,
-    trayStore: TabsTrayStore
+    trayStore: TabsTrayStore,
+    private val metrics: MetricController
 ) : LifecycleAwareFeature {
 
-    private val observer = TabLayoutObserver(interactor, trayStore)
+    private val observer = TabLayoutObserver(interactor, trayStore, metrics)
 
     /**
      * Start observing the [TabLayout] and select the current tab for initial state.
@@ -57,7 +61,8 @@ class TabLayoutMediator(
  */
 internal class TabLayoutObserver(
     private val interactor: TabsTrayInteractor,
-    private val trayStore: TabsTrayStore
+    private val trayStore: TabsTrayStore,
+    private val metrics: MetricController
 ) : TabLayout.OnTabSelectedListener {
 
     private var initialScroll = true
@@ -74,6 +79,12 @@ internal class TabLayoutObserver(
         interactor.setCurrentTrayPosition(tab.position, animate)
 
         trayStore.dispatch(TabsTrayAction.PageSelected(tab.toPage()))
+
+        Do exhaustive when (tab.toPage()) {
+            Page.NormalTabs -> metrics.track(Event.TabsTrayNormalModeTapped)
+            Page.PrivateTabs -> metrics.track(Event.TabsTrayPrivateModeTapped)
+            Page.SyncedTabs -> metrics.track(Event.TabsTraySyncedModeTapped)
+        }
     }
 
     override fun onTabUnselected(tab: TabLayout.Tab) = Unit

diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt
@@ -51,6 +51,7 @@ class DefaultTabsTrayController(
             "DefaultTabTrayController.onNewTabTapped",
             startTime
         )
+        sendNewTabEvent(isPrivate)
     }
 
     override fun onSyncStarted() {
@@ -68,4 +69,14 @@ class DefaultTabsTrayController(
             store.dispatch(TabsTrayAction.SyncCompleted)
         }
     }
+
+    private fun sendNewTabEvent(isPrivateModeSelected: Boolean) {
+        val eventToSend = if (isPrivateModeSelected) {
+            Event.NewPrivateTabTapped
+        } else {
+            Event.NewTabTapped
+        }
+
+        metrics.track(eventToSend)
+    }
 }
diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayFragment.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayFragment.kt
@@ -92,15 +92,17 @@ class TabsTrayFragment : AppCompatDialogFragment(), TabsTrayInteractor {
         super.onViewCreated(view, savedInstanceState)
         val activity = activity as HomeActivity
 
+        requireComponents.analytics.metrics.track(Event.TabsTrayOpened)
+
         val navigationInteractor =
             DefaultNavigationInteractor(
                 context = requireContext(),
                 tabsTrayStore = tabsTrayStore,
                 browserStore = requireComponents.core.store,
                 navController = findNavController(),
                 metrics = requireComponents.analytics.metrics,
-                dismissTabTray = ::dismissAllowingStateLoss,
-                dismissTabTrayAndNavigateHome = ::dismissTabTrayAndNavigateHome,
+                dismissTabTray = ::dismissTabsTray,
+                dismissTabTrayAndNavigateHome = ::dismissTabsTrayAndNavigateHome,
                 bookmarksUseCase = requireComponents.useCases.bookmarksUseCases,
                 collectionStorage = requireComponents.core.tabCollectionStorage
             )
@@ -144,8 +146,7 @@ class TabsTrayFragment : AppCompatDialogFragment(), TabsTrayInteractor {
         behavior.addBottomSheetCallback(
             TraySheetBehaviorCallback(
                 behavior,
-                navigationInteractor,
-                requireComponents.analytics.metrics
+                navigationInteractor
             )
         )
 
@@ -167,7 +168,8 @@ class TabsTrayFragment : AppCompatDialogFragment(), TabsTrayInteractor {
                 tabLayout = tab_layout,
                 interactor = this,
                 browserStore = requireComponents.core.store,
-                trayStore = tabsTrayStore
+                trayStore = tabsTrayStore,
+                metrics = requireComponents.analytics.metrics
             ), owner = this,
             view = view
         )
@@ -228,12 +230,16 @@ class TabsTrayFragment : AppCompatDialogFragment(), TabsTrayInteractor {
         )
     }
 
+    override fun onDestroyView() {
+        super.onDestroyView()
+    }
+
     override fun setCurrentTrayPosition(position: Int, smoothScroll: Boolean) {
         tabsTray.setCurrentItem(position, smoothScroll)
     }
 
     override fun navigateToBrowser() {
-        dismissAllowingStateLoss()
+        dismissTabsTray()
 
         val navController = findNavController()
 
@@ -299,10 +305,15 @@ class TabsTrayFragment : AppCompatDialogFragment(), TabsTrayInteractor {
 
     private val homeViewModel: HomeScreenViewModel by activityViewModels()
 
-    private fun dismissTabTrayAndNavigateHome(sessionId: String) {
+    private fun dismissTabsTrayAndNavigateHome(sessionId: String) {
         homeViewModel.sessionToDelete = sessionId
         val directions = NavGraphDirections.actionGlobalHome()
         findNavController().navigateBlockingForAsyncNavGraph(directions)
+        dismissTabsTray()
+    }
+
+    private fun dismissTabsTray() {
         dismissAllowingStateLoss()
+        requireComponents.analytics.metrics.track(Event.TabsTrayClosed)
     }
 }
diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInfoBannerBinding.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInfoBannerBinding.kt
@@ -85,6 +85,7 @@ class TabsTrayInfoBannerBinding(
                 }
             ) {
                 navigationInteractor.onTabSettingsClicked()
+                metrics?.track(Event.TabsTrayCfrTapped)
                 settings.shouldShowGridViewBanner = false
             }
         } else {
@@ -110,6 +111,7 @@ class TabsTrayInfoBannerBinding(
                 }
             ) {
                 navigationInteractor.onTabSettingsClicked()
+                metrics?.track(Event.TabsTrayCfrTapped)
                 settings.shouldShowAutoCloseTabsBanner = false
             }
         } else {

diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayViewHolder.kt
@@ -212,6 +212,7 @@ abstract class TabsTrayViewHolder(
 
         itemView.setOnLongClickListener {
             if (holder.selectedItems.isEmpty()) {
+                metrics.track(Event.CollectionTabLongPressed)
                 interactor.select(item)
                 true
             } else {

diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TraySheetBehaviorCallback.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TraySheetBehaviorCallback.kt
@@ -8,18 +8,14 @@ import android.view.View
 import androidx.constraintlayout.widget.ConstraintLayout
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.google.android.material.bottomsheet.BottomSheetBehavior.STATE_HIDDEN
-import org.mozilla.fenix.components.metrics.Event
-import org.mozilla.fenix.components.metrics.MetricController
 
 class TraySheetBehaviorCallback(
     private val behavior: BottomSheetBehavior<ConstraintLayout>,
-    private val trayInteractor: NavigationInteractor,
-    private val metrics: MetricController
+    private val trayInteractor: NavigationInteractor
 ) : BottomSheetBehavior.BottomSheetCallback() {
 
     override fun onStateChanged(bottomSheet: View, newState: Int) {
         if (newState == STATE_HIDDEN) {
-            metrics.track(Event.TabsTrayClosed)
             trayInteractor.onTabTrayDismissed()
         } else if (newState == BottomSheetBehavior.STATE_HALF_EXPANDED) {
             // We only support expanded and collapsed states.

diff --git a/app/src/test/java/org/mozilla/fenix/components/metrics/GleanMetricsServiceTest.kt b/app/src/test/java/org/mozilla/fenix/components/metrics/GleanMetricsServiceTest.kt
@@ -26,6 +26,8 @@ import org.mozilla.fenix.GleanMetrics.History
 import org.mozilla.fenix.GleanMetrics.Metrics
 import org.mozilla.fenix.GleanMetrics.SearchDefaultEngine
 import org.mozilla.fenix.GleanMetrics.SyncedTabs
+import org.mozilla.fenix.GleanMetrics.TabsTray
+import org.mozilla.fenix.GleanMetrics.TabsTrayCfr
 import org.mozilla.fenix.components.toolbar.ToolbarPosition
 import org.mozilla.fenix.helpers.FenixRobolectricTestRunner
 import org.mozilla.fenix.utils.BrowsersCache
@@ -258,4 +260,67 @@ class GleanMetricsServiceTest {
         assertEquals(1, events[0].extra!!.size)
         assertEquals("123", events[0].extra!!["addon_id"])
     }
+
+    @Test
+    fun `TabsTray events are correctly recorded`() {
+        assertFalse(TabsTray.opened.testHasValue())
+        gleanService.track(Event.TabsTrayOpened)
+        assertTrue(TabsTray.opened.testHasValue())
+
+        assertFalse(TabsTray.closed.testHasValue())
+        gleanService.track(Event.TabsTrayClosed)
+        assertTrue(TabsTray.closed.testHasValue())
+
+        assertFalse(TabsTray.openedExistingTab.testHasValue())
+        gleanService.track(Event.OpenedExistingTab)
+        assertTrue(TabsTray.openedExistingTab.testHasValue())
+
+        assertFalse(TabsTray.closedExistingTab.testHasValue())
+        gleanService.track(Event.ClosedExistingTab)
+        assertTrue(TabsTray.closedExistingTab.testHasValue())
+
+        assertFalse(TabsTray.privateModeTapped.testHasValue())
+        gleanService.track(Event.TabsTrayPrivateModeTapped)
+        assertTrue(TabsTray.privateModeTapped.testHasValue())
+
+        assertFalse(TabsTray.normalModeTapped.testHasValue())
+        gleanService.track(Event.TabsTrayNormalModeTapped)
+        assertTrue(TabsTray.normalModeTapped.testHasValue())
+
+        assertFalse(TabsTray.syncedModeTapped.testHasValue())
+        gleanService.track(Event.TabsTraySyncedModeTapped)
+        assertTrue(TabsTray.syncedModeTapped.testHasValue())
+
+        assertFalse(TabsTray.newTabTapped.testHasValue())
+        gleanService.track(Event.NewTabTapped)
+        assertTrue(TabsTray.newTabTapped.testHasValue())
+
+        assertFalse(TabsTray.newPrivateTabTapped.testHasValue())
+        gleanService.track(Event.NewPrivateTabTapped)
+        assertTrue(TabsTray.newPrivateTabTapped.testHasValue())
+
+        assertFalse(TabsTray.menuOpened.testHasValue())
+        gleanService.track(Event.TabsTrayMenuOpened)
+        assertTrue(TabsTray.menuOpened.testHasValue())
+
+        assertFalse(TabsTray.saveToCollection.testHasValue())
+        gleanService.track(Event.TabsTraySaveToCollectionPressed)
+        assertTrue(TabsTray.saveToCollection.testHasValue())
+
+        assertFalse(TabsTray.shareAllTabs.testHasValue())
+        gleanService.track(Event.TabsTrayShareAllTabsPressed)
+        assertTrue(TabsTray.shareAllTabs.testHasValue())
+
+        assertFalse(TabsTray.closeAllTabs.testHasValue())
+        gleanService.track(Event.TabsTrayCloseAllTabsPressed)
+        assertTrue(TabsTray.closeAllTabs.testHasValue())
+
+        assertFalse(TabsTrayCfr.dismiss.testHasValue())
+        gleanService.track(Event.TabsTrayCfrDismissed)
+        assertTrue(TabsTrayCfr.dismiss.testHasValue())
+
+        assertFalse(TabsTrayCfr.goToSettings.testHasValue())
+        gleanService.track(Event.TabsTrayCfrTapped)
+        assertTrue(TabsTrayCfr.goToSettings.testHasValue())
+    }
 }
diff --git a/app/src/test/java/org/mozilla/fenix/tabstray/TabLayoutMediatorTest.kt b/app/src/test/java/org/mozilla/fenix/tabstray/TabLayoutMediatorTest.kt
@@ -26,7 +26,7 @@ class TabLayoutMediatorTest {
         val store = createStore("123")
         val tabLayout: TabLayout = mockk(relaxed = true)
         val tab: TabLayout.Tab = mockk(relaxed = true)
-        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk())
+        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk(), mockk())
 
         every { tabLayout.getTabAt(POSITION_NORMAL_TABS) }.answers { tab }
 
@@ -40,7 +40,7 @@ class TabLayoutMediatorTest {
         val store = createStore("456")
         val tabLayout: TabLayout = mockk(relaxed = true)
         val tab: TabLayout.Tab = mockk(relaxed = true)
-        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk())
+        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk(), mockk())
 
         every { tabLayout.getTabAt(POSITION_PRIVATE_TABS) }.answers { tab }
 
@@ -53,7 +53,7 @@ class TabLayoutMediatorTest {
     fun `lifecycle methods adds and removes observer`() {
         val store = createStore("456")
         val tabLayout: TabLayout = mockk(relaxed = true)
-        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk())
+        val mediator = TabLayoutMediator(tabLayout, mockk(relaxed = true), store, mockk(), mockk())
 
         mediator.start()