1689496 - Add sponsored top sites pref to "user_prefs"

Status: VERIFIED FIXED

(Firefox :: New Tab Page, enhancement)

Description

[Nan Jiang [:nanj]]

This allows us to measure the enable/disable rates for the sponsored TopSites feature.

Comment 1

[Nan Jiang [:nanj]]

Attachment: Bug 1689496 - Add showSponsoredTopSites to user_prefs r=thecount

Comment 2

[Nan Jiang [:nanj]]

Attachment: data_review_request_sponsored_topsites.md

Comment 3

[Chris H-C :chutten]

Comment on attachment 9199937 [details]
data_review_request_sponsored_topsites.md

Load-balancing to Travis

Comment 4

[Travis Long [:travis_]]

Comment on attachment 9199937 [details]
data_review_request_sponsored_topsites.md

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?
   Yes

2. Is there a control mechanism that allows the user to turn the data collection on and off?
   Yes, through data collection opt-out or activity stream opt-out

3. If the request is for permanent data collection, is there someone who will monitor the data over time?
   Yes, Nan Jiang

4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?
   Category 2

5. Is the data collection request for default-on or default-off?
   default-on

6. Does the instrumentation include the addition of any new identifiers?
   No

7. Is the data collection covered by the existing Firefox privacy notice?
   Yes

8. Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No)
   No, the collection is permanent

9. Does the data collection use a third-party collection tool?
   No

Result: data-review+

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4ab7d6401938
Add showSponsoredTopSites to user_prefs r=thecount

Comment 6

[Nan Jiang [:nanj]]

:travis - thanks for the review!

Comment 7

[Alexandru Michis [:malexandru]]

https://hg.mozilla.org/mozilla-central/rev/4ab7d6401938

Comment 8

[Maria Heres, inactive, contact Ecosystem QA]

We have verified that observing the Browser Console when a New Tab page element is disabled or enabled from "about:preferences" a telemetry ping is sent which contains the "user_prefs" value for the previous state of the page (e.g. starting with all enabled, disabling Sponsored Top Sites -> 511, enabling Sponsored Top Sites -> 255) adjusted to include Sponsored Top Sites.

But that ping is not displayed when enabling or disabling "Web Search". :nanj, is this ok?

Preferences used when testing:
browser.ping-centre.log set to true
browser.search.region set to US
browser.topsites.useRemoteSetting set to true
browser.topsites.experiment.ebay-2020-1 set to true

Testing was performed on Windows 10, Linux Mint 20 and macOS 10.15.6 using Firefox Nightly 87.0a1 (Build ID: 20210208214800).

Comment 9

[Nan Jiang [:nanj]]

But that ping is not displayed when enabling or disabling "Web Search". :nanj, is this ok?

Thanks for the validation!

Yes, that's expected. Since the web search toggling behaves differently compared to other newtab components. Also, the user_prefs filed should be reported correctly (i.e. reflecting the current newtab configuration) in other Activity Stream pings (such as session and event pings).

Comment 10

[Maria Heres, inactive, contact Ecosystem QA]

I can confirm the user_prefs value is correctly reported for other randomly chosen Activity Stream pings. As a result I am marking this issue as verified fixed.