1879125 - Add telemetry for autoOpen settings toggle

Status: VERIFIED FIXED

(Firefox Graveyard :: Shopping, enhancement, P1)

Description

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Record an event when the settings auto-open toggle is clicked.

In related bug 1879119, we add telemetry to record changes to the autoOpen.userEnabled pref, so we don't need to record that here.

Comment 1

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

[Tracking Requested - why for this release]: We're missing a few telemetry probes for new UI that's already been uplifted into 123.

Comment 2

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Attachment: Bug 1879125 - Add telemetry for auto-open toggle clicks r?#shopping-reviewers,perry.mcmanis

Comment 3

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Comment on attachment 9378819 [details]
Bug 1879125 - Add telemetry for auto-open toggle clicks r?#shopping-reviewers,perry.mcmanis

DATA REVIEW REQUEST

1. What questions will you answer with this data?

Measure user interaction with experimental auto-open shopping changes shipping in 123, specifically, record when users click on the auto-open toggle.

2. Why does Mozilla need to answer these questions? Are there benefits for users?
   Do we need this information to address product or business requirements?

Product wants to track how often users disable and re-enable auto-open.

3. What alternative methods did you consider to answer these questions?
   Why were they not sufficient?

To measure clicks, we must instrument clicks.

4. Can current instrumentation answer these questions?

No.

5. List all proposed measurements and indicate the category of data collection for each
   measurement, using the Firefox data collection categories found on the Mozilla wiki.

Measurement Name	Measurement Description	Data Collection Category	Tracking Bug
`shopping.surface_auto_open_setting_toggled#action	Whether the toggle was used to enable or disable auto-open. Possible values are enabled and disabled.	interaction	https://bugzilla.mozilla.org/show_bug.cgi?id=1879125

6. Please provide a link to the documentation for this data collection which
   describes the ultimate data set in a public, complete, and accurate way.

This collection is Glean so is documented in the Glean Dictionary.

7. How long will this data be collected?

This collection has expiry '134'.

8. What populations will you measure?

All channels, countries, and locales, but this feature will be limited to a small experimental short-lived en-US audience for the initial data collection.

9. If this data collection is default on, what is the opt-out mechanism for users?

These collections are Glean. The opt-out can be found in the product's preferences.

10. Please provide a general description of how you will analyze this data.

Internal dashboards.

11. Where do you intend to share the results of your analysis?

Internally.

12. Is there a third-party tool (i.e. not Glean or Telemetry) that you
    are proposing to use for this data collection?

No.

Comment 4

[Chris H-C :chutten]

Comment on attachment 9378819 [details]
Bug 1879125 - Add telemetry for auto-open toggle clicks r?#shopping-reviewers,perry.mcmanis

PRELIMINARY NOTES:

I prefer data reviews to be in text attachments. Fits my workflow better as I can use the attachments details view to see the request and formulate the response at the same time.

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 can be controlled through the product's preferences.

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

No. This collection will expire in Firefox 134.

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 5

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Comment on attachment 9378819 [details]
Bug 1879125 - Add telemetry for auto-open toggle clicks r?#shopping-reviewers,perry.mcmanis

Beta/Release Uplift Approval Request

• User impact if declined: We need to track user interactions with the auto-open feature we've added in 123.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This patch just adds telemetry to an existing toggle. It includes tests. The feature is preffed off and will only be shown to a small experimental audience in en-US.
• String changes made/needed: None
• Is Android affected?: No

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/70f976446331
Add telemetry for auto-open toggle clicks r=perry.mcmanis

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/7b7a8120c5e7
fix eslint failures in browser/components/shopping/tests/browser/browser_ui_telemetry.js. r=lint-fix CLOSED TREE

Comment 8

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/70f976446331
https://hg.mozilla.org/mozilla-central/rev/7b7a8120c5e7

Comment 9

[Pascal Chevrel:pascalc]

Comment on attachment 9378819 [details]
Bug 1879125 - Add telemetry for auto-open toggle clicks r?#shopping-reviewers,perry.mcmanis

Approved for 123 beta 9, thanks. (I am also taking the eslint fix commit to beta)

Comment 10

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/024aa29904e4
https://hg.mozilla.org/releases/mozilla-beta/rev/7d9d609d626f

Comment 11

[Pascal Chevrel:pascalc]

https://hg.mozilla.org/releases/mozilla-beta/rev/024aa29904e4
https://hg.mozilla.org/releases/mozilla-beta/rev/7d9d609d626f

Comment 12

[Rares Doghi, Desktop QA]

Verified as fixed in our latest Nightly build 20240208095423.

Comment 13

[Rares Doghi, Desktop QA]

Verfied as fixed in our latest Beta build 123.0b9 20240209102425.