1805717 - Add a property to distinguish when the urlbar is in Search Mode

Status: VERIFIED FIXED

(Firefox :: Address Bar, enhancement, P3)

Description

[Marco Bonardo [:mak]]

When an event is recorded, right now it's not trivial to understand if the urlbar was in the default search-all mode or in a restriction mode like tabs, bookmarks, history... or a search engine.

It sounds like it would be useful to have a new search_mode: "engine"|"bookmarks"|"tabs"|... property in the event to track that fact.
Otherwise we could add it to an existing property, but I'm not sure where, the only one may be the sap property, but how we entered the sap and the current mode are orthogonal facts, so probably not the best idea.

Comment 1

[James Teow [:jteow]]

I think that makes sense, is that information for sending via Glean to help gain more context on particular events? That would definitely be helpful in measuring the impact of future projects on search mode usage. It also seems more intuitive than adding multiple variants in sap, because it is ultimately using the urlbar.

Small thing, but if search mode is not initiated, should the property remain empty vs. not be defined? I'm just looking at the object example in the QA for Urlbar Engagement Telemetry document and I see selected_resulted_subtype exists but is empty, so I'm assuming the search_mode property would also be "" when none is selected.

Comment 2

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1805717: Introduce search_mode property.

Comment 3

[Marco Bonardo [:mak]]

(In reply to James Teow [:jteow] from comment #1)

so I'm assuming the search_mode property would also be "" when none is selected.

Makes sense.

Comment 4

[Daisuke Akatsuka (:daisuke)]

Attachment: data-review-request-for-bug1805717.md

Comment 5

[Megan McCorquodale]

Comment on attachment 9308588 [details]
data-review-request-for-bug1805717.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, this will be documented in the Glean dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off?
   Yes, users can opt out of telemetry data collection.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?
   This will be monitored by the search and suggest team.

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, 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?
   No new identifiers.

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

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

---

data-review +

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3adf002ab926
Introduce search_mode property. r=mak,jteow

Comment 7

[Serban Stanca [:SerbanS]]

Backed out for searchMode mochitests related failures in browser_touchbar_searchrestrictions.js.

• Backout link
• Push with failures
• Failure Log
• Failure line: TEST-UNEXPECTED-FAIL | browser/components/touchbar/tests/browser/browser_touchbar_searchrestrictions.js | Expected searchMode - {"source":2,"isPreview":false,"entry":"touchbar"} deepEqual {"source":2,"telemetryLabel":"history","entry":"touchbar","isPreview":false} - JS frame :: resource://testing-common/UrlbarTestUtils.sys.mjs :: assertSearchMode :: line 577

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/344d36ca528b
Introduce search_mode property. r=mak,jteow

Comment 9

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/344d36ca528b

Comment 10

[Cristian Baica [:cbaica], Release Desktop QA]

The issue is verified fixed using the latest nightly Fx 119.0a1 on Windows 10 and Ubuntu 20.04. The search_mode parameter is correctly recorded in an event ping, having the following values as per specific search: search_engine, tabs, history, bookmarks.