From e8216e3079983c6d2ad9ec08a9c3cf9237405853 Mon Sep 17 00:00:00 2001
From: Sawyer Blatz <sdblatz@gmail.com>
Date: Thu, 3 Oct 2019 10:03:14 -0700
Subject: [PATCH] For #5094: Adds telemetry for suggestion toggles (#5704)

---
 app/metrics.yaml                                             | 5 ++++-
 .../java/org/mozilla/fenix/components/metrics/Metrics.kt     | 5 ++++-
 docs/metrics.md                                              | 2 +-
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/app/metrics.yaml b/app/metrics.yaml
index b2c019e2f..14ef32004 100644
--- a/app/metrics.yaml
+++ b/app/metrics.yaml
@@ -107,13 +107,16 @@ events:
     extra_keys:
       preference_key:
         description: "The preference key for the switch preference the user toggled. We currently track:
-          show_search_suggestions, remote_debugging, telemetry, tracking_protection"
+          show_search_suggestions, remote_debugging, telemetry, tracking_protection, search_bookmarks,
+          search_browsing_history, and show_clipboard_suggestions"
       enabled:
         description: "Whether or not the preference is *now* enabled"
     bugs:
     - 975
+    - 5094
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1896
+    - https://github.com/mozilla-mobile/fenix/pull/5704
     notification_emails:
     - fenix-core@mozilla.com
     expires: "2020-03-01"
diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt
index 8ae2470ee..f406f1060 100644
--- a/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt
+++ b/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt
@@ -134,7 +134,10 @@ sealed class Event {
             context.getString(R.string.pref_key_show_search_suggestions),
             context.getString(R.string.pref_key_remote_debugging),
             context.getString(R.string.pref_key_telemetry),
-            context.getString(R.string.pref_key_tracking_protection)
+            context.getString(R.string.pref_key_tracking_protection),
+            context.getString(R.string.pref_key_search_bookmarks),
+            context.getString(R.string.pref_key_search_browsing_history),
+            context.getString(R.string.pref_key_show_clipboard_suggestions)
         )
 
         override val extras: Map<Events.preferenceToggledKeys, String>?
diff --git a/docs/metrics.md b/docs/metrics.md
index b7f12ac0d..4b1e7b239 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -77,7 +77,7 @@ The following metrics are added to the ping:
 | 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)|<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 </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.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 preference switch in settings  |[1](https://github.com/mozilla-mobile/fenix/pull/1896)|<ul><li>enabled: Whether or not the preference is *now* enabled</li><li>preference_key: The preference key for the switch preference the user toggled. We currently track: show_search_suggestions, remote_debugging, telemetry, tracking_protection</li></ul>|2020-03-01 |
+| events.preference_toggled |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user toggled a preference switch in settings  |[1](https://github.com/mozilla-mobile/fenix/pull/1896), [2](https://github.com/mozilla-mobile/fenix/pull/TODO)|<ul><li>enabled: Whether or not the preference is *now* enabled</li><li>preference_key: The preference key for the switch preference the user toggled. We currently track: show_search_suggestions, remote_debugging, telemetry, tracking_protection, search_bookmarks, search_browsing_history, and show_clipboard_suggestions</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 |