For #11479: Record open tabs count in metrics ping

app/metrics.yaml

@@ -652,6 +652,38 @@ metrics:
     notification_emails:
       - fenix-core@mozilla.com
     expires: "2020-09-01"
+  tabs_open_count:
+    type: counter
+    lifetime: application
+    description: |
+      A counter that indicates how many NORMAL tabs a user has open. This value will
+      only be set if the user has at least *one* open tab. If they have 0,
+      this ping will not get sent, resulting in a null value. To disambiguate
+      between a failed `tabs_open_count` ping and 0 open tabs, please see
+      `has_open_tabs`.
+    send_in_pings:
+      - metrics
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/11479
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/12024
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2020-09-01"
+  has_open_tabs:
+    type: boolean
+    lifetime: application
+    description: |
+      A boolean that indicates if the user has any open NORMAL tabs.
+    send_in_pings:
+      - metrics
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/11479
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/12024
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2020-09-01"
 
 preferences:
   show_search_suggestions:

app/src/main/java/org/mozilla/fenix/browser/UriOpenedObserver.kt

@@ -12,16 +12,20 @@ import mozilla.components.browser.session.SessionManager
 import org.mozilla.fenix.components.metrics.MetricController
 import org.mozilla.fenix.ext.components
 import org.mozilla.fenix.ext.metrics
+import org.mozilla.fenix.ext.settings
 import org.mozilla.fenix.search.telemetry.ads.AdsTelemetry
+import org.mozilla.fenix.utils.Settings
 
 class UriOpenedObserver(
+    private val settings: Settings,
     private val owner: LifecycleOwner,
     private val sessionManager: SessionManager,
     metrics: MetricController,
     ads: AdsTelemetry
 ) : SessionManager.Observer {
 
     constructor(activity: FragmentActivity) : this(
+        activity.applicationContext.settings(),
         activity,
         activity.components.core.sessionManager,
         activity.metrics,
@@ -41,20 +45,24 @@ class UriOpenedObserver(
     }
 
     override fun onAllSessionsRemoved() {
+        settings.setOpenTabsCount(sessionManager.sessions.filter { !it.private }.size)
         sessionManager.sessions.forEach {
             it.unregister(singleSessionObserver)
         }
     }
 
     override fun onSessionAdded(session: Session) {
+        settings.setOpenTabsCount(sessionManager.sessions.filter { !it.private }.size)
         session.register(singleSessionObserver, owner)
     }
 
     override fun onSessionRemoved(session: Session) {
+        settings.setOpenTabsCount(sessionManager.sessions.filter { !it.private }.size)
         session.unregister(singleSessionObserver)
     }
 
     override fun onSessionsRestored() {
+        settings.setOpenTabsCount(sessionManager.sessions.filter { !it.private }.size)
         sessionManager.sessions.forEach {
             it.register(singleSessionObserver, owner)
         }

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

@@ -22,16 +22,15 @@ import org.mozilla.fenix.GleanMetrics.CustomTab
 import org.mozilla.fenix.GleanMetrics.DownloadNotification
 import org.mozilla.fenix.GleanMetrics.ErrorPage
 import org.mozilla.fenix.GleanMetrics.Events
-import org.mozilla.fenix.GleanMetrics.Events.preferenceToggled
 import org.mozilla.fenix.GleanMetrics.FindInPage
 import org.mozilla.fenix.GleanMetrics.History
 import org.mozilla.fenix.GleanMetrics.Logins
 import org.mozilla.fenix.GleanMetrics.MediaNotification
 import org.mozilla.fenix.GleanMetrics.MediaState
 import org.mozilla.fenix.GleanMetrics.Metrics
+import org.mozilla.fenix.GleanMetrics.Onboarding
 import org.mozilla.fenix.GleanMetrics.Pings
 import org.mozilla.fenix.GleanMetrics.Pocket
-import org.mozilla.fenix.GleanMetrics.Onboarding
 import org.mozilla.fenix.GleanMetrics.Preferences
 import org.mozilla.fenix.GleanMetrics.PrivateBrowsingMode
 import org.mozilla.fenix.GleanMetrics.PrivateBrowsingShortcut
@@ -661,6 +660,12 @@ class GleanMetricsService(private val context: Context) : MetricsService {
 
             searchWidgetInstalled.set(context.settings().searchWidgetInstalled)
 
+            val openTabsCount = context.settings().openTabsCount
+            hasOpenTabs.set(openTabsCount > 0)
+            if (openTabsCount > 0) {
+                tabsOpenCount.add(openTabsCount)
+            }
+
             val topSitesSize = context.settings().topSitesSize
             hasTopSites.set(topSitesSize > 0)
             if (topSitesSize > 0) {

app/src/main/java/org/mozilla/fenix/utils/Settings.kt

@@ -775,6 +775,19 @@ class Settings private constructor(
         default = 0
     )
 
+    fun setOpenTabsCount(count: Int) {
+        preferences.edit().putInt(
+            appContext.getPreferenceKey(R.string.pref_key_open_tabs_count),
+            count
+        ).apply()
+    }
+
+    val openTabsCount: Int
+        get() = preferences.getInt(
+            appContext.getPreferenceKey(R.string.pref_key_open_tabs_count),
+            0
+        )
+
     private var savedLoginsSortingStrategyString by stringPreference(
         appContext.getPreferenceKey(R.string.pref_key_saved_logins_sorting_strategy),
         default = SavedLoginsFragment.SORTING_STRATEGY_ALPHABETICALLY

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

@@ -177,6 +177,8 @@
 
     <string name="pref_key_debug_settings" translatable="false">pref_key_debug_settings</string>
 
+    <string name="pref_key_open_tabs_count" translatable="false">pref_key_open_tabs_count</string>
+
     <string name="pref_key_search_count" translatable="false">pref_key_search_count</string>
     <string name="pref_key_search_widget_cfr_display_count" translatable="false">pref_key_search_widget_cfr_display_count</string>
     <string name="pref_key_search_widget_cfr_dismiss_count" translatable="false">pref_key_search_widget_cfr_dismiss_count</string>

docs/metrics.md

@@ -82,10 +82,10 @@ The following metrics are added to the ping:
 | collections.tab_select_opened |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened the select tabs screen (the first step of the collection creation flow)  |[1](https://github.com/mozilla-mobile/fenix/pull/3935)||2020-09-01 |
 | collections.tabs_added |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user saved a list of tabs to an existing collection  |[1](https://github.com/mozilla-mobile/fenix/pull/3935)|<ul><li>tabs_open: The number of tabs open in the current session</li><li>tabs_selected: The number of tabs added to the collection</li></ul>|2020-09-01 |
 | context_menu.item_tapped |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user tapped an item in the browsers context menu  |[1](https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010)|<ul><li>named: The name of the item that was tapped. Available items are:  ``` open_in_new_tab, open_in_private_tab, open_image_in_new_tab, save_image, share_link, copy_link, copy_image_location ``` </li></ul>|2020-09-01 |
-| contextual_hint.tracking_protection.dismiss |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The enhanced tracking protection contextual hint was dismissed by pressing the close button  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
-| contextual_hint.tracking_protection.display |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The enhanced tracking protection contextual hint was displayed.  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
-| contextual_hint.tracking_protection.inside_tap |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user tapped inside of the etp contextual hint (which brings up the etp panel for this site).  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
-| contextual_hint.tracking_protection.outside_tap |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user tapped outside of the etp contextual hint (which has no effect).  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
+| contextual_hint.tracking_protection.dismiss |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The enhanced tracking protection contextual hint was dismissed by pressing the close button  |[1](https://github.com/mozilla-mobile/fenix/pull/11923)||2020-09-01 |
+| contextual_hint.tracking_protection.display |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The enhanced tracking protection contextual hint was displayed.  |[1](https://github.com/mozilla-mobile/fenix/pull/11923)||2020-09-01 |
+| contextual_hint.tracking_protection.inside_tap |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user tapped inside of the etp contextual hint (which brings up the etp panel for this site).  |[1](https://github.com/mozilla-mobile/fenix/pull/11923)||2020-09-01 |
+| contextual_hint.tracking_protection.outside_tap |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user tapped outside of the etp contextual hint (which has no effect).  |[1](https://github.com/mozilla-mobile/fenix/pull/11923)||2020-09-01 |
 | crash_reporter.closed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The crash reporter was closed  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708)|<ul><li>crash_submitted: A boolean that tells us whether or not the user submitted a crash report </li></ul>|2020-09-01 |
 | crash_reporter.opened |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The crash reporter was displayed  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708)||2020-09-01 |
 | custom_tab.action_button |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the action button provided by the launching app  |[1](https://github.com/mozilla-mobile/fenix/pull/1697)||2020-09-01 |
@@ -251,10 +251,12 @@ The following metrics are added to the ping:
 | metrics.adjust_network |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |A string containing the Adjust network ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty.  |[1](https://github.com/mozilla-mobile/fenix/pull/9253)||2020-09-01 |
 | metrics.default_browser |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |Is Fenix the default browser?  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)||2020-09-01 |
 | metrics.default_moz_browser |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The name of the default browser on device if and only if it's a Mozilla owned product  |[1](https://github.com/mozilla-mobile/fenix/pull/1953/), [2](https://github.com/mozilla-mobile/fenix/pull/5216)||2020-09-01 |
+| metrics.has_open_tabs |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |A boolean that indicates if the user has any open tabs.  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
 | metrics.has_top_sites |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |A boolean that indicates if the user has top sites  |[1](https://github.com/mozilla-mobile/fenix/pull/9556)||2020-09-01 |
 | metrics.mozilla_products |[string_list](https://mozilla.github.io/glean/book/user/metrics/string_list.html) |A list of all the Mozilla products installed on device. We currently scan for: Firefox, Firefox Beta, Firefox Aurora, Firefox Nightly, Firefox Fdroid, Firefox Lite, Reference Browser, Reference Browser Debug, Fenix, Focus, and Lockwise.  |[1](https://github.com/mozilla-mobile/fenix/pull/1953/), [2](https://github.com/mozilla-mobile/fenix/pull/5216)||2020-09-01 |
 | metrics.search_count |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |The labels for this counter are `<search-engine-name>.<source>`.  If the search engine is bundled with Fenix `search-engine-name` will be the name of the search engine. If it's a custom search engine (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the value will be `custom`.  `source` will be: `action`, `suggestion`, `widget` or `shortcut` (depending on the source from which the search started). Also added the `other` option for the source but it should never enter on this case.  |[1](https://github.com/mozilla-mobile/fenix/pull/1677), [2](https://github.com/mozilla-mobile/fenix/pull/5216), [3](https://github.com/mozilla-mobile/fenix/pull/7310)||2020-09-01 |
 | metrics.search_widget_installed |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |Whether or not the search widget is installed  |[1](https://github.com/mozilla-mobile/fenix/pull/10958)||2020-09-01 |
+| metrics.tabs_open_count |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |A counter that indicates how many tabs a user has open. This value will only be set if the user has at least *one* open tab. If they have 0, this ping will not get sent, resulting in a null value. To disambiguate between a failed `tabs_open_count` ping and 0 open tabs, please see `has_open_tabs`.  |[1](https://github.com/mozilla-mobile/fenix/pull/TODO)||2020-09-01 |
 | metrics.toolbar_position |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |A string that indicates the new position of the toolbar TOP or BOTTOM  |[1](https://github.com/mozilla-mobile/fenix/pull/6608)||2020-09-01 |
 | metrics.top_sites_count |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |A counter that indicates how many top sites a user has. This value will only be set if the user has at least *one* top site. If they have 0, this ping will not get sent, resulting in a null value. To disambiguate between a failed `top_sites_count` ping and 0 top sites, please see `has_top_sites`.  |[1](https://github.com/mozilla-mobile/fenix/pull/9556)||2020-09-01 |
 | perf.awesomebar.bookmark_suggestions |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Duration of a bookmarks awesomebar suggestion query.  |[1](https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979)||2020-09-15 |