For mozilla-mobile#7525 - Add telemetry for opening a top site in nor…

…mal and private mode and removing a top site

app/metrics.yaml

@@ -1669,4 +1669,39 @@ search_suggestions:
       - https://github.com/mozilla-mobile/fenix/pull/6746
     notification_emails:
      - [email protected]
-    expires: "2020-03-01"
+    expires: "2020-03-01"
+
+top_sites:
+  open_in_new_tab:
+    type: event
+    description: >
+      A user opens a new tab based on a top site item
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/6757
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/7523
+    notification_emails:
+      - [email protected]
+    expires: "2020-03-01"
+  open_in_private_tab:
+    type: event
+    description: >
+      A user opens a new private tab based on a top site item
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/6757
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/7523
+    notification_emails:
+      - [email protected]
+    expires: "2020-03-01"
+  remove:
+    type: event
+    description: >
+      A user removes a top site item
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/6757
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/7523
+    notification_emails:
+      - [email protected]
+    expires: "2020-03-01"

app/src/main/java/org/mozilla/fenix/components/metrics/GleanMetricsService.kt

@@ -42,6 +42,7 @@ import org.mozilla.fenix.GleanMetrics.SyncAccount
 import org.mozilla.fenix.GleanMetrics.SyncAuth
 import org.mozilla.fenix.GleanMetrics.Tab
 import org.mozilla.fenix.GleanMetrics.ToolbarSettings
+import org.mozilla.fenix.GleanMetrics.TopSites
 import org.mozilla.fenix.GleanMetrics.TrackingProtection
 import org.mozilla.fenix.ext.components
 import org.mozilla.fenix.ext.settings
@@ -454,6 +455,15 @@ private val Event.wrapper: EventWrapper<*>?
             { ToolbarSettings.changedPosition.record(it) },
             { ToolbarSettings.changedPositionKeys.valueOf(it) }
         )
+        is Event.TopSiteOpenInNewTab -> EventWrapper<NoExtraKeys>(
+            { TopSites.openInNewTab.record(it) }
+        )
+        is Event.TopSiteOpenInPrivateTab -> EventWrapper<NoExtraKeys>(
+            { TopSites.openInPrivateTab.record(it) }
+        )
+        is Event.TopSiteRemoved -> EventWrapper<NoExtraKeys>(
+            { TopSites.remove.record(it) }
+        )
         // Don't record other events in Glean:
         is Event.AddBookmark -> null
         is Event.OpenedBookmark -> null

app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt

@@ -128,6 +128,9 @@ sealed class Event {
     object NotificationDownloadTryAgain : Event()
     object NotificationMediaPlay : Event()
     object NotificationMediaPause : Event()
+    object TopSiteOpenInNewTab : Event()
+    object TopSiteOpenInPrivateTab : Event()
+    object TopSiteRemoved : Event()
     object TrackingProtectionTrackerList : Event()
     object TrackingProtectionIconPressed : Event()
     object TrackingProtectionSettingsPanel : Event()

app/src/main/java/org/mozilla/fenix/home/sessioncontrol/SessionControlController.kt

@@ -260,6 +260,7 @@ class DefaultSessionControlController(
     }
 
     override fun handleOpenInPrivateTabClicked(topSite: TopSite) {
+        metrics.track(Event.TopSiteOpenInPrivateTab)
         with(activity) {
             browsingModeManager.mode = BrowsingMode.Private
             openToBrowserAndLoad(
@@ -288,6 +289,8 @@ class DefaultSessionControlController(
     }
 
     override fun handleRemoveTopSiteClicked(topSite: TopSite) {
+        metrics.track(Event.TopSiteRemoved)
+
         lifecycleScope.launch(Dispatchers.IO) {
             topSiteStorage.removeTopSite(topSite)
         }
@@ -336,6 +339,7 @@ class DefaultSessionControlController(
     }
 
     override fun handleSelectTopSite(url: String) {
+        metrics.track(Event.TopSiteOpenInNewTab)
         activity.components.useCases.tabsUseCases.addTab.invoke(url, true, true)
         navController.nav(
             R.id.homeFragment,

docs/metrics.md

@@ -80,7 +80,7 @@ The following metrics are added to the ping:
 | download_notification.try_again |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user tapped on try again when a download fails in the download notification  |[1](https://github.com/mozilla-mobile/fenix/pull/6554)||2020-03-01 |
 | error_page.visited_error |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user encountered an error page  |[1](https://github.com/mozilla-mobile/fenix/pull/2491#issuecomment-492414486)|<ul><li>error_type: The error type of the error page encountered</li></ul>|2020-03-01 |
 | events.app_opened |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened the app  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)|<ul><li>source: The method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link`</li></ul>|2020-03-01 |
-| events.browser_menu_action |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A browser menu item was tapped  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708), [2](https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996), [3](https://github.com/mozilla-mobile/fenix/pull/6310)|<ul><li>item: A string containing the name of the item the user tapped. These items include: Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab, Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button, Quit, Reader Mode On, Reader Mode Off, Open In App </li></ul>|2020-03-01 |
+| events.browser_menu_action |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A browser menu item was tapped  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708), [2](https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996), [3](https://github.com/mozilla-mobile/fenix/pull/6310)|<ul><li>item: A string containing the name of the item the user tapped. These items include: Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab, Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button, Quit, Reader Mode On, Reader Mode Off, Open In App, Add to Firefox Home </li></ul>|2020-03-01 |
 | events.entered_url |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user entered a url  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)|<ul><li>autocomplete: A boolean that tells us whether the URL was autofilled by an Autocomplete suggestion</li></ul>|2020-03-01 |
 | events.opened_link |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened a link with Fenix  |[1](https://github.com/mozilla-mobile/fenix/pull/5975)|<ul><li>mode: The mode the link was opened in. Either 'PRIVATE' or 'NORMAL'</li></ul>|2020-03-01 |
 | events.performed_search |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user performed a search  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673), [2](https://github.com/mozilla-mobile/fenix/pull/1677)|<ul><li>source: A string that tells us how the user performed the search. Possible values are: * default.action * default.suggestion * shortcut.action * shortcut.suggestion </li></ul>|2020-03-01 |
@@ -150,6 +150,9 @@ The following metrics are added to the ping:
 | tab.media_pause |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the pause icon on a tab from the home screen  |[1](https://github.com/mozilla-mobile/fenix/pull/5266)||2020-03-01 |
 | tab.media_play |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the play icon on a tab from the home screen  |[1](https://github.com/mozilla-mobile/fenix/pull/5266)||2020-03-01 |
 | toolbar_settings.changed_position |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user selected a new position for the toolbar  |[1](https://github.com/mozilla-mobile/fenix/pull/6608)|<ul><li>position: A string that indicates the new position of the toolbar TOP or BOTTOM</li></ul>|2020-03-01 |
+| top_sites.open_in_new_tab |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opens a new tab based on a top site item  |[1](https://github.com/mozilla-mobile/fenix/pull/7523)||2020-03-01 |
+| top_sites.open_in_private_tab |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opens a new private tab based on a top site item  |[1](https://github.com/mozilla-mobile/fenix/pull/7523)||2020-03-01 |
+| top_sites.remove |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user removes a top site item  |[1](https://github.com/mozilla-mobile/fenix/pull/7523)||2020-03-01 |
 | tracking_protection.etp_setting_changed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user changed their tracking protection level setting to either strict or standard.  |[1](https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188)|<ul><li>etp_setting: The new setting for ETP: strict, standard</li></ul>|2020-03-01 |
 | tracking_protection.etp_settings |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened tracking protection settings through settings.  |[1](https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188)||2020-03-01 |
 | tracking_protection.etp_shield |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the tracking protection shield icon in toolbar.  |[1](https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188)||2020-03-01 |