1734447 - Record in telemetry environment the user's choice in the Firefox Suggest online opt-in onboarding dialog/modal

Status: VERIFIED FIXED

(Firefox :: Address Bar, task, P1)

Description

[Drew Willcoxon :adw]

We should record in telemetry environment the user's choice in the Firefox Suggest onboarding dialog. I confirmed with Rebecca that this will be useful data. This will use the new pref added in bug 1733687.

Comment 1

[Drew Willcoxon :adw]

Attachment: request.md

The patch that implements this telemetry isn't posted yet, but I'll post it soon.

Comment 2

[Drew Willcoxon :adw]

Attachment: Bug 1734447 - Record in telemetry environment the user's choice in the Firefox Suggest online opt-in onboarding dialog/modal.

Comment 3

[Drew Willcoxon :adw]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=c5f4d77fd3750259118a799c90aa2ef8cc9cd24e

Comment 4

[Teon Brooks [:teon]]

Comment on attachment 9244602 [details]
request.md

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. This collection is Telemetry so is documented in its definitions file TelemetryEnvironment.jsm.

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, Drew Willcoxon 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 there need to be a check-in in the future to determine whether to renew the data?

No. This collection is permanent.

---

Result: datareview+

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b7d477f1689d
Record in telemetry environment the user's choice in the Firefox Suggest online opt-in onboarding dialog/modal. r=chutten,dao

Comment 6

[Noemi Erli[:noemi_erli]]

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

Comment 7

[Drew Willcoxon :adw]

STR for QA

This is very similar to bug 1733687 except here we're verifying telemetry instead of a pref.

1. Enroll in Firefox Suggest online
2. Restart Firefox to trigger the online opt-in onboarding modal dialog
3. Click the Allow button
4. Open about:telemetry, click the Environment Data tab, scroll down to the settings section, and verify that userPrefs.browser.urlbar.quicksuggest.onboardingDialogChoice is present with value accept
5. Please repeat the STR for the other controls in the dialog: the Customize button, Learn more link, and Not now link
6. Please repeat the STR but instead of clicking a button, press: the Enter key to accept the dialog, and the Escape key to dismiss the dialog
7. Please repeat the STR but instead of clicking a button, use a keyboard shortcut to quit Firefox (e.g., Command-Q on Mac). The dialog should close and another dialog should open that asks if you want to quit Firefox. You can cancel that quit dialog.

Depending on how you closed the dialog, the userPrefs.browser.urlbar.quicksuggest.onboardingDialogChoice setting should have the following values:

• Allow button: accept
• Customize button: settings
• Learn more link: learn_more
• Not now link: not_now_link
• Enter key: accept
• Escape key: dismissed_escape_key
• Quit dialog opened: dismissed_other

Comment 8

[Drew Willcoxon :adw]

Comment on attachment 9244612 [details]
Bug 1734447 - Record in telemetry environment the user's choice in the Firefox Suggest online opt-in onboarding dialog/modal.

Beta/Release Uplift Approval Request

• User impact if declined: This is required for Firefox Suggest rollouts.
• 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: Please see comment 7
• List of other uplifts needed: Bug 1733687
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This change simply updates some telemetry when the user interacts with the Firefox Suggest onboarding dialog. Has thorough automated tests.
• String changes made/needed:

Comment 9

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9244612 [details]
Bug 1734447 - Record in telemetry environment the user's choice in the Firefox Suggest online opt-in onboarding dialog/modal.

Approved for 94.0b4.

Comment 10

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/2bd9ac2d4f2f

Comment 11

[Cosmin Muntean [:cmuntean], Ecosystem QA]

I have verified this issue on the latest Beta 94.0b4 (Build ID: 20211010185747) and the latest Nightly 95.0a1 (Build ID: 20211010214947) on Windows 10 x64, macOS 10.15.7 and Ubuntu 20.04 x64.

• The "browser.urlbar.quicksuggest.onboardingDialogChoice" pref, the "browser.urlbar.quicksuggest.onboardingDialogChoice" preference, and the "contextservices.quicksuggest" event are correctly registered for each scenario and have the correct values as described in the comment 7.