1829043 - Embedded Migration Wizard telemetry requirements in about:welcome

Status: VERIFIED FIXED

(Firefox :: Messaging System, enhancement, P2)

Description

[Punam Dahiya [:pdahiya]]

about:welcome sends action telemetry on click of primary buttons. With Embedded Migration wizard Import primary CTA is implemented inside custom migrationwizard component.

Scope of this bug is to implement listener in AboutWelcome container that listens to embedded Import primary CTA click and send primary click Action telemetry something like

AboutWelcomeUtils.sendActionTelemetry(props.messageId, "migrate_start");

https://searchfox.org/mozilla-central/rev/31f5847a4494b3646edabbdd7ea39cb88509afe2/browser/components/newtab/content-src/aboutwelcome/components/MultiStageAboutWelcome.jsx#356

Comment 1

[Shane Hughes [:aminomancer]]

The "Continue" button that appears after clicking the migration wizard's primary button also doesn't do anything. It needs to be hooked up to handleAction so it can advance screens. But I figure we can just set up an event listener on the migration wizard that, if the primary is the start button, we just send telemetry, and if the primary is the finish button, we advance screens. So makes sense to do both of those in this patch

Comment 2

[Shane Hughes [:aminomancer]]

Attachment: Bug 1829043 - Add actions for AboutWelcome embedded migration wizard. r=pdahiya,mconley

Add some properties to the migration wizard screen JSON to specify what
action to perform when CTAs inside the embedded migration wizard are
clicked. This lets us advance screens when the cancel or finish button
is clicked, and send telemetry when the start button is clicked. In
theory we could perform any special message actions too, but for now we
only need telemetry and screen navigation.

Comment 4

[Punam Dahiya [:pdahiya]]

[Tracking Requested - why for this release]:

Patch needed for embedded import wizard new user onboarding flow in Fx114

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/fb181ecc7a9c
Add actions for AboutWelcome embedded migration wizard. r=pdahiya,mconley

Comment 6

[Norisz Fay [:noriszfay]]

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

Comment 7

[Shane Hughes [:aminomancer]]

Comment on attachment 9330054 [details]
Bug 1829043 - Add actions for AboutWelcome embedded migration wizard. r=pdahiya,mconley

Beta/Release Uplift Approval Request

• User impact if declined: - Clicking the primary buttons in the about:welcome embedded migration wizard in 114 release will not advance screens, so the user would have to interact with the migration wizard and then click "Skip this step" to advance forward, which is confusing. The final step of the embedded wizard would be confusing since its primary button doesn't do anything without this patch.

• 114 release users will not send telemetry about interactions with the migration wizard.

• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• 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): The changes include listening to actions within the migration wizard and sending telemetry and advancing screens when the wizard's "finish" button is clicked. The behavior inside the wizard isn't affected, so it's more like an invisible layer on top of the wizard.
• String changes made/needed:
• Is Android affected?: No

Comment 8

[Pascal Chevrel (relman team) -> :pascalc]

Comment on attachment 9330054 [details]
Bug 1829043 - Add actions for AboutWelcome embedded migration wizard. r=pdahiya,mconley

Approved for 114 beta 3, thanks.

Comment 9

[Pascal Chevrel (relman team) -> :pascalc]

https://hg.mozilla.org/releases/mozilla-beta/rev/535bd7ac636b

Comment 10

[Shane Hughes [:aminomancer]]

Thanks!

Comment 11

[Marius Coman [:mcoman], Ecosystem QA]

I have tested this enhancement using the "browser.migrate.content-modal.about-welcome-behavior" pref set to "embedded" and I can confirm the following:

• An "IMPRESSION" ping is displayed in the "Browser Console" after the "Import" screen from the "about:welcome" page is displayed:
  TELEMETRY PING (about:welcome): {"experiments":{},"locale":"en-US","version":"114.0","release_channel":"beta","event":"IMPRESSION","event_context":"{\"page\":\"about:welcome\"}","message_id":"MR_WELCOME_DEFAULT_1_AW_IMPORT_SETTINGS_EMBEDDED_PIMG","addon_version":"20230511191645","client_id":"c91b03d4-a646-484f-a431-e4772328d609","browser_session_id":"cefa8c4e-bd36-479e-943b-ad192a7a82b5"

• An "CLICK_BUTTON" ping containing the "primary_button" attribute is displayed in the "Browser Console" if the "Import" primary button from first part of the "Import" screen is clicked:
  TELEMETRY PING (about:welcome): {"experiments":{},"locale":"en-US","version":"114.0","release_channel":"beta","event":"CLICK_BUTTON","event_context":"{\"source\":\"primary_button\",\"page\":\"about:welcome\"}","message_id":"MR_WELCOME_DEFAULT_1_AW_IMPORT_SETTINGS_EMBEDDED","addon_version":"20230511191645","client_id":"c91b03d4-a646-484f-a431-e4772328d609","browser_session_id":"cefa8c4e-bd36-479e-943b-ad192a7a82b5"}

• An "CLICK_BUTTON" ping containing the "migrate_close" source is displayed in the "Browser Console" if the "Continue" primary button from second part of the "Import" screen is clicked:
  TELEMETRY PING (about:welcome): {"experiments":{},"locale":"en-US","version":"114.0","release_channel":"beta","event":"CLICK_BUTTON","event_context":"{\"source\":\"migrate_close\",\"page\":\"about:welcome\"}","message_id":"MR_WELCOME_DEFAULT_1_AW_IMPORT_SETTINGS_EMBEDDED","addon_version":"20230511191645","client_id":"c91b03d4-a646-484f-a431-e4772328d609","browser_session_id":"cefa8c4e-bd36-479e-943b-ad192a7a82b5"}

Tested using the latest Firefox Nightly (115.0a1 Build ID - 20230512094914) and latest Firefox Beta (114.0b3 Build ID - 20230511191645) installed on Windows 10 x64, macOS 12.6.1, and Ubuntu 22.04 x64.

@Shane, could you please confirm if those are the correct telemetry that we should verify on this enhancement?

Comment 12

[Shane Hughes [:aminomancer]]

(In reply to Marius Coman [:mcoman], Ecosystem QA from comment #11)

I have tested this enhancement using the "browser.migrate.content-modal.about-welcome-behavior" pref set to "embedded" and I can confirm the following:
@Shane, could you please confirm if those are the correct telemetry that we should verify on this enhancement?

Thanks for the thorough testing! Yes, those pings look perfect!

Comment 13

[Marius Coman [:mcoman], Ecosystem QA]

Thanks, Shane, for the quick reply!

Considering this I am marking this enhancement as Verified.