1801290 - Improve history sidebar telemetry

Status: VERIFIED FIXED

(Firefox :: Firefox View, task, P1)

Description

[Sarah Clements [:sclements]]

The code here shows that there's telemetry being tracked regardless of whether there's an input for search. We should fix that and possibly track the types of filters people select.

We need this fixed before we start using the search in other surfaces, since it's not giving us any useful data.

Comment 1

[Sarah Clements [:sclements]]

:mak, if this isn't something your team has time for in the next week or two, we can have FX View engineers pick it up.

Comment 2

[Marco Bonardo [:mak]]

We are fully focused on the urlbar, fixing telemetry here to not account for empty searches is something we can do, but if you need additional probes to measure filters usage, I'd suggest checking if you can find someone in your team, because that will require more time for data-review and testing.

Comment 3

[Sarah Clements [:sclements]]

I think the filters probes could be useful. Mike, what do you think? We could cut a JIRA ticket for our team and flesh out any further telemetry requirements.

Comment 4

[Mike Kaply [:mkaply]]

I definitely think the filters probe would be useful. I wonder if we can even find out how many times people do something before actually clicking on a link?

Like "go to sidebar, search, search again, change filter, search, search, click"

Comment 5

[Marco Bonardo [:mak]]

setting as P5-S4 for the bookmarks system, but feel free to adjust the priority based on your needs.

Comment 6

[Sarah Clements [:sclements]]

:mak, we can have our team pick this up.

Comment 7

[:prathiksha]

Attachment: Bug 1801290 - Improve history sidebar telemetry.

Comment 8

[Ray Fambro]

Comment on attachment 9306031 [details]
Bug 1801290 - Improve history sidebar telemetry.

https://docs.google.com/document/d/1mYE8wiB0FaAz2ADvcqyDjMcQRHpu-38XPzG08iubqDA/edit#

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/adae65ae94ec
Improve history sidebar telemetry. r=mkaply

Comment 10

[Natalia Csoregi [:nataliaCs]]

Backed out for causing failures on browser_places_search_telemetry.js

• backout: https://hg.mozilla.org/integration/autoland/rev/bfb4b7f26e57e79e8eadb8de84c384d2d1587056
• push: https://treeherder.mozilla.org/jobs?repo=autoland&group_state=expanded&selectedTaskRun=ZolrdyIuRNWF1WqrYl_H2A.0&revision=adae65ae94ec39d7c9e462c1eb8278ed7560d824
• failure log: https://treeherder.mozilla.org/logviewer?job_id=398922804&repo=autoland&lineNumber=9188

[task 2022-12-07T17:07:47.465Z] 17:07:47     INFO - TEST-UNEXPECTED-FAIL | browser/components/places/tests/browser/browser_places_search_telemetry.js | Should have found an entry for PLACES_SEARCHBAR_CUMULATIVE_SEARCHES at index 2 - false == true - JS frame :: resource://testing-common/TelemetryTestUtils.jsm :: assertHistogram :: line 370
[task 2022-12-07T17:07:47.466Z] 17:07:47     INFO - Stack trace:
[task 2022-12-07T17:07:47.466Z] 17:07:47     INFO - resource://testing-common/TelemetryTestUtils.jsm:assertHistogram:370
[task 2022-12-07T17:07:47.467Z] 17:07:47     INFO - chrome://mochitests/content/browser/browser/components/places/tests/browser/browser_places_search_telemetry.js:test_places_search_telemetry:63
[task 2022-12-07T17:07:47.467Z] 17:07:47     INFO - Not taking screenshot here: see the one that was previously logged
[task 2022-12-07T17:07:47.468Z] 17:07:47     INFO - TEST-UNEXPECTED-FAIL | browser/components/places/tests/browser/browser_places_search_telemetry.js | Should have found an entry for PLACES_SEARCHBAR_CUMULATIVE_FILTER_COUNT at index 1 - false == true - JS frame :: resource://testing-common/TelemetryTestUtils.jsm :: assertHistogram :: line 370
[task 2022-12-07T17:07:47.469Z] 17:07:47     INFO - Stack trace:
[task 2022-12-07T17:07:47.469Z] 17:07:47     INFO - resource://testing-common/TelemetryTestUtils.jsm:assertHistogram:370
[task 2022-12-07T17:07:47.470Z] 17:07:47     INFO - chrome://mochitests/content/browser/browser/components/places/tests/browser/browser_places_search_telemetry.js:test_places_search_telemetry:68
[task 2022-12-07T17:07:47.471Z] 17:07:47     INFO - withSidebarTree: waiting sidebar load
[task 2022-12-07T17:07:47.479Z] 17:07:47     INFO - GECKO(2471) | [Parent 2471, Main Thread] WARNING: NS_ENSURE_SUCCESS(rv, rv) failed with result 0x80004005 (NS_ERROR_FAILURE): file /builds/worker/checkouts/gecko/chrome/nsChromeRegistry.cpp:180
[task 2022-12-07T17:07:47.480Z] 17:07:47     INFO - GECKO(2471) | [Parent 2471, Main Thread] WARNING: 'NS_FAILED(rv)', file /builds/worker/checkouts/gecko/chrome/nsChromeProtocolHandler.cpp:73
[task 2022-12-07T17:07:47.482Z] 17:07:47     INFO - Console message: Invalid chrome URI (need path): chrome://browser/
[task 2022-12-07T17:07:47.483Z] 17:07:47     INFO - GECKO(2471) | [Parent 2471: Main Thread]: I/DocShellAndDOMWindowLeak ++DOMWINDOW == 33 (7fa2a0f2d800) [pid = 2471] [serial = 383] [outer = 7fa2e7bebc60]
[task 2022-12-07T17:07:47.504Z] 17:07:47     INFO - withSidebarTree: executing the task

Comment 11

[:prathiksha]

We're landing the patch without a test for now. Tests will be added in https://bugzilla.mozilla.org/show_bug.cgi?id=1805250 soon.

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/fb46a8aabbf1
Improve history sidebar telemetry. r=mkaply

Comment 13

[Sandor Molnar[:smolnar]]

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

Comment 14

[:prathiksha]

Attachment: Firefox View Data Collection Request - Sidebar Telemetry.txt

Comment 15

[Chris H-C :chutten]

Comment on attachment 9308009 [details]
Firefox View Data Collection Request - Sidebar Telemetry.txt

DATA COLLECTION REVIEW RESPONSE:

Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes.

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

Yes. This collection is Telemetry so can be controlled through Firefox's Preferences.

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

Yes, Ray Fambro is responsible.

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

Category 2, Interaction.

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

Default on for all channels.

Does the instrumentation include the addition of any new identifiers?

No.

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

Yes.

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

No.

---

Result: datareview+

Comment 16

[:prathiksha]

Comment on attachment 9306031 [details]
Bug 1801290 - Improve history sidebar telemetry.

Beta/Release Uplift Approval Request

• User impact if declined: None
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: 1. Visit a few websites.

2. Open the history sidebar from View > Sidebar > History in the menubar.
3. Perform an arbitrary no. of searches and also apply the search filter a few times.
4. Click on a link in the searchbar.
5. Open about:telemetry and navigate to Histograms. Check that PLACES_SEARCHBAR_CUMULATIVE_SEARCHES and PLACES_SEARCHBAR_CUMULATIVE_FILTER_COUNT histograms have recorded a data point for the no. of searches performed and for the no. of search filters applied.

• List of other uplifts needed: None
• Risk to taking this patch: Medium
• Why is the change risky/not risky? (and alternatives if risky): Not very risky because it affects a small no. of users who use the history sidebar. Also, the patch is not introducing any user-facing changes. We are collecting interaction data about the sidebar.
• String changes made/needed: None
• Is Android affected?: No

Comment 17

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9306031 [details]
Bug 1801290 - Improve history sidebar telemetry.

Approved for 109.0b5.

Comment 18

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/4a46add1a948

Comment 19

[Alin Ilea, Desktop QA]

Verified - Fixed in latest Nightly 110.0a1 (2022-12-20) using Windows 10, macOS 12 and Ubuntu 20.

Comment 20

[Alin Ilea, Desktop QA]

Verified - Fixed in Beta 109.0b5 (build id: 20221220185745) using Windows 10, macOS 12 and Ubuntu 20.