For #6070 Adds telemetry for enabling search suggestions in private

app/metrics.yaml

@@ -114,7 +114,8 @@ events:
         description: "The preference key for the boolean (true/false) preference the user toggled. We currently track:
           show_search_suggestions, remote_debugging, telemetry, tracking_protection, search_bookmarks,
           search_browsing_history, show_clipboard_suggestions, show_search_shortcuts, open_links_in_a_private_tab,
-          pref_key_sync_logins, pref_key_sync_bookmarks and pref_key_sync_history"
+          pref_key_sync_logins, pref_key_sync_bookmarks, pref_key_sync_history
+          and pref_key_show_search_suggestions_in_private"
       enabled:
         description: "Whether or not the preference is *now* enabled"
     bugs:
@@ -123,13 +124,15 @@ events:
     - https://github.com/mozilla-mobile/fenix/issues/5737
     - https://github.com/mozilla-mobile/fenix/issues/5586
     - https://github.com/mozilla-mobile/fenix/issues/6396
+    - https://github.com/mozilla-mobile/fenix/issues/6070
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1896
     - https://github.com/mozilla-mobile/fenix/pull/5704
     - https://github.com/mozilla-mobile/fenix/pull/5886
     - https://github.com/mozilla-mobile/fenix/pull/5975
     - https://github.com/mozilla-mobile/fenix/pull/6352
     - https://github.com/mozilla-mobile/fenix/pull/6601
+    - https://github.com/mozilla-mobile/fenix/pull/6746
     notification_emails:
     - fenix-core@mozilla.com
     expires: "2020-03-01"
@@ -1654,3 +1657,16 @@ download_notification:
     notification_emails:
       - fenix-core@mozilla.com
     expires: "2020-03-01"
+
+search_suggestions:
+  enable_in_private:
+    type: event
+    description: >
+      A user enabled receiving search suggestions in private sessions
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/6070
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/6746
+    notification_emails:
+     - fenix-core@mozilla.com
+    expires: "2020-03-01"

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

@@ -6,8 +6,8 @@ package org.mozilla.fenix.components.metrics
 
 import android.content.Context
 import kotlinx.coroutines.Job
-import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.MainScope
 import mozilla.components.service.glean.BuildConfig
 import mozilla.components.service.glean.Glean
 import mozilla.components.service.glean.config.Configuration
@@ -36,6 +36,7 @@ import org.mozilla.fenix.GleanMetrics.QrScanner
 import org.mozilla.fenix.GleanMetrics.ReaderMode
 import org.mozilla.fenix.GleanMetrics.SearchDefaultEngine
 import org.mozilla.fenix.GleanMetrics.SearchShortcuts
+import org.mozilla.fenix.GleanMetrics.SearchSuggestions
 import org.mozilla.fenix.GleanMetrics.SearchWidget
 import org.mozilla.fenix.GleanMetrics.SyncAccount
 import org.mozilla.fenix.GleanMetrics.SyncAuth
@@ -446,6 +447,9 @@ private val Event.wrapper: EventWrapper<*>?
         is Event.ViewLoginPassword -> EventWrapper<NoExtraKeys>(
             { Logins.viewPasswordLogin.record(it) }
         )
+        is Event.PrivateBrowsingShowSearchSuggestions -> EventWrapper<NoExtraKeys>(
+            { SearchSuggestions.enableInPrivate.record(it) }
+        )
         is Event.ToolbarPositionChanged -> EventWrapper(
             { ToolbarSettings.changedPosition.record(it) },
             { ToolbarSettings.changedPositionKeys.valueOf(it) }

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

@@ -137,6 +137,7 @@ sealed class Event {
     object OpenOneLogin : Event()
     object CopyLogin : Event()
     object ViewLoginPassword : Event()
+    object PrivateBrowsingShowSearchSuggestions : Event()
 
     // Interaction events with extras
 
@@ -153,7 +154,8 @@ sealed class Event {
             context.getString(R.string.pref_key_open_links_in_a_private_tab),
             context.getString(R.string.pref_key_sync_logins),
             context.getString(R.string.pref_key_sync_bookmarks),
-            context.getString(R.string.pref_key_sync_history)
+            context.getString(R.string.pref_key_sync_history),
+            context.getString(R.string.pref_key_show_search_suggestions_in_private)
         )
 
         override val extras: Map<Events.preferenceToggledKeys, String>?

app/src/main/java/org/mozilla/fenix/search/SearchFragment.kt

@@ -209,6 +209,7 @@ class SearchFragment : Fragment(), UserInteractionHandler {
                 inflated.visibility = View.GONE
                 context?.settings()?.shouldShowSearchSuggestionsInPrivate = true
                 context?.settings()?.showSearchSuggestionsInPrivateOnboardingFinished = true
+                requireComponents.analytics.metrics.track(Event.PrivateBrowsingShowSearchSuggestions)
             }
 
             inflated.dismiss.setOnClickListener {

docs/metrics.md

@@ -85,7 +85,7 @@ The following metrics are added to the ping:
 | 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 |
-| events.preference_toggled |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user toggled a boolean preference in settings  |[1](https://github.com/mozilla-mobile/fenix/pull/1896), [2](https://github.com/mozilla-mobile/fenix/pull/5704), [3](https://github.com/mozilla-mobile/fenix/pull/5886), [4](https://github.com/mozilla-mobile/fenix/pull/5975), [5](https://github.com/mozilla-mobile/fenix/pull/6352), [6](https://github.com/mozilla-mobile/fenix/pull/6601)|<ul><li>enabled: Whether or not the preference is *now* enabled</li><li>preference_key: The preference key for the boolean (true/false) preference the user toggled. We currently track: show_search_suggestions, remote_debugging, telemetry, tracking_protection, search_bookmarks, search_browsing_history, show_clipboard_suggestions, show_search_shortcuts, open_links_in_a_private_tab, pref_key_sync_logins, pref_key_sync_bookmarks and pref_key_sync_history</li></ul>|2020-03-01 |
+| events.preference_toggled |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user toggled a boolean preference in settings  |[1](https://github.com/mozilla-mobile/fenix/pull/1896), [2](https://github.com/mozilla-mobile/fenix/pull/5704), [3](https://github.com/mozilla-mobile/fenix/pull/5886), [4](https://github.com/mozilla-mobile/fenix/pull/5975), [5](https://github.com/mozilla-mobile/fenix/pull/6352), [6](https://github.com/mozilla-mobile/fenix/pull/6601), [7](https://github.com/mozilla-mobile/fenix/pull/6746)|<ul><li>enabled: Whether or not the preference is *now* enabled</li><li>preference_key: The preference key for the boolean (true/false) preference the user toggled. We currently track: show_search_suggestions, remote_debugging, telemetry, tracking_protection, search_bookmarks, search_browsing_history, show_clipboard_suggestions, show_search_shortcuts, open_links_in_a_private_tab, pref_key_sync_logins, pref_key_sync_bookmarks, pref_key_sync_history and pref_key_show_search_suggestions_in_private</li></ul>|2020-03-01 |
 | events.search_bar_tapped |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user tapped the search bar  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)|<ul><li>source: The view the user was on when they initiated the search (For example: `Home` or `Browser`)</li></ul>|2020-03-01 |
 | events.whats_new_tapped |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened the "what's new" page button  |[1](https://github.com/mozilla-mobile/fenix/pull/5090)|<ul><li>source: The location from which the user selected the what's new button. Either 'about' or 'home'</li></ul>|2020-03-01 |
 | find_in_page.closed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user closed the find in page UI  |[1](https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010)||2020-03-01 |
@@ -130,6 +130,7 @@ The following metrics are added to the ping:
 | reader_mode.closed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user closed reader mode  |[1](https://github.com/mozilla-mobile/fenix/pull/4328)||2020-03-01 |
 | reader_mode.opened |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened reader mode  |[1](https://github.com/mozilla-mobile/fenix/pull/3941)||2020-03-01 |
 | search_shortcuts.selected |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user selected a search shortcut engine to use  |[1](https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449)|<ul><li>engine: The name of the built-in search engine the user selected as a string</li></ul>|2020-03-01 |
+| search_suggestions.enable_in_private |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user enabled receiving search suggestions in private sessions  |[1](https://github.com/mozilla-mobile/fenix/pull/6746)||2020-03-01 |
 | search_widget.new_tab_button |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed anywhere from the Firefox logo until the start of the microphone icon, opening a new tab search screen.  |[1](https://github.com/mozilla-mobile/fenix/pull/4714)||2020-03-01 |
 | search_widget.voice_button |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the microphone icon, opening a new voice search screen.  |[1](https://github.com/mozilla-mobile/fenix/pull/4714)||2020-03-01 |
 | sync_account.closed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user closed the sync account page  |[1](https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532)||2020-03-01 |