1617631 - Add "topsite" type to FX_URLBAR_SELECTED_RESULT_TYPE and FX_URLBAR_SELECTED_RESULT_INDEX_BY_TYPE

Status: VERIFIED FIXED

(Firefox :: Address Bar, task, P1)

Description

[Marco Bonardo [:mak]]

We'd like to have a long term measurement for top sites, we already have these histograms that track result types based on position. Top sites is not a separate result type in code, but it is conceptually very different from a normal result.
It sounds like splitting these results into a topsite type would allow us to easily get telemetry and uplift it.

Comment 1

[Marco Bonardo [:mak]]

Attachment: Bug 1617631 - Add a topsite type to the FX_URLBAR_SELECTED_RESULT_(TYPE/INDEX_BY_TYPE) histograms. r=adw

Comment 2

[Marco Bonardo [:mak]]

Attachment: data-review.txt

This is just adding a key to 2 existing enumerated histograms, Chutten suggested to ask for a data-review still, reusing the original one. At the time these were added we didn't have a data-review template, thus I'm filing it from scratch.
The original histograms were added in bug 775825 and bug 1345834

Comment 3

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

Comment on attachment 9128903 [details]
data-review.txt

Some conversation supporting the Cat 2 categorization from #data-stewards:mozilla.org:

>  it's the same as top sites in the new tab page. top sites are taken from the new tab page list, and we show them in the urlbar when there's no search string or if you click on the urlbar when it shows the currently loaded page

So a click here conveys the same amount of information as clicking on a topsite marker on newtab, which we already collect, and it would be difficult to learn if any specific user visited any specific site from observing this probe.

--

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, in Histograms.json and the probe dictionary in conjunction with the referenced source file and in-tree docs.

2) Is there a control mechanism that allows the user to turn the data collection on and off?

Yes, the Firefox telemetry opt-out.

3) If the request is for permanent data collection, is there someone who will monitor the data over time?

The Firefox search team, specifically :teon.

4) Using the **[category system of data types](https://wiki.mozilla.org/Firefox/Data_Collection)** on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 2, interaction data.

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**?

Nope.

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

It is!

8) Does there need to be a check-in in the future to determine whether to renew the data?

No, this is a permanent collection.

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

No.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a771166234c4
Add a topsite type to the FX_URLBAR_SELECTED_RESULT_(TYPE/INDEX_BY_TYPE) histograms. r=adw

Comment 5

[Marco Bonardo [:mak]]

Comment on attachment 9128890 [details]
Bug 1617631 - Add a topsite type to the FX_URLBAR_SELECTED_RESULT_(TYPE/INDEX_BY_TYPE) histograms. r=adw

Beta/Release Uplift Approval Request

• User impact if declined: This is additional telemetry that we need for our new design pref-flip experiment in Firefox 74
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: When the new design is on (included openViewOnFocus), and top sites are enabled for the New tab page, picking a top site page should increase the "topsite" count in FX_URLBAR_SELECTED_RESULT_TYPE and FX_URLBAR_SELECTED_RESULT_INDEX_BY_TYPE histograms.
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): It only affects a disabled by default feature
• String changes made/needed:

Comment 6

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/mozilla-central/rev/a771166234c4

Comment 7

[Pascal Chevrel:pascalc]

Comment on attachment 9128890 [details]
Bug 1617631 - Add a topsite type to the FX_URLBAR_SELECTED_RESULT_(TYPE/INDEX_BY_TYPE) histograms. r=adw

Low risk, has tests, uplift accepted for the beta branch before the merge and RC.

Comment 8

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/releases/mozilla-beta/rev/f6c28964ef8f

Comment 9

[Alexandru Trif, Desktop Test Engineering [:atrif]]

Verified using Firefox 75.0a1 (20200301213924) and 74.0b10 (20200228161510) from comment 8, while having browser.urlbar.openViewOnFocus and browser.urlbar.update1 to true on Windows 10x64, macOS 10.15 and Ubuntu 18.04:

1. the FX_URLBAR_SELECTED_RESULT_TYPE count in "Histograms" is correctly shown for the number 13 as a total of clicks for top sites section in the URL bar.
2. the FX_URLBAR_SELECTED_RESULT_INDEX_BY_TYPE in "Keyed Histograms" count is correctly shown for each row that is clicked from topsites section in the URL bar.