Bug 1730721 - Record Firefox Suggest prefs in telemetry environment. r=daleharvey, a=RyanVM
Differential Revision:
https://phabricator.services.mozilla.com/D125579
--- a/toolkit/components/telemetry/app/TelemetryEnvironment.jsm
+++ b/toolkit/components/telemetry/app/TelemetryEnvironment.jsm
@@ -251,16 +251,21 @@ const DEFAULT_ENVIRONMENT_PREFS = new Ma
["browser.shell.checkDefaultBrowser", { what: RECORD_PREF_VALUE }],
["browser.search.ignoredJAREngines", { what: RECORD_DEFAULTPREF_VALUE }],
["browser.search.region", { what: RECORD_PREF_VALUE }],
["browser.search.suggest.enabled", { what: RECORD_PREF_VALUE }],
["browser.search.widget.inNavBar", { what: RECORD_DEFAULTPREF_VALUE }],
["browser.startup.homepage", { what: RECORD_PREF_STATE }],
["browser.startup.page", { what: RECORD_PREF_VALUE }],
["browser.urlbar.showSearchSuggestionsFirst", { what: RECORD_PREF_VALUE }],
+ ["browser.urlbar.suggest.quicksuggest", { what: RECORD_DEFAULTPREF_VALUE }],
+ [
+ "browser.urlbar.suggest.quicksuggest.sponsored",
+ { what: RECORD_DEFAULTPREF_VALUE },
+ ],
["browser.urlbar.suggest.searches", { what: RECORD_PREF_VALUE }],
["devtools.chrome.enabled", { what: RECORD_PREF_VALUE }],
["devtools.debugger.enabled", { what: RECORD_PREF_VALUE }],
["devtools.debugger.remote-enabled", { what: RECORD_PREF_VALUE }],
["doh-rollout.doorhanger-decision", { what: RECORD_PREF_VALUE }],
["dom.ipc.plugins.enabled", { what: RECORD_PREF_VALUE }],
["dom.ipc.plugins.sandbox-level.flash", { what: RECORD_PREF_VALUE }],
["dom.ipc.processCount", { what: RECORD_PREF_VALUE }],
--- a/toolkit/components/telemetry/docs/data/environment.rst
+++ b/toolkit/components/telemetry/docs/data/environment.rst
@@ -377,16 +377,20 @@ userPrefs
This object contains user preferences.
Each key in the object is the name of a preference. A key's value depends on the policy with which the preference was collected. There are three such policies, "value", "state", and "default value". For preferences collected under the "value" policy, the value will be the preference's value. For preferences collected under the "state" policy, the value will be an opaque marker signifying only that the preference has a user value. The "state" policy is therefore used when user privacy is a concern. For preferences collected under the "default value" policy, the value will be the preference's default value, if the preference exists. If the preference does not exist, there is no key or value.
The following is a partial list of `collected preferences <https://searchfox.org/mozilla-central/search?q=const+DEFAULT_ENVIRONMENT_PREFS&path=>`_.
- ``browser.search.suggest.enabled``: The "master switch" for search suggestions everywhere in Firefox (search bar, urlbar, etc.). Defaults to true.
+- ``browser.urlbar.suggest.quicksuggest``: True if Firefox Suggest suggestions in general are enabled in the urlbar.
+
+- ``browser.urlbar.suggest.quicksuggest.sponsored``: True if sponsored Firefox Suggest suggestions in particular are enabled in the urlbar.
+
- ``browser.urlbar.suggest.searches``: True if search suggestions are enabled in the urlbar. Defaults to false.
- ``browser.zoom.full`` (deprecated): True if zoom is enabled for both text and images, that is if "Zoom Text Only" is not enabled. Defaults to true. This preference was collected in Firefox 50 to 52 (`Bug 979323 <https://bugzilla.mozilla.org/show_bug.cgi?id=979323>`_).
- ``security.tls.version.enable-deprecated``: True if deprecated versions of TLS (1.0 and 1.1) have been enabled by the user. Defaults to false.
- ``privacy.firstparty.isolate``: True if the user has changed the (unsupported, hidden) First Party Isolation preference. Defaults to false.