For #19915: Add telemetry for the toolbar Home screen button.

mozilla-mobile · Jun 10, 2021 · 1a91d20 · 1a91d20
1 parent 2ebc71f
commit 1a91d20
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/app/metrics.yaml b/app/metrics.yaml
@@ -433,6 +433,20 @@ events:
     notification_emails:
       - fenix-core@mozilla.com
     expires: "2021-05-10"
+  browser_toolbar_home_tapped:
+    type: event
+    description: |
+      An event that indicates that a user has tapped
+      home button on browser toolbar.
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/19915
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/19936
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2021-12-10"
 
 onboarding:
   fxa_auto_signin:

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
@@ -236,6 +236,8 @@ sealed class Event {
     object HomeMenuSettingsItemClicked : Event()
     object HomeScreenDisplayed : Event()
 
+    // Browser Toolbar
+    object BrowserToolbarHomeButtonClicked : Event()
     // Interaction events with extras
 
     data class TopSiteSwipeCarousel(val page: Int) : 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
@@ -833,6 +833,10 @@ private val Event.wrapper: EventWrapper<*>?
             { HomeScreen.homeScreenDisplayed.record(it) }
         )
 
+        is Event.BrowserToolbarHomeButtonClicked -> EventWrapper<NoExtraKeys>(
+            { Events.browserToolbarHomeTapped.record(it) }
+        )
+
         // Don't record other events in Glean:
         is Event.AddBookmark -> null
         is Event.OpenedAppFirstRun -> null

diff --git a/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarController.kt b/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarController.kt
@@ -164,6 +164,8 @@ class DefaultBrowserToolbarController(
     }
 
     override fun handleHomeButtonClick() {
+        metrics.track(Event.BrowserToolbarHomeButtonClicked)
+
         navController.navigateBlockingForAsyncNavGraph(
             BrowserFragmentDirections.actionGlobalHome()
         )

diff --git a/...src/test/java/org/mozilla/fenix/components/toolbar/DefaultBrowserToolbarControllerTest.kt b/...src/test/java/org/mozilla/fenix/components/toolbar/DefaultBrowserToolbarControllerTest.kt
@@ -36,6 +36,7 @@ import org.junit.Assert.assertEquals
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.mozilla.fenix.GleanMetrics.Events
 import org.mozilla.fenix.HomeActivity
 import org.mozilla.fenix.R
 import org.mozilla.fenix.browser.BrowserAnimator
@@ -318,6 +319,8 @@ class DefaultBrowserToolbarControllerTest {
         controller.handleHomeButtonClick()
 
         verify { navController.navigate(BrowserFragmentDirections.actionGlobalHome()) }
+        verify { metrics.track(Event.BrowserToolbarHomeButtonClicked) }
+
     }
 
     private fun createController(